NetReplImportDirEnum
The NetReplImportDirEnum function lists the replicated directories in the import path.
Security Requirements
No special group membership is required to successfully execute the NetReplImportDirEnum function.
NET_API_STATUS NetReplImportDirEnum(
LPCWSTR servername,
DWORD level,
LPBYTE *bufptr,
DWORD prefmaxlen,
LPDWORD entriesread,
LPDWORD totalentries,
LPDWORD resumehandle
);
Parameters
- servername
- [in] Pointer to a constant null-terminated Unicode string specifying the name of the remote server on which the function is to execute. The string must begin with \\. If this parameter is NULL, the local computer is used.
- level
- [in] Specifies the information level of the data. This parameter can be one of the following values.
Value |
Meaning |
0 |
Return import subdirectory names. The bufptr parameter points to an array of REPL_IDIR_INFO_0 structures. |
1 |
Return import subdirectory names and information. The bufptr parameter points to an array of REPL_IDIR_INFO_1 structures. |
- bufptr
- [out] Pointer to the buffer that receives the data. The format of this data depends on the value of the level parameter. This buffer is allocated by the system and must be freed using the NetApiBufferFree function. Note that you must free the buffer even if the function fails with ERROR_MORE_DATA.
- prefmaxlen
- [in] Specifies the preferred maximum length of returned data, in bytes. If you specify MAX_PREFERRED_LENGTH, the function allocates the amount of memory required for the data. If you specify another value in this parameter, it can restrict the number of bytes that the function returns. If the buffer size is insufficient to hold all entries, the function returns ERROR_MORE_DATA. For more information, see Network Management Function Buffers and Network Management Function Buffer Lengths.
- entriesread
- [out] Pointer to a DWORD value that receives the actual enumerated element count.
- totalentries
- [out] Pointer to a DWORD value that receives the total number of entries that could have been enumerated from the current resume position.
- resumehandle
- [in/out] Pointer to a DWORD value that contains a resume handle which is used to continue an existing search. The handle should be zero on the first call and left unchanged for subsequent calls. If resumehandle is NULL, no resume handle is stored.
Return Values
If the function succeeds, the return value is NERR_Success.
If the function fails, the return value is a Win32 API error code. For a list of error codes, see Error Codes.
Windows NT/2000: Requires Windows NT 4.0 or earlier.
Windows 95/98: Unsupported.
Header: Declared in Lmrepl.h; include Lm.h.
Library: Use Netapi32.lib.
See Also
Network Management Overview, Network Management Functions, Replicator Functions, NetReplImportDirGetInfo, REPL_IDIR_INFO_0, REPL_IDIR_INFO_1