ホーム › Storage.FileSystem › FindNextVolumeA

FindNextVolumeA

関数

ボリューム列挙で次のボリュームを取得する(ANSI版)。

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

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL FindNextVolumeA(
    HANDLE hFindVolume,
    LPSTR lpszVolumeName,
    DWORD cchBufferLength
);

パラメーター

名前	型	方向	説明
hFindVolume	HANDLE	inout	以前の FindFirstVolume 関数の呼び出しによって返されたボリューム検索ハンドル。
lpszVolumeName	LPSTR	out	検出されたボリュームの GUID パスを受け取る文字列へのポインター。
cchBufferLength	DWORD	in	ボリュームの GUID パスを受け取るバッファーの長さ( TCHAR 単位)。

戻り値の型: BOOL

公式ドキュメント

FindFirstVolume 関数の呼び出しによって開始されたボリューム検索を続行します。(FindNextVolumeA)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。一致するファイルが見つからない場合、 GetLastError 関数は ERROR_NO_MORE_FILES エラーコードを返します。その場合は、 FindVolumeClose 関数で検索を閉じてください。

解説(Remarks)

FindFirstVolume を呼び出して検索ハンドルを確立した後、 FindNextVolume 関数を使用して他のボリュームを検索できます。

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

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  (ANSI / -A)
#include <windows.h>

BOOL FindNextVolumeA(
    HANDLE hFindVolume,
    LPSTR lpszVolumeName,
    DWORD cchBufferLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool FindNextVolumeA(
    IntPtr hFindVolume,   // HANDLE in/out
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszVolumeName,   // LPSTR out
    uint cchBufferLength   // DWORD
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindNextVolumeA(
    hFindVolume As IntPtr,   ' HANDLE in/out
    <MarshalAs(UnmanagedType.LPStr)> lpszVolumeName As System.Text.StringBuilder,   ' LPSTR out
    cchBufferLength As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hFindVolume : HANDLE in/out
' lpszVolumeName : LPSTR out
' cchBufferLength : DWORD
Declare PtrSafe Function FindNextVolumeA Lib "kernel32" ( _
    ByVal hFindVolume As LongPtr, _
    ByVal lpszVolumeName As String, _
    ByVal cchBufferLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FindNextVolumeA = ctypes.windll.kernel32.FindNextVolumeA
FindNextVolumeA.restype = wintypes.BOOL
FindNextVolumeA.argtypes = [
    wintypes.HANDLE,  # hFindVolume : HANDLE in/out
    wintypes.LPSTR,  # lpszVolumeName : LPSTR 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')
FindNextVolumeA = Fiddle::Function.new(
  lib['FindNextVolumeA'],
  [
    Fiddle::TYPE_VOIDP,  # hFindVolume : HANDLE in/out
    Fiddle::TYPE_VOIDP,  # lpszVolumeName : LPSTR out
    -Fiddle::TYPE_INT,  # cchBufferLength : DWORD
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool FindNextVolumeA(IntPtr hFindVolume, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszVolumeName, uint cchBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FindNextVolumeA' -Namespace Win32 -PassThru
# $api::FindNextVolumeA(hFindVolume, lpszVolumeName, cchBufferLength)

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

出力引数:

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