NWDSBeginClassItem(3nw)


NWDSBeginClassItem -- begins a class item definition (which is a part of an object class definition) in an request buffer to be used by a Directory Services Schema function

Synopsis

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

NWDSCCODE N_API NWDSBeginClassItem (NWDSContextHandle context, pBuf_T buf);

Description

The parameters are as follows:

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

buf
(IN) Points to the request buffer being prepared.

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 which is allocated by NWDSAllocBuf and initialized by NWDSInitBuf for the DSV_DEFINE_CLASS operation.

NWDSBeginClassItem is used in conjunction with NWDSPutClassName and NWDSPutAttrName to prepare a request buffer for NWDSDefineClass to use in creating a new object-class definition. This request buffer must contain a sequence of five sets of class definition item lists. The lists must occur in the following order:

  1. Super Class Names

  2. Containment Class Names

  3. Naming Attribute Names

  4. Mandatory Attribute Names

  5. Optional Attribute Names

If a particular definition item list is empty, NWDSBeginClassItem must still be called for that list. For example, if the class definition has no mandatory attributes, you must call NWDSBeginClassItem to move to the Mandatory Attribute Names list and then immediately call NWDSBeginClassItem again to move to the Optional Attribute Names list.

The complete steps for creating a new object class definition are found in the reference for NWDSDefineClass.

Services

Directory

NCP calls

None

References

NWDSPutClassName(3nw), NWDSPutClassItem(3nw)
30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.