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

FindFirstVolumeA

関数
システム上のボリューム列挙を開始する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

HANDLE FindFirstVolumeA(
    LPSTR lpszVolumeName,
    DWORD cchBufferLength
);

パラメーター

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

戻り値の型: HANDLE

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は検索ハンドルであり、以降の 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  (ANSI / -A)
#include <windows.h>

HANDLE FindFirstVolumeA(
    LPSTR lpszVolumeName,
    DWORD cchBufferLength
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr FindFirstVolumeA(
    [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 FindFirstVolumeA(
    <MarshalAs(UnmanagedType.LPStr)> lpszVolumeName As System.Text.StringBuilder,   ' LPSTR out
    cchBufferLength As UInteger   ' DWORD
) As IntPtr
End Function
' lpszVolumeName : LPSTR out
' cchBufferLength : DWORD
Declare PtrSafe Function FindFirstVolumeA Lib "kernel32" ( _
    ByVal lpszVolumeName As String, _
    ByVal cchBufferLength As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FindFirstVolumeA = ctypes.windll.kernel32.FindFirstVolumeA
FindFirstVolumeA.restype = ctypes.c_void_p
FindFirstVolumeA.argtypes = [
    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')
FindFirstVolumeA = Fiddle::Function.new(
  lib['FindFirstVolumeA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszVolumeName : LPSTR out
    -Fiddle::TYPE_INT,  # cchBufferLength : DWORD
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn FindFirstVolumeA(
        lpszVolumeName: *mut u8,  // LPSTR 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.Ansi, SetLastError = true)]
public static extern IntPtr FindFirstVolumeA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszVolumeName, uint cchBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FindFirstVolumeA' -Namespace Win32 -PassThru
# $api::FindFirstVolumeA(lpszVolumeName, cchBufferLength)
#uselib "KERNEL32.dll"
#func global FindFirstVolumeA "FindFirstVolumeA" sptr, sptr
; FindFirstVolumeA varptr(lpszVolumeName), cchBufferLength   ; 戻り値は stat
; lpszVolumeName : LPSTR out -> "sptr"
; cchBufferLength : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global FindFirstVolumeA "FindFirstVolumeA" var, int
; res = FindFirstVolumeA(lpszVolumeName, cchBufferLength)
; lpszVolumeName : LPSTR out -> "var"
; cchBufferLength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HANDLE FindFirstVolumeA(LPSTR lpszVolumeName, DWORD cchBufferLength)
#uselib "KERNEL32.dll"
#cfunc global FindFirstVolumeA "FindFirstVolumeA" var, int
; res = FindFirstVolumeA(lpszVolumeName, cchBufferLength)
; lpszVolumeName : LPSTR out -> "var"
; cchBufferLength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procFindFirstVolumeA = kernel32.NewProc("FindFirstVolumeA")
)

// lpszVolumeName (LPSTR out), cchBufferLength (DWORD)
r1, _, err := procFindFirstVolumeA.Call(
	uintptr(lpszVolumeName),
	uintptr(cchBufferLength),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function FindFirstVolumeA(
  lpszVolumeName: PAnsiChar;   // LPSTR out
  cchBufferLength: DWORD   // DWORD
): THandle; stdcall;
  external 'KERNEL32.dll' name 'FindFirstVolumeA';
result := DllCall("KERNEL32\FindFirstVolumeA"
    , "Ptr", lpszVolumeName   ; LPSTR out
    , "UInt", cchBufferLength   ; DWORD
    , "Ptr")   ; return: HANDLE
●FindFirstVolumeA(lpszVolumeName, cchBufferLength) = DLL("KERNEL32.dll", "void* FindFirstVolumeA(char*, dword)")
# 呼び出し: FindFirstVolumeA(lpszVolumeName, cchBufferLength)
# lpszVolumeName : LPSTR out -> "char*"
# cchBufferLength : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn FindFirstVolumeA(
    lpszVolumeName: [*c]u8, // LPSTR out
    cchBufferLength: u32 // DWORD
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc FindFirstVolumeA(
    lpszVolumeName: ptr char,  # LPSTR out
    cchBufferLength: uint32  # DWORD
): pointer {.importc: "FindFirstVolumeA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
void* FindFirstVolumeA(
    char* lpszVolumeName,   // LPSTR out
    uint cchBufferLength   // DWORD
);
ccall((:FindFirstVolumeA, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
      (Ptr{UInt8}, UInt32),
      lpszVolumeName, cchBufferLength)
# lpszVolumeName : LPSTR out -> Ptr{UInt8}
# cchBufferLength : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* FindFirstVolumeA(
    char* lpszVolumeName,
    uint32_t cchBufferLength);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.FindFirstVolumeA(lpszVolumeName, cchBufferLength)
-- lpszVolumeName : LPSTR out
-- cchBufferLength : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const FindFirstVolumeA = lib.func('__stdcall', 'FindFirstVolumeA', 'void *', ['char *', 'uint32_t']);
// FindFirstVolumeA(lpszVolumeName, cchBufferLength)
// lpszVolumeName : LPSTR out -> 'char *'
// cchBufferLength : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  FindFirstVolumeA: { parameters: ["buffer", "u32"], result: "pointer" },
});
// lib.symbols.FindFirstVolumeA(lpszVolumeName, cchBufferLength)
// lpszVolumeName : LPSTR out -> "buffer"
// cchBufferLength : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* FindFirstVolumeA(
    char* lpszVolumeName,
    uint32_t cchBufferLength);
C, "KERNEL32.dll");
// $ffi->FindFirstVolumeA(lpszVolumeName, cchBufferLength);
// lpszVolumeName : LPSTR 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.ASCII_OPTIONS);
    Pointer FindFirstVolumeA(
        byte[] lpszVolumeName,   // LPSTR out
        int cchBufferLength   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun FindFirstVolumeA = FindFirstVolumeA(
    lpszVolumeName : UInt8*,   # LPSTR out
    cchBufferLength : UInt32   # DWORD
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FindFirstVolumeANative = Pointer<Void> Function(Pointer<Utf8>, Uint32);
typedef FindFirstVolumeADart = Pointer<Void> Function(Pointer<Utf8>, int);
final FindFirstVolumeA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<FindFirstVolumeANative, FindFirstVolumeADart>('FindFirstVolumeA');
// lpszVolumeName : LPSTR out -> Pointer<Utf8>
// cchBufferLength : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FindFirstVolumeA(
  lpszVolumeName: PAnsiChar;   // LPSTR out
  cchBufferLength: DWORD   // DWORD
): THandle; stdcall;
  external 'KERNEL32.dll' name 'FindFirstVolumeA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FindFirstVolumeA"
  c_FindFirstVolumeA :: CString -> Word32 -> IO (Ptr ())
-- lpszVolumeName : LPSTR out -> CString
-- cchBufferLength : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let findfirstvolumea =
  foreign "FindFirstVolumeA"
    (string @-> uint32_t @-> returning (ptr void))
(* lpszVolumeName : LPSTR out -> string *)
(* 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 ("FindFirstVolumeA" find-first-volume-a :convention :stdcall) :pointer
  (lpsz-volume-name :pointer)   ; LPSTR out
  (cch-buffer-length :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FindFirstVolumeA = Win32::API::More->new('KERNEL32',
    'HANDLE FindFirstVolumeA(LPSTR lpszVolumeName, DWORD cchBufferLength)');
# my $ret = $FindFirstVolumeA->Call($lpszVolumeName, $cchBufferLength);
# lpszVolumeName : LPSTR out -> LPSTR
# cchBufferLength : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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