NWDSGetClassItem(3nw)


NWDSGetClassItem -- returns the name of the next object class item stored in a result buffer

Synopsis

   #include <nwnet.h> 
   or 
   #include <nwdsbuft.h> 
   

NWDSCCODE N_API NWDSGetClassItem (NWDSContextHandle context, pBuf_T buf, pnstr8 itemName);

Description

The parameters are as follows:

context
(IN) Specifies the Directory context for the request.

buf
(IN) Points to the result buffer being read.

itemName
(OUT) Points to the name of the item (attribute or class) at the current position in the result buffer.

Return values

0x0000
SUCCESSFUL

Negative Value
Negative values indicate errors. For errors returned by Directory Services, see ``Directory Services OS Errors'' (-001 to -255), ``Directory Services Client Library Errors'' (-301 to -399), or ``Directory Services Agent in the Server Errors'' (-601 to -699).

Notices

buf points to a Buf_T filled in by NWDSReadClassDef.

itemName points to the name of either an attribute or a class. The item is a member of one of the five class-definition-item lists:

  1. Super Class Names

  2. Containment Class Names

  3. Naming Attribute Names

  4. Mandatory Attribute Names

  5. Optional Attribute Names

The user must allocate space for the class item name pointed to by itemName. The size of the allocated memory is ((MAX_SCHEMA_NAME_CHARS)+1)*sizeof(character size) where character size is 1 for single-byte characters, and 2 for double-byte characters (Unicode is double-byte). One character is used for NULL termination.

Before retrieving the class items from a class-definition-item list, determine the number of items in the list by calling NWDSGetClassItemCount. Then retrieve the items associated with the list by repeatedly calling NWDSGetClassItem once for each item in the list. Then determine the number of items in the next list by calling NWDSGetClassItemCount, and retrieve the values for the list by calling NWDSGetClassItem, and so on until you have retrieved all of the information from all off the lists.


NOTE: You must retrieve the information from the class-definition-item lists in the order shown above.

For the complete steps for reading class-definition information, see NWDSReadClassDef(3nw)

Services

Directory

NCP calls

None

References

NWDSGetClassDef(3nw), NWDSGetClassItemCount(3nw), NWDSListContainableClasses(3nw), NWDSReadClassDef(3nw)
30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.