System🔗

Compute Devices🔗

activate_compute_deviceActivateComputeDevice: Activate a compute device.

deactivate_all_compute_devicesDeactivateAllComputeDevices: Deactivate all compute devices.

deactivate_compute_deviceDeactivateComputeDevice: Deactivate a compute device.

get_compute_device_infoGetComputeDeviceInfo: Get information on a compute device.

get_compute_device_paramGetComputeDeviceParam: Query compute device parameters.

init_compute_deviceInitComputeDevice: Initialize a compute device.

open_compute_deviceOpenComputeDevice: Open a compute device.

query_available_compute_devicesQueryAvailableComputeDevices: Get the list of available compute devices.

release_all_compute_devicesReleaseAllComputeDevices: Close all compute devices.

release_compute_deviceReleaseComputeDevice: Close a compute_device.

set_compute_device_paramSetComputeDeviceParam: Set parameters of an compute device.

Database🔗

count_relationCountRelation: Number of entries in the HALCON database.

get_modulesGetModules: Query of used modules and the module key.

reset_obj_dbResetObjDb: Reset the HALCON system for iconic objects.

Encrypted Item🔗

read_encrypted_itemReadEncryptedItem: Read an encrypted item from a file.

write_encrypted_itemWriteEncryptedItem: Write an encrypted item to a file.

Error Handling🔗

get_checkGetCheck: State of the HALCON control modes.

get_error_textGetErrorText: Inquiry after the error text of a HALCON error number.

get_extended_error_infoGetExtendedErrorInfo: Returns the extended error information for the calling thread’s last HALCON error.

get_spyGetSpy: Current configuration of the HALCON debugging-tool.

query_spyQuerySpy: Inquiring for possible settings of the HALCON debugging tool.

set_checkSetCheck: Activating and deactivating of HALCON control modes.

set_spySetSpy: Control of the HALCON Debugging Tools.

I/O Devices🔗

close_io_channelCloseIoChannel: Close I/O channels.

close_io_deviceCloseIoDevice: Close the specified I/O device.

control_io_channelControlIoChannel: Perform an action on I/O channels.

control_io_deviceControlIoDevice: Perform an action on the I/O device.

control_io_interfaceControlIoInterface: Perform an action on the I/O interface.

get_io_channel_paramGetIoChannelParam: Query specific parameters of I/O channels.

get_io_device_paramGetIoDeviceParam: Query settings of an I/O device instance.

open_io_channelOpenIoChannel: Open and configure I/O channels.

open_io_deviceOpenIoDevice: Open and configure an I/O device.

query_io_deviceQueryIoDevice: Query information about channels of the specified I/O device.

query_io_interfaceQueryIoInterface: Query information about the specified I/O device interface.

read_io_channelReadIoChannel: Read a value from the specified I/O channels.

set_io_channel_paramSetIoChannelParam: Set specific parameters of I/O channels.

set_io_device_paramSetIoDeviceParam: Configure a specific I/O device instance.

write_io_channelWriteIoChannel: Write a value to the specified I/O channels.

Information🔗

get_chapter_infoGetChapterInfo: Get information concerning the chapters on operators.

get_keywordsGetKeywords: Get keywords which are assigned to operators.

get_operator_infoGetOperatorInfo: Get information concerning a HALCON-operator.

get_operator_nameGetOperatorName: Get operators with the given string as a substring of their name.

get_param_infoGetParamInfo: Get information concerning the operator parameters.

get_param_namesGetParamNames: Get the names of the parameters of a HALCON-operator.

get_param_numGetParamNum: Get number of the different parameter classes of a HALCON-operator.

get_param_typesGetParamTypes: Get default data type for the control parameters of a HALCON-operator.

query_operator_infoQueryOperatorInfo: Query slots concerning information with relation to the operator get_operator_infoGetOperatorInfo.

query_param_infoQueryParamInfo: Query slots of the online-information concerning the operator get_param_infoGetParamInfo.

search_operatorSearchOperator: Search names of all operators assigned to one keyword.

Memory Block🔗

compare_memory_blockCompareMemoryBlock: Compare contents of memory blocks regarding equality.

create_memory_block_externCreateMemoryBlockExtern: Create a memory block from an external pointer.

create_memory_block_extern_copyCreateMemoryBlockExternCopy: Create a memory block from an external pointer by copying.

get_memory_block_ptrGetMemoryBlockPtr: Return the data pointer and size of a memory block.

read_memory_blockReadMemoryBlock: Read a memory block from a file.

write_memory_blockWriteMemoryBlock: Write a memory block to a file.

Multithreading🔗

broadcast_conditionBroadcastCondition: Signal a condition synchronization object.

clear_barrierClearBarrier: Destroy a barrier synchronization object.

clear_conditionClearCondition: Destroy a condition synchronization object.

clear_eventClearEvent: Clear the event synchronization object.

clear_messageClearMessage: Close a message handle and release all associated resources.

clear_message_queueClearMessageQueue: Close a message queue handle and release all associated resources.

clear_mutexClearMutex: Clear the mutex synchronization object.

create_barrierCreateBarrier: Create a barrier synchronization object.

create_conditionCreateCondition: Create a condition variable synchronization object.

create_eventCreateEvent: Create an event synchronization object.

create_messageCreateMessage: Create a new empty message.

create_message_queueCreateMessageQueue: Create a new empty message queue.

create_mutexCreateMutex: Create a mutual exclusion synchronization object.

dequeue_messageDequeueMessage: Receive one or more messages from the message queue.

enqueue_messageEnqueueMessage: Enqueue one or more messages to the message queue.

get_current_hthread_idGetCurrentHthreadId: Return the HALCON thread ID of the current thread.

get_message_objGetMessageObj: Retrieve an object associated with the key from the message.

get_message_paramGetMessageParam: Query message parameters or information about the message.

get_message_queue_paramGetMessageQueueParam: Query message queue parameters or information about the queue.

get_message_tupleGetMessageTuple: Retrieve a tuple associated with the key from the message.

get_threading_attribGetThreadingAttrib: Query the attributes of a threading / synchronization object.

interrupt_operatorInterruptOperator: Attempt to interrupt an operator running in a different thread.

lock_mutexLockMutex: Lock a mutex synchronization object.

read_messageReadMessage: Read a message from a file.

set_message_objSetMessageObj: Add a key/object pair to the message.

set_message_paramSetMessageParam: Set message parameter or invoke commands on the message.

set_message_queue_paramSetMessageQueueParam: Set message queue parameters or invoke commands on the queue.

set_message_tupleSetMessageTuple: Add a key/tuple pair to the message.

signal_conditionSignalCondition: Signal a condition synchronization object.

signal_eventSignalEvent: Unlock an event synchronization object.

timed_wait_conditionTimedWaitCondition: Bounded wait on the signal of a condition synchronization object.

try_lock_mutexTryLockMutex: Lock a mutex synchronization object.

try_wait_eventTryWaitEvent: Lock an event synchronization object only if it is unlocked.

unlock_mutexUnlockMutex: Unlock a mutex synchronization object.

wait_barrierWaitBarrier: Wait on the release of a barrier synchronization object.

wait_conditionWaitCondition: wait on the signal of a condition synchronization object.

wait_eventWaitEvent: Lock an event synchronization object.

write_messageWriteMessage: Write a message to a file.

Operating System🔗

count_secondsCountSeconds: Passed Time.

get_system_timeGetSystemTime: Read out the system time.

system_callSystemCall: Execute a system command.

wait_secondsWaitSeconds: Delaying the execution of the program.

Parallelization🔗

get_aop_infoGetAopInfo: Return AOP information for operators.

optimize_aopOptimizeAop: Check hardware regarding its potential for automatic operator parallelization.

query_aop_infoQueryAopInfo: Query indexing structure of AOP information for operators.

read_aop_knowledgeReadAopKnowledge: Load knowledge about hardware dependent behavior of automatic operator parallelization.

set_aop_infoSetAopInfo: Set AOP information for operators.

write_aop_knowledgeWriteAopKnowledge: Write knowledge about hardware dependent behavior of automatic operator parallelization to file.

Parameters🔗

get_systemGetSystem: Get current value of HALCON system parameters.

get_system_infoGetSystemInfo: Get current value of system information without requiring a license.

set_operator_timeoutSetOperatorTimeout: Set a timeout for an operator.

set_systemSetSystem: Set HALCON system parameters.

Serial🔗

clear_serialClearSerial: Clear the buffer of a serial connection.

close_serialCloseSerial: Close a serial device.

get_serial_paramGetSerialParam: Get the parameters of a serial device.

open_serialOpenSerial: Open a serial device.

read_serialReadSerial: Read from a serial device.

set_serial_paramSetSerialParam: Set the parameters of a serial device.

write_serialWriteSerial: Write to a serial connection.

Serialized Item🔗

clear_serialized_itemClearSerializedItem: Delete a serialized item.

create_serialized_item_ptrCreateSerializedItemPtr: Create a serialized item.

decrypt_serialized_itemDecryptSerializedItem: Decrypt an encrypted item.

encrypt_serialized_itemEncryptSerializedItem: Encrypt a serialized item.

fread_serialized_itemFreadSerializedItem: Read a serialized item from a file.

fwrite_serialized_itemFwriteSerializedItem: Write a serialized item to a file.

get_serialized_item_ptrGetSerializedItemPtr: Access the data pointer of a serialized item.

Sockets🔗

close_socketCloseSocket: Close a socket.

get_next_socket_data_typeGetNextSocketDataType: Determine the HALCON data type of the next socket data.

get_socket_descriptorGetSocketDescriptor: Get the socket descriptor of a socket used by the operating system.

get_socket_paramGetSocketParam: Get the value of a socket parameter.

open_socket_acceptOpenSocketAccept: Open a socket that accepts connection requests.

open_socket_connectOpenSocketConnect: Open a socket and connect it to an accepting socket.

receive_dataReceiveData: Receive arbitrary data from external devices or applications using a generic socket connection.

receive_imageReceiveImage: Receive an image over a socket connection.

receive_regionReceiveRegion: Receive regions over a socket connection.

receive_serialized_itemReceiveSerializedItem: Receive a serialized item over a socket connection.

receive_tupleReceiveTuple: Receive a tuple over a socket connection.

receive_xldReceiveXld: Receive an XLD object over a socket connection.

send_dataSendData: Send arbitrary data to external devices or applications using a generic socket communication.

send_imageSendImage: Send an image over a socket connection.

send_regionSendRegion: Send regions over a socket connection.

send_serialized_itemSendSerializedItem: Send a serialized item over a socket connection.

send_tupleSendTuple: Send a tuple over a socket connection.

send_xldSendXld: Send an XLD object over a socket connection.

set_socket_paramSetSocketParam: Set a socket parameter.

socket_accept_connectSocketAcceptConnect: Accept a connection request on a listening socket of the protocol type 'HALCON'"HALCON" or 'TCP'"TCP"/'TCP4'"TCP4"/'TCP6'"TCP6".