RasDeleteEntry

The RasDeleteEntry function deletes an entry from a phone book.

DWORD RasDeleteEntry(
  LPCTSTR lpszPhonebook,  // pointer to full path and filename of 
                          // phone-book file
  LPCTSTR lpszEntry       // pointer to an entry name to delete
);
 

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.

lpszEntry

Pointer to a null-terminated string containing the name of an existing entry to be deleted.

Return Values

If the function succeeds, the return value is zero.

If the function fails, the return value is ERROR_INVALID_NAME.

QuickInfo

  Windows NT: Requires version 4.0 or later.
  Windows: Requires Windows 95 OSR2 or later.
  Windows CE: Requires version 1.0 or later.
  Header: Declared in ras.h.
  Import Library: Use rasapi32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

See Also

Remote Access Service Overview, RAS Server Administration Functions, RasCreatePhonebookEntry, RasEnumEntries