You are here: Start » Function Reference » System
System
Assertions |
||||
Icon | Name | Description / Applications | Modules | |
---|---|---|---|---|
AssertImageEqualTo | Asserts that two images are equal or differ by a small given margin. |
FoundationLite | ||
Binary Data |
||||
Icon | Name | Description / Applications | Modules | |
LoadBuffer | Reads bytes from a file and returns them as a bytes buffer. |
FoundationLite | ||
SaveBuffer | Writes bytes from a byte buffer to a file. |
FoundationLite | ||
Configuration |
||||
Icon | Name | Description / Applications | Modules | |
ChargeImageMemoryPools | Preallocates memory buffers for images. This may improve performance when many images are created and destroyed in an application. |
FoundationLite | ||
CheckLicense | Check license for a specified module. |
FoundationLite | ||
ControlAVX2 | Enables or disables AVX2 cpu extension usage by other filters. |
FoundationLite | ||
ControlImageMemoryPools | Enables or disables deterministic image memory allocator. This may improve performance when many images are created and destroyed in an application. |
FoundationLite | ||
ControlParallelComputing | Enables or disables filters multithreading parallelization. |
FoundationLite | ||
ControlSIMD | Enables or disables SIMD cpu extension (e.g. SSE, AVX2, NEON) usage by other filters. This filter does not affect third party components e.g. camera software, OpenCV. |
FoundationLite | ||
ControlSSE | Enables or disables SSE cpu extension usage by other filters. |
FoundationLite | ||
DischargeImageMemoryPools | Releases preallocated image memory buffers. |
FoundationLite | ||
GetAvailableLicenses | Reads available licenses in the system. |
FoundationLite | ||
GetComputerID | Gets current Computer ID. Can be used for creating custom license protection for integrator's applications. |
FoundationLite | ||
GetDongleSerialNumber | Gets the current usb dongle's serial number. |
FoundationBasic | ||
GetLibraryVersion | Gets current library version. |
FoundationLite | ||
GetThreadLimitInfo | Returns how many threads are possible and a list of threads currently being used. Makes it easier to diagnose licensing problems related to exceeding the limit of threads. |
FoundationLite | ||
InitLibrary | Initializes library internals. Should be called before any other function from AVL. If you do not call this first, initialization will be done in the first iteration, possibly affecting system's performance. |
FoundationLite | ||
InspectImageMemoryPools | Returns information about allocated image memory buffers. This information can be used for preallocation. |
FoundationLite | ||
VerifyProjectID | Verifies a project ID. This tools is useful for system integrators who need verification if a system is used with a license coming from a legitimate source. |
FoundationBasic | ||
WriteLog | Write log message with selected log level. |
FoundationLite | ||
File System |
||||
Icon | Name | Description / Applications | Modules | |
EnumerateObjects | Enumerates the avdata files present in a disk directory and sorts them according to the specified order and loads an object from a file. |
FoundationLite | ||
EnumerateFiles | Enumerates the files present in a disk directory. |
FoundationLite | ||
EnumerateFiles_Random | Enumerates the files present in a disk directory sorted randomly. |
FoundationLite | ||
EnumerateObjects | Enumerates the avdata files present in a disk directory and sorts them according to the specified order and loads an object from a file. |
FoundationLite | ||
CheckDiskSpace | Determines the information about the filesystem on which the pathname inPath is located. |
FoundationLite | ||
ConvertPathToAbsolute | Makes the path absolute, inStartPath + inPath |
FoundationLite | ||
ConvertPathToRelative | Makes the path relative to inBasePath |
FoundationLite | ||
CopyFiles | Copies files that match a pattern from a directory to other directory. |
FoundationLite | ||
CreateDirectories | Creates a directory tree if it does not exist. |
FoundationLite | ||
FileAttributes | Provides information about file, e.g. size, modification time |
FoundationLite | ||
FileChecksum | Returns CRC checksum of the input file. |
FoundationLite | ||
FindDirectories | Returns subdirectories of the input directory. |
FoundationLite | ||
FindFiles | Returns files of the input directory. |
FoundationLite | ||
JoinPathParts | Joins path parts |
FoundationLite | ||
RemoveFile_ByTime | Removes files older than the specified date/time from a directory. |
FoundationLite | ||
RemoveFile_Multiple | Removes files that match a pattern from a directory. |
FoundationLite | ||
RemoveFile_Single | Removes single file. |
FoundationLite | ||
SplitFileNameToParts | Splits the filename to base and extension, the extension is considered |
FoundationLite | ||
SplitPathToNameParent | Splits a file path into a file name and a parent directory |
FoundationLite | ||
SplitPathToParts | Determines the information about the filesystem on which the pathname inPath is located. |
FoundationLite | ||
TestDirectoryEmpty | Checks if a given directory is empty. |
FoundationLite | ||
TestDirectoryExists | Checks if a given directory is present. |
FoundationLite | ||
TestFileEmpty | Checks if the size of the file is equal to zero. |
FoundationLite | ||
TestFileExists | Checks if a given file is present. |
FoundationLite | ||
FTP |
||||
Icon | Name | Description / Applications | Modules | |
Ftp_ReceiveFile | Downloads a file from a remote server using FTP (File Transfer Protocol). |
FoundationLite | ||
Ftp_ReceiveImage | Downloads an image from a remote server using FTP (File Transfer Protocol). |
FoundationLite | ||
Ftp_ReceiveString | Downloads a text string from a remote server using FTP (File Transfer Protocol). |
FoundationLite | ||
Ftp_SendFile | Sends a file to a remote server using FTP (File Transfer Protocol). |
FoundationLite | ||
Ftp_SendImage | Sends an image to a remote server using FTP (File Transfer Protocol). |
FoundationLite | ||
Ftp_SendString | Sends a string to a remote serve using FTP (File Transfer Protocol). |
FoundationLite | ||
HTTP |
||||
Icon | Name | Description / Applications | Modules | |
Http_DecodeURL | Converts text from URL friendly text to a string. |
FoundationLite | ||
Http_EncodeURL | Converts string to URL friendly text. |
FoundationLite | ||
Http_SendBinaryData | Sends a raw HTTP request. |
FoundationLite | ||
Http_SendCustomRequest | Sends a custom HTTP request. |
FoundationLite | ||
Http_SendRequest_DELETE | Sends a DELETE request to server and receives a text answer. |
FoundationLite | ||
Http_SendRequest_DELETE_ByteBuffer | Sends a DELETE request to server and receives a binary answer. |
FoundationLite | ||
Http_SendRequest_GET | Sends a GET request to server and receives a text answer. |
FoundationLite | ||
Http_SendRequest_GET_ByteBuffer | Sends a GET request to server and receives a binary answer. |
FoundationLite | ||
Http_SendRequest_PATCH | Sends a PATCH request to the server and receives a text answer. |
FoundationLite | ||
Http_SendRequest_PATCH_ByteBuffer | Sends a PATCH request to the server and receives a text answer. |
FoundationLite | ||
Http_SendRequest_PATCH_JSON | Sends a PATCH request in JSON format to the server and receives a text answer. |
FoundationLite | ||
Http_SendRequest_POST | Sends a POST request to the server and receives a text answer. |
FoundationLite | ||
Http_SendRequest_POST_ByteBuffer | Sends a POST request to the server and receives a text answer. |
FoundationLite | ||
Http_SendRequest_POST_JSON | Sends a POST request in JSON format to the server and receives a text answer. |
FoundationLite | ||
Http_SendRequest_PUT | Sends a PUT request to the server and receives a text answer. |
FoundationLite | ||
Http_SendRequest_PUT_ByteBuffer | Sends a PUT request to the server and receives a text answer. |
FoundationLite | ||
Http_SendRequest_PUT_JSON | Sends a PUT request in JSON format to the server and receives a text answer. |
FoundationLite | ||
INI |
||||
Icon | Name | Description / Applications | Modules | |
INI_AddBoolValue | Adds or updates an INI value in the specified section & key. |
FoundationLite | ||
INI_AddIntegerValue | Adds or updates an INI value in the specified section & key. |
FoundationLite | ||
INI_AddRealValue | Adds or updates an INI value in the specified section & key.s |
FoundationLite | ||
INI_AddSection | Adds a new section. |
FoundationLite | ||
INI_AddStringValue | Adds or updates an INI value in the specified section & key. |
FoundationLite | ||
INI_GetAllSectionKeys | Gets all key names within a section. |
FoundationLite | ||
INI_GetAllSections | Gets all section names in the INI. |
FoundationLite | ||
INI_GetAllValues | Gets all values within a section & key. |
FoundationLite | ||
INI_GetBoolValue | Gets value from section & key. |
FoundationLite | ||
INI_GetIntegerValue | Gets value from section & key. |
FoundationLite | ||
INI_GetRealValue | Gets value from section & key. |
FoundationLite | ||
INI_GetStringValue | Gets value from section & key. |
FoundationLite | ||
INI_LoadFile | Loads an INI file. |
FoundationLite | ||
INI_SaveFile | Saves an INI file. |
FoundationLite | ||
Interoperability |
||||
Icon | Name | Description / Applications | Modules | |
LoadEntities_FromDxf | Loads entities from a DXF file as an array of point arrays. |
FoundationPro | ||
LoadImage_FromDxf | Loads data from a DXF file as an image. |
FoundationPro | ||
LoadImage_FromWebsite | Loads a JPG image from a website. |
FoundationBasic | ||
LoadPoint3DGrid | Loads entities from a file of one of available types as an array of points in 3D. |
FoundationBasic | ||
LoadPoint3DGridWithImage | Loads entities from a file of one of available types as an array of points in 3D and an image. Assumes an ordered rectangular grid with no holes. |
FoundationBasic | ||
LoadSurfaceWithImage | Loads entities from a file of one of available types as an array of points in 3D and an image. Assumes an unordered grid with possible holes. |
FoundationBasic | ||
SavePoint3DGrid | Saves Point3DGrid in to file in one of the supported formats. |
FoundationBasic | ||
Json |
||||
Icon | Name | Description / Applications | Modules | |
Json_SetFormatParameters | Sets format parameters of JSON data. |
FoundationLite | ||
Json_SetParseOptions | Sets parse options of JSON data. |
FoundationLite | ||
Modbus TCP |
||||
Icon | Name | Description / Applications | Modules | |
ModbusTCP_Close | Closes a connected Modbus socket gracefully. |
FoundationLite | ||
ModbusTCP_Connect | Connects as a client to a remote Modbus server socket. |
FoundationLite | ||
ModbusTCP_ForceMultipleCoils | Function Code 15. Forces each coil in a sequence of coils to either ON or OFF in a remote device |
FoundationLite | ||
ModbusTCP_ReadCoils | Function Code 01. Reads contiguous status of coils in a remote device |
FoundationLite | ||
ModbusTCP_ReadDiscreteInputs | Function Code 02. Reads contiguous status of discrete inputs in a remote device |
FoundationLite | ||
ModbusTCP_ReadExceptionStatus | Function Code 07. Attempts to read Exception Status |
FoundationLite | ||
ModbusTCP_ReadInputIntegerRegisters | Function Code 04. Reads contiguous input registers in a remote device |
FoundationLite | ||
ModbusTCP_ReadInputRealRegisters | Function Code 04. Reads contiguous input registers in a remote device |
FoundationLite | ||
ModbusTCP_ReadInputRegisters_AsByteBuffer | Function Code 03. Reads contiguous input registers in a remote device |
FoundationLite | ||
ModbusTCP_ReadMultipleIntegerRegisters | Function Code 03. Reads the contents of a contiguous block of holding registers in a remote device |
FoundationLite | ||
ModbusTCP_ReadMultipleRealRegisters | Function Code 03. Reads the contents of a contiguous block of holding registers in a remote device |
FoundationLite | ||
ModbusTCP_ReadMultipleRegisters_AsByteBuffer | Function Code 03. Reads the contents of a contiguous block of holding registers in a remote device |
FoundationLite | ||
ModbusTCP_SendBuffer | Sends data using Modbus TCP frame format. |
FoundationLite | ||
ModbusTCP_WriteCoil | Function Code 05. Writes a single output to either ON or OFF in a remote device |
FoundationLite | ||
ModbusTCP_WriteMultipleIntegerRegisters | Function Code 16. Writes a block of contiguous registers (1 to 123 registers) in a remote device |
FoundationLite | ||
ModbusTCP_WriteMultipleRealRegisters | Function Code 16. Writes a block of contiguous registers (1 to 123 registers) in a remote device |
FoundationLite | ||
ModbusTCP_WriteMultipleRegisters_AsByteBuffer | Function Code 16. Writes a block of contiguous registers (1 to 123 registers) in a remote device |
FoundationLite | ||
ModbusTCP_WriteSingleRegister | Function Code 06. Writes a single holding register in a remote device |
FoundationLite | ||
OPC UA |
||||
Icon | Name | Description / Applications | Modules | |
OPCUAClient_Close | Closes a connection with a OPC UA server. |
FoundationLite | ||
OPCUAClient_Connect | Establishes a connection to a OPC UA server |
FoundationLite | ||
OPCUAClient_ReadBoolValue | Reads a Boolean value of a variable node from a OPC UA server. |
FoundationLite | ||
OPCUAClient_ReadByteBufferValue | Reads a ByteString compatible value of a variable node from a OPC UA server. |
FoundationLite | ||
OPCUAClient_ReadDoubleValue | Reads a Double compatible value of a variable node from a OPC UA server. |
FoundationLite | ||
OPCUAClient_ReadIntegerArrayValue | Reads an Integer compatible array value of a variable node from a OPC UA server. |
FoundationLite | ||
OPCUAClient_ReadIntegerValue | Reads an up to 32bit Integer compatible value of a variable node from a OPC UA server. |
FoundationLite | ||
OPCUAClient_ReadLongValue | Reads an up to 64bit Integer compatible value of a variable node from a OPC UA server. |
FoundationLite | ||
OPCUAClient_ReadRealArrayValue | Reads a Float compatible array value of a variable node from a OPC UA server. |
FoundationLite | ||
OPCUAClient_ReadRealValue | Reads a Float compatible value of a variable node from a OPC UA server. |
FoundationLite | ||
OPCUAClient_ReadStringArrayValue | Reads a String compatible array value of a variable node from a OPC UA server. |
FoundationLite | ||
OPCUAClient_ReadStringValue | Reads a String compatible value of a variable node from a OPC UA server. |
FoundationLite | ||
OPCUAClient_SetupSecurityCertificates | Configures the security layers of OPC UA client to server connections for this application |
FoundationLite | ||
OPCUAClient_WriteBoolValue | Writes a Boolean value to a variable node in a OPC UA server. |
FoundationLite | ||
OPCUAClient_WriteByteBufferValue | Writes a ByteString value to a variable node in a OPC UA server. |
FoundationLite | ||
OPCUAClient_WriteDoubleValue | Writes a Double value to a variable node in a OPC UA server. |
FoundationLite | ||
OPCUAClient_WriteIntegerArrayValue | Writes an array of Integer values to a variable node in a OPC UA server. |
FoundationLite | ||
OPCUAClient_WriteIntegerValue | Writes an Integer value to a variable node in a OPC UA server. |
FoundationLite | ||
OPCUAClient_WriteLongValue | Writes a 64bit Integer value to a variable node in a OPC UA server. |
FoundationLite | ||
OPCUAClient_WriteRealArrayValue | Writes an array of Float values to a variable node in a OPC UA server. |
FoundationLite | ||
OPCUAClient_WriteRealValue | Writes a Float value to a variable node in a OPC UA server. |
FoundationLite | ||
OPCUAClient_WriteStringArrayValue | Writes an array of String values to a variable node in a OPC UA server. |
FoundationLite | ||
OPCUAClient_WriteStringValue | Writes a String value to a variable node in a OPC UA server. |
FoundationLite | ||
OPCUA_FormatDateTime | Converts the OPC UA DateTime timestamp value to a readable formats |
FoundationLite | ||
Process |
||||
Icon | Name | Description / Applications | Modules | |
ReadEnvironmentVariable | Reads environment variable by given name. |
FoundationLite | ||
ReadEnvironmentVariable_OrNil | Reads environment variable by given name. |
FoundationLite | ||
Serial Port |
||||
Icon | Name | Description / Applications | Modules | |
SerialPort_Config | Configures the serial port. |
FoundationLite | ||
SerialPort_ReadBuffer | Reads raw binary data from serial port. |
FoundationLite | ||
SerialPort_ReadByte | Reads one character in binary mode from serial port. |
FoundationLite | ||
SerialPort_ReadChar | Reads single character from serial port. |
FoundationLite | ||
SerialPort_ReadString | Reads string characters from serial port. |
FoundationLite | ||
SerialPort_ReadStringUntil | Reads the string from the serial port to encounter a string delimiter. |
FoundationLite | ||
SerialPort_WriteBuffer | Writes raw binary data from a byte buffer to serial port. |
FoundationLite | ||
SerialPort_WriteByte | Writes one character in binary mode to serial port. |
FoundationLite | ||
SerialPort_WriteChar | Writes single ASCII character to device. |
FoundationLite | ||
SerialPort_WriteString | Writes string characters to serial port. |
FoundationLite | ||
TCP IP |
||||
Icon | Name | Description / Applications | Modules | |
TcpIp_Accept | Accepts a connection from a remote client. |
FoundationLite | ||
TcpIp_Close | Closes a connected TCP socket gracefully. |
FoundationLite | ||
TcpIp_Connect | Connects as a client to a remote TCP server socket. |
FoundationLite | ||
TcpIp_ReadAllBuffer | Receives data from a connected socket until the other side closes connection. |
FoundationLite | ||
TcpIp_ReadAllText | Receives text from a connected socket until the other side closes connection. |
FoundationLite | ||
TcpIp_ReadBuffer | Receives a fixed number of bytes from a connected TCP socket. |
FoundationLite | ||
TcpIp_ReadLine | Reads from a connected TCP socket until receiving a specific sequence. |
FoundationLite | ||
TcpIp_WriteBuffer | Outputs a block of raw data through a connected TCP socket. |
FoundationLite | ||
TcpIp_WriteText | Outputs a string through a connected TCP socket. |
FoundationLite | ||
Time |
||||
Icon | Name | Description / Applications | Modules | |
CurrentDateTime | Returns a string containing the date time information in selected format and all of the date time data separately. |
FoundationLite | ||
Delay | Suspends the program workflow for inTime milliseconds. |
FoundationLite | ||
DelayByPeriod | Suspends the program workflow for inTime milliseconds relative to the end of the filter's last invoke time. |
FoundationLite | ||
GetClockTime | Stops clock to measure performance. |
FoundationLite | ||
MakeDateTime | Returns a valid DateTime object completed with the input parameters. |
FoundationLite | ||
MeasurePeriod | Returns elapsed time in milliseconds from last filter call. |
FoundationLite | ||
StartClock | Starts clock to measure performance. |
FoundationLite | ||
User Input |
||||
Icon | Name | Description / Applications | Modules | |
GetKeyboardKeys | Returns virtual key codes of the pressed keys or NULL if no key was pressed. |
FoundationLite | ||
GetKeyboardKeyState | Checks if the specified keyboard key is down and if it is toggled. |
FoundationLite |