RasEditPhonebookEntryA function (ras.h)

Article
02/22/2024

[This function has been deprecated as of Windows Vista and its functionality has been replaced by RasEntryDlg.]

The RasEditPhonebookEntry function edits an existing phone-book entry. The function displays a dialog box in which the user can modify the existing information.

Syntax

DWORD RasEditPhonebookEntryA(
  [in] HWND   unnamedParam1,
  [in] LPCSTR unnamedParam2,
  [in] LPCSTR unnamedParam3
);

Parameters

[in] unnamedParam1

Handle to the parent window of the dialog box.

[in] unnamedParam2

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.

[in] unnamedParam3

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

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.

Return code	Description
ERROR_BUFFER_INVALID	The phone-book entry buffer is invalid.
ERROR_CANNOT_OPEN_PHONEBOOK	The phone book is corrupted or missing components.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	The phone-book entry does not exist.

Remarks

When calling RasEntryDlg, set each member of the RASENTRYDLG structure passed to lpinfo to zero except:

dwSize = sizeof(RASENTRYDLG)
hwndOwner = the hwnd parameter above

Note

The ras.h header defines RasEditPhonebookEntry as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	ras.h
Library	Rasapi32.lib
DLL	Rasapi32.dll