NWDSGetCountByClassAndName

Counts the immediate subordinates of an eDirectory object, restricting the count to objects of a specified object class, with a specific name, or both.

Local Servers:blocking
Remote Servers:blocking
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 <nwdsdsa.h> 
   
  N_EXTERN_LIBRARY (NWDSCCODE)  NWDSGetCountByClassAndName  ( 
     NWDSContextHandle   context,  
     pnstr8              objectName,  
     pnstr8              className,  
     pnstr8              subordinateName,  
     pnint32             count); 
  

Pascal

  uses netwin32 
   
  Function NWDSGetCountByClassAndName 
    (context : NWDSContextHandle; 
     objectName : pnstr8; 
     className : pnstr8; 
     subordinateName : pnstr8; 
     count : pnint32 
  ) : NWDSCCODE;
  

Parameters

context

(IN) Specifies the NDS context for the request.

objectName

(IN) Points to the object name whose subordinates are to be counted.

className

(IN) Points to the base class to be used as a filter when determining which objects should be counted.

subordinateName

(IN) Points to a name to be used as a filter when determining which objects should be counted.

count

(OUT) Points to the count of subordinate objects matching the filters.

Return Values

These are common return values.

0x0000 0000

SUCCESSFUL

0x8996

SERVER_OUT_OF_MEMORY

0x89E2

TOO_FEW_FRAGMENTS

0x89E3

TOO_MANY_FRAGMENTS

0x89E4

PROTOCOL_VIOLATION

0x89E5

SIZE_LIMIT_EXCEEDED

0x89FD

UNKNOWN_REQUEST

0x89FD

INVALID_PACKET_LENGTH

0x89FE

BAD_PACKET

0x89FF

Failure not related to eDirectory

nonzero value

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

Remarks

NWDSGetCountByClassAndName is similar to NWDSListByClassAndName except no information, other than a count of objects, is returned by NWDSGetCountByClassAndName.

The location of the subordinate object(s) in the eDirectory tree is immediately subordinate to the object specified by objectName. It is not relative to the current name context in the NDS context specified by context.

The relationship between className and subordinateName is an "AND" relationship.

  • When className and subordinateName are provided, the count of immediate subordinate objects is restricted by both filters.

  • When className is NULL and subordinateName is NULL, the count of all immediate subordinates is returned.

  • When className is provided and subordinateName is NULL, the count of immediate subordinates is restricted only by the className filter.

  • When subordinateName is provided and className is NULL, the count of immediate subordinates is restricted only by the subordinateName filter.

The following examples show how to use wildcards for untyped names:

     c*   Any object whose left-most name begins with a "c" 
           character.   M*y  Any object beginning with "M" and ending with "y" 
              such as Mary.
  

If the wildcard name specified for subordinateName includes a type, such as "CN," the name must include the equals (=) sign. The following examples show how to use wildcards for typed names:

     cn=*   Any object whose left-most name is a common name.
     cn=c*  Any object whose left-most name is a common name 
            and begin with "c."  
     o*=*   Any object whose naming attribute is of a type 
            beginning with an "o," such as O or OU.   
     o*=c*  Any object whose left-most name is of a type 
            beginning with an "o," and whose name begins 
            with "c."
  

NCP Calls

See Also

NWDSListByClassAndName