You are here: Start » System

System

Icon	Name	Description / Applications
Assertions
	AssertImageEqualTo	Asserts that two images are equal or differ by a small given margin.
	AssertArraySizeEqualTo	Asserts that an array has expected size.
	AssertArraySizeNotEqualTo	Asserts that an array size is unequal to reference size.
	AssertObjectEqualTo	Asserts that an object is equal to the expected one.
	AssertObjectNil	Asserts that an object is Nil.
	AssertObjectNotEqualTo	Asserts that an object is not equal to the expected one.
	AssertObjectNotNil	Asserts that an object is not Nil.
	ThrowError	Throws specific error.
Binary Data
Icon	Name	Description / Applications
	LoadBuffer	Reads bytes from a file and returns them as a bytes buffer.
	ReadBoolFromBuffer	Reads boolean value in specified binary format from byte buffer.
	ReadBufferArrayFromBuffer	Splits chunk of data from byte buffer into array of buffers of equal sizes.
	ReadDoubleFromBuffer	Reads double value in specified binary format from a byte buffer.
	ReadIntegerArrayFromBuffer	Reads an array of integer values in specified binary format from a byte buffer.
	ReadIntegerFromBuffer	Reads integer value in specified binary format from a byte buffer.
	ReadLongFromBuffer	Reads integer value in specified binary format from a byte buffer.
	ReadRealFromBuffer	Reads real value in specified binary format from a byte buffer.
	ReadStringFromBuffer	Reads string value in specified binary format from a byte buffer.
	SaveBuffer	Writes bytes from a byte buffer to a file.
	WriteBoolToBuffer	Converts boolean value into specified integer binary representation and writes it to a byte buffer.
	WriteBufferArrayToBuffer	Writes connected content of all source buffer array items into other byte buffer.
	WriteBufferToBuffer	Writes content of a source byte buffer into other byte buffer.
	WriteDoubleToBuffer	Converts double value into specified binary representation and writes it to a byte buffer.
	WriteIntegerArrayToBuffer	Converts an array of integer values into specified binary representation and writes it to a byte buffer.
	WriteIntegerToBuffer	Converts integer value into specified binary representation and writes it to a byte buffer.
	WriteLongToBuffer	Converts integer value into specified binary representation and writes it to a byte buffer.
	WriteRealToBuffer	Converts real value into specified binary representation and writes it to a byte buffer.
	WriteStringToBuffer	Converts string value into specified binary representation and writes it to a byte buffer.
Configuration
Icon	Name	Description / Applications
	ChargeImageMemoryPools	Preallocates memory buffers for images. This may improve performance when many images are created and destroyed in an application.
	CheckLicense	Check license for a specified module.
	ControlAVX2	Enables or disables AVX2 cpu extension usage by other filters.
	ControlImageMemoryPools	Enables or disables deterministic image memory allocator. This may improve performance when many images are created and destroyed in an application.
	ControlParallelComputing	Enables or disables filters multithreading parallelization.
	ControlSIMD	Enables or disables SIMD cpu extension (e.g. SSE, AVX2, NEON) usage by other filters.
	ControlSSE	Enables or disables SSE cpu extension usage by other filters.
	DischargeImageMemoryPools	Releases preallocated image memory buffers.
	GetAvailableLicenses	Reads available licenses in the system.
	GetComputerID	Gets current Computer ID. Can be used for creating custom license protection for integrator's applications.
	GetLibraryVersion	Gets current library version.
	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.
	InitLibrary	Initializes library internals. Should be called before any other function from FIL. If you do not call this first, initialization will be done in the first iteration, possibly affecting system's performance.
	InspectImageMemoryPools	Returns information about allocated image memory buffers. This information can be used for preallocation.
	WriteLog	Write log message with selected log level.
File System
Icon	Name	Description / Applications
	EnumerateObjects	Enumerates the fidata files present in a disk directory and sorts them according to the specified order and loads an object from a file.
	EnumerateFiles	Enumerates the files present in a disk directory.
	EnumerateFiles_Random	Enumerates the files present in a disk directory sorted randomly.
	EnumerateObjects	Enumerates the fidata files present in a disk directory and sorts them according to the specified order and loads an object from a file.
	CheckDiskSpace	Determines the information about the filesystem on which the pathname inPath is located.
	CopyFiles	Copies files that match a pattern from a directory to other directory.
	CreateDirectories	Creates a directory tree if it does not exist.
	FileAttributes	Provides information about file, e.g. size, modification time
	FileChecksum	Returns CRC checksum of the input file.
	FindDirectories	Returns subdirectories of the input directory.
	FindFiles	Returns files of the input directory.
	GenerateFileName	Generates consecutive file names, e.g. for saving series of images
	RemoveDirectory	Removes a directory, with all files and subdirectories.
	RemoveFile_Multiple	Removes files that match a pattern from a directory.
	RemoveFile_Single	Removes single file.
	TestDirectoryEmpty	Checks if a given directory is empty.
	TestDirectoryExists	Checks if a given directory is present.
	TestFileEmpty	Checks if the size of the file is equal to zero.
	TestFileExists	Checks if a given file is present.
Modbus TCP
Icon	Name	Description / Applications
	ModbusTCP_Close	Close a connected Modbus socket gracefully.
	ModbusTCP_Connect	Connects as a client to a remote Modbus server socket.
	ModbusTCP_ForceMultipleCoils	Function Code 15. Force each coil in a sequence of coils to either ON or OFF in a remote device
	ModbusTCP_ReadCoils	Function Code 01. Read contiguous status of coils in a remote device
	ModbusTCP_ReadDiscreteInputs	Function Code 02. Read contiguous status of discrete inputs in a remote device
	ModbusTCP_ReadExceptionStatus	Function Code 07. Attempts to read Exception Status
	ModbusTCP_ReadInputIntegerRegisters	Function Code 04. Read contiguous input registers in a remote device
	ModbusTCP_ReadInputRealRegisters	Function Code 04. Read contiguous input registers in a remote device
	ModbusTCP_ReadInputRegisters_AsByteBuffer	Function Code 03. Read contiguous input registers in a remote device
	ModbusTCP_ReadMultipleIntegerRegisters	Function Code 03. Read the contents of a contiguous block of holding registers in a remote device
	ModbusTCP_ReadMultipleRealRegisters	Function Code 03. Read the contents of a contiguous block of holding registers in a remote device
	ModbusTCP_ReadMultipleRegisters_AsByteBuffer	Function Code 03. Read the contents of a contiguous block of holding registers in a remote device
	ModbusTCP_SendBuffer	Sends data using Modbus TCP frame format.
	ModbusTCP_WriteCoil	Function Code 05. Write a single output to either ON or OFF in a remote device
	ModbusTCP_WriteMultipleIntegerRegisters	Function Code 16. Write a block of contiguous registers (1 to 123 registers) in a remote device
	ModbusTCP_WriteMultipleRealRegisters	Function Code 16. Write a block of contiguous registers (1 to 123 registers) in a remote device
	ModbusTCP_WriteMultipleRegisters_AsByteBuffer	Function Code 16. Write a block of contiguous registers (1 to 123 registers) in a remote device
	ModbusTCP_WriteSingleRegister	Function Code 06. Write a single holding register in a remote device
Serial Port
Icon	Name	Description / Applications
	SerialPort_Config	Configures the serial port.
	SerialPort_ReadBuffer	Reads raw binary data from serial port.
	SerialPort_ReadByte	Reads one character in binary mode from serial port.
	SerialPort_ReadChar	Reads single character from serial port.
	SerialPort_ReadString	Reads string characters from serial port.
	SerialPort_ReadStringUntil	Reads the string from the serial port to encounter a string delimiter.
	SerialPort_WriteBuffer	Writes raw binary data from a byte buffer to serial port.
	SerialPort_WriteByte	Writes one character in binary mode to serial port.
	SerialPort_WriteChar	Write single ASCII character to device.
	SerialPort_WriteString	Writes string characters to serial port.
TCP IP
Icon	Name	Description / Applications
	TcpIp_Accept	Accepts a connection from a remote client.
	TcpIp_Close	Close a connected TCP socket gracefully.
	TcpIp_Connect	Connects as a client to a remote TCP server socket.
	TcpIp_ReadAllBuffer	Receives data from a connected socket until the other side closes connection.
	TcpIp_ReadAllText	Receives text from a connected socket until the other side closes connection.
	TcpIp_ReadBuffer	Receives a fixed number of bytes from a connected TCP socket.
	TcpIp_ReadLine	Reads from a connected TCP socket until receiving a specific sequence.
	TcpIp_WriteBuffer	Outputs a block of raw data through a connected TCP socket.
	TcpIp_WriteText	Outputs a string through a connected TCP socket.
Time
Icon	Name	Description / Applications
	CurrentDateTime	Returns a string containing the date time information in selected format and all of the date time data separately.
	Delay	Suspends the program workflow for inTime milliseconds.
	DelayByPeriod	Suspends the program workflow for inTime milliseconds relative to the end of the filter's last invoke time.
	GetClockTime	Stops clock to measure performance.
	MeasurePeriod	Returns elapsed time in milliseconds from last filter call.
	StartClock	Starts clock to measure performance.
User Input
Icon	Name	Description / Applications
	GetKeyboardKeys	Returns virtual key codes of the pressed keys or NULL if no key was pressed.
	GetKeyboardKeyState	Checks if the specified keyboard key is down and if it is toggled.