RASSUBENTRY structure

The RASSUBENTRY structure contains information about a subentry of a RAS phone-book entry. The RasSetSubEntryProperties and RasGetSubEntryProperties functions use this structure to set and retrieve the properties of a subentry.

Syntax

typedef struct tagRASSUBENTRY {
  DWORD dwSize;
  DWORD dwfFlags;
  TCHAR szDeviceType[RAS_MaxDeviceType + 1];
  TCHAR szDeviceName[RAS_MaxDeviceName + 1];
  TCHAR szLocalPhoneNumber[RAS_MaxPhoneNumber + 1];
  DWORD dwAlternateOffset;
} RASSUBENTRY;

Members

• dwSize
  Specifies the size, in bytes, of the RASSUBENTRY structure. Before calling RasSetSubEntryProperties or RasGetSubEntryProperties, set dwSize to sizeof(RASSUBENTRY) to identify the version of the structure.

• dwfFlags
  Currently unused. The RasSetSubEntryProperties function sets this member to zero. The RasGetSubEntryProperties function ignores this member.

• szDeviceType
  Specifies a null-terminated string indicating the RAS device type referenced by szDeviceName. See RASENTRY for a list of possible device types.

• szDeviceName
  Specifies a null-terminated string that contains the name of the TAPI device to use with this phone-book entry. To enumerate all available RAS-capable devices, use the RasEnumDevices function.

• szLocalPhoneNumber
  Specifies a null-terminated string that contains a telephone number. RAS uses the szLocalPhoneNumber string as the entire phone number; the number includes any required country/region or area codes. See Dialable Addresses for more information on the format of dialable phone numbers.

• dwAlternateOffset
  Specifies the offset, in bytes, from the beginning of the structure to a list of consecutive null-terminated strings. The last string is terminated by two consecutive null characters. The strings are alternate phone numbers that RAS dials in the order listed if the primary number (see szLocalPhoneNumber) fails to connect. The alternate phone number strings are ANSI or Unicode, depending on whether you use the ANSI or Unicode version of the structure.

Requirements

Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Ras.h
Unicode and ANSI names	RASSUBENTRYW (Unicode) and RASSUBENTRYA (ANSI)

See also

Remote Access Service (RAS) Overview

Remote Access Service Structures

Dialable Addresses

RasGetSubEntryProperties

RasSetSubEntryProperties