NWIntScanDirEntryInfo(3nw)


NWIntScanDirEntryInfo -- obtains information about 3.x and 4.x directory entries (files or directories) in the DOS name space

Synopsis

   #include <nwdentry.h> 
   or 
   #include <nwcalls.h> 
   

NWCCODE N_API NWIntScanDirEntryInfo (NWCONN_HANDLE conn, NWDIR_HANDLE dirHandle, nuint16 attrs, pnuint32 iterHandle, pnuint8 searchPattern, NWENTRY_INFO N_FAR * entryInfo, nuint16 augmentFlag);

Description

The parameters are as follows:

conn
(IN) Specifies the NetWare server connection handle.

dirHandle
(IN) Specifies the NetWare DOS directory handle indexing the directory to scan. Not optional; value must not be zero (0).

attrs
(IN) Specifies the attributes to be used for the scan.

iterHandle
(IN/OUT) Points to an nuint32 buffer to receive the search sequence from the server.

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

entryInfo
(OUT) Points to NWENTRY_INFO. This is initially zeroed out.

augmentFlag
(IN) Specifies if wildcards are augmented:

0 = wildcards are not augmented
non-zero = all wildcards are augmented

Return values

0x0000
SUCCESSFUL

0x8801
INVALID_CONNECTION

0x8989
NO_SEARCH_PRIVILEGES

0x8998
VOLUME_DOES_NOT_EXIST

0x899B
BAD_DIRECTORY_HANDLE

0x899C
INVALID_PATH

0x89FF
NO_FILES_FOUND_ERROR

Notices

NWIntScanDirEntryInfo is replacing NWScanDirEntryInfo.

NWIntScanDirEntryInfo can be used reiteratively with wildcards. On the first call, iterHandle should point to -1. After that, the server manages the information. All scanning is complete when the server returns 0x89FF.

searchPattern cannot point to any path elements and dirHandle must index the complete path.

NWIntScanDirEntryInfo can also be used to scan for information about other directories, including the root directory. In this mode, dirHandle needs to index the root or a directory, and searchPattern needs to point to a NULL value.

NWIntScanDirEntryInfo works with DOS name space only. To scan using alternate name spaces, convert the path to DOS name space by calling either NWGetNSPath or NWScanNSEntryInfo. You can also scan the Mac name space using NWAFPScanFileInformation.

Possible attrs values follow:

C Value Value Name
0x00 FA_NORMAL
0x02 FA_HIDDEN
0x04 FA_SYSTEM
0x10 FA_DIRECTORY

 
 ------------------------- 
| C Value|  Value Name   | 
|--------|---------------| 
| 0x00   |  FA_NORMAL    | 
|--------|---------------| 
| 0x02   |  FA_HIDDEN    | 
|--------|---------------| 
| 0x04   |  FA_SYSTEM    | 
|--------|---------------| 
| 0x10   |  FA_DIRECTORY | 
|--------|---------------| 

NWENTRY_INFO should be initialized to 0 before NWIntScanDirEntryInfo is called for the first time.

Services

File Systems

NCP calls

0x2222 22 01
Get Directory Path

0x2222 22 30
Scan A Directory

0x2222 22 31
Get Directory Entry

References

NWGetNSInfo(3nw), NWIntScanExtendedInfo(3nw), NWScanNSEntryInfo(3nw), NWAFPScanFileInformation(3nw)
30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.