Partager via

RASENTRYDLG structure

  • Article

The RASENTRYDLG structure is used in the RasEntryDlg function to specify additional input and output parameters.

Syntax

typedef struct tagRASENTRYDLG {
  IN  DWORD     dwSize;
  IN  HWND      hwndOwner;
  IN  DWORD     dwFlags;
  IN  LONG      xDlg;
  IN  LONG      yDlg;
  OUT TCHAR     szEntry[RAS_MaxEntryName + 1];
  OUT DWORD     dwError;
  IN  ULONG_PTR reserved;
  IN  ULONG_PRT reserved2;
} RASENTRYDLG;

Members

  • dwSize
    Specifies the size of this structure, in bytes. Before calling RasEntryDlg, set this member to sizeof(RASENTRYDLG) to indicate the version of the structure. If dwSize is not a valid size, RasEntryDlg fails and sets the dwError member to ERROR_INVALID_SIZE.

  • hwndOwner
    Specifies the window that owns the modal RasEntryDlg dialog box. This member can be any valid window handle, or it can be NULL if the dialog box has no owner.

  • dwFlags
    A set of bit flags that indicate the options enabled for the dialog box. This parameter can be a combination of the RASEDFLAG_PositionDlg flag and one of the other flags listed following to indicate whether the RasEntryDlg function is creating, copying, or editing a phone-book entry.

    Value Meaning
    RASEDFLAG_PositionDlg

    Causes RasEntryDlg to use the values specified by the xDlg and yDlg members to position the dialog box. If this flag is not set, the dialog box is centered on the owner window, unless hwndOwner is NULL, in which case, the dialog box is centered on the screen.
    RASEDFLAG_NewEntry

    Causes RasEntryDlg to display a wizard for creating a new phone-book entry.
    RASEDFLAG_CloneEntry

    Causes RasEntryDlg to create a new entry by copying the properties of an existing entry. The function displays a property sheet containing the properties associated with the phone-book entry specified by the lpszEntry parameter of RasEntryDlg. The user can edit the properties and specify a name for the new entry.

    Windows Vista or later:  This flag is not supported.
    RASEDFLAG_NoRename

    Causes RasEntryDlg to display a property sheet for editing the properties of the phone-book entry specified by the lpszEntry parameter of RasEntryDlg. The user can change the properties of the entry but not its name.
    RASEDFLAG_ShellOwned

    Windows XP/2000:  Reserved. Do not use.
    RASEDFLAG_NewPhoneEntry

    Windows XP/2000:  Similar to RASEDFLAG_NewEntry. However, this flag causes the wizard to go directly to the page for a new phone-line entry.
    RASEDFLAG_NewTunnelEntry

    Windows XP/2000:  Similar to RASEDFLAG_NewEntry. However, this flag causes the wizard to go directly to the page for a new tunnel entry.
    RASEDFLAG_NewDirectEntry

    Windows XP/2000:  Similar to RASEDFLAG_NewEntry. However, this flag causes the wizard to go directly to the page for a new direct-connection entry.

    Windows Vista or later:  This flag is not supported.
    RASEDFLAG_NewBroadbandEntry

    Windows XP:  Causes RasEntryDlg to display a wizard that creates a new broadband phonebook entry.
    RASEDFLAG_IncomingConnection

    Windows Vista or later:  When this flag is set, the RasEntryDlg function displays a wizard that allows a user to enable and configure incoming connections, thus allowing other computers to connect to the computer through the internet or phone line.

     

  • xDlg
    Specifies the horizontal screen coordinate of the upper-left corner of the dialog box. This value is used only if the RASEDFLAG_PositionDlg flag is set.

  • yDlg
    Specifies the vertical screen coordinate of the upper-left corner of the dialog box. This value is used only if the RASEDFLAG_PositionDlg flag is set.

  • szEntry
    On exit, szEntry is set to the name of the phone-book entry that was edited or created.

  • dwError
    The RasEntryDlg function sets this member to a system error code or RAS error code if an error occurs. If no error occurs, the function sets dwError to zero. This value is ignored on input.

  • reserved
    Reserved; must be zero.

  • reserved2
    Reserved; must be zero.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

 Rasdlg.h

Unicode and ANSI names

RASENTRYDLGW (Unicode) and RASENTRYDLGA (ANSI)

See also

Remote Access Service (RAS) Overview

Remote Access Service Structures

RasEntryDlg