Partager via


RasValidateEntryNameA, fonction (ras.h)

La fonction RasValidateEntryName valide le format d’un nom d’entrée de connexion. Le nom doit contenir au moins un caractère alphanumérique non blanc.

Syntaxe

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

Paramètres

[in] unnamedParam1

Pointeur vers une chaîne terminée par null qui spécifie le chemin d’accès complet et le nom de fichier d’un fichier PBK (Phone-Book). Si ce paramètre est NULL, la fonction utilise le fichier de livre téléphonique par défaut actuel.

Windows Me/98/95 : Ce paramètre doit toujours être NULL. La mise en réseau rendez-vous stocke les entrées de livres téléphoniques dans le Registre plutôt que dans un fichier de livres téléphoniques.

[in] unnamedParam2

Pointeur vers une chaîne terminée par null qui spécifie un nom d’entrée.

Les caractères suivants ne sont pas autorisés dans un nom d’entrée.

Personnage Signification
|
barre verticale
>
supérieur au symbole
<
inférieur au symbole
?
point d’interrogation
*
astérisque
\
barre oblique vers l’arrière
/
Barre oblique
:
côlon
 

Windows 2000 ou version ultérieure : Le nom d’entrée ne peut pas commencer par un point (« . »).

Valeur de retour

Si la fonction réussit, la valeur de retour est ERROR_SUCCESS.

Si la fonction échoue, la valeur de retour est l’un des codes d’erreur suivants ou une valeur de Codes d’erreur d’acheminement et d’accès à distance ou Winerror.h.

Valeur Signification
ERROR_ALREADY_EXISTS
Le nom d’entrée existe déjà dans le phonebook spécifié.
ERROR_CANNOT_FIND_PHONEBOOK
Le phonebook spécifié n’existe pas.
ERROR_INVALID_NAME
Le format du nom d’entrée spécifié n’est pas valide.

Remarques

L’exemple de code suivant valide l’entrée de livre téléphonique spécifiée par la variable 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;
    }
}

Note

L’en-tête ras.h définit RasValidateEntryName comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence Valeur
client minimum pris en charge Windows 2000 Professionnel [applications de bureau uniquement]
serveur minimum pris en charge Windows 2000 Server [applications de bureau uniquement]
plateforme cible Windows
d’en-tête ras.h
bibliothèque Rasapi32.lib
DLL Rasapi32.dll

Voir aussi

RasCreatePhonebookEntry

RasGetEntryProperties

Vue d’ensemble service d’accès à distance (RAS)

fonctions de service d’accès à distance