Fonction RasRenameEntryA (ras.h)

Article
03/01/2024

La fonction RasRenameEntry modifie le nom d’une entrée dans un annuaire 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 d’annuaire téléphonique (PBK). Si ce paramètre a la valeur NULL, la fonction utilise le fichier d’annuaire téléphonique par défaut actuel. Le fichier d’annuaire 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 Accès réseau à distance.

Windows Me/98/95 : Ce paramètre doit toujours avoir la valeur NULL. La mise en réseau à distance stocke les entrées d’annuaire téléphonique dans le registre plutôt que dans un fichier d’annuaire téléphonique.

[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 retournée

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 provenant des codes d’erreur de routage et d’accès à distance ou de 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 portant le nom lpszNewEntry existe déjà.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	L’entrée de l’annuaire téléphonique n’existe pas.

Remarques

La fonction RasRenameEntry autorise les noms d’entrée qui ne seraient pas acceptés par l’interface utilisateur réseau à distance. Les noms d’entrée spécifiés dans RasRenameEntry peuvent se composer de n’importe quelle chaîne qui respecte les conditions suivantes :

La chaîne ne peut pas avoir une longueur supérieure à RAS_MaxEntryName (comme défini 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 l’annuaire téléphonique avec le nom spécifié par pszOldName en 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;
}

Notes

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

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	ras.h
Bibliothèque	Rasapi32.lib
DLL	Rasapi32.dll

Voir aussi

RasValidateEntryName

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

Fonctions du service d’accès à distance

Partager via