RasRenameEntry
[New
- Windows NT]
The RasRenameEntry
function changes the name of an entry in a phone book.
DWORD RasRenameEntry(
|
LPTSTR lpszPhonebook, |
// pointer to full
path and filename of phone-book file |
|
LPTSTR lpszOldEntry, |
// pointer to the
old entry name |
|
LPTSTR lpszNewEntry |
// pointer to the
new entry name |
|
); |
|
Parameters
lpszPhonebook
Windows
NT: Pointer to a null-terminated
string that specifies the full path and filename 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.
lpszOldEntry
Pointer to a
null-terminated string containing an existing entry name.
lpszNewEntry
Pointer to a
null-terminated string containing the new entry name. Before calling RasRenameEntry,
call the RasValidateEntryName
function to validate the new entry name.
Return Values
If the
function succeeds, the return value is zero.
If the
function fails, the return value is one of the following error codes.
|
Value |
Meaning |
|
ERROR_INVALID_NAME |
The lpszNewEntry
name is invalid. |
|
ERROR_ALREADY_EXISTS |
An entry
with the lpszNewEntry name already exists. |
|
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY |
The
phone-book entry does not exist. |
See Also