MprAdminPortEnum function (mprapi.h)
The MprAdminPortEnum function enumerates all active ports in a specific connection, or all ports available for use or currently used by RAS.
Syntax
DWORD MprAdminPortEnum(
[in] RAS_SERVER_HANDLE hRasServer,
[in] DWORD dwLevel,
[in] HANDLE hRasConnection,
[out] LPBYTE *lplpbBuffer,
[in] DWORD dwPrefMaxLen,
[out] LPDWORD lpdwEntriesRead,
[out] LPDWORD lpdwTotalEntries,
[in] LPDWORD lpdwResumeHandle
);
Parameters
[in] hRasServer
A handle to the RAS server whose ports are to be enumerated. To obtain this handle, call MprAdminServerConnect.
[in] dwLevel
A DWORD value that describes the format in which the information is returned in the lplpbBuffer parameter. Must be zero.
[in] hRasConnection
A handle to a connection for which the active ports are enumerated. If this parameter is INVALID_HANDLE_VALUE, all the ports in use or available for use by RRAS are enumerated. To obtain this handle, call MprAdminConnectionEnum.
[out] lplpbBuffer
On successful completion, a pointer to an array of RAS_PORT_0 structures that describes the port. Free this memory by calling MprAdminBufferFree.
[in] dwPrefMaxLen
A value that specifies the preferred maximum length of returned data, in 8-bit bytes. If this parameter is -1, the buffer that is returned is large enough to hold all available data.
[out] lpdwEntriesRead
A pointer to a DWORD variable. This variable receives the total number of ports that are enumerated from the current resume position.
[out] lpdwTotalEntries
A pointer to a DWORD variable. This variable receives the total number of ports that could have been enumerated from the current resume position.
[in] lpdwResumeHandle
A pointer to a DWORD variable. On successful execution, this parameter specifies a handle that can be used to resume the enumeration. This parameter should be zero on the first call and left unchanged on subsequent calls. If the return code is ERROR_MORE_DATA, the call can be reissued with the handle to retrieve more data. If the handle is NULL on return, the enumeration cannot be continued. This handle is invalid for other types of error returns.
Return value
If the function succeeds, the return value is NO_ERROR.
If the function fails, the return value is one of the error codes listed in the following table.
| Value | Meaning |
|---|---|
|
The calling application does not have sufficient privileges. |
|
The Demand Dial Manager (DDM) is not running, possibly because the Dynamic Interface Manager (DIM) is configured to run only on a LAN. |
|
At least one of the following parameters is NULL or does not point to valid memory: lplpBuffer, lpdwEntriesRead, or lpdwTotalEntries. |
|
Not all of the data was returned with this call. To obtain additional data, call the function again using the handle that was returned in the IpdwResumeHandle parameter. |
|
The dwLevel parameter is not zero. |
|
The hConnection parameter is NULL. |
|
An error from MprError.h, RasError.h, or WinError.h. |
Remarks
If the RRAS redistributable is installed, this function is available on Windows NT 4.0. However, the version of Mprapi.dll that is provided with the RRAS redistributable exports the function as RasAdminPortEnum rather than MprAdminPortEnum. Therefore, when using the RRAS redistributable, use LoadLibrary and GetProcAddress to access this function.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | mprapi.h |
| Library | Mprapi.lib |
| DLL | Mprapi.dll |