Standard Library Reference

Boca Raton Documentation Team

© 2024 HPCC Systems®. All rights reserved

We welcome your comments and feedback about this document via email to

Please include Documentation Feedback in the subject line and reference the document name, page numbers, and current Version Number in the text of the message.

LexisNexis and the Knowledge Burst logo are registered trademarks of Reed Elsevier Properties Inc., used under license.

HPCC Systems® is a registered trademark of LexisNexis Risk Data Management Inc.

Other products, logos, and services may be trademarks or registered trademarks of their respective companies.

All names and example data used in this manual are fictitious. Any similarity to actual persons, living or dead, is purely coincidental.


Logical Files
CompareFiles
DeleteLogicalFile
LogicalFileList
GetNoCommonDefault
FileExists
ForeignLogicalFileName
GetFileDescription
GetLogicalFileAttribute
ProtectLogicalFile
RenameLogicalFile
SetFileDescription
SetReadOnly
VerifyFile
SuperFiles
CreateSuperFile
SuperFileExists
DeleteSuperFile
GetSuperFileSubCount
GetSuperFileSubName
LogicalFileSuperOwners
LogicalFileSuperSubList
SuperFileContents
FindSuperFileSubName
StartSuperFileTransaction
AddSuperFile
RemoveSuperFile
ClearSuperFile
RemoveOwnedSubFiles
SwapSuperFile
ReplaceSuperFile
PromoteSuperFileList
FinishSuperFileTransaction
External Files
ExternalLogicalFileName
MoveExternalFile
DeleteExternalFile
CreateExternalDirectory
RemoteDirectory
File Browsing
SetColumnMapping
GetColumnMapping
AddFileRelationship
FileRelationshipList
RemoveFileRelationship
File Movement
DfuPlusExec
AbortDfuWorkunit
Copy
DeSpray
RemotePull
Replicate
SprayFixed
SprayDelimited / SprayVariable
SprayXML
SprayJson
WaitDfuWorkunit
SetExpireDays
GetExpireDays
ClearExpireDays
String Handling
CleanAccents
CleanSpaces
CompareAtStrength
CompareIgnoreCase
Contains
CountWords
DecodeBase64
EditDistance
EditDistanceWithinRadius
EncodeBase64
EndsWith
EqualIgnoreCase
ExcludeFirstWord
ExcludeLastWord
ExcludeNthWord
Extract
ExtractMultiple
Filter
FilterOut
Find
FindCount
FindAtStrength
FindAtStrengthReplace
FindReplace
FindWord
FromHexPairs
GetNthWord
RemoveSuffix
Repeat
Reverse
SplitWords
SubstituteExcluded
SubstituteIncluded
StartsWith
ToHexPairs
ToLowerCase
ToTitleCase
ToUpperCase
Translate
Version
WildMatch
WordCount
Metaphone Support
Primary
Secondary
Double
Cryptography Support
Cryptographic Library Overview
SupportedHashAlgorithms
SupportedSymmetricCipherAlgorithms
SupportedPublicKeyAlgorithms
Hashing Module
Hash
SymmetricEncryption Module
Encrypt (Symmetric)
Decrypt (Symmetric)
PublicKeyEncryption Module
Encrypt (PKE)
Decrypt (PKE)
Sign (PKE)
VerifySignature (PKE)
PublicKeyEncryptionFromBuffer Module
Encrypt (PKE From Buffer)
Decrypt (PKE From Buffer)
Sign (PKE From Buffer)
VerifySignature (PKE From Buffer)
PublicKeyEncryptionFromLFN Module
Encrypt (PKE From LFN)
Decrypt (PKE From LFN)
Sign (PKE From LFN)
VerifySignature (PKE From LFN)
Date and Time Handling
Date Data Types
Time Data Types
Year
Month
Day
Hour
Minute
Second
DateFromParts
TimeFromParts
IsLeapYear
IsDateLeapYear
IsValidDate
IsValidTime
IsValidGregorianDate
FromGregorianYMD
ToGregorianYMD
FromStringToDate
Today
CurrentDate
CurrentTime
DayOfWeek
DayOfYear
DaysBetween
MonthsBetween
AdjustDate
AdjustCalendar
MonthWeekNumFromDate
YearWeekNumFromDate
TimestampToString
UniqueTZAbbreviations
UniqueTZLocations
TZDataForLocation
FindTZData
SecondsBetweenTZ
AdjustTimeTZ
ToLocalTime
ToUTCTime
AppendTZOffset
AppendTZAdjustedTime
Cluster Handling
Node
Nodes
LogicalToPhysical
DaliServer
Group
GetExpandLogicalName
Job Handling
WUID
Target
Name
User
OS
Platform
LogString
File Monitoring
MonitorFile
MonitorLogicalFileName
Logging
dbglog
addWorkunitInformation
addWorkunitWarning
addWorkunitError
getGlobalId
getLocalId
generateGloballyUniqueID
getElapsedMs
Auditing
Audit
Utilities
GetHostName
ResolveHostName
GetUniqueInteger
GetEspUrl
PlatformVersionCheck
Debugging
GetParseTree
GetXMLParseTree
Sleep
msTick
Email
SendEmail
SendEmailAttachData
SendEmailAttachText
Workunit Services
WorkunitExists
WorkunitList
SetWorkunitAppValue
WUIDonDate
WUIDdaysAgo
WorkunitTimeStamps
WorkunitMessages
WorkunitFilesRead
WorkunitFilesWritten
WorkunitTimings
BLAS Support
Types
ICellFunc
Apply2Cells
dasum
daxpy
dgemm
dgetf2
dpotf2
dscal
dsyrk
dtrsm
extract_diag
extract_tri
make_diag
make_vector
trace
Math Support
Infinity
NaN
isInfinite
isNaN
isFinite
FMod
FMatch