RasDeleteEntry

The RasDeleteEntry function deletes an entry from a phone book.

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

Parameters

lpszPhonebook

Windows NT/2000: 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.

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 ERROR_SUCCESS.

If the function fails, the return value is ERROR_INVALID_NAME.

Remarks

The following sample code deletes the phone-book entry specified by the variable lpszEntry.

nRet = RasDeleteEntry(NULL, lpszEntry);
if (nRet != ERROR_SUCCESS)
{
    printf("RasDeleteEntry failed: Error = %d\n", nRet);
}
else
{
    printf("Entry %s deleted successfully\n", lpszEntry);
}

Requirements

  Windows NT/2000: Requires Windows NT 4.0 or later.
  Windows 95/98: Requires Windows 95 OSR2 or later.
  Header: Declared in Ras.h.
  Library: Use Rasapi32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000.

See Also

Remote Access Service (RAS) Overview, Remote Access Service Functions, RasCreatePhonebookEntry, RasEnumEntries