Función RasRenameEntryA (ras.h)

La función RasRenameEntry cambia el nombre de una entrada en una libreta de teléfonos.

Sintaxis

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

Parámetros

[in] unnamedParam1

Puntero a una cadena terminada en null que especifica la ruta de acceso completa y el nombre de archivo de un archivo de libreta de teléfonos (PBK). Si este parámetro es NULL, la función usa el archivo de libreta de teléfonos predeterminado actual. El archivo de libreta telefónica predeterminado es el seleccionado por el usuario en la hoja de propiedades Preferencias de usuario del cuadro de diálogo Redes de acceso telefónico .

Windows Me/98/95: Este parámetro siempre debe ser NULL. Las redes de acceso telefónico almacenan entradas de libreta de teléfonos en el Registro en lugar de en un archivo de libreta de teléfonos.

[in] unnamedParam2

Puntero a una cadena terminada en null que especifica un nombre de entrada existente.

[in] unnamedParam3

Puntero a una cadena terminada en null que especifica el nuevo nombre de entrada. Antes de llamar a RasRenameEntry, llame a la función RasValidateEntryName para validar el nuevo nombre de entrada.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es ERROR_SUCCESS.

Si se produce un error en la función, el valor devuelto es uno de los siguientes códigos de error o un valor de Enrutamiento y códigos de error de acceso remoto o Winerror.h.

Valor	Significado
ERROR_NOT_ENOUGH_MEMORY	La función no pudo asignar memoria suficiente para completar la operación.
ERROR_INVALID_NAME	El nombre lpszNewEntry no es válido.
ERROR_ALREADY_EXISTS	Ya existe una entrada con el nombre lpszNewEntry .
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	La entrada de la libreta de teléfonos no existe.

Comentarios

La función RasRenameEntry permite los nombres de entrada que la interfaz de usuario de red de acceso telefónico no aceptaría. Los nombres de entrada especificados en RasRenameEntry pueden constar de cualquier cadena que cumpla las condiciones siguientes:

1. La cadena no puede tener una longitud mayor que RAS_MaxEntryName (como se define en Ras.h).
2. La cadena no puede constar completamente de caracteres de espacio o tabulación.
3. El primer carácter de la cadena no puede ser un carácter de punto (".").

En el ejemplo de código siguiente se cambia el nombre de la entrada de la libreta de teléfonos con el nombre especificado por pszOldName al nuevo nombre especificado por 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;
}

Nota

El encabezado ras.h define RasRenameEntry como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	ras.h
Library	Rasapi32.lib
Archivo DLL	Rasapi32.dll

Consulte también

RasValidateEntryName

Información general sobre el servicio de acceso remoto (RAS)

Funciones del Servicio de acceso remoto