NetFileEnum

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
No
Import Library
netapi32.lib
Header File
lmshare.h
Unicode
WinNT
Platform Notes
All LanMan APIs are UNICODE only

The NetFileEnum function supplies information about some or all open files on a server, allowing the user to supply a resume handle and get required information through repeated calls to the function.

Security Requirements
Only members of the Administrators or Account Operators local group can successfully execute NetFileEnum.

NET_API_STATUS NetFileEnum(

LPTSTR servername,
LPTSTR basepath,
LPTSTR username,
DWORD level,
LPBYTE *bufptr,
DWORD prefmaxlen,
LPDWORD entriesread,
LPDWORD totalentries,
LPDWORD resume_handle
);

Parameters
servername
Pointer to a Unicode string containing the name of the remote server on which the function is to execute. A NULL pointer or string specifies the local computer.

basepath
Pointer to a Unicode string containing a qualifier for the returned information. If NULL, all open resources are enumerated. If not NULL, the function enumerates only resources that have basepath as a prefix. A prefix is the path component up to a backslash.

username
Pointer to a Unicode string that specifies the name of the user. If not NULL, username serves as a qualifier to the enumeration. The files returned are limited to those that have user names matching the qualifier. If username is NULL, no user-name qualifier is used.
level
Specifies one of the following values to return the level of information pointed to in the bufptr parameter.

Value	Meaning
2	Return file identification number. The returned buffer will contain an array of FILE_INFO_2 structures.
	Return information about the file. The returned buffer will contain an array of FILE_INFO_3 structures.

bufptr
Pointer to the address of the return information structure.

prefmaxlen
Preferred maximum length, in 8-bit bytes, of returned data.

entriesread
Pointer to a DWORD that contains the actual enumerated element count.

totalentries
Pointer to a DWORD that contains the total number of entries that could have been enumerated from the current resume position.

resume_handle
Pointer to a DWORD that contains a resume handle, which is used to continue an existing file search. The handle should be zero on the first call and left unchanged for subsequent calls. If resume_handle is NULL, then no resume handle is stored.