通过

RasRenameEntryA 函数 （ras.h）

  • 项目

RasRenameEntry 函数更改电话簿中条目的名称。

语法

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

参数

[in] unnamedParam1

指向以 null 结尾的字符串的指针，该字符串指定电话簿 （PBK） 文件的完整路径和文件名。 如果此参数 NULL，则该函数使用当前的默认电话簿文件。 默认电话簿文件是用户在 用户首选项拨号网络 对话框中选择的文件。

Windows Me/98/95：此参数应始终 NULL。 拨号网络将电话簿条目存储在注册表中，而不是存储在电话簿文件中。

[in] unnamedParam2

指向指定现有条目名称的以 null 结尾的字符串的指针。

[in] unnamedParam3

指向指定新条目名称的以 null 结尾的字符串的指针。 在调用 RasRenameEntry之前，请调用 RasValidateEntryName 函数来验证新条目名称。

返回值

如果函数成功，则返回值 ERROR_SUCCESS。

如果函数失败，则返回值是以下错误代码之一或来自 路由和远程访问错误代码 或 Winerror.h 的值。

价值 意义
ERROR_NOT_ENOUGH_MEMORY
 该函数无法分配足够的内存来完成操作。
ERROR_INVALID_NAME
 lpszNewEntry 名称无效。
ERROR_ALREADY_EXISTS
 lpszNewEntry 名称的条目已存在。
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY
 电话簿条目不存在。

言论

RasRenameEntry 函数允许拨号网络用户界面不接受的条目名称。 RasRenameEntry 中指定的条目名称 可以包含符合以下条件的任何字符串：

  1. 字符串的长度不能大于 RAS_MaxEntryName（如 Ras.h 中定义）。
  2. 字符串不能完全包含空格或制表符。
  3. 字符串中的第一个字符不能是句点字符（“.）。
下面的代码示例将名为 pszOldName 指定的电话簿条目重命名为由 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;
}

注意

ras.h 标头将 RasRenameEntry 定义为一个别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。 有关详细信息，请参阅函数原型的 约定。

要求

要求 价值
最低支持的客户端 Windows 2000 Professional [仅限桌面应用]
支持的最低服务器 Windows 2000 Server [仅限桌面应用]
目标平台 窗户
标头 ras.h
库 Rasapi32.lib
DLL Rasapi32.dll

另请参阅

RasValidateEntryName

远程访问服务（RAS）概述

远程访问服务函数