System#

Functions

ITALA_API_C void ERR_GetLastErrorMessage(char *message, size_t *pSize)#
ITALA_API_C ItalaError ERR_GetLastErrorCode()#
ITALA_API_C ItalaError SYS_Initialize()#

Entry point of the runtime. It allocates all necessary resources and creates the system instance. Only one system can be created at a time. If a system instance is already alive, a call to this function leads to an error.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError SYS_Dispose()#

Dispose the instance of the System.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError SYS_EnumerateDevices(uint64_t timeout)#

Enumerates devices across all interfaces. The maximum number of enumerated devices is 255. To retrieve the number of devices discovered and retrive them by index use:

See also

SYS_GetSizeLastEnumeration and

See also

SYS_GetByIndexLastEnumeration.

Parameters:
  • timeout[in] Maximum amount of time in ms for the enumeration to terminate.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError SYS_EnumerateDevicesByInterface(InterfaceInfo itfInfo, uint64_t timeout)#

Enumerates all devices under a specific network interface. The maximum number of enumerated devices is 255.To retrieve the number of devices discovered and retrive them by index use:

See also

SYS_GetSizeLastEnumeration and

See also

SYS_GetByIndexLastEnumeration.

Parameters:
  • itfInfo[in] Interface info of the specific network interface.

  • timeout[in] Maximum amount of time in ms for the enumeration to terminate.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError SYS_EnumerateDevicesByInterfaces(InterfaceInfo *itfInfoList, size_t size, uint64_t timeout)#

Enumerates all devices under a list of specific interfaces. The maximum number of enumerated devices is 255..To retrieve the number of devices discovered and retrive them by index use:

See also

SYS_GetSizeLastEnumeration and

See also

SYS_GetByIndexLastEnumeration.

Parameters:
  • itfInfoList[in] Interface info array of the specific network interface.

  • size[in] Amount of interfaces contained in itfInfoList.

  • timeout[in] Maximum amount of time in ms for the enumeration to terminate.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError SYS_GetDeviceCount(size_t *deviceCount)#

Retrieve the number of devices enumerated the last time an EnumerationDevices method have been called.

Parameters:
  • deviceCount[out] The amount of devices the last enumeration have discovered.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError SYS_GetDeviceByIndex(size_t index, DeviceInfo *deviceInfo)#

Retrieve the device info by index.

Parameters:
  • index[in] Index of the device to retrieve.

  • deviceInfo[out] Device info retrived.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError SYS_CreateDevice(DeviceInfo deviceInfo, H_DEVICE *phDevice)#

Creates a device instance which represents a physical device, given its identyfing info. The maximum number of simultaneously created devices is 50. When no longer needed, device instances must be disposed via DEV_Dispose().

Parameters:
  • deviceInfo[in] Device info of the specific device to create.

  • phDevice[out] Handle to Device instance.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError SYS_GetNodeMap(H_NODEMAP *phNodemap)#

Get the GenICam nodemap of the GenTL System module. The nodemap instance is accessible via GenApi NODEMAP_ functinos and allows the user to configure the behaviour of the system.

Parameters:
  • phNodemap[out] Handle to NodeMap instance.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError SYS_EnumerateInterfaces()#

Enumerates the available network interfaces.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError SYS_GetInterfaceCount(size_t *interfaceCount)#

Retrieve the number of interfaces enumerated.

Parameters:
  • interfaceCount[out] The amount of interfaces the last enumeration have discovered.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError SYS_GetInterfaceByIndex(size_t index, InterfaceInfo *itfInfo)#

Retrieve interface info by index.

Parameters:
  • index[in] Index of the device to retrieve.

  • itfInfo[out] Interface info retrived.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError SYS_GetInterfaceNodemap(InterfaceInfo itfInfo, H_NODEMAP *phNodeMap)#

Get the GenICam nodemap of a network interface. The nodemap instance is accessible via GenApi NODEMAP_ functinos and allows the user to configure the behaviour of the interface.

Parameters:
  • itfInfo[in] nterface info of the specific network interface.

  • phNodeMap[out] MHandle to Nodemap instance.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.