RasAdminPortEnum 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 MprAdminPortEnum function.]
The RasAdminPortEnum function enumerates all ports on the specified RAS server. For each port on the server, the function returns the RAS_PORT_0 structure that contains information about the port.
Syntax
DWORD RasAdminPortEnum(
_In_ const WCHAR *lpszServer,
_Out_ PRAS_PORT_0 *ppRasPort0,
_Out_ WORD *pcEntriesRead
);
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.
-
ppRasPort0 [out]
-
Pointer to a variable that receives a pointer to a buffer that contains an array of RAS_PORT_0 structures. When the application has finished with the memory, free it by calling the RasAdminFreeBuffer function.
-
pcEntriesRead [out]
-
Pointer to a 16-bit variable that receives the total number of RAS_PORT_0 structures returned in the ppRasPort0 array.
Return value
If the function succeeds, the return value is ERROR_SUCCESS.
If the function fails, the return value can be the following error code.
| Value | Meaning |
|---|---|
|
No ports could be enumerated. This could be because all configured ports on the server are currently being used for dialing out. |
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 |
|