ServiceReader.ReadBytes (METH) ¶ METHOD ReadBytes : UDINT InOut: Scope Name Type Comment Return ReadBytes UDINT Input pBuffer POINTER TO BYTE The read bytes will be written to this location udiCount UDINT The number of bytes to be read
ServiceReader.ReadBytesSwapped (METH) ¶ METHOD ReadBytesSwapped : UDINT InOut: Scope Name Type Comment Return ReadBytesSwapped UDINT Input pBuffer POINTER TO BYTE The read bytes will be written to this location udiCount UDINT The number of bytes to be read
ServiceReader.ReadDWord (METH) ¶ METHOD ReadDWord : UDINT InOut: Scope Name Type Return ReadDWord UDINT Output dw DWORD
ServiceReader.ReadLWord (METH) ¶ METHOD ReadLWord : UDINT InOut: Scope Name Type Return ReadLWord UDINT Output lw LWORD
ServiceReader.ReadString (METH) ¶ METHOD ReadString : UDINT InOut: Scope Name Type Return ReadString UDINT Output str STRING(255)
ServiceReader.ReadWString (METH) ¶ METHOD ReadWString : UDINT InOut: Scope Name Type Return ReadWString UDINT Output wstr WSTRING(255)
ServiceReader.ReadWord (METH) ¶ METHOD ReadWord : UDINT InOut: Scope Name Type Return ReadWord UDINT Output wd WORD
ServiceReader.TagId (PROP) ¶ PROPERTY TagId : UDINT
BACnetRegisterClientEventNotification (FUN) ¶ FUNCTION BACnetRegisterClientEventNotification : IEC_BACNET_STATUS Registers an device notification class reference for event and alarm acquisation. This function enables the user appliaction to subscribe to an event and alarm source very easy. This function will do most of the work, normally a client application has to manage, just in one call. It checks periodical for the presence and online state for devices and checks for integrity of the alarms and event acquired from other devices. InOut: Scope Name Type Comment Return BACnetRegisterClientEventNotification IEC_BACNET_STATUS Input hCustomer IEC_BACNET_HANDLE An handle to an created advanced BACnet client customer created by BACnetOpenClientCustomer . devId IEC_BACNET_INST_NUMBER The device instance number from the remote or local device from which the events or alarms shall be acquired. notifClass IEC_BACNET_INST_NUMBER The notification class object instance number from the remote or local device from which the events or alarms shall be acquired. pValidTransitions POINTER TO IEC_BACNET_BIT_STRING A pointer to an bit string structure which contians the bits for the transitions on which a notification shall be sent. More information can be found under BACNET_DESTINATION pValidDays POINTER TO IEC_BACNET_BIT_STRING A pointer to an bit string structure which contians the bits for the weekdays on which a notification shall be sent. More information can be found under BACNET_DESTINATION pFromTime POINTER TO IEC_BACNET_TIME A pointer to a time structure which contains the start time at which notifications shall be sent. More information can be found under BACNET_DESTINATION pToTime POINTER TO IEC_BACNET_TIME A pointer to a time structure which contains the end time at which notifications shall NOT be sent anymore. More information can be found under BACNET_DESTINATION nSubscribeMode IEC_BACNET_CLIENT_SUBSCRIBE_MODE This defines how the data is acquired. pICallback CmpEventMgr.ICmpEventCallback A pointer to the event-callback interface which gets called on BACnet event notification. To unregister a NULL pointer shall be used here. pUserArg POINTER TO BYTE A pointer to data from the user application which is transparent for the API. This pointer will not be modified by the BACnet API. This pointer and the pUserFct pointer is associated with the given device instance and notification class object instance pair. So for every different combination of those parameters these pointers are stored. This pointer may be NULL.
BACnetRegisterClientUnsubscribeCompletionCallback (FUN) ¶ FUNCTION BACnetRegisterClientUnsubscribeCompletionCallback : IEC_BACNET_STATUS Registers the user application callback for completed unregistrations. 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 pointer cancels the callback. This function gives a user application the ability to get notified if an unregistration of device object property reference has completed. Depending on the type of registration made (COV, COVP or POLLING), an unregistration may need some time to be processed. The function for initiation of the unregistration BACnetUnregisterClientDataPoint completes directly but the callback is called after the unsubscription for event or value notification in the remote device has completed. The application may only expect unsubscribe complete callbacks for which the BACnetUnregisterClientDataPoint function call has returned the BACNET_STATUS_BUSY. In case that all registered references have been retrievd by polling this function callback will also be called for the last customer which unregisters the last reference to an device but the referenced object will be the device and the property will be PROP_ALL and the index BACNET_VOID_INDEX (-1). InOut: Scope Name Type Comment Return BACnetRegisterClientUnsubscribeCompletionCallback IEC_BACNET_STATUS Input hCustomer IEC_BACNET_HANDLE An handle to an created advanced BACnet client customer created by BACnetOpenClientCustomer . pICallback CmpEventMgr.ICmpEventCallback A pointer to the event-callback interface which gets called which gets called on completion of an unregistration. To unregister a NULL pointer shall be used here. pUserUnsubArg POINTER TO BYTE A pointer to data from the user application which is transparent for the API. This pointer will not be modified by the BACnet API. This may be NULL.