Compartilhar via


Função RasValidateEntryNameA (ras.h)

A função RasValidateEntryName valida o formato de um nome de entrada de conexão. O nome deve conter pelo menos um caractere alfanumérico que não seja de espaço em branco.

Sintaxe

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

Parâmetros

[in] unnamedParam1

Um ponteiro para uma cadeia de caracteres terminada em nulo que especifica o caminho completo e o nome do arquivo de um PBK (lista telefônica). Se esse parâmetro for NULL, a função usará o arquivo de agendamento telefônico padrão atual.

Windows Me/98/95: Esse parâmetro sempre deve ser NULL. A rede discada armazena entradas de agendamento telefônico no registro, em vez de em um arquivo de agendamento telefônico.

[in] unnamedParam2

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica um nome de entrada.

Os caracteres a seguir não são permitidos em um nome de entrada.

Personagem Significado
|
barra vertical
>
maior que o símbolo
<
menor que o símbolo
?
ponto de interrogação
*
asterisco
\
barra retrógrada
/
barra
:
cólon
 

Windows 2000 ou posterior: O nome da entrada não pode começar com um período (".").

Valor de retorno

Se a função for bem-sucedida, o valor retornado será ERROR_SUCCESS.

Se a função falhar, o valor retornado será um dos seguintes códigos de erro ou um valor de códigos de erro de roteamento e acesso remoto ou Winerror.h.

Valor Significado
ERROR_ALREADY_EXISTS
O nome da entrada já existe na pasta telefônica especificada.
ERROR_CANNOT_FIND_PHONEBOOK
A pasta telefônica especificada não existe.
ERROR_INVALID_NAME
O formato do nome de entrada especificado é inválido.

Observações

O código de exemplo a seguir valida a entrada do catálogo telefônico especificada pela variável 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;
    }
}

Nota

O cabeçalho ras.h define RasValidateEntryName como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito Valor
de cliente com suporte mínimo Windows 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino Windows
cabeçalho ras.h
biblioteca Rasapi32.lib
de DLL Rasapi32.dll

Consulte também

RasCreatePhonebookEntry

RasGetEntryProperties

Visão geral do RAS (Serviço de Acesso Remoto)

Funções do Serviço de Acesso Remoto