WNetEnumResource
The WNetEnumResource
function continues a network-resource enumeration started by the WNetOpenEnum
DWORD WNetEnumResource(
HANDLE hEnum, |
// handle to
enumeration |
LPDWORD lpcCount, |
// pointer to
entries to list |
LPVOID lpBuffer, |
// pointer to
buffer for results |
LPDWORD lpBufferSize |
// pointer to
buffer size variable |
); |
|
Parameters
hEnum
Identifies an
enumeration instance. This handle must be returned by WNetOpenEnum.
lpcCount
Points to a
variable specifying the number of entries requested. If the number requested is
0xFFFFFFFF, the function returns as many entries as possible.
When the
function finishes successfully, the variable pointed to by this parameter
contains the number of entries actually read.
lpBuffer
Points to the
buffer that receives the enumeration results, which are returned as an array of
NETRESOURCE
lpBufferSize
Points to a
variable that specifies the size, in bytes, of the lpBuffer parameter.
If the buffer is too small to receive even one entry, this parameter receives
the required size of the buffer.
Return Values
If the
function succeeds, the return value is one of the following values:
Value |
Meaning |
NO_ERROR |
The
enumeration succeeded, and the buffer contains the requested data. The
calling application can continue to call WNetEnumResource to complete
the enumeration. |
ERROR_NO_MORE_ITEMS |
There are
no more entries. The buffer contents are undefined. |
If the function
fails, the return value is an error code. To get extended error information,
call GetLastError
Value |
Meaning |
ERROR_MORE_DATA |
More entries
are available with subsequent calls. |
ERROR_INVALID_HANDLE |
The handle
given by the hEnum parameter is not valid. |
ERROR_NO_NETWORK |
No network
is present. This condition is tested before hEnum is tested for
validity. |
ERROR_EXTENDED_ERROR |
A network-specific
error occurred. To get a description of the error, use the WNetGetLastError |
The function
returns error codes for compatibility with Windows version 3.1. For
compatibility with the Win32 API, the function also sets the error code value
returned by GetLastError
Remarks
An
application cannot set the lpBuffer parameter to NULL and retrieve the
required buffer size from the lpBufferSize parameter. Instead, the
application should allocate a buffer of a reasonable size 16 kilobytes (K) is typical and use the value of lpBufferSize for error
detection.
See Also