RAS Server and Port Administration

The RAS server administration functions enable you to get information about a specified RAS server and its ports. These functions also enable you to terminate a connection on a specified RAS server port.

The RasAdminServerGetInfo function returns a RAS_SERVER_0 structure that contains information about the configuration of a RAS server. The returned information includes the number of ports currently available for connection, the number of ports currently in use, and the server version number.

The RasAdminPortEnum function retrieves an array of RAS_PORT_0 structures that contains information for each of the ports configured on a RAS server. The information for each port includes:

  • The name of the port
  • Information about the device attached to the port
  • Whether the RAS server associated with the port is a Windows NT/Windows 2000 Server
  • Whether the port is currently in use, and if it is, information about the connection

You can call the RasAdminPortGetInfo function to get additional information about a specified port on a RAS server. This function returns a RAS_PORT_1 structure that contains a RAS_PORT_0 structure and additional information about the current state of the port. The RasAdminPortGetInfo function also returns an array of RAS_PARAMETERS structures that describe the values of any media-specific keys associated with the port. A RAS_PARAMETERS structure uses a value from the RAS_PARAMS_FORMAT enumeration to indicate the format of the value for each media-specific key.

The RasAdminPortGetInfo function also returns a RAS_PORT_STATISTICS structure that contains various statistic counters for the current connection, if any, on the port. For a port that is part of a multilink connection, RasAdminPortGetInfo returns statistics for the individual port and cumulative statistics for all ports involved in the connection. You can use the RasAdminPortClearStatistics function to reset the statistic counters for the port. The RasAdminPortDisconnect function disconnects a port that is in use.

Use the RasAdminFreeBuffer function to free memory allocated by the RasAdminPortEnum and RasAdminPortGetInfo functions. Use the RasAdminGetErrorString function to get a string that describes a RAS error code returned by one of the RAS server administration (RasAdmin) functions.