BACnetUTCTimeSynchronization (FUN) ¶ FUNCTION BACnetUTCTimeSynchronization : IEC_BACNET_STATUS Sends an Utc-Time-Synchronization request Sends a BACnet UTC-Time-Synchronization request. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetUTCTimeSynchronization IEC_BACNET_STATUS Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be NULL. In this case the MAC address of this device will be used. Otherwise this shall be the MAC address returned on device object construction. pDestinationAddress POINTER TO IEC_BACNET_ADDRESS This is the MAC address of the device to which the request should be sent. dateTime POINTER TO IEC_BACNET_DATE_TIME The current date and time which will be distributed.
String_ToText ¶ BACnetAccessCredentialDisableReasonString (Function) BACnetAccessCredentialDisableString (Function) BACnetAccessDoorPVString (Function) BACnetAccessEventString (Function) BACnetAccessPassbackModeString (Function) BACnetAccessUserTypeString (Function) BACnetAccessZoneOccupancyStateString (Function) BACnetAccumulatorStatusString (Function) BACnetActionString (Function) BACnetAuditLevelString (Function) BACnetAuditOperationString (Function) BACnetAuthenticationStatusString (Function) BACnetAuthorizationModeString (Function) BACnetBackupStateString (Function) BACnetBinaryPVString (Function) BACnetDataTypeString (Function) BACnetDayOfWeekBitsString (Function) BACnetDayOfWeekString (Function) BACnetDevStatusString (Function) BACnetDoorAlarmStateString (Function) BACnetDoorSecuredStatusString (Function) BACnetDoorStatusString (Function) BACnetDoorValueString (Function) BACnetEnumString (Function) BACnetEventStateString (Function) BACnetEventTransitionString (Function) BACnetEventTypeString (Function) BACnetFileAccessString (Function) BACnetLifeSafetyModeString (Function) BACnetLifeSafetyOpString (Function) BACnetLifeSafetyStateString (Function) BACnetLightingInProgressString (Function) BACnetLightingTransitionString (Function) BACnetLimitEnableString (Function) BACnetLockStatusString (Function) BACnetLoggingTypeString (Function) BACnetMaintenanceString (Function) BACnetMonthString (Function) BACnetNodeTypeString (Function) BACnetNotifyTypeString (Function) BACnetObjTypeString (Function) BACnetObjectIdToText (Function) BACnetPDUtypeToText (Function) BACnetPolarityString (Function) BACnetProgramErrorString (Function) BACnetProgramRequestString (Function) BACnetProgramStateString (Function) BACnetPropIDString (Function) BACnetPropertyIdToText (Function) BACnetReliabilityString (Function) BACnetSecurityLevelString (Function) BACnetSegmentString (Function) BACnetServiceChoiceToText (Function) BACnetServiceString (Function) BACnetShedStateString (Function) BACnetSilencedStateString (Function) BACnetStatusFlagString (Function) BACnetUnitsString (Function) BACnetVtClassesSupportedString (Function)
BACnetAccessCredentialDisableReasonString (FUN) ¶ FUNCTION BACnetAccessCredentialDisableReasonString : STRING Retrieves the textual value representation for the access-credential-disable-reason enumeration. Return: A pointer to the corresponding character text string. InOut: Scope Name Type Comment Return BACnetAccessCredentialDisableReasonString STRING Input CredDis IEC_BACNET_ACCESS_CREDENTIAL_DISABLE_REASON The corresponding enumration value.
BACnetAccessCredentialDisableString (FUN) ¶ FUNCTION BACnetAccessCredentialDisableString : STRING Retrieves the textual value representation for the access-credential-disable enumeration. Return: A pointer to the corresponding character text string. InOut: Scope Name Type Comment Return BACnetAccessCredentialDisableString STRING Input CredDis IEC_BACNET_ACCESS_CREDENTIAL_DISABLE The corresponding enumration value.
BACnetAccessDoorPVString (FUN) ¶ FUNCTION BACnetAccessDoorPVString : STRING Retrieves the textual value representation for the door-value enumeration. Return: A pointer to the corresponding character text string. InOut: Scope Name Type Comment Return BACnetAccessDoorPVString STRING Input DoorValue IEC_BACNET_DOOR_VALUE The corresponding enumration value.
BACnetSetRoutingFilterCallback (FUN) ¶ FUNCTION BACnetSetRoutingFilterCallback : IEC_BACNET_STATUS This function registers an callback for routing filtering. This registers a callback routine. This callback can be registered at any time. If the callback is registered more than once, the new callback procedure replaces old one. A NULL procedure pointer cancels the callback.n This callback may be used by an application which needs to decide if an received packet should be routed to its destination by returning TRUE as return value in the calllback or not by returning FALSE. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetSetRoutingFilterCallback IEC_BACNET_STATUS Input pICallback CmpEventMgr.ICmpEventCallback Pointer to the event-callback interface. Event-callback argument type is EVT_BACNET_ROUTING_FILTER . Purpose documented in BACstack: A pointer to the callback to make decisions of routing for received packets.
BACnetSrvcAbortCbCompletion (FUN) ¶ FUNCTION BACnetSrvcAbortCbCompletion : IEC_BACNET_STATUS Sends a server abort This service completion function completes a callback hook by sending an BACnet abort reply to the service initiator and releases all allocated resources for this request in the API too. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetSrvcAbortCbCompletion IEC_BACNET_STATUS Input phTransaction POINTER TO BYTE The transaction handle which is returned in any confirmed BACnet service hook to identify the pending service request in the API. eAbortReason IEC_BACNET_ABORT_REASON The reason for the BACnet-Abort reply.
BACnetSrvcErrorCbCompletion (FUN) ¶ FUNCTION BACnetSrvcErrorCbCompletion : IEC_BACNET_STATUS Sends a server error This service completion function completes a callback hook by sending an BACnet error reply to the service initiator and releases all allocated resources for this request in the API too. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetSrvcErrorCbCompletion IEC_BACNET_STATUS Input phTransaction POINTER TO BYTE The transaction handle which is returned in any confirmed BACnet service hook to identify the pending service request in the API. errClass IEC_BACNET_ERROR_CLASS Error information, specifies the error class of the occurred failure. errCode IEC_BACNET_ERROR_CODE Error information, specifies the error code of the occurred failure.
BACnetSrvcGetMacAddressesFromHandle (FUN) ¶ FUNCTION BACnetSrvcGetMacAddressesFromHandle : IEC_BACNET_STATUS Returns the source and destination BACnet MAC addresses from an valid BACnet transaction. Returns the source and destination BACnet MAC addresses from an valid BACnet transaction. If the handle is not valid an error will be returned. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetSrvcGetMacAddressesFromHandle IEC_BACNET_STATUS Input pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pSourceAddr POINTER TO IEC_BACNET_ADDRESS A pointer to the memory provided by the application to store the source address from the transaction. pDestAddr POINTER TO IEC_BACNET_ADDRESS A pointer to the memory provided by the application to store the destination address from the transaction.
BACnetSrvcGetPortIdAndLinkTypeFromHandle (FUN) ¶ FUNCTION BACnetSrvcGetPortIdAndLinkTypeFromHandle : IEC_BACNET_STATUS Returns the source port-id and datalink layer type from an valid BACnet transaction over which this request has been received. Returns the source port-id and datalink layer type from an valid BACnet transaction over which this request has been received. If the handle is not valid an error will be returned. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetSrvcGetPortIdAndLinkTypeFromHandle IEC_BACNET_STATUS Input pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pPortId POINTER TO IEC_BACNET_BYTE A pointer to the memory provided by the application to store the port-id. The port-id correlates with the configured port-id in the datalink layer configuration. pDlType POINTER TO IEC_BACNET_STACK_DATALINK_TYPE A pointer to the memory provided by the application to store the datalink layer type. The type correlates with the configured link type in the datalink layer configuration.