RASSUBENTRY

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.

typedef struct tagRASSUBENTRY {
    DWORD      dwSize;
    DWORD      dwfFlags;
    //
    // Device
    //
    TCHAR      szDeviceType[ RAS_MaxDeviceType + 1 ];
    TCHAR      szDeviceName[ RAS_MaxDeviceName + 1 ];
    //
    // Phone numbers
    //
    TCHAR      szLocalPhoneNumber[ RAS_MaxPhoneNumber + 1 ];
    DWORD      dwAlternateOffset;
#if (WINVER >= 0x500)
    //
    // Port Name
    //
    TCHAR       szPortName[ RAS_MaxDeviceName + 1 ];
#endif
} 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. This member can be one of the following string constants.

String	Description
RASDT_Modem	A modem accessed through a COM port.
RASDT_Isdn	An ISDN card with the corresponding NDISWAN driver installed.
RASDT_X25	An X.25 card with the corresponding NDISWAN driver installed.
RASDT_Vpn	A virtual private network connection.
RASDT_Pad	A Packet Assembler/Disassembler

Windows 95: The RASDT_Vpn device type is supported on Windows 95 only if Microsoft Dial-Up Networking Version 1.2 is installed. The RASDT_X25 and RASDT_Pad device types are not supported on Windows 95.

Windows 98: The RASDT_Vpn device type is supported on Windows 98. However, the RASDT_X25 and RASDT_Pad device types are not currently supported on Windows 98

szDeviceName

Specifies a null-terminated string containing 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 containing a telephone number. The way RAS uses this string depends on whether the RASEO_UseCountryAndAreaCodes flag is set in the dwfOptions member of the RASENTRY structure for this phone-book entry. If the flag is set, RAS combines szLocalPhoneNumber with the country and area codes specified in the RASENTRY structure. If the flag is not set, RAS uses the szLocalPhoneNumber string as the entire phone number.

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.

szPortName

Specifies a null-terminated string containing the name of the port. The port name will depend on the RAS device type. For example, typical port names for a modem device would be "COM1" or "COM2.". For virtual private networks, the port name identifies the VPN connection.

QuickInfo

  Windows NT: Requires version 4.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in ras.h.
  Unicode: Defined as Unicode and ANSI structures.

RASSUBENTRY

Members

QuickInfo

See Also