Windows Dev Center

RasSetSubEntryProperties function

The RasSetSubEntryProperties function creates a new subentry or modifies an existing subentry of a specified phone-book entry.

Syntax


DWORD RasSetSubEntryProperties(
  _In_ LPCTSTR       lpszPhonebook,
  _In_ LPCTSTR       lpszEntry,
  _In_ DWORD         dwSubEntry,
  _In_ LPRASSUBENTRY lpRasSubEntry,
  _In_ DWORD         dwcbRasSubEntry,
  _In_ LPBYTE        lpbDeviceConfig,
  _In_ DWORD         dwcbDeviceConfig
);

Parameters

lpszPhonebook [in]

Pointer to a null-terminated string that specifies the full path and file name of a phone-book (PBK) file. If this parameter is NULL, the function uses the current default phone-book file. The default phone-book file is the one selected by the user in the User Preferences property sheet of the Dial-Up Networking dialog box.

Windows Me/98/95:  This parameter should always be NULL. Dial-up networking stores phone-book entries in the registry rather than in a phone-book file.

lpszEntry [in]

Pointer to a null-terminated string that specifies the name of an existing entry in the phone book.

dwSubEntry [in]

Specifies the one-based index of the subentry. If the index matches an existing subentry index, the function changes the properties of that subentry. If the index does not match an existing index, the function creates a new subentry.

lpRasSubEntry [in]

Pointer to the RASSUBENTRY structure that specifies the data for the subentry.

The structure might be followed by an array of null-terminated alternate phone number strings. The last string is terminated by two consecutive null characters. The dwAlternateOffset member of the RASSUBENTRY structure contains the offset to the first string.

dwcbRasSubEntry [in]

Specifies the size, in bytes, of the lpRasSubEntry buffer.

lpbDeviceConfig [in]

Pointer to a TAPI device configuration block. This parameter is currently unused. The caller should pass NULL for this parameter. For more information about TAPI device configuration blocks, see the function lineGetDevConfig.

dwcbDeviceConfig [in]

Specifies the size of the TAPI device configuration block. This parameter is currently unused. The caller should pass zero for this parameter.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the return value is one of the following error codes or a value from Routing and Remote Access Error Codes or Winerror.h.

ValueMeaning
ERROR_BUFFER_INVALID

The address or buffer specified by lpRasEntry is invalid.

ERROR_CANNOT_FIND_PHONEBOOK_ENTRY

The phone-book entry does not exist.

ERROR_CANNOT_OPEN_PHONEBOOK

The phone book is corrupted or missing components.

ERROR_INVALID_PARAMETER

The function was called with an invalid parameter.

 

Remarks

A RAS phone-book entry can have zero or more subentries, each minimally consisting of a device and a phone number. A phone-book entry with multiple subentries can be configured to dial either the first available subentry or all subentries when the entry is dialed.

Use the RasGetEntryProperties function to retrieve the RASENTRY structure containing information about the subentries of a phone-book entry. The dwSubEntries member indicates the number of subentries and the dwDialMode member indicates the dialing configuration.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Ras.h

Library

Rasapi32.lib

DLL

Rasapi32.dll

Unicode and ANSI names

RasSetSubEntryPropertiesW (Unicode) and RasSetSubEntryPropertiesA (ANSI)

See also

Remote Access Service (RAS) Overview
Remote Access Service Functions
RasGetEntryProperties
RASENTRY
RASSUBENTRY

 

 

Community Additions

ADD
Show:
© 2015 Microsoft