ホーム › Storage.FileSystem › FindFirstVolumeMountPointW

FindFirstVolumeMountPointW

関数

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

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

シグネチャ

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

HANDLE FindFirstVolumeMountPointW(
    LPCWSTR lpszRootPathName,
    LPWSTR lpszVolumeMountPoint,
    DWORD cchBufferLength
);

パラメーター

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

戻り値の型: HANDLE

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

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

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 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。

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

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

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

' lpszRootPathName : LPCWSTR
' lpszVolumeMountPoint : LPWSTR out
' cchBufferLength : DWORD
Declare PtrSafe Function FindFirstVolumeMountPointW Lib "kernel32" ( _
    ByVal lpszRootPathName As LongPtr, _
    ByVal lpszVolumeMountPoint 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

FindFirstVolumeMountPointW = ctypes.windll.kernel32.FindFirstVolumeMountPointW
FindFirstVolumeMountPointW.restype = ctypes.c_void_p
FindFirstVolumeMountPointW.argtypes = [
    wintypes.LPCWSTR,  # lpszRootPathName : LPCWSTR
    wintypes.LPWSTR,  # lpszVolumeMountPoint : 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')
FindFirstVolumeMountPointW = Fiddle::Function.new(
  lib['FindFirstVolumeMountPointW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszRootPathName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpszVolumeMountPoint : 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 FindFirstVolumeMountPointW(
        lpszRootPathName: *const u16,  // LPCWSTR
        lpszVolumeMountPoint: *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 FindFirstVolumeMountPointW([MarshalAs(UnmanagedType.LPWStr)] string lpszRootPathName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszVolumeMountPoint, uint cchBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FindFirstVolumeMountPointW' -Namespace Win32 -PassThru
# $api::FindFirstVolumeMountPointW(lpszRootPathName, lpszVolumeMountPoint, cchBufferLength)

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

出力引数:

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