Global Constants ¶ ERROR_CODES (GVL)
ERROR_CODES (GVL) ¶ The ERROR_CODES constants are used to identify a specific device or bus error. They are part of ERROR_INFO structure. The constants are divided up into different categories. The categories determine the severity of the occurred error. The exact classification of each error is done individually by each device and each bus. Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant EC_NO_ERROR CAA.IDENT 16#0 no error EC_FIRST_INFO CAA.IDENT 16#1000 first error number of category INFO EC_LAST_INFO CAA.IDENT 16#1FFF last error number of category INFO EC_FIRST_WARNING CAA.IDENT 16#2000 first error number of category WARNING EC_LAST_WARNING CAA.IDENT 16#2FFF last error number of category WARNING EC_FIRST_ERROR CAA.IDENT 16#3000 first error number of category ERROR EC_LAST_ERROR CAA.IDENT 16#3FFF last error number of category ERROR EC_FIRST_EMCY CAA.IDENT 16#4000 first error number of category EMERGENCY EC_LAST_EMCY CAA.IDENT 16#4FFF last error number of category EMERGENCY
Interfaces ¶ IBus (Interface) Fieldbus-dependent-methods GetSpecificBusState (Method) GetBusDiagnosisInfo (Method) GetBusErrorAsync (Method) GetBusInfo (Method) GetBusState (Method) GetQoS (Method) IDevice (Interface) Fieldbus-dependent-methods GetSpecificDeviceErrorAsync (Method) GetSpecificDeviceState (Method) GetDeviceDiagnosisInfo (Method) GetDeviceErrorAsync (Method) GetDeviceInfo (Method) GetDeviceState (Method) SetCommunicationState (Method) IDevice2 (Interface) CheckCurrentSupportedCommunicationState (Method) CheckSupportedCommunicationState (Method) ILogger (Interface) DisableLogger (Method) EnableLogger (Method) GetLogEntry (Method) INode (Folder) ChildNodeCount (Property) Enable (Property) FirstChildNode (Property) IsRootNode (Property) NextSiblingNode (Property) ParentNode (Property) SiblingNodeCount (Property) IReconfigureProvider (Folder) ReconfigureActive (Property) ReconfigureAsync (Method) RegisterIRPChild (Method) SiblingIRP (Property) IStack (Interface) GetBusScanAsync (Method) GetLogger (Method)
IBus (ITF) ¶ INTERFACE IBus EXTENDS INode This is a generic bus interface. It provides basic information on a fieldbus 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: GetBusDiagnosisInfo GetBusErrorAsync GetBusInfo GetBusState GetQoS GetSpecificBusState Structure: Fieldbus-dependent-methods GetSpecificBusState (Method) GetBusDiagnosisInfo (Method) GetBusErrorAsync (Method) GetBusInfo (Method) GetBusState (Method) GetQoS (Method)
Fieldbus dependent methods ¶ GetSpecificBusState (Method)
IBus.GetBusDiagnosisInfo (METH) ¶ METHOD GetBusDiagnosisInfo : ERROR Returns a DiagnosisInfo if xDiagnosisInfoAvailable of IBus.GetBusState was true. Note The interpretation of pData is fieldbus dependent and will be specified by the associated fieldbus driver. InOut: Scope Name Type Comment Return GetBusDiagnosisInfo ERROR Input pData CAA.PVOID Pointer to memory szSize CAA.SIZE Size of memory in bytes where pData is pointing to Output szCount CAA.SIZE Number of Bytes written to pData
IBus.GetBusErrorAsync (METH) ¶ METHOD GetBusErrorAsync : PROC_STATE Returns the bus error of the current node. Note This is an asynchronous method. For easier handling use function block GetBusError . InOut: Scope Name Type Comment Return GetBusErrorAsync PROC_STATE Input eCmd PROC_CMD Inout eriBusError ERROR_INFO error information Output eError ERROR
IBus.GetBusInfo (METH) ¶ METHOD GetBusInfo : ERROR Returns the bus information of the current node. InOut: Scope Name Type Comment Return GetBusInfo ERROR Inout buiInfo BUS_INFO bus information
IBus.GetBusState (METH) ¶ METHOD GetBusState : BUS_STATE Returns the bus state of the current node; if method returns BUS_STATE.ERROR further information can be read by GetBusError . InOut: Scope Name Type Comment Return GetBusState BUS_STATE current bus state Output xDiagnosisInfoAvailable BOOL if true, diagnosis info can be read by calling IBus.GetBusDiagnosisInfo (if supported) eError ERROR
IBus.GetQoS (METH) ¶ METHOD GetQoS : ERROR Returns quality of service information for the current bus. InOut: Scope Name Type Comment Return GetQoS ERROR Inout QualityInfo QOS_INFO quality of service information