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

Статья
11/20/2024

Функция 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 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	ras.h
библиотеки	Rasapi32.lib
DLL	Rasapi32.dll

См. также

RasCreatePhonebookEntry

RasGetEntryProperties

Обзор службы удаленного доступа (RAS)

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

Поделиться через