ホーム › Networking.Clustering › ResUtilSetUnknownProperties

ResUtilSetUnknownProperties

関数

未知のプロパティをクラスタキーに設定する。

DLLRESUTILS.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

// RESUTILS.dll
#include <windows.h>

DWORD ResUtilSetUnknownProperties(
    HKEY hkeyClusterKey,
    const RESUTIL_PROPERTY_ITEM* pPropertyTable,
    const void* pInPropertyList,
    DWORD cbInPropertyListSize
);

パラメーター

名前	型	方向	説明
hkeyClusterKey	HKEY	in	設定するプロパティの格納場所を示すクラスターデータベースキー。
pPropertyTable	RESUTIL_PROPERTY_ITEM*	in	この関数で設定してはならないプロパティを指定するプロパティテーブルへのポインター。
pInPropertyList	void*	in	プロパティリストへのポインター。このリストに含まれ、かつ pInPropertyList に含まれないプロパティが設定されます。
cbInPropertyListSize	DWORD	in	pInPropertyList が指す入力バッファーのサイズ (バイト単位) へのポインター。

戻り値の型: DWORD

公式ドキュメント

クラスターオブジェクトの未知のプロパティ (unknown properties) をクラスターデータベースに格納します。

戻り値

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

操作が失敗した場合、この関数はシステムエラーコードを返します。

解説(Remarks)

ResUtilSetUnknownProperties は、pInPropertyList に列挙されているプロパティのうち、pPropertyTable に列挙されていないものだけを設定します。

プロパティリストの作成には ResUtilAddUnknownProperties を、未知のプロパティの取得には ResUtilGetAllProperties を使用してください。

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

ResUtilSetUnknownProperties は、それ以外のリソース 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)

各言語での呼び出し定義

// RESUTILS.dll
#include <windows.h>

DWORD ResUtilSetUnknownProperties(
    HKEY hkeyClusterKey,
    const RESUTIL_PROPERTY_ITEM* pPropertyTable,
    const void* pInPropertyList,
    DWORD cbInPropertyListSize
);

[DllImport("RESUTILS.dll", ExactSpelling = true)]
static extern uint ResUtilSetUnknownProperties(
    IntPtr hkeyClusterKey,   // HKEY
    IntPtr pPropertyTable,   // RESUTIL_PROPERTY_ITEM*
    IntPtr pInPropertyList,   // void*
    uint cbInPropertyListSize   // DWORD
);

<DllImport("RESUTILS.dll", ExactSpelling:=True)>
Public Shared Function ResUtilSetUnknownProperties(
    hkeyClusterKey As IntPtr,   ' HKEY
    pPropertyTable As IntPtr,   ' RESUTIL_PROPERTY_ITEM*
    pInPropertyList As IntPtr,   ' void*
    cbInPropertyListSize As UInteger   ' DWORD
) As UInteger
End Function

' hkeyClusterKey : HKEY
' pPropertyTable : RESUTIL_PROPERTY_ITEM*
' pInPropertyList : void*
' cbInPropertyListSize : DWORD
Declare PtrSafe Function ResUtilSetUnknownProperties Lib "resutils" ( _
    ByVal hkeyClusterKey As LongPtr, _
    ByVal pPropertyTable As LongPtr, _
    ByVal pInPropertyList As LongPtr, _
    ByVal cbInPropertyListSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ResUtilSetUnknownProperties = ctypes.windll.resutils.ResUtilSetUnknownProperties
ResUtilSetUnknownProperties.restype = wintypes.DWORD
ResUtilSetUnknownProperties.argtypes = [
    wintypes.HANDLE,  # hkeyClusterKey : HKEY
    ctypes.c_void_p,  # pPropertyTable : RESUTIL_PROPERTY_ITEM*
    ctypes.POINTER(None),  # pInPropertyList : void*
    wintypes.DWORD,  # cbInPropertyListSize : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RESUTILS.dll')
ResUtilSetUnknownProperties = Fiddle::Function.new(
  lib['ResUtilSetUnknownProperties'],
  [
    Fiddle::TYPE_VOIDP,  # hkeyClusterKey : HKEY
    Fiddle::TYPE_VOIDP,  # pPropertyTable : RESUTIL_PROPERTY_ITEM*
    Fiddle::TYPE_VOIDP,  # pInPropertyList : void*
    -Fiddle::TYPE_INT,  # cbInPropertyListSize : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "resutils")]
extern "system" {
    fn ResUtilSetUnknownProperties(
        hkeyClusterKey: *mut core::ffi::c_void,  // HKEY
        pPropertyTable: *const RESUTIL_PROPERTY_ITEM,  // RESUTIL_PROPERTY_ITEM*
        pInPropertyList: *const (),  // void*
        cbInPropertyListSize: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("RESUTILS.dll")]
public static extern uint ResUtilSetUnknownProperties(IntPtr hkeyClusterKey, IntPtr pPropertyTable, IntPtr pInPropertyList, uint cbInPropertyListSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RESUTILS_ResUtilSetUnknownProperties' -Namespace Win32 -PassThru
# $api::ResUtilSetUnknownProperties(hkeyClusterKey, pPropertyTable, pInPropertyList, cbInPropertyListSize)

#uselib "RESUTILS.dll"
#func global ResUtilSetUnknownProperties "ResUtilSetUnknownProperties" sptr, sptr, sptr, sptr
; ResUtilSetUnknownProperties hkeyClusterKey, varptr(pPropertyTable), pInPropertyList, cbInPropertyListSize   ; 戻り値は stat
; hkeyClusterKey : HKEY -> "sptr"
; pPropertyTable : RESUTIL_PROPERTY_ITEM* -> "sptr"
; pInPropertyList : void* -> "sptr"
; cbInPropertyListSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "RESUTILS.dll"
#cfunc global ResUtilSetUnknownProperties "ResUtilSetUnknownProperties" sptr, var, sptr, int
; res = ResUtilSetUnknownProperties(hkeyClusterKey, pPropertyTable, pInPropertyList, cbInPropertyListSize)
; hkeyClusterKey : HKEY -> "sptr"
; pPropertyTable : RESUTIL_PROPERTY_ITEM* -> "var"
; pInPropertyList : void* -> "sptr"
; cbInPropertyListSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RESUTILS.dll"
#cfunc global ResUtilSetUnknownProperties "ResUtilSetUnknownProperties" sptr, sptr, sptr, int
; res = ResUtilSetUnknownProperties(hkeyClusterKey, varptr(pPropertyTable), pInPropertyList, cbInPropertyListSize)
; hkeyClusterKey : HKEY -> "sptr"
; pPropertyTable : RESUTIL_PROPERTY_ITEM* -> "sptr"
; pInPropertyList : void* -> "sptr"
; cbInPropertyListSize : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。