GetRoot (FUN) ¶ FUNCTION GetRoot : INode The function returns the root device (= PLC device). InOut: Scope Name Type Comment Return GetRoot INode root node
INode_TO_IBus (FUN) ¶ FUNCTION INode_TO_IBus : IBus Converts an INode object to an IBus object. If itfNode is no IBus object function returns zero. InOut: Scope Name Type Comment Return INode_TO_IBus IBus corresponding IBus or zero if itfNode is no IBus object Input itfNode INode node to be converted
INode_TO_IDevice (FUN) ¶ FUNCTION INode_TO_IDevice : IDevice Converts an INode object to an IDevice object. If itfNode is no IDevice object function returns zero. InOut: Scope Name Type Comment Return INode_TO_IDevice IDevice corresponding IDevice or zero if itfNode is no IDevice object Input itfNode INode node to be converted
INode_TO_IDevice2 (FUN) ¶ FUNCTION INode_TO_IDevice2 : IDevice2 Converts an INode object to an IDevice2 object. If itfNode is no IDevice2 object function returns zero. InOut: Scope Name Type Comment Return INode_TO_IDevice2 IDevice2 corresponding IDevice2 or zero if itfNode is no IDevice2 object Input itfNode INode node to be converted
IDevice.GetDeviceState (METH) ¶ METHOD GetDeviceState : DEVICE_STATE Returns the state of the device; if device state is DEVICE_STATE.ERROR further information can be read by GetDeviceError . InOut: Scope Name Type Comment Return GetDeviceState DEVICE_STATE current device state Output xDiagnosisInfoAvailable BOOL if true, diagnosis info can be read by calling IDevice.GetDeviceDiagnosisInfo (if supported) eError ERROR
IDevice.SetCommunicationState (METH) ¶ METHOD SetCommunicationState : ERROR Starts, stops or resets a device Note Use IDevice2.CheckSupportedCommunicationState and IDevice2.CheckCurrentSupportedCommunicationState to check which transitions are possible! InOut: Scope Name Type Comment Return SetCommunicationState ERROR Input eRequestedState DEVICE_TRANSITION_STATE desired transition
IDevice2 (ITF) ¶ INTERFACE IDevice2 EXTENDS IDevice Interface extension for IDevice Properties: ChildNodeCount , inherited from INode Enable , inherited from INode FirstChildNode , inherited from INode IsRootNode , inherited from INode NextSiblingNode , inherited from INode ParentNode , inherited from INode SiblingNodeCount , inherited from INode Methods: CheckCurrentSupportedCommunicationState CheckSupportedCommunicationState GetDeviceDiagnosisInfo , inherited from IDevice GetDeviceErrorAsync , inherited from IDevice GetDeviceInfo , inherited from IDevice GetDeviceState , inherited from IDevice GetSpecificDeviceErrorAsync , inherited from IDevice GetSpecificDeviceState , inherited from IDevice SetCommunicationState , inherited from IDevice Structure: CheckCurrentSupportedCommunicationState (Method) CheckSupportedCommunicationState (Method)
IDevice2.CheckCurrentSupportedCommunicationState (METH) ¶ METHOD CheckCurrentSupportedCommunicationState : BOOL This method checks if a specific DEVICE_TRANSITION_STATE can be processed in the current state. Note Use IDevice2.CheckSupportedCommunicationState to check which DEVICE_TRANSITION_STATE is supported in general. InOut: Scope Name Type Comment Return CheckCurrentSupportedCommunicationState BOOL True if node supports the requested DEVICE_TRANSITION_STATE in the current state. Input eRequestedState DEVICE_TRANSITION_STATE The communication state to be checked.
IDevice2.CheckSupportedCommunicationState (METH) ¶ METHOD CheckSupportedCommunicationState : BOOL This method checks if a specific DEVICE_TRANSITION_STATE is supported by the node in general. Note Use IDevice2.CheckCurrentSupportedCommunicationState to check which DEVICE_TRANSITION_STATE is possible in the current state. InOut: Scope Name Type Comment Return CheckSupportedCommunicationState BOOL True if node supports the requested DEVICE_TRANSITION_STATE in general. Input eRequestedState DEVICE_TRANSITION_STATE The communication state to be checked.
ILogger (ITF) ¶ INTERFACE ILogger Interface for a logger. Methods: DisableLogger EnableLogger GetLogEntry Structure: DisableLogger (Method) EnableLogger (Method) GetLogEntry (Method)
