NWScanNSEntryInfoSet

Scans a set of directory and file entry information by using a specific name space.

Local Servers:blocking
Remote Servers:blocking
NetWare Server:3.11, 3.12, 3.2, 4.x, 5.x, 6.x
Platform:NLM, Windows NT*, Windows* 95, Windows 98
Library:Cross-Platform NetWare Calls (CAL*.*)
Service:Name Space

Syntax

   #include <nwnamspc.h> 
   or 
   #include <nwcalls.h>
   
   NWCCODE NWScanNSEntryInfoSet (
      NWCONN_HANDLE           conn,
      NWDIR_HANDLE            dirHandle,
      nuint8                  buNameSpace,
      nuint16                 suAttr,
      SEARCH_SEQUENCE N_FAR  *pIterHnd,
      const nstr8 N_FAR      *pbstrSrchPattern,
      nuint32                 luRetMask,
      pnuint8                 pbuMoreEntriesFlag,
      punint16                psuNumReturned,
      nuint16                 suNumItems,
      NW_ENTRY_INFO N_FAR    *pEntryInfo);
   

Parameters

conn

(IN) Specifies the NetWare server connection handle.

dirHandle

(IN) Specifies the directory handle associated with the directory to be scanned (must be the parent directory handle).

buNameSpace

(IN) Specifies the name space of dirHandle (see Section 20.5, Name Space Flag Values).

suAttr

(IN) Specifies the attributes to be used for the scan (see Section 20.8, Search Attributes Values).

pIterHnd

(IN/OUT) Points to SEARCH_SEQUENCE.

pbstrSrchPattern

(IN) Points to the name of the entry for which to scan (wildcards are allowed).

luRetMask

(IN) Specifies which information is to be returned in the array pointed to by pEntryInfo (see Section 20.6, Basic Return Mask Values-this parameter cannot take Extended Return Mask Values).

pbuMoreEntriesFlag

(OUT) Points to a flag indicating whether more entries are avilable:

  • 0xFF More entries are available
  • 0 No more entries are available
psuNumReturned

(OUT) Points to a value indicating how many NW_ENTRY_INFO structures were actually returned in the pEntryInfo array.

suNumItems

(IN) Specifies the size of the array pointed to by pEntryInfo.

pEntryInfo

(OUT) Points to an array of NW_ENTRY_INFO structures.

Return Values

These are common return values; see Return Values (Return Values for C) for more information.

0x0000

SUCCESSFUL

0x8801

INVALID_CONNECTION

0x8998

VOLUME_DOES_NOT_EXIST

0x899B

BAD_DIRECTORY_HANDLE

0x899C

INVALID_PATH

0x890A

NLM_INVALID_CONNECTION

Remarks

NWScanNSEntryInfoSet is a version of NWScanNSEntryInfo that has been enhanced to return a list of entry information.

For the first request, the searchDirNumber field in SEARCH_SEQUENCE should be set to -1. Thereafter, the server manages the information; users should never directly change the value.

NCP Calls

See Also

NWGetNSEntryInfo, NWGetNSInfo, NWSetNSInfo