RasRenameEntryA 関数 (ras.h)
RasRenameEntry 関数は、電話帳のエントリの名前を変更します。
構文
DWORD RasRenameEntryA(
[in] LPCSTR unnamedParam1,
[in] LPCSTR unnamedParam2,
[in] LPCSTR unnamedParam3
);
パラメーター
[in] unnamedParam1
電話帳 (PBK) ファイルの完全なパスとファイル名を指定する null で終わる文字列へのポインター。 このパラメーターが NULL の場合、関数は現在の既定の電話帳ファイルを使用します。 既定の電話帳ファイルは、[ダイヤルアップ ネットワーク] ダイアログ ボックスの [ユーザー設定] プロパティ シートでユーザーが選択したファイルです。
Windows Me/98/95: このパラメーターは常に NULL である必要があります。 ダイヤルアップ ネットワークでは、電話帳ファイルではなく、レジストリに電話帳エントリが格納されます。
[in] unnamedParam2
既存のエントリ名を指定する null で終わる文字列へのポインター。
[in] unnamedParam3
新しいエントリ名を指定する null で終わる文字列へのポインター。 RasRenameEntry を呼び出す前に、RasValidateEntryName 関数を呼び出して新しいエントリ名を検証します。
戻り値
関数が成功した場合、戻り値は ERROR_SUCCESS。
関数が失敗した場合、戻り値は次のいずれかのエラー コードか、 ルーティングおよびリモート アクセス エラー コード または Winerror.h からの値です。
値 | 意味 |
---|---|
|
関数は、操作を完了するのに十分なメモリを割り当てませんでした。 |
|
lpszNewEntry 名が無効です。 |
|
lpszNewEntry 名のエントリは既に存在します。 |
|
電話帳エントリが存在しません。 |
注釈
RasRenameEntry 関数を使用すると、ダイヤルアップ ネットワーク ユーザー インターフェイスで受け入れられないエントリ名を使用できます。 RasRenameEntry で指定されたエントリ名は、次の条件に従う任意の文字列で構成できます。
- 文字列の長さがRAS_MaxEntryNameを超えることはできません (Ras.h で定義されています)。
- 文字列は、スペースまたはタブ文字で完全に構成することはできません。
- 文字列の最初の文字をピリオド文字 (".") にすることはできません。
#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 バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | ras.h |
Library | Rasapi32.lib |
[DLL] | Rasapi32.dll |
こちらもご覧ください
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示