Monitor library constants

Subtopics

Return values

The following return codes are for rc fields in the _TWG_xxx structs:

Return Value Description
RC_OK The operation was successful.
RC_INVALID_CMD The specified command is not implemented.
RC_INVALID_PARMS An invalid number of input parameters was specified.
RC_INVALID_INPUT An input parameter was invalid or NULL.
RC_INVALID_VERSION An unsupported struct version was sent.
RC_MEMORY_FAILURE Memory allocation failed.
RC_INVALID_OUTPUT The returned output is invalid.
RC_INVALID_PATH An unknown path was sent.
RC_INVALID_HANDLE An invalid handle was sent or returned.
RC_INVALID_DATA The returned struct contains invalid data.
RC_INVALID_TYPE The specified data was for an unsupported attribute type.
RC_INVALID_TRANSPORT Problems occurred when using the transport services.
RC_NODE_UNAVAILABLE The specified DynamicNode is not available, but might be later.
RC_INVALID_ID An invalid threshold ID was sent or returned.

Defined attribute/node types supported by monitor DLLs

The following defined attribute/node types are supported by monitor DLLs:

Attribute Description
INVALID_ATTRIBUTE The attribute is a node that cannot be monitored.
DYNAMICNODE_ATTRIBUTE The attribute is a leaf that can be monitored.

Monitor handle define

The following define is used to indicate that a handle could not be acquired or to invalidate a handle being returned:

Define Description
INVALID_HANDLE The specified path could not be resolved to a leaf.

Data types returned by NodeData

The following defined data types can be returned by the NodeData structure:

Data Type Description
INVALID_NODEDATA The NodeData does not contain any valid data.
DOUBLE_NODEDATA The data should be interpreted as a double value.
STRING_NODEDATA The data should be interpreted as an offset to a string.

Define types for exporting entry points

The following define types should be used for exporting the required monitor DLL entry points. The type has been defined for each supported operating system so common code and programming requirements can be maintained.

Define Description
MONENTPNT Properly exports the required monitor library entry points.
MONFAR This define is used only for Windows 3.x support.

Define types for structure versions

The following define the versions of the structures being used. Currently there is only one supported version of each structure.

Define Description
CURRENT_PATH_VERSION Defines the current version of the AttributePath structure
CURRENT_NODE_VERSION Defines the current version of the AttributeNode structure
CURRENT_NODE_LIST_VERSION Defines the current version of the AttributeNodeList structure
CURRENT_NODEPARMS_VERSION Defines the current version of the NodeParms structure
CURRENT_NODEDATA_VERSION Defines the current version of the NodeData structure