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

ResUtilEnumResources

関数
指定種別の依存リソースをコールバックで列挙する。
DLLRESUTILS.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD ResUtilEnumResources(
    HRESOURCE hSelf,
    LPCWSTR lpszResTypeName,
    LPRESOURCE_CALLBACK pResCallBack,
    void* pParameter
);

パラメーター

名前型方向説明
hSelfHRESOURCEinクラスターリソースへの省略可能なハンドル。hSelf で指定されたリソースに対しては、コールバック関数は呼び出されません。
lpszResTypeNameLPCWSTRin列挙するリソースの範囲を絞り込むリソースの種類の名前への省略可能なポインター。lpszResTypeName を指定した場合は、指定した種類のリソースのみが列挙されます。
pResCallBackLPRESOURCE_CALLBACKin

列挙された各リソースに対して呼び出されるユーザー定義関数へのポインター。この関数は、ResourceCallback コールバック関数の定義に準拠する必要があります(パラメーター名は定義の一部ではなく、分かりやすさのためにここで追記しています)。

DWORD (*LPRESOURCE_CALLBACK)( 
  HRESOURCE hSelf, 
  HRESOURCE hEnum, 
  PVOID pParameter 
);
pParametervoid*inoutコールバック関数に任意の種類のデータを渡すための汎用バッファー。ResUtilEnumResources はこのパラメーターを一切使用せず、単にポインターをコールバック関数に渡すだけです。このパラメーターに NULL を渡せるかどうかは、コールバック関数の実装方法によって異なります。

戻り値の型: DWORD

公式ドキュメント

ローカルクラスター内のすべてのリソースを列挙し、各リソースに対してユーザー定義の操作を開始します。PRESUTIL_ENUM_RESOURCES 型は、この関数へのポインターを定義します。

戻り値

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

操作が失敗した場合、この関数は直ちに列挙を中止し、コールバック関数が返した値を返します。

解説(Remarks)

ResUtilEnumResources は、ClusterResourceEnum 関数の便利で使いやすい代替手段です。

ResUtilEnumResources はローカルクラスターにのみ接続するため、クラスターノード上で実行する必要があります。リモートのクラスターを指定するには、ResUtilEnumResourcesEx 関数を使用します。

次の例では、ResUtilEnumResources を使用して、クラスター内のすべてのリソースの名前と状態を一覧表示します。

//////////////////////////////////////////////////////////////////////
//  ClusDocEx_EnumDemo.cpp
//
//  Uses the ResUtilEnumResources function to list the names and 
//  states of all cluster resources.
//
//  To compile and run this example you will need two other examples 
//  from the documentation:  ClusDocEx.h (see "ClusDocEx.h") and 
//  ClusDocEx_GetControlCodeOutput.cpp (see "Getting Information with 
//  Control Codes").
// 
//////////////////////////////////////////////////////////////////////
#include "ClusDocEx.h"
#include "ClusDocEx_GetControlCodeOutput.cpp"

DWORD
MyCallbackFunction(
    HRESOURCE hSelf,
    HRESOURCE hCurrentEnum,
    PVOID pData );

LPRESOURCE_CALLBACK g_pMyCallbackFunction = &MyCallbackFunction;

int main( void )
{
    wprintf( L"\n\nResource (State)\n----------------\n" );
    DWORD dwResult = ResUtilEnumResources( 
                         NULL, 
                         NULL, 
                         g_pMyCallbackFunction, 
                         NULL );
    if( dwResult != ERROR_SUCCESS )
    {
        ClusDocEx_DebugPrint( L"ResUtilEnumResources returned an error.", dwResult );
        return 1;
    }
    else
        return 0;
}

DWORD
MyCallbackFunction(
    HRESOURCE hSelf,
    HRESOURCE hCurrentEnum,
    PVOID pData )
{
    DWORD dwResult           = ERROR_SUCCESS,
          cbNameSize         = 0, 
          dwState            = 0;

    WCHAR* pszState    = NULL;
    WCHAR* pszEnumName = ClusDocEx_ResGetControlCodeOutput(
                            hCurrentEnum,
                            NULL,
                            CLUSCTL_RESOURCE_GET_NAME,
                            &cbNameSize );
    if( pszEnumName == NULL )
    {
        dwResult = GetLastError();
        goto EndFunc;
    }

    dwState = GetClusterResourceState(
                  hCurrentEnum,
                  NULL,
                  NULL,
                  NULL,
                  NULL );
    switch( dwState )
    {
    case ClusterResourceOnline:
        pszState = L"Online";
        break;
    case ClusterResourceOffline:
        pszState = L"Offline";
        break;
    case ClusterResourcePending:
        pszState = L"Pending";
        break;
    case ClusterResourceOnlinePending:
        pszState = L"OnlinePending";
        break;
    case ClusterResourceOfflinePending:
        pszState = L"OfflinePending";
        break;
    case ClusterResourceFailed:
        pszState = L"Failed";
        break;
    case ClusterResourceInitializing:
        pszState = L"Initializing";
        break;
    default:
        pszState = L"Unknown";
        break;
    }
    wprintf( L"%ls (%ls)\n", pszEnumName, pszState );

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

各言語での呼び出し定義

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

DWORD ResUtilEnumResources(
    HRESOURCE hSelf,
    LPCWSTR lpszResTypeName,
    LPRESOURCE_CALLBACK pResCallBack,
    void* pParameter
);
[DllImport("RESUTILS.dll", ExactSpelling = true)]
static extern uint ResUtilEnumResources(
    IntPtr hSelf,   // HRESOURCE
    [MarshalAs(UnmanagedType.LPWStr)] string lpszResTypeName,   // LPCWSTR
    IntPtr pResCallBack,   // LPRESOURCE_CALLBACK
    IntPtr pParameter   // void* in/out
);
<DllImport("RESUTILS.dll", ExactSpelling:=True)>
Public Shared Function ResUtilEnumResources(
    hSelf As IntPtr,   ' HRESOURCE
    <MarshalAs(UnmanagedType.LPWStr)> lpszResTypeName As String,   ' LPCWSTR
    pResCallBack As IntPtr,   ' LPRESOURCE_CALLBACK
    pParameter As IntPtr   ' void* in/out
) As UInteger
End Function
' hSelf : HRESOURCE
' lpszResTypeName : LPCWSTR
' pResCallBack : LPRESOURCE_CALLBACK
' pParameter : void* in/out
Declare PtrSafe Function ResUtilEnumResources Lib "resutils" ( _
    ByVal hSelf As LongPtr, _
    ByVal lpszResTypeName As LongPtr, _
    ByVal pResCallBack As LongPtr, _
    ByVal pParameter As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ResUtilEnumResources = ctypes.windll.resutils.ResUtilEnumResources
ResUtilEnumResources.restype = wintypes.DWORD
ResUtilEnumResources.argtypes = [
    ctypes.c_ssize_t,  # hSelf : HRESOURCE
    wintypes.LPCWSTR,  # lpszResTypeName : LPCWSTR
    ctypes.c_void_p,  # pResCallBack : LPRESOURCE_CALLBACK
    ctypes.POINTER(None),  # pParameter : void* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RESUTILS.dll')
ResUtilEnumResources = Fiddle::Function.new(
  lib['ResUtilEnumResources'],
  [
    Fiddle::TYPE_INTPTR_T,  # hSelf : HRESOURCE
    Fiddle::TYPE_VOIDP,  # lpszResTypeName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pResCallBack : LPRESOURCE_CALLBACK
    Fiddle::TYPE_VOIDP,  # pParameter : void* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "resutils")]
extern "system" {
    fn ResUtilEnumResources(
        hSelf: isize,  // HRESOURCE
        lpszResTypeName: *const u16,  // LPCWSTR
        pResCallBack: *const core::ffi::c_void,  // LPRESOURCE_CALLBACK
        pParameter: *mut ()  // void* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("RESUTILS.dll")]
public static extern uint ResUtilEnumResources(IntPtr hSelf, [MarshalAs(UnmanagedType.LPWStr)] string lpszResTypeName, IntPtr pResCallBack, IntPtr pParameter);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RESUTILS_ResUtilEnumResources' -Namespace Win32 -PassThru
# $api::ResUtilEnumResources(hSelf, lpszResTypeName, pResCallBack, pParameter)
#uselib "RESUTILS.dll"
#func global ResUtilEnumResources "ResUtilEnumResources" sptr, sptr, sptr, sptr
; ResUtilEnumResources hSelf, lpszResTypeName, pResCallBack, pParameter   ; 戻り値は stat
; hSelf : HRESOURCE -> "sptr"
; lpszResTypeName : LPCWSTR -> "sptr"
; pResCallBack : LPRESOURCE_CALLBACK -> "sptr"
; pParameter : void* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "RESUTILS.dll"
#cfunc global ResUtilEnumResources "ResUtilEnumResources" sptr, wstr, sptr, sptr
; res = ResUtilEnumResources(hSelf, lpszResTypeName, pResCallBack, pParameter)
; hSelf : HRESOURCE -> "sptr"
; lpszResTypeName : LPCWSTR -> "wstr"
; pResCallBack : LPRESOURCE_CALLBACK -> "sptr"
; pParameter : void* in/out -> "sptr"
; DWORD ResUtilEnumResources(HRESOURCE hSelf, LPCWSTR lpszResTypeName, LPRESOURCE_CALLBACK pResCallBack, void* pParameter)
#uselib "RESUTILS.dll"
#cfunc global ResUtilEnumResources "ResUtilEnumResources" intptr, wstr, intptr, intptr
; res = ResUtilEnumResources(hSelf, lpszResTypeName, pResCallBack, pParameter)
; hSelf : HRESOURCE -> "intptr"
; lpszResTypeName : LPCWSTR -> "wstr"
; pResCallBack : LPRESOURCE_CALLBACK -> "intptr"
; pParameter : void* in/out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	resutils = windows.NewLazySystemDLL("RESUTILS.dll")
	procResUtilEnumResources = resutils.NewProc("ResUtilEnumResources")
)

// hSelf (HRESOURCE), lpszResTypeName (LPCWSTR), pResCallBack (LPRESOURCE_CALLBACK), pParameter (void* in/out)
r1, _, err := procResUtilEnumResources.Call(
	uintptr(hSelf),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszResTypeName))),
	uintptr(pResCallBack),
	uintptr(pParameter),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function ResUtilEnumResources(
  hSelf: NativeInt;   // HRESOURCE
  lpszResTypeName: PWideChar;   // LPCWSTR
  pResCallBack: Pointer;   // LPRESOURCE_CALLBACK
  pParameter: Pointer   // void* in/out
): DWORD; stdcall;
  external 'RESUTILS.dll' name 'ResUtilEnumResources';
result := DllCall("RESUTILS\ResUtilEnumResources"
    , "Ptr", hSelf   ; HRESOURCE
    , "WStr", lpszResTypeName   ; LPCWSTR
    , "Ptr", pResCallBack   ; LPRESOURCE_CALLBACK
    , "Ptr", pParameter   ; void* in/out
    , "UInt")   ; return: DWORD
●ResUtilEnumResources(hSelf, lpszResTypeName, pResCallBack, pParameter) = DLL("RESUTILS.dll", "dword ResUtilEnumResources(int, char*, void*, void*)")
# 呼び出し: ResUtilEnumResources(hSelf, lpszResTypeName, pResCallBack, pParameter)
# hSelf : HRESOURCE -> "int"
# lpszResTypeName : LPCWSTR -> "char*"
# pResCallBack : LPRESOURCE_CALLBACK -> "void*"
# pParameter : void* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "resutils" fn ResUtilEnumResources(
    hSelf: isize, // HRESOURCE
    lpszResTypeName: [*c]const u16, // LPCWSTR
    pResCallBack: ?*anyopaque, // LPRESOURCE_CALLBACK
    pParameter: ?*anyopaque // void* in/out
) callconv(std.os.windows.WINAPI) u32;
proc ResUtilEnumResources(
    hSelf: int,  # HRESOURCE
    lpszResTypeName: WideCString,  # LPCWSTR
    pResCallBack: pointer,  # LPRESOURCE_CALLBACK
    pParameter: pointer  # void* in/out
): uint32 {.importc: "ResUtilEnumResources", stdcall, dynlib: "RESUTILS.dll".}
pragma(lib, "resutils");
extern(Windows)
uint ResUtilEnumResources(
    ptrdiff_t hSelf,   // HRESOURCE
    const(wchar)* lpszResTypeName,   // LPCWSTR
    void* pResCallBack,   // LPRESOURCE_CALLBACK
    void* pParameter   // void* in/out
);
ccall((:ResUtilEnumResources, "RESUTILS.dll"), stdcall, UInt32,
      (Int, Cwstring, Ptr{Cvoid}, Ptr{Cvoid}),
      hSelf, lpszResTypeName, pResCallBack, pParameter)
# hSelf : HRESOURCE -> Int
# lpszResTypeName : LPCWSTR -> Cwstring
# pResCallBack : LPRESOURCE_CALLBACK -> Ptr{Cvoid}
# pParameter : void* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t ResUtilEnumResources(
    intptr_t hSelf,
    const uint16_t* lpszResTypeName,
    void* pResCallBack,
    void* pParameter);
]]
local resutils = ffi.load("resutils")
-- resutils.ResUtilEnumResources(hSelf, lpszResTypeName, pResCallBack, pParameter)
-- hSelf : HRESOURCE
-- lpszResTypeName : LPCWSTR
-- pResCallBack : LPRESOURCE_CALLBACK
-- pParameter : void* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('RESUTILS.dll');
const ResUtilEnumResources = lib.func('__stdcall', 'ResUtilEnumResources', 'uint32_t', ['intptr_t', 'str16', 'void *', 'void *']);
// ResUtilEnumResources(hSelf, lpszResTypeName, pResCallBack, pParameter)
// hSelf : HRESOURCE -> 'intptr_t'
// lpszResTypeName : LPCWSTR -> 'str16'
// pResCallBack : LPRESOURCE_CALLBACK -> 'void *'
// pParameter : void* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("RESUTILS.dll", {
  ResUtilEnumResources: { parameters: ["isize", "buffer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.ResUtilEnumResources(hSelf, lpszResTypeName, pResCallBack, pParameter)
// hSelf : HRESOURCE -> "isize"
// lpszResTypeName : LPCWSTR -> "buffer"
// pResCallBack : LPRESOURCE_CALLBACK -> "pointer"
// pParameter : void* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t ResUtilEnumResources(
    intptr_t hSelf,
    const uint16_t* lpszResTypeName,
    void* pResCallBack,
    void* pParameter);
C, "RESUTILS.dll");
// $ffi->ResUtilEnumResources(hSelf, lpszResTypeName, pResCallBack, pParameter);
// hSelf : HRESOURCE
// lpszResTypeName : LPCWSTR
// pResCallBack : LPRESOURCE_CALLBACK
// pParameter : void* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Resutils extends StdCallLibrary {
    Resutils INSTANCE = Native.load("resutils", Resutils.class);
    int ResUtilEnumResources(
        long hSelf,   // HRESOURCE
        WString lpszResTypeName,   // LPCWSTR
        Callback pResCallBack,   // LPRESOURCE_CALLBACK
        Pointer pParameter   // void* in/out
    );
}
@[Link("resutils")]
lib LibRESUTILS
  fun ResUtilEnumResources = ResUtilEnumResources(
    hSelf : LibC::SSizeT,   # HRESOURCE
    lpszResTypeName : UInt16*,   # LPCWSTR
    pResCallBack : Void*,   # LPRESOURCE_CALLBACK
    pParameter : Void*   # void* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ResUtilEnumResourcesNative = Uint32 Function(IntPtr, Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
typedef ResUtilEnumResourcesDart = int Function(int, Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
final ResUtilEnumResources = DynamicLibrary.open('RESUTILS.dll')
    .lookupFunction<ResUtilEnumResourcesNative, ResUtilEnumResourcesDart>('ResUtilEnumResources');
// hSelf : HRESOURCE -> IntPtr
// lpszResTypeName : LPCWSTR -> Pointer<Utf16>
// pResCallBack : LPRESOURCE_CALLBACK -> Pointer<Void>
// pParameter : void* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ResUtilEnumResources(
  hSelf: NativeInt;   // HRESOURCE
  lpszResTypeName: PWideChar;   // LPCWSTR
  pResCallBack: Pointer;   // LPRESOURCE_CALLBACK
  pParameter: Pointer   // void* in/out
): DWORD; stdcall;
  external 'RESUTILS.dll' name 'ResUtilEnumResources';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ResUtilEnumResources"
  c_ResUtilEnumResources :: CIntPtr -> CWString -> Ptr () -> Ptr () -> IO Word32
-- hSelf : HRESOURCE -> CIntPtr
-- lpszResTypeName : LPCWSTR -> CWString
-- pResCallBack : LPRESOURCE_CALLBACK -> Ptr ()
-- pParameter : void* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let resutilenumresources =
  foreign "ResUtilEnumResources"
    (intptr_t @-> (ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* hSelf : HRESOURCE -> intptr_t *)
(* lpszResTypeName : LPCWSTR -> (ptr uint16_t) *)
(* pResCallBack : LPRESOURCE_CALLBACK -> (ptr void) *)
(* pParameter : void* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library resutils (t "RESUTILS.dll"))
(cffi:use-foreign-library resutils)

(cffi:defcfun ("ResUtilEnumResources" res-util-enum-resources :convention :stdcall) :uint32
  (h-self :int64)   ; HRESOURCE
  (lpsz-res-type-name (:string :encoding :utf-16le))   ; LPCWSTR
  (p-res-call-back :pointer)   ; LPRESOURCE_CALLBACK
  (p-parameter :pointer))   ; void* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ResUtilEnumResources = Win32::API::More->new('RESUTILS',
    'DWORD ResUtilEnumResources(LPARAM hSelf, LPCWSTR lpszResTypeName, LPVOID pResCallBack, LPVOID pParameter)');
# my $ret = $ResUtilEnumResources->Call($hSelf, $lpszResTypeName, $pResCallBack, $pParameter);
# hSelf : HRESOURCE -> LPARAM
# lpszResTypeName : LPCWSTR -> LPCWSTR
# pResCallBack : LPRESOURCE_CALLBACK -> LPVOID
# pParameter : void* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

類似 API
公式の関連項目
使用する型