GlobalTextList (Text List) ¶

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

GetLibVersionNumber (FUN) ¶ FUNCTION GetLibVersionNumber : DWORD This function has been automatically generated from the project information. InOut: Scope Name Type Return GetLibVersionNumber DWORD

GetCurrentDisplayedModuleInstance (FUN) ¶ FUNCTION GetCurrentDisplayedModuleInstance : IModule This function returns the instance whose page-visualization is displayed in the main frame. Might return 0. InOut: Scope Name Type Comment Return GetCurrentDisplayedModuleInstance IModule Input iVisuClientId INT The visu ClientID whose main frame is checked. Must be in the range of VISU_MIN_NUMBER_OF_CLIENTS and VISU_MAX_NUMBER_OF_CLIENTS. pEnv POINTER TO MEnv A pointer to the environment of a module instance. Must not be null.

IModuleVisuClientListener (ITF) ¶ INTERFACE IModuleVisuClientListener EXTENDS IModule Module FunctionBlocks implementing this interface will be called whenever a visu client is de-/registered Properties: ComAddress , inherited from IBaseInstance Environment , inherited from IModule FirstErrorInstance , inherited from IModule FirstErrorNumber , inherited from IModule Handle , inherited from IModule InstanceName , inherited from IBaseInstance LastErrorInstance , inherited from IModule LastErrorNumber , inherited from IModule ModuleInfo , inherited from IModule Methods: ClientCreated ClientDestroyed CallPrioHighEnd , inherited from IModule CallPrioHighStart , inherited from IModule CallPrioLowEnd , inherited from IModule CallPrioLowStart , inherited from IModule CallPrioMediumEnd , inherited from IModule CallPrioMediumStart , inherited from IModule ClearErrors , inherited from IModule GetErrorMessage , inherited from IModule GetFirstErrorMessage , inherited from IModule GetLastErrorMessage , inherited from IModule Init , inherited from IBaseInstance Main , inherited from IBaseInstance OnAfterOnlineChange , inherited from IBaseInstance OnBeforeOnlineChange , inherited from IBaseInstance Structure: ClientCreated (Method) ClientDestroyed (Method)

IModuleVisuClientListener.ClientCreated (METH) ¶ METHOD ClientCreated This method will be called when a visu client is registered InOut: Scope Name Type Comment Input iClientID INT The ID of the new visu client

IModuleVisuClientListener.ClientDestroyed (METH) ¶ METHOD ClientDestroyed This method will be called when a visu client is deregistered InOut: Scope Name Type Comment Input iClientID INT The ID of the visu client that is being deregistered

BACnetClientConfirm ¶ BACnetClientConfPrivateTransfer (FunctionBlock) FreeResult (Method) HasResult (Method) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientConfTextMessage (FunctionBlock) Request (Method) SampleInputs (Method)

BACnetClientConfPrivateTransfer (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientConfPrivateTransfer EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a ConfirmedPrivateTransfer-Request in the BACnet-Network. If execution completed successfully and xDone is TRUE, result is filled with valid data, in any other case the data in result are not valid. InOut: Scope Name Type Initial Comment Inherited from Input xExecute BOOL Rising edge: Starts defined operation FALSE : Resets the defined operation after ready condition was reached ETrigATo xAbort BOOL TRUE : Aborts the operation ETrigATo udiTimeOut UDINT Max. operating time for executing [µs], 0: No operating time limit ETrigATo Output xDone BOOL TRUE : Ready condition reached ETrigATo xBusy BOOL TRUE : Operation is running ETrigATo xError BOOL TRUE : Error condition reached ETrigATo xAborted BOOL TRUE : Abort condition reached ETrigATo Input dwTargetDeviceNumber DWORD The device number of the targeted device in the BACnet- Network. BACnetClientBase pTargetDeviceAddress POINTER TO CmpBACnet.IEC_BACNET_ADDRESS 0 Optional : The device address of the targeted device in the BACnet-Network. If an adress is given the given device number is ignored. BACnetClientBase Output eStatus CmpBACnet.IEC_BACNET_STATUS CmpBACnet.IEC_BACNET_STATUS.BACNET_STATUS_OK If an error occured, the error state. BACnetClientBase errorResult CmpBACnet.IEC_BACNET_ERROR STRUCT(tag := CmpBACnet.IEC_BACNET_FAILURE_TYPE._FAILURE_MAX_SIZE) If an error occured (this means eStatus <> BACNET_STATUS_OK), whereas the sent BACnet-Request was answered with an specific error information, the latter is contained in this structure. BACnetClientBase iState DINT 0 The State in which the FB is during execution: 0: No execution, resetted state 1: Searching for the Target-Device and a valid address for it 2: Sending the BACnet-Request into the network 3: Waiting for the answer (if there is one) to the BACnet-Request made in 2 4: Finishing the call, setting of the output variables BACnetClientBase Input nVendorID CmpBACnet.IEC_BACNET_UNSIGNED This parameter, of type Unsigned, specifies the unique vendor identification code for the type of vendor-proprietary service to be performed. nServiceNumber CmpBACnet.IEC_BACNET_UNSIGNED This parameter, of type Unsigned, specifies the desired service to be performed. fParametersPresent CmpBACnet.IEC_BACNET_BOOLEAN If set to True the parameters value is valid. parameters CmpBACnet.IEC_BACNET_BUFFER This optional parameter shall transport additional parameters for the service specified by ‘Vendor ID’ and ‘Service Number’. The datatype and interpretation of these parameters is a local matter. nByteCount CmpBACnet.IEC_BACNET_UNSIGNED This is the size of the filled bytes in the parameters buffer on reply to the confirmed service variant of this type. Output result CmpBACnet.IEC_BACNET_PRIVATE_TRANSFER_INFO If the BACnet-Request succeeded (xDone is TRUE and no error occured (xError is FALSE)), this variable holds the result of the request. Properties: Instance , inherited from BACnetClientBase Running , inherited from BACnetClientBase Server , inherited from BACnetClientBase SourceDeviceAddress , inherited from BACnetClientBase SourceDeviceNumber , inherited from BACnetClientBase TargetDeviceAddress , inherited from BACnetClientBase TargetDeviceNumber , inherited from BACnetClientBase Methods: FreeResult HasResult InitializeOutputs Request SampleInputs RegisterToServer , inherited from BACnetClientBase UnregisterFromServer , inherited from BACnetClientBase Structure: FreeResult (Method) HasResult (Method) InitializeOutputs (Method) Request (Method) SampleInputs (Method)