OSAClearValues(S_ADM)
OSAClearList, OSARemoveAttribute --
remove return list structure
Syntax
#include <scoAdmin/osaStdDef.h>
void OSARemoveAttribute(returnListPtr, attributeToken)
void OSAClearList(returnListPtr)
Description
These procedures allow the C/C++ OSAs
to remove all or portions of a previously
altered return list structure.
OSARemoveAttribute looks for the named
attribute in the return list
structure and if it is found it removes it and any value(s) associated with it
from the return list structure. The given attribute can still be added
to the list again at some future time.
OSAClearList removes all attributes and their data from a return
list structure. It will also remove any data added to the list by calls
to the OSAReturnBoolean and OSAReturnActionData commands.
Additional data can still be added to the list at some future time.
It is not recommend that OSAClearList
and OSARemoveAttribute be
called excessively on the same return list instance, as it will slow
down future access time on that return list structure.
Arguments
ofParameterList_cl *returnListPtr-
A pointer to the return list data structure. All return values are
contained in this structure and are accessed and changed via
SCOadmin services library routines.
attributeToken_t attributeToken-
The predefined token that represents the attribute to which the given value
should be associated with. These tokens are defined in the
OSA's CDT.
Error messages
Assertion Failed index < numberOfElementsInList-
For some reason the Server API is
trying to free an attribute past the end of the list.
Assertion Failed loop + 1 < numberOfElementsInList-
For some reason the Server API is trying to free an
attribute's value that doesn't exist.
Assertion Failed loop == 0 && beginingOfTypeList[loop] == class_value-
For some reason the class information structure is not stored with the
attribute list.
Assertion Failed messageList != NULL-
The routines were handed an NULL returnListPtr.
See also
OSAReturnValues(S_ADM)
© 2005 The SCO Group, Inc. All rights reserved.
SCO OpenServer Release 6.0.0 -- 03 June 2005