PFNRASSETCOMMSETTINGS callback function (ras.h)

Article
10/13/2021

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

Syntax

PFNRASSETCOMMSETTINGS Pfnrassetcommsettings;

DWORD Pfnrassetcommsettings(
  [in] HANDLE hPort,
  [in] tagRASCOMMSETTINGS *pRasCommSettings,
  [in] PVOID pvReserved
)
{...}

Parameters

[in] hPort

Handle to the port on which to apply the settings. This handle is passed to the custom-scripting DLL in the RasCustomScriptExecute function.

[in] pRasCommSettings

Pointer to a RASCOMMSETTINGS structure that specifies the settings to be applied to the port.

[in] pvReserved

Reserved for future use. This parameter must be NULL.

Return value

This callback function does not return a value.

Remarks

RAS passes the custom-scripting DLL a pointer to the RasSetCommSettings function when RAS calls RasCustomScriptExecute. The pointer is stored in the RASCUSTOMSCRIPTEXTENSIONS structure that is passed as the last parameter of RasCustomScriptExecute.

Requirements

Requirement	Value
Minimum supported client	Windows XP, Windows 2000 Professional with SP2 [desktop apps only]
Minimum supported server	Windows Server 2003, Windows 2000 Server with SP2 [desktop apps only]
Target Platform	Windows
Header	ras.h