ホーム › Storage.FileSystem › FindFirstVolumeMountPointA

FindFirstVolumeMountPointA

関数

ボリューム上のマウントポイント列挙を開始する(ANSI版)。

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

シグネチャ

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

HANDLE FindFirstVolumeMountPointA(
    LPCSTR lpszRootPathName,
    LPSTR lpszVolumeMountPoint,
    DWORD cchBufferLength
);

パラメーター

名前	型	方向	説明
lpszRootPathName	LPCSTR	in	マウントされたフォルダーをスキャンする対象ボリュームのボリューム GUID パス。末尾のバックスラッシュが必要です。
lpszVolumeMountPoint	LPSTR	out	最初に見つかったマウント済みフォルダーの名前を受け取るバッファーへのポインター。
cchBufferLength	DWORD	in	マウントされたフォルダーへのパスを受け取るバッファーの長さ( TCHAR 単位)。

戻り値の型: HANDLE

公式ドキュメント

指定したボリューム上のマウントされたフォルダーの名前を取得します。(ANSI)

戻り値

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

ボリューム上にマウントされたフォルダーが見つからず関数が失敗した場合、戻り値は INVALID_HANDLE_VALUE エラーコードになります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

FindFirstVolumeMountPoint 関数はマウントされたフォルダーの検索ハンドルを開き、指定したボリューム上で最初に見つかったマウント済みフォルダーに関する情報を返します。検索ハンドルが確立された後は、 FindNextVolumeMountPoint 関数を使用して他のマウントされたフォルダーを検索できます。検索ハンドルが不要になったら、 FindVolumeMountPointClose 関数で閉じてください。

FindFirstVolumeMountPoint、 FindNextVolumeMountPoint、および FindVolumeMountPointClose 関数は、指定したボリュームのマウント済みフォルダーへのパスを返します。これらはドライブ文字やボリューム GUID パスを返しません。ボリュームの GUID パスを列挙する方法については、 Enumerating Volume GUID Paths を参照してください。

これらの関数によって返されるマウント済みフォルダーの順序と、他の関数やツールによって返されるマウント済みフォルダーの順序との間に、何らかの相関があると想定してはなりません。

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

テクノロジ	サポート
Server Message Block (SMB) 3.0 プロトコル	いいえ
SMB 3.0 透過的フェールオーバー (TFO)	いいえ
SMB 3.0 とスケールアウトファイル共有 (SO)	いいえ
クラスター共有ボリュームファイルシステム (CsvFS)	いいえ
回復性のあるファイルシステム (ReFS)	いいえ

SMB はボリューム管理関数をサポートしていません。CsvFS は CSV ボリュームへのマウントポイントの追加をサポートしていません。 ReFS はマウントポイントをインデックス化しません。

メモ

winbase.h ヘッダーは FindFirstVolumeMountPoint を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーやランタイムエラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 FindFirstVolumeMountPointA(
    LPCSTR lpszRootPathName,
    LPSTR lpszVolumeMountPoint,
    DWORD cchBufferLength
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr FindFirstVolumeMountPointA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszRootPathName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszVolumeMountPoint,   // LPSTR out
    uint cchBufferLength   // DWORD
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindFirstVolumeMountPointA(
    <MarshalAs(UnmanagedType.LPStr)> lpszRootPathName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszVolumeMountPoint As System.Text.StringBuilder,   ' LPSTR out
    cchBufferLength As UInteger   ' DWORD
) As IntPtr
End Function

' lpszRootPathName : LPCSTR
' lpszVolumeMountPoint : LPSTR out
' cchBufferLength : DWORD
Declare PtrSafe Function FindFirstVolumeMountPointA Lib "kernel32" ( _
    ByVal lpszRootPathName As String, _
    ByVal lpszVolumeMountPoint 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

FindFirstVolumeMountPointA = ctypes.windll.kernel32.FindFirstVolumeMountPointA
FindFirstVolumeMountPointA.restype = ctypes.c_void_p
FindFirstVolumeMountPointA.argtypes = [
    wintypes.LPCSTR,  # lpszRootPathName : LPCSTR
    wintypes.LPSTR,  # lpszVolumeMountPoint : 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')
FindFirstVolumeMountPointA = Fiddle::Function.new(
  lib['FindFirstVolumeMountPointA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszRootPathName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszVolumeMountPoint : LPSTR out
    -Fiddle::TYPE_INT,  # cchBufferLength : DWORD
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "kernel32")]
extern "system" {
    fn FindFirstVolumeMountPointA(
        lpszRootPathName: *const u8,  // LPCSTR
        lpszVolumeMountPoint: *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 FindFirstVolumeMountPointA([MarshalAs(UnmanagedType.LPStr)] string lpszRootPathName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszVolumeMountPoint, uint cchBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FindFirstVolumeMountPointA' -Namespace Win32 -PassThru
# $api::FindFirstVolumeMountPointA(lpszRootPathName, lpszVolumeMountPoint, cchBufferLength)

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

出力引数:

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