|
Overview |
|
|
|
Group |
|
|
|
Quick Info
Windows NT
| Yes
| Win95
| No
| Win32s
| No
| Import Library
| rassapi.lib
| Header File
| rassapi.h
| Unicode
| WinNT
| Platform Notes
| None
|
|
|
RasAdminPortGetInfo
[New - Windows NT]
The RasAdminPortGetInfo function retrieves information about a specified port on a specified server.
DWORD RasAdminPortGetInfo(
const WCHAR *lpszServer,
| // pointer to the server name
| const WCHAR *lpszPort,
| // pointer to the name of port on the server
| RAS_PORT_1 *pRasPort1,
| // receives the state of the port
| RAS_PORT_STATISTICS *pRasStats,
| // receives statistics about the port
| RAS_PARAMETERS **ppRasParams
| // receives an array of media-specific parameters and values
| );
|
|
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.
lpszPort
Pointer to a null-terminated Unicode string that contains the name of the port
on the server.
pRasPort1
Pointer to a RAS_PORT_1 structure that the function fills in with information about the state of the
port.
pRasStats
Pointer to a RAS_PORT_STATISTICS structure that the function fills in with statistics about the port.
ppRasParams
Pointer to a variable that receives a pointer to an array of RAS_PARAMETERS structures. Each structure contains the name of a media-specific key, such as
MAXCONNECTBPS, and its associated value. When your application is finished
with the memory pointed to by *ppRasParams, free it by calling the RasAdminFreeBuffer function.
Return Values
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
| ERROR_DEV_NOT_EXIST
| The specified port is invalid.
| ERROR_NOT_ENOUGH_MEMORY
| Insufficient memory to allocate a buffer for the ppRasParams array.
|
Do not call GetLastError to get error information for this function.
See Also
RAS_PARAMETERS, RAS_PORT_1, RAS_PORT_STATISTICS, RasAdminFreeBuffer
Related Links
Software for Delphi and C++ Builder developers
Software for Visual Studio .NET developers
Software for Visual Basic 6 developers
Delphi Tips&Tricks
MegaDetailed.NET
More Online Helps
Win32 Multimedia Programmer's Reference (mmedia.hlp)
OLE Programmer's Reference (ole.hlp)
Microsoft Windows Pen API Programmer's Reference (penapi.hlp)
Microsoft Windows Sockets 2 Reference (sock2.hlp)
Microsoft Windows Telephony API (TAPI) Programmer's Reference (tapi.hlp)
Unix Manual Pages
|
