OSAGetAttrToken(3sadm)

OSAGetAttrToken: OSAGetAttrCount, OSAAttrIsPresent, OSAGetAttrByIndex, OSAGetAttrArraySize -- get information about attribute list structure

Synopsis

CC ... -lsysadm -lvtcl -ltclx -ltcl -lsocket -lgen -lm

#include <scoadmin/osaStdDef.h>

int OSAGetAttrCount(attributeListPtr)

bool_t OSAAttrIsPresent(attributeListPtr, attributeToken)

attributeToken_t OSAGetAttrByIndex(errStatusPtr, attributeListPtr, attributeIndex)

int OSAGetAttrArraySize(errStatusPtr, attributeListPtr, attributeToken)

Description

These procedures allow the C/C++ OSAs to get information about the attribute list structure and the attributes contained in that structure.

OSAGetAttrCount examines the list provided by the client's request (the command line). It returns a count of the number of attributes that were given.

OSAAttrIsPresent returns a boolean TRUE or FALSE depending on if the attribute represented by the given attributeToken is present in the list provided by the client's request (the command line).

OSAGetAttrByIndex returns the attributeToken representing the attributeIndex'th attribute in the list provided by the client's request (the command line).

OSAGetAttrArraySize returns the size of the set-valued attribute's data in the list provided by the client's request (the command line).

Arguments

ofParameterList_cl *attributeListPtr: A pointer to the attribute list data structure. All attribute values that provided by the calling client are contained in this structure and are accessed via SCOadmin services library routines.
attributeToken_t attributeToken: The predefined token that represents the attribute. These tokens are defined in the OSA's CDT.
errStatus_cl *errStatusPtr: A pointer to the error stack data structure. If an error occurs in retrieving the data, the appropriate error will be placed in the error stack. This data can be referenced using the library functions associated with the error stack.
int attributeIndex: An index into the attribute list structure, asking for the attributeIndex'th attribute that is given in the structure. The list starts at zero (0).

Diagnostics

NO_SUCH_ATTRIBUTE: The attribute represented by attributeToken was not provided by the client in the attributeList.

References

OSAGetAttrArrayValues(3sadm), OSAGetAttributeValues(3sadm)