Edit

Share via


ras.h header

This header is used by Routing and Remote Access Service. For more information, see:

ras.h contains the following programming interfaces:

Functions

 
RasClearConnectionStatistics

The RasClearConnectionStatistics functions clears any accumulated statistics for the specified RAS connection.
RasClearLinkStatistics

The RasClearLinkStatistics functions clears any accumulated statistics for the specified link in a RAS multilink connection.
RasConnectionNotificationA

The RasConnectionNotification function specifies an event object that the system sets to the signaled state when a RAS connection is created or terminated. (ANSI)
RasConnectionNotificationW

The RasConnectionNotification function specifies an event object that the system sets to the signaled state when a RAS connection is created or terminated. (Unicode)
RasCreatePhonebookEntryA

The RasCreatePhonebookEntry function creates a new phone-book entry. The function displays a dialog box in which the user types information for the phone-book entry. (ANSI)
RasCreatePhonebookEntryW

The RasCreatePhonebookEntry function creates a new phone-book entry. The function displays a dialog box in which the user types information for the phone-book entry. (Unicode)
RasDeleteEntryA

The RasDeleteEntry function deletes an entry from a phone book. (ANSI)
RasDeleteEntryW

The RasDeleteEntry function deletes an entry from a phone book. (Unicode)
RasDeleteSubEntryA

The RasDeleteSubEntry function deletes the specified subentry from the specified phone-book entry. (ANSI)
RasDeleteSubEntryW

The RasDeleteSubEntry function deletes the specified subentry from the specified phone-book entry. (Unicode)
RasDialA

The RasDial function establishes a RAS connection between a RAS client and a RAS server. The connection data includes callback and user-authentication information. (ANSI)
RasDialW

The RasDial function establishes a RAS connection between a RAS client and a RAS server. The connection data includes callback and user-authentication information. (Unicode)
RasEditPhonebookEntryA

The RasEditPhonebookEntry function edits an existing phone-book entry. The function displays a dialog box in which the user can modify the existing information. (ANSI)
RasEditPhonebookEntryW

The RasEditPhonebookEntry function edits an existing phone-book entry. The function displays a dialog box in which the user can modify the existing information. (Unicode)
RasEnumAutodialAddressesA

The RasEnumAutodialAddresses function returns a list of all addresses in the AutoDial mapping database. (ANSI)
RasEnumAutodialAddressesW

The RasEnumAutodialAddresses function returns a list of all addresses in the AutoDial mapping database. (Unicode)
RasEnumConnectionsA

The RasEnumConnections function lists all active RAS connections. It returns each connection's handle and phone-book entry name. (ANSI)
RasEnumConnectionsW

The RasEnumConnections function lists all active RAS connections. It returns each connection's handle and phone-book entry name. (Unicode)
RasEnumDevicesA

The RasEnumDevices function returns the name and type of all available RAS-capable devices. (ANSI)
RasEnumDevicesW

The RasEnumDevices function returns the name and type of all available RAS-capable devices. (Unicode)
RasEnumEntriesA

The RasEnumEntries function lists all entry names in a remote access phone book. (ANSI)
RasEnumEntriesW

The RasEnumEntries function lists all entry names in a remote access phone book. (Unicode)
RasFreeEapUserIdentityA

Use the RasFreeEapUserIdentity function to free the memory buffer returned by RasGetEapUserIdentity. (ANSI)
RasFreeEapUserIdentityW

Use the RasFreeEapUserIdentity function to free the memory buffer returned by RasGetEapUserIdentity. (Unicode)
RasGetAutodialAddressA

The RasGetAutodialAddress function retrieves information about all the AutoDial entries associated with a network address in the AutoDial mapping database. (ANSI)
RasGetAutodialAddressW

The RasGetAutodialAddress function retrieves information about all the AutoDial entries associated with a network address in the AutoDial mapping database. (Unicode)
RasGetAutodialEnableA

The RasGetAutodialEnable function indicates whether the AutoDial feature is enabled for a specified TAPI dialing location. (ANSI)
RasGetAutodialEnableW

The RasGetAutodialEnable function indicates whether the AutoDial feature is enabled for a specified TAPI dialing location. (Unicode)
RasGetAutodialParamA

The RasGetAutodialParam function retrieves the value of an AutoDial parameter. (ANSI)
RasGetAutodialParamW

The RasGetAutodialParam function retrieves the value of an AutoDial parameter. (Unicode)
RasGetConnectionStatistics

The RasGetConnectionStatistics function retrieves accumulated connection statistics for the specified connection.
RasGetConnectStatusA

The RasGetConnectStatus function retrieves information on the current status of the specified remote access connection. An application can use this call to determine when an asynchronous RasDial call is complete. (ANSI)
RasGetConnectStatusW

The RasGetConnectStatus function retrieves information on the current status of the specified remote access connection. An application can use this call to determine when an asynchronous RasDial call is complete. (Unicode)
RasGetCountryInfoA

The RasGetCountryInfo function retrieves country/region-specific dialing information from the Windows Telephony list of countries/regions. (ANSI)
RasGetCountryInfoW

The RasGetCountryInfo function retrieves country/region-specific dialing information from the Windows Telephony list of countries/regions. (Unicode)
RasGetCredentialsA

The RasGetCredentials function retrieves the user credentials associated with a specified RAS phone-book entry. (ANSI)
RasGetCredentialsW

The RasGetCredentials function retrieves the user credentials associated with a specified RAS phone-book entry. (Unicode)
RasGetCustomAuthDataA

Use the RasGetCustomAuthData function to retrieve connection-specific authentication information. This information is not specific to a particular user. (ANSI)
RasGetCustomAuthDataW

Use the RasGetCustomAuthData function to retrieve connection-specific authentication information. This information is not specific to a particular user. (Unicode)
RasGetEapUserDataA

Use the RasGetEapUserData function to retrieve user-specific Extensible Authentication Protocol (EAP) information for the specified phone-book entry. (ANSI)
RasGetEapUserDataW

Use the RasGetEapUserData function to retrieve user-specific Extensible Authentication Protocol (EAP) information for the specified phone-book entry. (Unicode)
RasGetEapUserIdentityA

The RasGetEapUserIdentity function retrieves identity information for the current user. Use this information to call RasDial with a phone-book entry that requires Extensible Authentication Protocol (EAP). (ANSI)
RasGetEapUserIdentityW

The RasGetEapUserIdentity function retrieves identity information for the current user. Use this information to call RasDial with a phone-book entry that requires Extensible Authentication Protocol (EAP). (Unicode)
RasGetEntryDialParamsA

The RasGetEntryDialParams function retrieves the connection information saved by the last successful call to the RasDial or RasSetEntryDialParams function for a specified phone-book entry. (ANSI)
RasGetEntryDialParamsW

The RasGetEntryDialParams function retrieves the connection information saved by the last successful call to the RasDial or RasSetEntryDialParams function for a specified phone-book entry. (Unicode)
RasGetEntryPropertiesA

The RasGetEntryProperties function retrieves the properties of a phone-book entry. (ANSI)
RasGetEntryPropertiesW

The RasGetEntryProperties function retrieves the properties of a phone-book entry. (Unicode)
RasGetErrorStringA

The RasGetErrorString function obtains an error message string for a specified RAS error value. (ANSI)
RasGetErrorStringW

The RasGetErrorString function obtains an error message string for a specified RAS error value. (Unicode)
RasGetLinkStatistics

The RasGetLinkStatistics function retrieves accumulated statistics for the specified link in a RAS multilink connection.
RasGetNapStatus

Retrieves the Network Access Protection (NAP) connection state variables for a given remote access connection.
RasGetProjectionInfoEx

Obtains information about Point-to-Point Protocol (PPP) or Internet Key Exchange version 2 (IKEv2) remote access projection operations for all RAS connections on the local client.
RasGetSubEntryHandleA

The RasGetSubEntryHandle function retrieves a connection handle for a specified subentry of a multilink connection. (ANSI)
RasGetSubEntryHandleW

The RasGetSubEntryHandle function retrieves a connection handle for a specified subentry of a multilink connection. (Unicode)
RasGetSubEntryPropertiesA

The RasGetSubEntryProperties function retrieves information about a subentry for a specified phone-book entry. (ANSI)
RasGetSubEntryPropertiesW

The RasGetSubEntryProperties function retrieves information about a subentry for a specified phone-book entry. (Unicode)
RasHangUpA

The RasHangUp function terminates a remote access connection. The connection is specified with a RAS connection handle. The function releases all RASAPI32.DLL resources associated with the handle. (ANSI)
RasHangUpW

The RasHangUp function terminates a remote access connection. The connection is specified with a RAS connection handle. The function releases all RASAPI32.DLL resources associated with the handle. (Unicode)
RasInvokeEapUI

The RasInvokeEapUI function displays a custom user interface to obtain Extensible Authentication Protocol (EAP) information from the user.
RasRenameEntryA

The RasRenameEntry function changes the name of an entry in a phone book. (ANSI)
RasRenameEntryW

The RasRenameEntry function changes the name of an entry in a phone book. (Unicode)
RasSetAutodialAddressA

The RasSetAutodialAddress function can add an address to the AutoDial mapping database. Alternatively, the function can delete or modify the data associated with an existing address in the database. (ANSI)
RasSetAutodialAddressW

The RasSetAutodialAddress function can add an address to the AutoDial mapping database. Alternatively, the function can delete or modify the data associated with an existing address in the database. (Unicode)
RasSetAutodialEnableA

The RasSetAutodialEnable function enables or disables the AutoDial feature for a specified TAPI dialing location. (ANSI)
RasSetAutodialEnableW

The RasSetAutodialEnable function enables or disables the AutoDial feature for a specified TAPI dialing location. (Unicode)
RasSetAutodialParamA

The RasSetAutodialParam function sets the value of an AutoDial parameter. (ANSI)
RasSetAutodialParamW

The RasSetAutodialParam function sets the value of an AutoDial parameter. (Unicode)
RasSetCredentialsA

Sets the user credentials associated with a specified RAS phone-book entry. (ANSI)
RasSetCredentialsW

Sets the user credentials associated with a specified RAS phone-book entry. (Unicode)
RasSetCustomAuthDataA

Use the RasSetCustomAuthData function to set connection-specific authentication information. This information should not be specific to a particular user. (ANSI)
RasSetCustomAuthDataW

Use the RasSetCustomAuthData function to set connection-specific authentication information. This information should not be specific to a particular user. (Unicode)
RasSetEapUserDataA

Use the RasSetEapUserData function to store user-specific Extensible Authentication Protocol (EAP) information for the specified phone-book entry in the registry. (ANSI)
RasSetEapUserDataW

Use the RasSetEapUserData function to store user-specific Extensible Authentication Protocol (EAP) information for the specified phone-book entry in the registry. (Unicode)
RasSetEntryDialParamsA

The RasSetEntryDialParams function changes the connection information saved by the last successful call to the RasDial or RasSetEntryDialParams function for a specified phone-book entry. (ANSI)
RasSetEntryDialParamsW

The RasSetEntryDialParams function changes the connection information saved by the last successful call to the RasDial or RasSetEntryDialParams function for a specified phone-book entry. (Unicode)
RasSetEntryPropertiesA

The RasSetEntryProperties function changes the connection information for an entry in the phone book or creates a new phone-book entry. (ANSI)
RasSetEntryPropertiesW

The RasSetEntryProperties function changes the connection information for an entry in the phone book or creates a new phone-book entry. (Unicode)
RasSetSubEntryPropertiesA

The RasSetSubEntryProperties function creates a new subentry or modifies an existing subentry of a specified phone-book entry. (ANSI)
RasSetSubEntryPropertiesW

The RasSetSubEntryProperties function creates a new subentry or modifies an existing subentry of a specified phone-book entry. (Unicode)
RasUpdateConnection

The RasUpdateConnection function updates the tunnel endpoints of an Internet Key Exchange version 2 (IKEv2) connection.
RasValidateEntryNameA

The RasValidateEntryName function validates the format of a connection entry name. The name must contain at least one non-white-space alphanumeric character. (ANSI)
RasValidateEntryNameW

The RasValidateEntryName function validates the format of a connection entry name. The name must contain at least one non-white-space alphanumeric character. (Unicode)

Callback functions

 
ORASADFUNC

The ORASADFunc function is an application-defined callback function that is used to provide a customized user interface for autodialing.
PFNRASFREEBUFFER

The custom-scripting DLL calls RasFreeBuffer to release a memory buffer that was allocated by a previous call to RasGetBuffer.
PFNRASGETBUFFER

The custom-scripting DLL calls RasGetBuffer to allocate memory for sending or receiving data over the port connected to the server.
PFNRASRECEIVEBUFFER

The custom-scripting DLL calls the RasReceiveBuffer function to inform RAS that it is ready to receive data from the server over the specified port.
PFNRASRETRIEVEBUFFER

The custom-scripting DLL calls the RasRetrieveBuffer function to obtain data received from the RAS server over the specified port.
PFNRASSENDBUFFER

The custom-scripting DLL calls the RasSendBuffer function to send data to the server over the specified port.
PFNRASSETCOMMSETTINGS

Call RasSetCommSettings from a custom-scripting DLL to change the settings on the port for the connection.
RASADFUNCA

The RASADFunc function is an application-defined callback function that is used to provide a customized user interface for autodialing. (ANSI)
RASADFUNCW

The RASADFunc function is an application-defined callback function that is used to provide a customized user interface for autodialing. (Unicode)
RasCustomDeleteEntryNotifyFn

The RasCustomDeleteEntryNotify function is an application-defined function that is exported by a third-party custom-dialing DLL. This function allows third-party vendors to implement custom dialogs for managing phone-book entries.
RasCustomDialFn

The RasCustomDial function is an application-defined function that is exported by a third-party custom-dialing DLL. This function allows third-party vendors to implement custom remote-access dialing routines.
RasCustomHangUpFn

The RasCustomHangUp function is an application-defined function that is exported by a third-party custom-dialing DLL. This function allows third-party vendors to implement custom connection hang-up routines.
RasCustomScriptExecuteFn

RAS calls the RasCustomScriptExecute function when establishing a connection for a phone-book entry that has the RASEO_CustomScript option set.
RASDIALFUNC

The RasDialFunc callback function is called by the RasDial function when a change of state occurs during a RAS connection process.
RASDIALFUNC1

A RasDialFunc1 function is called by the RasDial function when a change of state occurs during a remote access connection process.
RASDIALFUNC2

A RasDialFunc2 callback function is called by the RasDial function calls when a change of state occurs during a remote access connection process.

Structures

 
RAS_PROJECTION_INFO

Contains the Point-to-Point (PPP) or Internet Key Exchange version 2 (IKEv2) projection information for a RAS connection.
RAS_STATS

The RAS_STATS structure stores the statistics for a single-link RAS connection, or for one of the links in a multilink RAS connection.
RASDEVSPECIFICINFO

Used to send a cookie for server validation and bypass point-to-point (PPP) authentication.
RASIKEV2_PROJECTION_INFO

Contains projection information obtained during Internet Key Exchange (IKE) negotiation.
RASNAPSTATE

The Network Access Protection (NAP) variables for a remote access connection.
RASPPP_PROJECTION_INFO

Contains information obtained during Point-to-Point (PPP) negotiation of Internet Protocol version 4 (IPv4) and IPv6 projection operations, and PPP Link Control Protocol (LCP)/multilink, and Compression Control Protocol (CCP) negotiation.

Enumerations

 
RASPROJECTION_INFO_TYPE

Is used in the RAS_PROJECTION_INFO structure to represent either a RASPPP_PROJECTION_INFO or RASIKEV2_PROJECTION_INFO structure.