[New - Windows NT]
The RasAdminPortEnum function enumerates all ports on the specified RAS server. For each port on the server, the function returns a RAS_PORT_0 structure that contains information about the port.
DWORD RasAdminPortEnum(
const WCHAR *lpszServer, | // pointer to the server name |
PRAS_PORT_0 *ppRasPort0, | // receives a pointer to an array of port information |
WORD *pcEntriesRead | // receives the number of ports enumerated |
); |
Parameters
lpszServer
Pointer to a null-terminated Unicode string that contains the name of the Windows NT RAS server. Specify the name with leading "\\" characters, in the form: \\servername.
ppRasPort0
Pointer to a variable that receives a pointer to a buffer that contains an array of RAS_PORT_0 structures. When your application has finished with the memory, free it by calling the RasAdminFreeBuffer function.
pcEntriesRead
Pointer to a 16-bit variable that receives the total number of RAS_PORT_0 structures returned in the ppRasPort0 array.
Return Values
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 |
NERR_ItemNotFound | No ports could be enumerated. This could be because all configured ports on the server are currently being used for dialing out. |
Do not call GetLastError to get error information for this function.
See Also