Library Information ¶ GetLibVersion (Function) GetLibVersionNumber (Function) IsLibReleased (Function)
GetLibVersion (FUN) ¶ FUNCTION GetLibVersion : VERSION This function has been automatically generated from the project information. InOut: Scope Name Type Return GetLibVersion VERSION
GetHandleOfCallback (FUN) ¶ FUNCTION GetHandleOfCallback : CAA.HANDLE This function gets the handle of callback via the callback number (ctNumber); InOut: Scope Name Type Comment Return GetHandleOfCallback CAA.HANDLE Handle to the callback, CAA.gc_hINVALID if ctNumber is invalid Input ctNumber CAA.COUNT number of Callback (value between 1 and CB_GetNumberActiveCallbacks) peError POINTER TO ERROR Pointer to error ID
GetNumberActiveCallbacks (FUN) ¶ FUNCTION GetNumberActiveCallbacks : CAA.COUNT This function gets the number of registered callbacks InOut: Scope Name Type Comment Return GetNumberActiveCallbacks CAA.COUNT The number of registered callbacks. Input peError POINTER TO ERROR Pointer to an error ID
IsHandleValid (FUN) ¶ FUNCTION IsHandleValid : BOOL This function checks, whether a callback with handle hHandle is registered InOut: Scope Name Type Comment Return IsHandleValid BOOL TRUE if the handle is valid. FALSE otherwhise. Input hHandle CAA.HANDLE handle of Callback peError POINTER TO ERROR Pointer to error ID
Helper ¶ DecodeClass (Function) DecodeEvent (Function) EncodeSpec (Function)
DecodeClass (FUN) ¶ FUNCTION DecodeClass : EVENT_CLASS This function serves to extract the vaue eClass of type EVENT_CLASS from parameter dwSpec of the callback function. InOut: Scope Name Type Comment Return DecodeClass EVENT_CLASS The EVENT_CLASS of dwSpec. Input dwSpec DWORD A combination of EVENT and EVENT_CLASS
DecodeEvent (FUN) ¶ FUNCTION DecodeEvent : EVENT This function serves to extract value eEvent of type _Event from parameter dwSpec of the callback function. InOut: Scope Name Type Comment Return DecodeEvent EVENT The EVENT of dwSpec Input dwSpec DWORD A combination of EVENT and EVENT_CLASS
BACnetIPdatalink.CheckNetworkSettings (METH) ¶ METHOD PROTECTED CheckNetworkSettings : BOOL Checks, if parent ETH device is configured properly. Returns TRUE if the network settings are valid. In case FALSE is returned the BACnetServer will not start. In case there is nothing to check (BACnetIPdatalink underneath BACnetServer or PLC) simply return TRUE. InOut: Scope Name Type Comment Return CheckNetworkSettings BOOL Input pConnector POINTER TO IoConfigConnector “child” connector to parent device, parent device could be “Common.Ethernet” (Ethernet), “Common.BACnet” (BACnetServer) or “Common.PCI” (PLC).
EncodeSpec (FUN) ¶ FUNCTION EncodeSpec : DWORD This function servers to create the parameter dwSpec of type DWORD, which is necessary for callback functions, out of two values of type EVENT and EVENT_SOURCE . InOut: Scope Name Type Comment Return EncodeSpec DWORD Input eEvent EVENT Event to be used eClass EVENT_CLASS Event class to be used