RasAdminPortGetInfo function
[This function is provided only for backward compatibility with Windows NT Server 4.0. It returns ERROR_CALL_NOT_IMPLEMENTED on Windows Server 2003. Applications should use the MprAdminPortGetInfo function.]
The RasAdminPortGetInfo function retrieves information about a specified port on a specified server.
Syntax
DWORD RasAdminPortGetInfo(
_In_ const WCHAR *lpszServer,
_In_ const WCHAR *lpszPort,
_Out_ RAS_PORT_1 *pRasPort1,
_Out_ RAS_PORT_STATISTICS *pRasStats,
_Out_ RAS_PARAMETERS **ppRasParams
);
Parameters
-
lpszServer [in]
-
Pointer to a null-terminated Unicode string that specifies the name of the RAS server. Specify the name with leading "\\" characters, in the form: \\servername.
-
lpszPort [in]
-
Pointer to a null-terminated Unicode string that specifies the name of the port on the server.
-
pRasPort1 [out]
-
Pointer to the RAS_PORT_1 structure that the function fills in with information about the state of the port.
-
pRasStats [out]
-
Pointer to the RAS_PORT_STATISTICS structure that the function fills in with statistics about the port.
-
ppRasParams [out]
-
Pointer to a pointer variable that receives the address of an array of RAS_PARAMETERS structures. Each structure contains the name of a media-specific key, such as MAXCONNECTBPS, and its associated value. When the application is finished with this memory, free it by calling the RasAdminFreeBuffer function.
Return value
If the function succeeds, the return value is ERROR_SUCCESS.
If the function fails, the return value can be one of the following error codes.
| Value | Meaning |
|---|---|
|
The specified port is invalid. |
|
Insufficient memory to allocate a buffer for the ppRasParams array. |
There is no extended error information for this function; do not call GetLastError.
Requirements
| Requirement | Value |
|---|---|
| End of client support |
Windows 2000 Professional |
| End of server support |
Windows 2000 Server |
| Header |
|
| Library |
|
| DLL |
|