NWDSReadSyntaxDef

Returns the syntax definition for a given eDirectory syntax identifier.

NetWare Server:4.x, 5.x, 6.x
Platform:NLM, Windows NT, Windows 95, Windows 98, Windows 2000, Windows XP
Library:Cross-Platform NDS (NET*.*)
Service:NDS

Syntax

C

  #include <nwnet.h> 
  or 
  #include <nwdsmisc.h> 
   
  N_EXTERN_LIBRARY (NWDSCCODE)  NWDSReadSyntaxDef  ( 
     NWDSContextHandle   context,  
     nuint32             syntaxID,  
     pSyntax_Info_T      syntaxDef);
  

Pascal

  uses netwin32 
   
  Function NWDSReadSyntaxDef 
    (context : NWDSContextHandle; 
     syntaxID : nuint32; 
     syntaxDef : pSyntax_Info_T 
  ) : NWDSCCODE;
  

Parameters

context

(IN) Specifies the NDS context for the request.

syntaxID

(IN) Specifies the syntax identifier whose definition is to be returned (see Section 5.26, Syntax IDs).

syntaxDef

(OUT) Points to a Syntax_Info_T structure, which receives the syntax definition.

Return Values

0x0000 0000

SUCCESSFUL

nonzero value

Nonzero values indicate errors. See NDS Return Values (–001 to –799).

Remarks

The syntaxID parameter is an identifier (not a string) of a syntax. These identifiers (such as SYN_TEL_NUMBER) are enumerated in the nwdsdefs.h file.

This is a local function. Syntaxes are well known.

NCP Calls