NWDSReadSyntaxDef(3nw)


NWDSReadSyntaxDef -- returns the syntax definition for a given Directory syntax identifier

Synopsis

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

NWDSCCODE N_API NWDSReadSyntaxDef (NWDSContextHandle context, nuint32 syntaxID, pSyntax_Info_T syntaxDef);

Description

The parameters are as follows:

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

syntaxID
(IN) Specifies the syntax identifier whose definition is to be returned.

syntaxDef
(OUT) Points to a Syntax_Info_T structure that receives the syntax 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

syntaxID is an identifier (not a string) of a syntax. These identifiers (such as SYN_TEL_NUMBER) are enumerated in NWDSDEFS.H.

This is a local function. Syntaxes are well known.

Services

Directory

NCP calls

None
30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.