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

IsFileOnClusterSharedVolume

関数
指定ファイルがクラスター共有ボリューム上にあるか判定する。
DLLCLUSAPI.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD IsFileOnClusterSharedVolume(
    LPCWSTR lpszPathName,
    BOOL* pbFileIsOnSharedVolume
);

パラメーター

名前方向説明
lpszPathNameLPCWSTRin判定対象ファイルのパスを示すワイド文字列。
pbFileIsOnSharedVolumeBOOL*outCSV上にあるかの判定結果を受け取るBOOLへのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD IsFileOnClusterSharedVolume(
    LPCWSTR lpszPathName,
    BOOL* pbFileIsOnSharedVolume
);
[DllImport("CLUSAPI.dll", ExactSpelling = true)]
static extern uint IsFileOnClusterSharedVolume(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszPathName,   // LPCWSTR
    out bool pbFileIsOnSharedVolume   // BOOL* out
);
<DllImport("CLUSAPI.dll", ExactSpelling:=True)>
Public Shared Function IsFileOnClusterSharedVolume(
    <MarshalAs(UnmanagedType.LPWStr)> lpszPathName As String,   ' LPCWSTR
    <Out> ByRef pbFileIsOnSharedVolume As Boolean   ' BOOL* out
) As UInteger
End Function
' lpszPathName : LPCWSTR
' pbFileIsOnSharedVolume : BOOL* out
Declare PtrSafe Function IsFileOnClusterSharedVolume Lib "clusapi" ( _
    ByVal lpszPathName As LongPtr, _
    ByRef pbFileIsOnSharedVolume As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

IsFileOnClusterSharedVolume = ctypes.windll.clusapi.IsFileOnClusterSharedVolume
IsFileOnClusterSharedVolume.restype = wintypes.DWORD
IsFileOnClusterSharedVolume.argtypes = [
    wintypes.LPCWSTR,  # lpszPathName : LPCWSTR
    ctypes.c_void_p,  # pbFileIsOnSharedVolume : BOOL* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CLUSAPI.dll')
IsFileOnClusterSharedVolume = Fiddle::Function.new(
  lib['IsFileOnClusterSharedVolume'],
  [
    Fiddle::TYPE_VOIDP,  # lpszPathName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pbFileIsOnSharedVolume : BOOL* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "clusapi")]
extern "system" {
    fn IsFileOnClusterSharedVolume(
        lpszPathName: *const u16,  // LPCWSTR
        pbFileIsOnSharedVolume: *mut i32  // BOOL* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("CLUSAPI.dll")]
public static extern uint IsFileOnClusterSharedVolume([MarshalAs(UnmanagedType.LPWStr)] string lpszPathName, out bool pbFileIsOnSharedVolume);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CLUSAPI_IsFileOnClusterSharedVolume' -Namespace Win32 -PassThru
# $api::IsFileOnClusterSharedVolume(lpszPathName, pbFileIsOnSharedVolume)
#uselib "CLUSAPI.dll"
#func global IsFileOnClusterSharedVolume "IsFileOnClusterSharedVolume" sptr, sptr
; IsFileOnClusterSharedVolume lpszPathName, varptr(pbFileIsOnSharedVolume)   ; 戻り値は stat
; lpszPathName : LPCWSTR -> "sptr"
; pbFileIsOnSharedVolume : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "CLUSAPI.dll"
#cfunc global IsFileOnClusterSharedVolume "IsFileOnClusterSharedVolume" wstr, var
; res = IsFileOnClusterSharedVolume(lpszPathName, pbFileIsOnSharedVolume)
; lpszPathName : LPCWSTR -> "wstr"
; pbFileIsOnSharedVolume : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD IsFileOnClusterSharedVolume(LPCWSTR lpszPathName, BOOL* pbFileIsOnSharedVolume)
#uselib "CLUSAPI.dll"
#cfunc global IsFileOnClusterSharedVolume "IsFileOnClusterSharedVolume" wstr, var
; res = IsFileOnClusterSharedVolume(lpszPathName, pbFileIsOnSharedVolume)
; lpszPathName : LPCWSTR -> "wstr"
; pbFileIsOnSharedVolume : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	clusapi = windows.NewLazySystemDLL("CLUSAPI.dll")
	procIsFileOnClusterSharedVolume = clusapi.NewProc("IsFileOnClusterSharedVolume")
)

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

extern "clusapi" fn IsFileOnClusterSharedVolume(
    lpszPathName: [*c]const u16, // LPCWSTR
    pbFileIsOnSharedVolume: [*c]i32 // BOOL* out
) callconv(std.os.windows.WINAPI) u32;
proc IsFileOnClusterSharedVolume(
    lpszPathName: WideCString,  # LPCWSTR
    pbFileIsOnSharedVolume: ptr int32  # BOOL* out
): uint32 {.importc: "IsFileOnClusterSharedVolume", stdcall, dynlib: "CLUSAPI.dll".}
pragma(lib, "clusapi");
extern(Windows)
uint IsFileOnClusterSharedVolume(
    const(wchar)* lpszPathName,   // LPCWSTR
    int* pbFileIsOnSharedVolume   // BOOL* out
);
ccall((:IsFileOnClusterSharedVolume, "CLUSAPI.dll"), stdcall, UInt32,
      (Cwstring, Ptr{Int32}),
      lpszPathName, pbFileIsOnSharedVolume)
# lpszPathName : LPCWSTR -> Cwstring
# pbFileIsOnSharedVolume : BOOL* out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t IsFileOnClusterSharedVolume(
    const uint16_t* lpszPathName,
    int32_t* pbFileIsOnSharedVolume);
]]
local clusapi = ffi.load("clusapi")
-- clusapi.IsFileOnClusterSharedVolume(lpszPathName, pbFileIsOnSharedVolume)
-- lpszPathName : LPCWSTR
-- pbFileIsOnSharedVolume : BOOL* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('CLUSAPI.dll');
const IsFileOnClusterSharedVolume = lib.func('__stdcall', 'IsFileOnClusterSharedVolume', 'uint32_t', ['str16', 'int32_t *']);
// IsFileOnClusterSharedVolume(lpszPathName, pbFileIsOnSharedVolume)
// lpszPathName : LPCWSTR -> 'str16'
// pbFileIsOnSharedVolume : BOOL* out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("CLUSAPI.dll", {
  IsFileOnClusterSharedVolume: { parameters: ["buffer", "pointer"], result: "u32" },
});
// lib.symbols.IsFileOnClusterSharedVolume(lpszPathName, pbFileIsOnSharedVolume)
// lpszPathName : LPCWSTR -> "buffer"
// pbFileIsOnSharedVolume : BOOL* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t IsFileOnClusterSharedVolume(
    const uint16_t* lpszPathName,
    int32_t* pbFileIsOnSharedVolume);
C, "CLUSAPI.dll");
// $ffi->IsFileOnClusterSharedVolume(lpszPathName, pbFileIsOnSharedVolume);
// lpszPathName : LPCWSTR
// pbFileIsOnSharedVolume : BOOL* 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 Clusapi extends StdCallLibrary {
    Clusapi INSTANCE = Native.load("clusapi", Clusapi.class);
    int IsFileOnClusterSharedVolume(
        WString lpszPathName,   // LPCWSTR
        IntByReference pbFileIsOnSharedVolume   // BOOL* out
    );
}
@[Link("clusapi")]
lib LibCLUSAPI
  fun IsFileOnClusterSharedVolume = IsFileOnClusterSharedVolume(
    lpszPathName : UInt16*,   # LPCWSTR
    pbFileIsOnSharedVolume : Int32*   # BOOL* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef IsFileOnClusterSharedVolumeNative = Uint32 Function(Pointer<Utf16>, Pointer<Int32>);
typedef IsFileOnClusterSharedVolumeDart = int Function(Pointer<Utf16>, Pointer<Int32>);
final IsFileOnClusterSharedVolume = DynamicLibrary.open('CLUSAPI.dll')
    .lookupFunction<IsFileOnClusterSharedVolumeNative, IsFileOnClusterSharedVolumeDart>('IsFileOnClusterSharedVolume');
// lpszPathName : LPCWSTR -> Pointer<Utf16>
// pbFileIsOnSharedVolume : BOOL* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function IsFileOnClusterSharedVolume(
  lpszPathName: PWideChar;   // LPCWSTR
  pbFileIsOnSharedVolume: Pointer   // BOOL* out
): DWORD; stdcall;
  external 'CLUSAPI.dll' name 'IsFileOnClusterSharedVolume';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "IsFileOnClusterSharedVolume"
  c_IsFileOnClusterSharedVolume :: CWString -> Ptr CInt -> IO Word32
-- lpszPathName : LPCWSTR -> CWString
-- pbFileIsOnSharedVolume : BOOL* out -> Ptr CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let isfileonclustersharedvolume =
  foreign "IsFileOnClusterSharedVolume"
    ((ptr uint16_t) @-> (ptr int32_t) @-> returning uint32_t)
(* lpszPathName : LPCWSTR -> (ptr uint16_t) *)
(* pbFileIsOnSharedVolume : BOOL* out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library clusapi (t "CLUSAPI.dll"))
(cffi:use-foreign-library clusapi)

(cffi:defcfun ("IsFileOnClusterSharedVolume" is-file-on-cluster-shared-volume :convention :stdcall) :uint32
  (lpsz-path-name (:string :encoding :utf-16le))   ; LPCWSTR
  (pb-file-is-on-shared-volume :pointer))   ; BOOL* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $IsFileOnClusterSharedVolume = Win32::API::More->new('CLUSAPI',
    'DWORD IsFileOnClusterSharedVolume(LPCWSTR lpszPathName, LPVOID pbFileIsOnSharedVolume)');
# my $ret = $IsFileOnClusterSharedVolume->Call($lpszPathName, $pbFileIsOnSharedVolume);
# lpszPathName : LPCWSTR -> LPCWSTR
# pbFileIsOnSharedVolume : BOOL* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。