RASDIALEXTENSIONS structure

The RASDIALEXTENSIONS structure contains information about extended features of the RasDial function. Enable one or more of these extensions by passing a pointer to a RASDIALEXTENSIONS structure when you call RasDial. If you do not pass a pointer to a RASDIALEXTENSIONS structure to RasDial, RasDial uses the default settings that are noted in the following descriptions.

Syntax


typedef struct _RADIALEXTENSIONS {
  DWORD              dwSize;
  DWORD              dwfOptions;
  HWND               hwndParent;
  ULONG_PTR          reserved;
  ULONG_PTR          reserved1;
  RASEAPINFO         RasEapInfo;
  BOOL               fSkipPppAuth;
  RASDEVSPECIFICINFO RasDevSpecificInfo;
} RASDIALEXTENSIONS, *PRASDIALEXTENSIONS;

Members

dwSize

Specifies the size of this structure, in bytes. Set this member to sizeof(RASDIALEXTENSIONS). This indicates the version of the structure.

dwfOptions

A set of bit flags that specify RasDial extensions. The following bit flags are defined; set all undefined bits to zero.

FlagsMeaning
RDEOPT_UsePrefixSuffixIf this flag is set, RasDial uses the prefix and suffix that is in the RAS phone book.

If this flag is not set, RasDial ignores the prefix and suffix that is in the RAS phone book.

If no phone book entry name is specified in the call to RasDial, the actual value of this flag is ignored, and it is assumed to be zero.

RDEOPT_PausedStatesIf this flag is set, RasDial accepts paused states. Examples of paused states are terminal mode, retry logon, change password, set callback number, and EAP authentication.

If this flag is not set, RasDial reports a fatal error if it enters a paused state.

RDEOPT_IgnoreModemSpeakerIf this flag is set, RasDial ignores the modem speaker setting that is in the RAS phone book, and uses the setting specified by the RDEOPT_SetModemSpeaker bit flag.

If this flag is not set, RasDial uses the modem speaker setting that is in the RAS phone book, and ignores the setting specified by the RDEOPT_SetModemSpeaker bit flag.

If no phone book entry name is specified in the call to RasDial, the choice is between using a default setting or the setting specified by the RDEOPT_SetModemSpeaker bit flag. The default setting is used if RDEOPT_IgnoreModemSpeaker is zero. The setting specified by RDEOPT_SetModemSpeaker is used if RDEOPT_IgnoreModemSpeaker is one.

RDEOPT_SetModemSpeakerIf this flag is set, and RDEOPT_IgnoreModemSpeaker is one, RasDial sets the modem speaker on.

If this flag is not set, and RDEOPT_IgnoreModemSpeaker is one, RasDial sets the modem speaker off.

If RDEOPT_IgnoreModemSpeaker is not set, RasDial ignores the value of RDEOPT_SetModemSpeaker, and sets the modem speaker based on the RAS phone-book setting or the default setting.

RDEOPT_IgnoreSoftwareCompressionIf this flag is set, RasDial ignores the software compression setting that is in the RAS phone book, and uses the setting specified by the RDEOPT_SetSoftwareCompression bit flag.

If this flag is not set, RasDial uses the software compression setting that is in the RAS phone book, and ignores the setting specified by the RDEOPT_SetSoftwareCompression flag.

If no phone-book entry name is specified in the call to RasDial, the choice is between using a default setting or the setting specified by the RDEOPT_SetSoftwareCompression bit flag. The default setting is used if RDEOPT_IgnoreSoftwareCompression is zero. The setting specified by RDEOPT_SetSoftwareCompression is used if RDEOPT_IgnoreSoftwareCompression is one.

RDEOPT_SetSoftwareCompressionIf this flag is set, and RDEOPT_IgnoreSoftwareCompression is one, RasDial uses software compression.

If this flag is not set, and RDEOPT_IgnoreSoftwareCompression is one, RasDial does not use software compression.

If RDEOPT_IgnoreSoftwareCompression is zero, RasDial ignores the value of RDEOPT_SetSoftwareCompression, and sets the software compression state based on the RAS phone-book setting or the default setting.

RDEOPT_UseCustomScriptingIf this flag is set, RasDial invokes a custom-scripting DLL after establishing the connection to the server.

RasDial only invokes the DLL if all of the following conditions are met:

  • This flag is set
  • A custom-scripting DLL is correctly registered with the system.
  • The RASEO_CustomScript option is specified in the phone-book entry.

See RAS Custom-Scripting for more information.

RDEOPT_CustomDialIf this flag is set, RasDial dials normally instead of calling the RasCustomDial entrypoint of the custom dialer. This flag is used when RasCustomDialDlg calls RasDial so that RasDial does not have to call the custom dialer back.
RDEOPT_NoUserWindows Vista or later: If this flag is set, the connection was dialed from a Windows Logon context. In this case, RasDial uses default user preferences for the connection. This flag must be set if RCD_Logon is set in the dwfOptions parameter of RasCustomDialDlg.

 

The default value for each of these flags is zero.

hwndParent

Handle to a parent window that a security DLL can use for dialog box creation and centering.

The default value for this member is NULL.

This member is optional; it is not required when no security DLL is defined.

Note  Note that this is not the window that receives RasDial progress notifications.

reserved

This member is reserved for future use. It must be set to zero.

reserved1

This member is reserved for future use. It must be set to zero.

RasEapInfo

A RASEAPINFO structure that contains user-specific Extensible Authentication Protocol (EAP) information.

fSkipPppAuth

Windows 7 or later: If this member is TRUE, then Point to Point Protocol (PPP) authentication is skipped and the value in RasDevSpecificInfo will be passed to the server for validation. Otherwise, this member is FALSE and PPP authentication proceeds normally.

RasDevSpecificInfo

Windows 7 or later: A RASDEVSPECIFICINFO structure that contains a cookie to be used for PPP authentication. This cookie is only valid if fSkipPppAuth is TRUE.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Ras.h

See also

Remote Access Service (RAS) Overview
Remote Access Service Structures
RasDial
RasInvokeEapUI

 

 

Community Additions

ADD
Show:
© 2014 Microsoft