|
ProviewR Programmer's Reference Manual
V6.1.4
|
Modules | |
| Gdh Data Structures | |
| Gdh Functions | |
The Global Data Handler API contains functions to get information about the classes, volumes and objects in the realtime database. There are also functions to create, delete and move object in the database.
Includefiles
The includefile for Gdh is
The return status codes are defined in the files
| gdh_GetAttributeCharacteristics() | Get the characteristics of an attribute given its name and the class it belongs to. |
| gdh_NameToAttrref() | Convert from name string to attribute reference. |
| gdh_AttrrefToName() | Translate an attribute reference to name. |
| gdh_ClassAttrToAttrref() | Converts a class and attribute string to attrref format. |
| gdh_ClassAttrrefToAttr() | Get the attribute name from a class and attrref. |
| gdh_GetAttributeCharAttrref() | Get the characteristics of an attribute. |
| gdh_AttrArefToObjectAref() | Get the attriubte reference to an object or attribute object, from the attribute reference to an attribute in the object. |
| gdh_ArefANameToAref() | Get the attribute reference for an attribute in an object attribute reference, where the attribute is specified by a string. |
| gdh_AttrValueToString() | Convert attribute value to string. |
| gdh_AttrStringToValue() | Convert a string to attribute value. |
| gdh_ArefDisabled() | Check if an attribute is disabled. |
| gdh_GetClassList() | Get the object identity for the first object in the list of objects of a specified class. |
| gdh_GetNextObject() | Get the object identity of the next object in the list of objects of a certain class. |
| gdh_GetPreviousObject() | Get the object identity of the previous object in the list of objects of a certain class. |
| gdh_GetClassListAttrRef() | Get the attribute reference of the first object in the list of objects of a certain class. The object can be a solitary object or an attribute object. |
| gdh_GetNextAttrRef() | Get the attrref of the next object in the list of objects of a certain class. The object can be a solitary object or an attribute object. |
| gdh_GetObjectClassList() | Get the attribute reference of the first attribute object of a specified class in a specified object. |
| gdh_GetNextObjectAttrRef() | Get the attrref of the next attribute object of a specified class in a specified object. |
| gdh_ClassNameToId() | Get the class identity corresponding to a class specified by name. |
| gdh_GetSuperClass() | Get the superclass for a class. |
| gdh_GetEnumValueDef() | Get definition information for an enumeration type. |
| gdh_GetMaskBitDef() | Get definition information for a mask type. |
| gdh_DLRefObjectInfoAttrref() | Request a direct link to the data denoted by an attribute reference. |
| gdh_DLUnrefObjectInfo() | Terminate direct linking of an object or an object attribute. |
| gdh_DLUnrefObjectInfoAll() | Removes all direct links set up by this process. |
| gdh_GetSubscriptionOldness() | Checks the oldness of a certain subscription. |
| gdh_RefObjectInfo() | The routine returns an address to the data denoted by name. The name can be either an object or an object attribute. |
| gdh_UnrefObjectInfo() | Terminates the subscriptions defined by the subscription identity. |
| gdh_UnrefObjectInfoAll() | Terminates all subscriptions set up by this process. |
| gdh_RefObjectInfoList() | This routine returns addresses to teh information that is denoted by"objref[].fullname". |
| gdh_SetSubscriptionDefaults() | Sets default subscription timers for future subscription requests. |
| gdh_SubRefObjectInfoAttrref() | This routine returns a subid to the information that is denoted by 'aref'. The name can be either an object or an object attribute. |
| gdh_SubRefObjectInfoName() | Get the adress of the data that is denoted by 'name'. |
| gdh_SubUnrefObjectInfoList() | Terminates a list of subscriptions. |
| gdh_SubUnrefObjectInfo() | Terminates subscription of an object or attribute. |
| gdh_SubUnrefObjectInfoAll() | Terminates all subscriptions set up by this process. |
| gdh_SubData() | Fetch the data associated with a subscription. |
| gdh_SubSize() | Fetch the data size associated with a subscription. |
| gdh_SubAssociateBuffer() | Associate a buffer with the subscription. |
| gdh_SubRefObjectInfoList() | Sets up a list of subscriptions to an object/attribute. |
| gdh_FWriteObject() | Write the content of an object to textfile. |
| gdh_FReadObject() | Read a textfile into an object. |
| gdh_Init() | Initialize the process to the Proview runtime environment. |
| gdh_NethandlerRunning() | Check if the Nethandler has started. |
| gdh_GetSecurityInfo() | Get security information. |
| gdh_StoreRtdbPointer() | Convert pointer to rtdb relative pointer. |
| gdh_TranslateRtdbPointer() | Convert rtdb relative pointer to absolute pointer. |
| gdh_GetObjectNodeIndex() | Get the node identity of the owner of an object. |
| gdh_GetNodeIndex() | Get the node identity of the local node. |
| gdh_GetNodeObject() | Return the objid of the node object for a node identifier (of type pwr_tNodeId). |
| gdh_CreateObject() | Create an object in a dynamic volume. |
| gdh_DeleteObject() | Remove a local object. |
| gdh_RenameObject() | Rename a local object. |
| gdh_MoveObject() | Move a local object. |
| gdh_GetRootList() | Get the first root object in the object tree. |
| gdh_GetParent() | Get the object identity of the parent of an object. |
| gdh_GetLocalParent() | Get the object identity of the local parent of an object. |
| gdh_GetChild() | Get the object identity of the first child of an object. |
| gdh_GetNextSibling() | Get the object identity of the next sibling (i.e. the next object with the same parent). |
| gdh_GetPreviousSibling() | Get the object identity of the previous sibling (i.e. the previous object with the same parent). |
| gdh_GetObjectSize() | Get the size of the body of an object. |
| gdh_GetDynamicAttrSize() | Get the size of a dynamic attribute. |
| gdh_GetObjectClass() | Get the class identifier of an object. |
| gdh_GetAttrRefTid() | Get the type or class identifier of an attribute reference. |
| gdh_GetObjectLocation() | Return the location of an object. |
| gdh_GetObjectDLCount() | Gets the direct link count of an object. |
| gdh_GetAlarmInfo() | Get the alarm status for a certain object. |
| gdh_SetAlarmLevel() | This routine sets the alarm level for a certain object. |
| gdh_SetAlarmBlockLevel() | Sets the alarm block level for a certain object. |
| gdh_GetObjectInfo() | Fetch data from an object or an attribute. |
| gdh_GetObjectInfoAttrref() | Fech the data of an attribute or a whole object body. |
| gdh_SetObjectInfo() | Change the value of an attribute of the whole body of an object. |
| gdh_SetObjectInfoAttrref() | Change the data of an object or attribute. |
| gdh_GetTimeDL() | Fetch a direct linked absolute time value. |
| gdh_SetTimeDL() | Store a direct linked absolute time value. |
| gdh_GetDeltaTimeDL() | Fetch a direct linked delta time value. |
| gdh_SetDeltaTimeDL() | Store a direct linked delta time value. |
| gdh_GetStrDL() | Fetch a direct linked string value. |
| gdh_SetStrDL() | Store a direct linked string value. |
| gdh_GetObjectInfoTime() | Fetch an absolute time value from an attribute. |
| gdh_SetObjectInfoTime() | Store a absolute time value from an attribute. |
| gdh_GetObjectInfoDeltaTime() | Fetch a delta time value from an attribute. |
| gdh_SetObjectInfoDeltaTime() | Store a delta time value from an attribute. |
| gdh_GetObjectInfoStr() | Fetch a string value from an attribute. |
| gdh_SetObjectInfoStr() | Store a string value from an attribute. |
| gdh_ObjidToName() | Get the name of an object by its object identity. |
| gdh_ObjidToPointer() | Gets the address of the data of an object, given its object identity. |
| gdh_MountObjidToPointer() | Get a pointer to a mount object. |
| gdh_AttrRefToPointer() | Get the address of the data of an attribute reference. |
| gdh_NameToObjid() | Get the object identity of an object specified by name. |
| gdh_NameToPointer() | Get the address of the data of an object, given its name. |
| gdh_GetVolumeList() | Get the first volume. |
| gdh_GetNextVolume() | Get the next volume in the volume list. |
| gdh_VolumeIdToName() | Get the name for a volume denoted by volume identity. |
| gdh_GetVolumeInfo() | Get info for a volume. |
1.9.1