Функция RasValidateEntryNameA (ras.h)

  • Статья

Функция RasValidateEntryName проверяет формат имени записи подключения. Имя должно содержать по крайней мере один буквенно-цифровой символ, отличный от пробела.

Синтаксис

DWORD RasValidateEntryNameA(
  [in] LPCSTR unnamedParam1,
  [in] LPCSTR unnamedParam2
);

Параметры

[in] unnamedParam1

Указатель на строку, завершающуюся null, которая указывает полный путь и имя файла телефонной книги (PBK). Если этот параметр имеет значение NULL, функция использует текущий файл телефонной книги по умолчанию.

Windows Me/98/95: Этот параметр всегда должен иметь значение NULL. Коммутируемая сеть сохраняет записи телефонной книги в реестре, а не в файле телефонной книги.

[in] unnamedParam2

Указатель на строку, завершающуюся значением NULL, которая указывает имя записи.

Следующие символы не допускаются в имени записи.

Знак Значение
|
 вертикальная полоса
>
 больше символа
<
 меньше символа
?
вопросительный знак
*
 звездочка
\
 косая черта назад
/
 косая черта
:
Толстой кишки
 

Windows 2000 или более поздней версии: Имя записи не может начинаться с точки (".").

Возвращаемое значение

Если функция завершается успешно, возвращаемое значение будет ERROR_SUCCESS.

Если функция завершается ошибкой, возвращается один из следующих кодов ошибок или значение из кода ошибок маршрутизации и удаленного доступа или Winerror.h.

Значение Значение
ERROR_ALREADY_EXISTS
 Имя записи уже существует в указанной телефонной книге.
ERROR_CANNOT_FIND_PHONEBOOK
 Указанная телефонная книга не существует.
ERROR_INVALID_NAME
 Недопустимый формат указанного имени записи.

Комментарии

В следующем примере кода проверяется запись телефонной книги, указанная переменной lpszEntry.

#include <windows.h>
#include <stdio.h>
#include "ras.h"
#include <tchar.h>

DWORD __cdecl wmain(){

    LPTSTR lpszEntry = L"EntryName\0";

    DWORD 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;
    }
}

Примечание

Заголовок ras.h определяет RasValidateEntryName в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

   
Минимальная версия клиента Windows 2000 Professional [только классические приложения]
Минимальная версия сервера Windows 2000 Server [только классические приложения]
Целевая платформа Windows
Header ras.h
Библиотека Rasapi32.lib
DLL Rasapi32.dll

См. также раздел

RasCreatePhonebookEntry

RasGetEntryProperties

Общие сведения о службе удаленного доступа (RAS)

Функции службы удаленного доступа