Win32 API 日本語リファレンス
ホーム › Networking.Clustering › PRESUTIL_ADD_UNKNOWN_PROPERTIES

PRESUTIL_ADD_UNKNOWN_PROPERTIES

コールバック

シグネチャ

DWORD PRESUTIL_ADD_UNKNOWN_PROPERTIES(
    HKEY hkeyClusterKey,
    RESUTIL_PROPERTY_ITEM* pPropertyTable,
    void* pOutPropertyList,
    DWORD pcbOutPropertyListSize,
    DWORD* pcbBytesReturned,
    DWORD* pcbRequired
);

パラメーター

フィールド型説明
hkeyClusterKeyHKEY読み取るプロパティの場所を示すクラスターデータベースキーへのポインターです。
pPropertyTableRESUTIL_PROPERTY_ITEM*オブジェクトの共通プロパティおよびプライベートプロパティを記述したプロパティテーブルへのポインターです。クラスターデータベース内に存在し、このプロパティテーブルには存在しないプロパティが、プロパティリストに追加されます。
pOutPropertyListvoid*取得したプロパティを受け取るバッファーへのポインターです。入力時、このバッファーには既存のプロパティリストが格納されていてもよく、空でもかまいません。出力時には、取得されたプロパティが既存のリストの末尾に追加されます。バッファーが空の場合は、新しいプロパティリストとして返されます。
pcbOutPropertyListSizeDWORDpOutPropertyList が指すバッファーの総バイトサイズです。バッファーのサイズは、既存のプロパティリストと返されるプロパティリストの両方を格納できる大きさである必要があります。
pcbBytesReturnedDWORD*入力時は、pOutPropertyList バッファーに格納されているプロパティリストのバイトサイズへのポインターです。出力時は、pOutPropertyList が指すプロパティリストの総バイト数へのポインターです。
pcbRequiredDWORD*出力時に、返されるプロパティリストを格納するために必要な総バイト数を指します。pOutPropertyList バッファーが小さすぎた場合は、必要なサイズで再割り当てできます。

公式ドキュメント

クラスターデータベースから未知のプロパティの集合を取得し、プロパティリストの末尾に追加します。

戻り値

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

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

戻り値 説明
ERROR_NOT_ENOUGH_MEMORY
 メモリの割り当て中にエラーが発生しました。

解説(Remarks)

ResUtilAddUnknownProperties の入力パラメーターと出力パラメーターの関係を次の図に示します。

:::image type="content" source="./images/resutil.png" border="false" alt-text="Diagram showing input and output parameters listed separately in two buffers. Two unknown properties have been added to the output parameter list.":::

ユーティリティ関数 ResUtilAddUnknownProperties は、クラスターデータベース(hkeyClusterKey の配下)に格納されているプロパティを列挙し、プロパティテーブル(pPropertyTable)内で対応するプロパティを探します。クラスターデータベースには記載されているがプロパティテーブルには記載されていないプロパティが、プロパティリスト(pOutPropertyList)に追加されます。

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