ホーム › Networking.Clustering › GetClusterResourceNetworkName

GetClusterResourceNetworkName

関数

クラスターリソースに関連するネットワーク名を取得する。

DLLCLUSAPI.dll呼出規約winapiSetLastErrorあり対応OSwindowsserver2008

シグネチャ

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

BOOL GetClusterResourceNetworkName(
    HRESOURCE hResource,
    LPWSTR lpBuffer,
    DWORD* nSize
);

パラメーター

名前	型	方向	説明
hResource	HRESOURCE	in	依存する側のリソースのハンドル。
lpBuffer	LPWSTR	out	リソースが依存している Network Name リソースの Name プライベートプロパティを格納した、null で終わる Unicode 文字列を含むバッファー。
nSize	DWORD*	inout	入力時は、lpBuffer が指すバッファーの文字数へのポインター。出力時は、lpBuffer が指すバッファーに格納された Network Name リソースのネットワーク名の文字数(null 終端文字を除く)へのポインター。

戻り値の型: BOOL

公式ドキュメント

リソースが依存している Network Name リソースの Name プライベートプロパティを取得します。

戻り値

操作に成功した場合、関数は TRUE を返します。

操作に失敗した場合、関数は FALSE を返します。エラーの詳細については、GetLastError を呼び出してください。

解説(Remarks)

リソース DLL のエントリポイント関数から GetClusterResourceNetworkName を呼び出さないでください。 GetClusterResourceNetworkName はワーカースレッドから安全に呼び出せます。詳細については、 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)

各言語での呼び出し定義

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

BOOL GetClusterResourceNetworkName(
    HRESOURCE hResource,
    LPWSTR lpBuffer,
    DWORD* nSize
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CLUSAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetClusterResourceNetworkName(
    IntPtr hResource,   // HRESOURCE
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer,   // LPWSTR out
    ref uint nSize   // DWORD* in/out
);

<DllImport("CLUSAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetClusterResourceNetworkName(
    hResource As IntPtr,   ' HRESOURCE
    <MarshalAs(UnmanagedType.LPWStr)> lpBuffer As System.Text.StringBuilder,   ' LPWSTR out
    ByRef nSize As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hResource : HRESOURCE
' lpBuffer : LPWSTR out
' nSize : DWORD* in/out
Declare PtrSafe Function GetClusterResourceNetworkName Lib "clusapi" ( _
    ByVal hResource As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByRef nSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetClusterResourceNetworkName = ctypes.windll.clusapi.GetClusterResourceNetworkName
GetClusterResourceNetworkName.restype = wintypes.BOOL
GetClusterResourceNetworkName.argtypes = [
    ctypes.c_ssize_t,  # hResource : HRESOURCE
    wintypes.LPWSTR,  # lpBuffer : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # nSize : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CLUSAPI.dll')
GetClusterResourceNetworkName = Fiddle::Function.new(
  lib['GetClusterResourceNetworkName'],
  [
    Fiddle::TYPE_INTPTR_T,  # hResource : HRESOURCE
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPWSTR out
    Fiddle::TYPE_VOIDP,  # nSize : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clusapi")]
extern "system" {
    fn GetClusterResourceNetworkName(
        hResource: isize,  // HRESOURCE
        lpBuffer: *mut u16,  // LPWSTR out
        nSize: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CLUSAPI.dll", SetLastError = true)]
public static extern bool GetClusterResourceNetworkName(IntPtr hResource, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer, ref uint nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CLUSAPI_GetClusterResourceNetworkName' -Namespace Win32 -PassThru
# $api::GetClusterResourceNetworkName(hResource, lpBuffer, nSize)

#uselib "CLUSAPI.dll"
#func global GetClusterResourceNetworkName "GetClusterResourceNetworkName" sptr, sptr, sptr
; GetClusterResourceNetworkName hResource, varptr(lpBuffer), varptr(nSize)   ; 戻り値は stat
; hResource : HRESOURCE -> "sptr"
; lpBuffer : LPWSTR out -> "sptr"
; nSize : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CLUSAPI.dll"
#cfunc global GetClusterResourceNetworkName "GetClusterResourceNetworkName" sptr, var, var
; res = GetClusterResourceNetworkName(hResource, lpBuffer, nSize)
; hResource : HRESOURCE -> "sptr"
; lpBuffer : LPWSTR out -> "var"
; nSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CLUSAPI.dll"
#cfunc global GetClusterResourceNetworkName "GetClusterResourceNetworkName" sptr, sptr, sptr
; res = GetClusterResourceNetworkName(hResource, varptr(lpBuffer), varptr(nSize))
; hResource : HRESOURCE -> "sptr"
; lpBuffer : LPWSTR out -> "sptr"
; nSize : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。