ホーム › Storage.InstallableFileSystems › FilterVolumeFindFirst

FilterVolumeFindFirst

関数

ミニフィルターのボリューム列挙を開始する。

DLLFLTLIB.dll呼出規約winapi

シグネチャ

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

HRESULT FilterVolumeFindFirst(
    FILTER_VOLUME_INFORMATION_CLASS dwInformationClass,
    void* lpBuffer,
    DWORD dwBufferSize,
    DWORD* lpBytesReturned,
    HANDLE* lpVolumeFind
);

パラメーター

名前

型

方向

説明

dwInformationClass

FILTER_VOLUME_INFORMATION_CLASS

要求する情報の種類。このパラメーターには、次の値のいずれかを指定できます。

値	意味
FilterVolumeBasicInformation	lpBuffer パラメーターが指すバッファーに、そのボリュームの FILTER_VOLUME_BASIC_INFORMATION 構造体が格納されます。
FilterVolumeStandardInformation	lpBuffer パラメーターが指すバッファーに、そのボリュームの FILTER_VOLUME_STANDARD_INFORMATION 構造体が格納されます。この構造体は Windows Vista 以降で使用できます。

lpBuffer

void*

out

要求した情報を受け取る、呼び出し元が割り当てたバッファーへのポインター。バッファーに返される情報の型は、dwInformationClass パラメーターによって決まります。

dwBufferSize

DWORD

lpBuffer パラメーターが指すバッファーのサイズ (バイト単位)。呼び出し元は、指定した dwInformationClass に応じてこのパラメーターを設定する必要があります。

lpBytesReturned

DWORD*

out

FilterVolumeFindFirst の呼び出しが成功した場合に、lpBuffer が指すバッファーに返されたバイト数を受け取る、呼び出し元が割り当てた変数へのポインター。このパラメーターは必須であり、NULL にすることはできません。

lpVolumeFind

HANDLE*

out

FilterVolumeFindFirst の呼び出しが成功した場合にミニフィルターの検索ハンドルを受け取る、呼び出し元が割り当てた変数へのポインター。成功しなかった場合は INVALID_HANDLE_VALUE を受け取ります。この検索ハンドルは、後続の FilterVolumeFindNext および FilterVolumeFindClose の呼び出しで使用できます。

戻り値の型: HRESULT

公式ドキュメント

FilterVolumeFindFirst 関数は、ボリュームに関する情報を返します。

戻り値

FilterVolumeFindFirst は、ボリュームに関する情報を正常に返した場合に S_OK を返します。それ以外の場合は、次のような HRESULT エラー値を返します。

戻り値	説明
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)	lpBuffer が指すバッファーが、要求された情報を格納するのに十分な大きさではありません。この値が返された場合、lpBytesReturned には、指定した dwInformationClass の構造体に必要なバッファーのサイズ (バイト単位) が格納されます。
HRESULT_FROM_WIN32(ERROR_INVALID_PARAMETER)	dwInformationClass パラメーターに無効な値が指定されました。たとえば、Windows Vista より前のオペレーティングシステムで FilterVolumeStandardInformation を指定した場合、FilterVolumeFindFirst はこの HRESULT 値を返します。
HRESULT_FROM_WIN32(ERROR_NO_MORE_ITEMS)	フィルターマネージャーが認識しているボリュームの一覧に、ボリュームが見つかりませんでした。

解説(Remarks)

この FilterVolumeFindFirst 関数は、フィルターマネージャーが認識しているボリュームのスキャンを開始するために使用します。

FilterVolumeFindFirst は検索ハンドルを開き、フィルターマネージャーが認識しているボリュームの一覧で最初に見つかったボリュームに関する情報を返します。検索ハンドルを確立した後は、FilterVolumeFindNext 関数を使用して、フィルターマネージャーの一覧内にある他のボリュームを検索します。検索ハンドルが不要になったら、FilterVolumeFindClose を呼び出して閉じてください。

FilterVolumeFindFirst と FilterVolumeFindNext を使用してフィルターマネージャーが認識しているボリュームの一覧を列挙する場合、一覧内の 2 つ以上のボリュームが同じ名前を持つ可能性がある点に注意してください。詳細については、「Understanding Volume Enumerations with Duplicate Volume Names」を参照してください。

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

各言語での呼び出し定義

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

HRESULT FilterVolumeFindFirst(
    FILTER_VOLUME_INFORMATION_CLASS dwInformationClass,
    void* lpBuffer,
    DWORD dwBufferSize,
    DWORD* lpBytesReturned,
    HANDLE* lpVolumeFind
);

[DllImport("FLTLIB.dll", ExactSpelling = true)]
static extern int FilterVolumeFindFirst(
    int dwInformationClass,   // FILTER_VOLUME_INFORMATION_CLASS
    IntPtr lpBuffer,   // void* out
    uint dwBufferSize,   // DWORD
    out uint lpBytesReturned,   // DWORD* out
    IntPtr lpVolumeFind   // HANDLE* out
);

<DllImport("FLTLIB.dll", ExactSpelling:=True)>
Public Shared Function FilterVolumeFindFirst(
    dwInformationClass As Integer,   ' FILTER_VOLUME_INFORMATION_CLASS
    lpBuffer As IntPtr,   ' void* out
    dwBufferSize As UInteger,   ' DWORD
    <Out> ByRef lpBytesReturned As UInteger,   ' DWORD* out
    lpVolumeFind As IntPtr   ' HANDLE* out
) As Integer
End Function

' dwInformationClass : FILTER_VOLUME_INFORMATION_CLASS
' lpBuffer : void* out
' dwBufferSize : DWORD
' lpBytesReturned : DWORD* out
' lpVolumeFind : HANDLE* out
Declare PtrSafe Function FilterVolumeFindFirst Lib "fltlib" ( _
    ByVal dwInformationClass As Long, _
    ByVal lpBuffer As LongPtr, _
    ByVal dwBufferSize As Long, _
    ByRef lpBytesReturned As Long, _
    ByVal lpVolumeFind As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FilterVolumeFindFirst = ctypes.windll.fltlib.FilterVolumeFindFirst
FilterVolumeFindFirst.restype = ctypes.c_int
FilterVolumeFindFirst.argtypes = [
    ctypes.c_int,  # dwInformationClass : FILTER_VOLUME_INFORMATION_CLASS
    ctypes.POINTER(None),  # lpBuffer : void* out
    wintypes.DWORD,  # dwBufferSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpBytesReturned : DWORD* out
    ctypes.c_void_p,  # lpVolumeFind : HANDLE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('FLTLIB.dll')
FilterVolumeFindFirst = Fiddle::Function.new(
  lib['FilterVolumeFindFirst'],
  [
    Fiddle::TYPE_INT,  # dwInformationClass : FILTER_VOLUME_INFORMATION_CLASS
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* out
    -Fiddle::TYPE_INT,  # dwBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # lpBytesReturned : DWORD* out
    Fiddle::TYPE_VOIDP,  # lpVolumeFind : HANDLE* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "fltlib")]
extern "system" {
    fn FilterVolumeFindFirst(
        dwInformationClass: i32,  // FILTER_VOLUME_INFORMATION_CLASS
        lpBuffer: *mut (),  // void* out
        dwBufferSize: u32,  // DWORD
        lpBytesReturned: *mut u32,  // DWORD* out
        lpVolumeFind: *mut *mut core::ffi::c_void  // HANDLE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("FLTLIB.dll")]
public static extern int FilterVolumeFindFirst(int dwInformationClass, IntPtr lpBuffer, uint dwBufferSize, out uint lpBytesReturned, IntPtr lpVolumeFind);
"@
$api = Add-Type -MemberDefinition $sig -Name 'FLTLIB_FilterVolumeFindFirst' -Namespace Win32 -PassThru
# $api::FilterVolumeFindFirst(dwInformationClass, lpBuffer, dwBufferSize, lpBytesReturned, lpVolumeFind)

#uselib "FLTLIB.dll"
#func global FilterVolumeFindFirst "FilterVolumeFindFirst" sptr, sptr, sptr, sptr, sptr
; FilterVolumeFindFirst dwInformationClass, lpBuffer, dwBufferSize, varptr(lpBytesReturned), lpVolumeFind   ; 戻り値は stat
; dwInformationClass : FILTER_VOLUME_INFORMATION_CLASS -> "sptr"
; lpBuffer : void* out -> "sptr"
; dwBufferSize : DWORD -> "sptr"
; lpBytesReturned : DWORD* out -> "sptr"
; lpVolumeFind : HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "FLTLIB.dll"
#cfunc global FilterVolumeFindFirst "FilterVolumeFindFirst" int, sptr, int, var, sptr
; res = FilterVolumeFindFirst(dwInformationClass, lpBuffer, dwBufferSize, lpBytesReturned, lpVolumeFind)
; dwInformationClass : FILTER_VOLUME_INFORMATION_CLASS -> "int"
; lpBuffer : void* out -> "sptr"
; dwBufferSize : DWORD -> "int"
; lpBytesReturned : DWORD* out -> "var"
; lpVolumeFind : HANDLE* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "FLTLIB.dll"
#cfunc global FilterVolumeFindFirst "FilterVolumeFindFirst" int, sptr, int, sptr, sptr
; res = FilterVolumeFindFirst(dwInformationClass, lpBuffer, dwBufferSize, varptr(lpBytesReturned), lpVolumeFind)
; dwInformationClass : FILTER_VOLUME_INFORMATION_CLASS -> "int"
; lpBuffer : void* out -> "sptr"
; dwBufferSize : DWORD -> "int"
; lpBytesReturned : DWORD* out -> "sptr"
; lpVolumeFind : HANDLE* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。