ホーム › Storage.FileSystem › FindFirstVolumeW

FindFirstVolumeW

関数

システム上の最初のボリュームを列挙し検索を開始する。

DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

HANDLE FindFirstVolumeW(
    LPWSTR lpszVolumeName,
    DWORD cchBufferLength
);

パラメーター

名前	型	方向	説明
lpszVolumeName	LPWSTR	out	最初に見つかったボリュームの GUID パスを指定する null 終端文字列を受け取るバッファーへのポインター。
cchBufferLength	DWORD	in	ボリューム GUID パスを受け取るバッファーの長さ( TCHAR 単位)。

戻り値の型: HANDLE

公式ドキュメント

コンピューター上のボリュームの名前を取得します。(FindFirstVolumeW)

戻り値

関数が成功した場合、戻り値は後続の FindNextVolume 関数および FindVolumeClose 関数の呼び出しで使用される検索ハンドルです。

関数がボリュームを 1 つも見つけられなかった場合、戻り値は INVALID_HANDLE_VALUE エラーコードです。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

FindFirstVolume 関数はボリューム検索ハンドルを開き、コンピューター上で最初に見つかったボリュームに関する情報を返します。検索ハンドルが確立された後は、 FindNextVolume 関数を使用して他のボリュームを検索できます。検索ハンドルが不要になったら、 FindVolumeClose 関数を使用して閉じます。

これらの関数が返すボリュームの順序と、コンピューター上のボリュームの順序との間に何らかの相関があると想定しないでください。特に、ボリュームの順序と、 BIOS(存在する場合)またはディスクアドミニストレーターによって割り当てられたドライブ文字との間に相関があると想定しないでください。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジーでサポートされています。

テクノロジー	サポート状況
Server Message Block (SMB) 3.0 プロトコル	いいえ
SMB 3.0 Transparent Failover (TFO)	いいえ
SMB 3.0 with Scale-out File Shares (SO)	いいえ
Cluster Shared Volume File System (CsvFS)	はい
Resilient File System (ReFS)	はい

SMB はボリューム管理関数をサポートしていません。

例

例については、 Displaying Volume Paths を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

HANDLE FindFirstVolumeW(
    LPWSTR lpszVolumeName,
    DWORD cchBufferLength
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr FindFirstVolumeW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszVolumeName,   // LPWSTR out
    uint cchBufferLength   // DWORD
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindFirstVolumeW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszVolumeName As System.Text.StringBuilder,   ' LPWSTR out
    cchBufferLength As UInteger   ' DWORD
) As IntPtr
End Function

' lpszVolumeName : LPWSTR out
' cchBufferLength : DWORD
Declare PtrSafe Function FindFirstVolumeW Lib "kernel32" ( _
    ByVal lpszVolumeName As LongPtr, _
    ByVal cchBufferLength As Long) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FindFirstVolumeW = ctypes.windll.kernel32.FindFirstVolumeW
FindFirstVolumeW.restype = ctypes.c_void_p
FindFirstVolumeW.argtypes = [
    wintypes.LPWSTR,  # lpszVolumeName : LPWSTR out
    wintypes.DWORD,  # cchBufferLength : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
FindFirstVolumeW = Fiddle::Function.new(
  lib['FindFirstVolumeW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszVolumeName : LPWSTR out
    -Fiddle::TYPE_INT,  # cchBufferLength : DWORD
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn FindFirstVolumeW(
        lpszVolumeName: *mut u16,  // LPWSTR out
        cchBufferLength: u32  // DWORD
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern IntPtr FindFirstVolumeW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszVolumeName, uint cchBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FindFirstVolumeW' -Namespace Win32 -PassThru
# $api::FindFirstVolumeW(lpszVolumeName, cchBufferLength)

#uselib "KERNEL32.dll"
#func global FindFirstVolumeW "FindFirstVolumeW" wptr, wptr
; FindFirstVolumeW varptr(lpszVolumeName), cchBufferLength   ; 戻り値は stat
; lpszVolumeName : LPWSTR out -> "wptr"
; cchBufferLength : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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