ホーム › Networking.Clustering › PRESUTIL_SET_EXPAND_SZ_VALUE

PRESUTIL_SET_EXPAND_SZ_VALUE

コールバック

シグネチャ

DWORD PRESUTIL_SET_EXPAND_SZ_VALUE(
    HKEY hkeyClusterKey,
    LPWSTR pszValueName,
    LPWSTR pszNewValue,
    LPWSTR* ppszOutString
);

パラメーター

フィールド	型	説明
hkeyClusterKey	HKEY	クラスターデータベース内で展開可能な文字列値が格納されている場所を示すキーです。
pszValueName	LPWSTR	更新する値の名前を格納した、null で終わる Unicode 文字列です。
pszNewValue	LPWSTR	新しい展開可能な文字列値へのポインターです。
ppszOutString	LPWSTR*	更新後の値のコピーを受け取る文字列ポインターへのポインターです。使用する場合、呼び出し元は *ppszOutValue に対して LocalFree を呼び出す必要があります。

公式ドキュメント

クラスターデータベースに展開可能な文字列値を設定します。PRESUTIL_SET_EXPAND_SZ_VALUE 型は、この関数へのポインターを定義します。

戻り値

処理に成功した場合、この関数は ERROR_SUCCESS を返します。

処理に失敗した場合、この関数はシステムエラーコードを返します。返される可能性のあるエラーコードは次のとおりです。

戻り値	説明
ERROR_NOT_ENOUGH_MEMORY	メモリを割り当てようとしたときにエラーが発生しました。

解説(Remarks)

ResUtilSetExpandSzValue ユーティリティ関数は、新しい値のためにメモリを割り当て、Cluster API の関数 ClusterRegSetValue を呼び出します。

展開可能な文字列値は、"%SystemRoot%" のような未展開の環境変数参照を含む、null で終わる Unicode 文字列を表すデータを格納します。

メモリリークを避けるため、*ppszOutValue に対して必ず LocalFree を呼び出してください。

次のリソース DLL のエントリポイント関数からは、ResUtilSetExpandSzValue を呼び出さないでください。

ResUtilSetExpandSzValue は、これら以外のリソース DLL のエントリポイント関数やワーカースレッドからであれば、安全に呼び出せます。詳細については、Function Calls to Avoid in Resource DLLs を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)