RasRenameEntryA, fonction (ras.h)

Article
11/20/2024

La fonction RasRenameEntry modifie le nom d’une entrée dans un livre téléphonique.

Syntaxe

DWORD RasRenameEntryA(
  [in] LPCSTR unnamedParam1,
  [in] LPCSTR unnamedParam2,
  [in] LPCSTR unnamedParam3
);

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. Le fichier de carnet téléphonique par défaut est celui sélectionné par l’utilisateur dans la feuille de propriétés Préférences utilisateur de la boîte de dialogue Mise en réseau rendez-vous.

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 existant.

[in] unnamedParam3

Pointeur vers une chaîne terminée par null qui spécifie le nouveau nom d’entrée. Avant d’appeler RasRenameEntry, appelez la fonction RasValidateEntryName pour valider le nouveau nom d’entrée.

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_NOT_ENOUGH_MEMORY	La fonction n’a pas pu allouer suffisamment de mémoire pour terminer l’opération.
ERROR_INVALID_NAME	Le nom lpszNewEntry n’est pas valide.
ERROR_ALREADY_EXISTS	Une entrée avec le nom lpszNewEntry existe déjà.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	L’entrée par téléphone n’existe pas.

Remarques

La fonction RasRenameEntry autorise les noms d’entrée qui ne seraient pas acceptés par l’interface utilisateur de mise en réseau rendez-vous. Les noms d’entrée spécifiés dans RasRenameEntry peuvent être constitués de n’importe quelle chaîne conforme aux conditions suivantes :

La chaîne ne peut pas avoir une longueur supérieure à RAS_MaxEntryName (telle que définie dans Ras.h).
La chaîne ne peut pas se composer entièrement d’espace ou de caractères de tabulation.
Le premier caractère de la chaîne ne peut pas être un caractère de point (« . »).

L’exemple de code suivant renomme l’entrée de livre téléphonique avec le nom spécifié par pszOldName au nouveau nom spécifié par pszNewName.

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

DWORD main (){

    DWORD dwErr = ERROR_SUCCESS;
    LPCTSTR pszOldName = L"RAS Connection 1\0";
    LPCTSTR pszNewName = L"RAS Connection 2\0";

    dwErr = RasValidateEntryName(NULL, pszNewName);
    if (ERROR_SUCCESS != dwErr)
    {
        printf("RasValidateEntryName failed: Error = %d\n", dwErr);
        return dwErr;
    }

    dwErr = RasRenameEntry(NULL, pszOldName, pszNewName);
    if (ERROR_SUCCESS != dwErr)
    {
        printf("RasRenameEntry failed: Error = %d\n", dwErr);
        return dwErr;
    }

    printf("Successfully renamed entry '%s' to '%s'\n", pszOldName, pszNewName);

    return 0;
}

Note

L’en-tête ras.h définit RasRenameEntry 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

RasValidateEntryName

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

fonctions de service d’accès à distance

Partager via