RasValidateEntryName

The RasValidateEntryName function validates the format of a connection entry name. The name must contain at least one non-white-space alphanumeric character.

DWORD RasValidateEntryName(
  LPCTSTR lpszPhonebook,  // pointer to full path and file name of 
                          //  phone-book file
  LPCTSTR lpszEntry       // pointer to the entry name to validate
);

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 an entry name.

Windows NT/2000: The entry name cannot begin with a period (".").

Return Values

If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the return value is ERROR_INVALID_NAME or ERROR_ALREADY_EXISTS.

Remarks

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

nRet = RasValidateEntryName(NULL, lpszEntry);
switch (nRet)
{
    case ERROR_SUCCESS:
        printf("Entry name: %s is valid but doesn't exist in the default phone book\n", lpszEntry);
        break;
    case ERROR_INVALID_NAME:
        printf("Entry name: %s is invalid\n", lpszEntry);
        break;
    case ERROR_ALREADY_EXISTS:
        printf("Entry name: %s already exists in the default phone book\n", lpszEntry);
        break;
    default:
        printf("RasValidateEntryName failed: Error = %d\n", nRet);
        break;
}

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, RasGetEntryProperties