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 的值。

備註

RasRenameEntry 函式允許撥號網路使用者介面不接受的項目名稱。 RasRenameEntry 中指定的項目名稱可以包含符合下列條件的任何字串：

1. 字串的長度不能超過 Ras.h) 中所定義的RAS_MaxEntryName (。
2. 字串不能完全包含空格或製表符。
3. 字串中的第一個字元不能是句號字元 (“。”) 。

#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;
}

規格需求

另請參閱

RasValidateEntryName

遠端訪問服務 (RAS) 概觀

遠端存取服務函式