NWDSGetClassDef(3nw)


NWDSGetClassDef -- retrieves an object-class definition from a result buffer

Synopsis

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

NWDSCCODE N_API NWDSGetClassDef (NWDSContextHandle context, pBuf_T buf, pnstr8 className, pClass_Info_T classInfo);

Description

The parameters are as follows:

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

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

className
(OUT) Points to the name of the object-class definition at the current position in the buffer.

classInfo
(OUT) Points to the initial portion of the object-class definition.

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

NWDSGetClassDef is used to retrieve class definitions from a result buffer filled in by NWDSReadClassDef.

className points to the name of the current class in the buffer. You must allocate space for the class name. The size of the allocated memory is ((MAX_SCHEMA_NAME_CHARS)+1)*sizeof(characters 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.

If NWDSReadClassDef is called with infoType set to DS_CLASS_DEF_NAMES, classInfo of NWDSGetClassDef is ignored and can be NULL.

The complete steps for retrieving class information from a result buffer are listed in the reference for NWDSReadClassDef.

Services

Directory

NCP calls

None

References

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