Win32 API 日本語リファレンス
ホームStorage.FileSystem › FindNextVolumeW

FindNextVolumeW

関数
ボリューム列挙で次のボリュームを取得する。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL FindNextVolumeW(
    HANDLE hFindVolume,
    LPWSTR lpszVolumeName,
    DWORD cchBufferLength
);

パラメーター

名前方向説明
hFindVolumeHANDLEinout以前の FindFirstVolume 関数の呼び出しによって返されたボリューム検索ハンドル。
lpszVolumeNameLPWSTRout見つかったボリューム GUID パスを受け取る文字列へのポインター。
cchBufferLengthDWORDinボリューム GUID パスを受け取るバッファーの長さ(TCHAR 単位)。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 0 以外になります。

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

解説(Remarks)

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

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

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

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル いいえ
SMB 3.0 トランスペアレントフェールオーバー (TFO) いいえ
SMB 3.0 とスケールアウトファイル共有 (SO) いいえ
クラスター共有ボリュームファイルシステム (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>

BOOL FindNextVolumeW(
    HANDLE hFindVolume,
    LPWSTR lpszVolumeName,
    DWORD cchBufferLength
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool FindNextVolumeW(
    IntPtr hFindVolume,   // HANDLE in/out
    [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 FindNextVolumeW(
    hFindVolume As IntPtr,   ' HANDLE in/out
    <MarshalAs(UnmanagedType.LPWStr)> lpszVolumeName As System.Text.StringBuilder,   ' LPWSTR out
    cchBufferLength As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hFindVolume : HANDLE in/out
' lpszVolumeName : LPWSTR out
' cchBufferLength : DWORD
Declare PtrSafe Function FindNextVolumeW Lib "kernel32" ( _
    ByVal hFindVolume As LongPtr, _
    ByVal lpszVolumeName As LongPtr, _
    ByVal cchBufferLength As Long) As Long
' 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

FindNextVolumeW = ctypes.windll.kernel32.FindNextVolumeW
FindNextVolumeW.restype = wintypes.BOOL
FindNextVolumeW.argtypes = [
    wintypes.HANDLE,  # hFindVolume : HANDLE in/out
    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')
FindNextVolumeW = Fiddle::Function.new(
  lib['FindNextVolumeW'],
  [
    Fiddle::TYPE_VOIDP,  # hFindVolume : HANDLE in/out
    Fiddle::TYPE_VOIDP,  # lpszVolumeName : LPWSTR out
    -Fiddle::TYPE_INT,  # cchBufferLength : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn FindNextVolumeW(
        hFindVolume: *mut core::ffi::c_void,  // HANDLE in/out
        lpszVolumeName: *mut u16,  // LPWSTR 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.Unicode, SetLastError = true)]
public static extern bool FindNextVolumeW(IntPtr hFindVolume, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszVolumeName, uint cchBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FindNextVolumeW' -Namespace Win32 -PassThru
# $api::FindNextVolumeW(hFindVolume, lpszVolumeName, cchBufferLength)
#uselib "KERNEL32.dll"
#func global FindNextVolumeW "FindNextVolumeW" wptr, wptr, wptr
; FindNextVolumeW hFindVolume, varptr(lpszVolumeName), cchBufferLength   ; 戻り値は stat
; hFindVolume : HANDLE in/out -> "wptr"
; lpszVolumeName : LPWSTR out -> "wptr"
; cchBufferLength : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global FindNextVolumeW "FindNextVolumeW" sptr, var, int
; res = FindNextVolumeW(hFindVolume, lpszVolumeName, cchBufferLength)
; hFindVolume : HANDLE in/out -> "sptr"
; lpszVolumeName : LPWSTR out -> "var"
; cchBufferLength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL FindNextVolumeW(HANDLE hFindVolume, LPWSTR lpszVolumeName, DWORD cchBufferLength)
#uselib "KERNEL32.dll"
#cfunc global FindNextVolumeW "FindNextVolumeW" intptr, var, int
; res = FindNextVolumeW(hFindVolume, lpszVolumeName, cchBufferLength)
; hFindVolume : HANDLE in/out -> "intptr"
; lpszVolumeName : LPWSTR out -> "var"
; cchBufferLength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procFindNextVolumeW = kernel32.NewProc("FindNextVolumeW")
)

// hFindVolume (HANDLE in/out), lpszVolumeName (LPWSTR out), cchBufferLength (DWORD)
r1, _, err := procFindNextVolumeW.Call(
	uintptr(hFindVolume),
	uintptr(lpszVolumeName),
	uintptr(cchBufferLength),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FindNextVolumeW(
  hFindVolume: THandle;   // HANDLE in/out
  lpszVolumeName: PWideChar;   // LPWSTR out
  cchBufferLength: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'FindNextVolumeW';
result := DllCall("KERNEL32\FindNextVolumeW"
    , "Ptr", hFindVolume   ; HANDLE in/out
    , "Ptr", lpszVolumeName   ; LPWSTR out
    , "UInt", cchBufferLength   ; DWORD
    , "Int")   ; return: BOOL
●FindNextVolumeW(hFindVolume, lpszVolumeName, cchBufferLength) = DLL("KERNEL32.dll", "bool FindNextVolumeW(void*, char*, dword)")
# 呼び出し: FindNextVolumeW(hFindVolume, lpszVolumeName, cchBufferLength)
# hFindVolume : HANDLE in/out -> "void*"
# lpszVolumeName : LPWSTR out -> "char*"
# cchBufferLength : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn FindNextVolumeW(
    hFindVolume: ?*anyopaque, // HANDLE in/out
    lpszVolumeName: [*c]u16, // LPWSTR out
    cchBufferLength: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc FindNextVolumeW(
    hFindVolume: pointer,  # HANDLE in/out
    lpszVolumeName: ptr uint16,  # LPWSTR out
    cchBufferLength: uint32  # DWORD
): int32 {.importc: "FindNextVolumeW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int FindNextVolumeW(
    void* hFindVolume,   // HANDLE in/out
    wchar* lpszVolumeName,   // LPWSTR out
    uint cchBufferLength   // DWORD
);
ccall((:FindNextVolumeW, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{UInt16}, UInt32),
      hFindVolume, lpszVolumeName, cchBufferLength)
# hFindVolume : HANDLE in/out -> Ptr{Cvoid}
# lpszVolumeName : LPWSTR out -> Ptr{UInt16}
# cchBufferLength : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t FindNextVolumeW(
    void* hFindVolume,
    uint16_t* lpszVolumeName,
    uint32_t cchBufferLength);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.FindNextVolumeW(hFindVolume, lpszVolumeName, cchBufferLength)
-- hFindVolume : HANDLE in/out
-- lpszVolumeName : LPWSTR out
-- cchBufferLength : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const FindNextVolumeW = lib.func('__stdcall', 'FindNextVolumeW', 'int32_t', ['void *', 'uint16_t *', 'uint32_t']);
// FindNextVolumeW(hFindVolume, lpszVolumeName, cchBufferLength)
// hFindVolume : HANDLE in/out -> 'void *'
// lpszVolumeName : LPWSTR out -> 'uint16_t *'
// cchBufferLength : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  FindNextVolumeW: { parameters: ["pointer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.FindNextVolumeW(hFindVolume, lpszVolumeName, cchBufferLength)
// hFindVolume : HANDLE in/out -> "pointer"
// lpszVolumeName : LPWSTR out -> "buffer"
// cchBufferLength : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FindNextVolumeW(
    void* hFindVolume,
    uint16_t* lpszVolumeName,
    uint32_t cchBufferLength);
C, "KERNEL32.dll");
// $ffi->FindNextVolumeW(hFindVolume, lpszVolumeName, cchBufferLength);
// hFindVolume : HANDLE in/out
// lpszVolumeName : LPWSTR out
// cchBufferLength : DWORD
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.UNICODE_OPTIONS);
    boolean FindNextVolumeW(
        Pointer hFindVolume,   // HANDLE in/out
        char[] lpszVolumeName,   // LPWSTR out
        int cchBufferLength   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun FindNextVolumeW = FindNextVolumeW(
    hFindVolume : Void*,   # HANDLE in/out
    lpszVolumeName : UInt16*,   # LPWSTR out
    cchBufferLength : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FindNextVolumeWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32);
typedef FindNextVolumeWDart = int Function(Pointer<Void>, Pointer<Utf16>, int);
final FindNextVolumeW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<FindNextVolumeWNative, FindNextVolumeWDart>('FindNextVolumeW');
// hFindVolume : HANDLE in/out -> Pointer<Void>
// lpszVolumeName : LPWSTR out -> Pointer<Utf16>
// cchBufferLength : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FindNextVolumeW(
  hFindVolume: THandle;   // HANDLE in/out
  lpszVolumeName: PWideChar;   // LPWSTR out
  cchBufferLength: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'FindNextVolumeW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FindNextVolumeW"
  c_FindNextVolumeW :: Ptr () -> CWString -> Word32 -> IO CInt
-- hFindVolume : HANDLE in/out -> Ptr ()
-- lpszVolumeName : LPWSTR out -> CWString
-- cchBufferLength : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let findnextvolumew =
  foreign "FindNextVolumeW"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* hFindVolume : HANDLE in/out -> (ptr void) *)
(* lpszVolumeName : LPWSTR out -> (ptr uint16_t) *)
(* cchBufferLength : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("FindNextVolumeW" find-next-volume-w :convention :stdcall) :int32
  (h-find-volume :pointer)   ; HANDLE in/out
  (lpsz-volume-name :pointer)   ; LPWSTR out
  (cch-buffer-length :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FindNextVolumeW = Win32::API::More->new('KERNEL32',
    'BOOL FindNextVolumeW(HANDLE hFindVolume, LPWSTR lpszVolumeName, DWORD cchBufferLength)');
# my $ret = $FindNextVolumeW->Call($hFindVolume, $lpszVolumeName, $cchBufferLength);
# hFindVolume : HANDLE in/out -> HANDLE
# lpszVolumeName : LPWSTR out -> LPWSTR
# cchBufferLength : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目