NetFileEnum2 or Net32FileEnum2

The NetFileEnum2 API supplies information about some or all open files on the server, allowing the user to supply a key to get the required information through iterated calls to the API.

The NetFileEnum2 API replaces the NetFileEnum API, which is now obsolete.

Restrictions

This API can be called from DLS and OS/2 workstations, but DLS workstations can issue this call only to a remote LAN Server workstation. Administrator authority is required to call this API.

#include <netcons.h>
#include <shares.h>
 
NetFileEnum2(pszServername, pszPath, pszUserID,
             sLevel, buf, usBuflen,
             pusEntriesReturned, pEntriesRemain,
             pResumeKey);            /* 16 bit */
 
Net32FileEnum2(pszServername, pszPath, pszUserID,
             ulLevel, buf, ulBuflen,
             pulEntriesReturned, pEntriesRemain,
             pResumeKey);            /* 32 bit */

See Common Parameter Definitions for descriptions of parameters not defined here.

pszPath

pszUserID

sLevel

ulLevel

Opened Resources Level 2

pEntriesRemain

(16-bit unsigned short LSFAR * or 32-bit unsigned long LSFAR *) points to an unsigned short integer indicating the number of entries that have not yet been read.

pResumeKey

void LSFAR *

res_file_enum_2

The following table lists the return codes most significant to this API. (See API Return Codes for a complete list of return codes.) кФФФФФФФФФФФФФФФФФФФФФФФФФФФФФТФФФФФФФТФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФПГSYMBOLICCONSTANT ГVALUEГMEANING Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_Success Г 0 Г No errors were encountered. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_ACCESS_DENIED Г 5 Г Administrator privilege is required. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_BAD_NETPATH Г 53 Г The network path cannot be found. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_NETWORK_ACCESS_DENIED Г 65 Г Network access is denied. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_INVALID_PARAMETER Г 87 Г At least one parameter value is not Г
Г Г Г valid. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_INVALID_LEVEL Г 124 Г The sLevel parameter is not valid. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_MORE_DATA Г 234 Г Additional data is available, but the Г
Г Г Г buffer is too small. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_NetNotStarted Г2102 ГTheredirectorNETWKSTA . 200hasnot Г
Г Г Г been started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_RemoteOnly Г 2106 Г This operation is not supported on Г
Г Г Г workstations. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_ServerNotStarted Г 2114 Г The Server service has not been Г
Г Г Г started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_WkstaNotStarted Г 2138 Г The Requester service has not been Г
Г Г Г started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_InvalidAPI Г 2142 Г The requested API is not supported on Г
Г Г Г the remote server. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_InvalidComputer Г 2351 Г The specified computer name is not Г
Г Г Г valid. Г
РФФФФФФФФФФФФФФФФФФФФФФФФФФФФФСФФФФФФФСФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФй

If you call this API with the buffer length parameter equal to zero, the API returns a value for total entries available. This technique is useful if you do not know the exact buffer size required.

This API provides a way for the user to overcome the problem that arises when the information returned exceeds 64KB. To initialize the key pResumeKey, use the macro instruction FRK_INIT supplied in the file SHARES.H, which accepts a structure FRK as an argument. The following is an example of an application code segment:

  FRK f;
 
  FRK_INIT( f );
  NetFileEnum2 ( ..., &f);

When invoked with an initial pResumeKey, if the supplied buffer is too small to return all the requested information, the NetFileEnum2 API returns the error code ERROR_MORE_DATA and a pResumeKey suitable for retrieving the remaining data. When invoked with a pResumeKey from a previous call, it resumes the enumeration where indicated by *pResumeKey. The user must not attempt to set this key other than to initialize it. Other values of *pResumeKey supplied by the user must have been returned by a preceding call to NetFileEnum2.

NetFileEnum2 never returns an entry that has partial data; that is, a fixed-length data record and all variable-length data is present for each returned item. Items that cannot fit completely are not returned in the buffer. This differs from normal Enum function calls, which return partial data for some entries (usually the last few) if the buffer is too small. Enum2 is different in that the entries can be retrieved in full by subsequent calls (using the pResumeKey). Consequently, partial data could be misleading and is less useful than in normal Enum functions.

The pszUserID parameter, if not NULL, serves as a qualifier to the enumeration. The files returned are limited to those whose pszUserID matches the qualifier.

The pszPath parameter, if not NULL, serves as a prefix to qualify the enumeration. The entries returned are limited to those whose names begin with the qualifier string. For example, a pszPath of C:\TMP enumerates only open files whose path names begin with C:\TMP, C:\TMPFILE, and C:\TMP\DOCUMENT.

If both the pszUserID and the pszPath parameters are specified, only the files matching both the qualifying conditions are returned.

[Back]

[Next]