ホーム › Storage.FileSystem › FindNextVolumeMountPointW

FindNextVolumeMountPointW

関数

マウントポイント列挙で次の項目を取得する(Unicode版)。

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

シグネチャ

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

BOOL FindNextVolumeMountPointW(
    HANDLE hFindVolumeMountPoint,
    LPWSTR lpszVolumeMountPoint,
    DWORD cchBufferLength
);

パラメーター

名前	型	方向	説明
hFindVolumeMountPoint	HANDLE	in	前回の FindFirstVolumeMountPoint 関数の呼び出しによって返された、マウントされたフォルダーの検索ハンドル。
lpszVolumeMountPoint	LPWSTR	out	見つかった、マウントされたフォルダーの名前を受け取るバッファーへのポインター。
cchBufferLength	DWORD	in	マウントされたフォルダー名を受け取るバッファーの長さ( TCHAR 単位)。

戻り値の型: BOOL

公式ドキュメント

FindFirstVolumeMountPoint 関数の呼び出しによって開始されたマウントされたフォルダーの検索を続行します。(Unicode)

戻り値

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

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。マウントされたフォルダーがこれ以上見つからない場合、 GetLastError 関数は ERROR_NO_MORE_FILES エラーコードを返します。その場合は、 FindVolumeMountPointClose 関数で検索を終了します。

解説(Remarks)

FindFirstVolumeMountPoint を呼び出して検索ハンドルを確立した後、 FindNextVolumeMountPoint 関数を使用して他のマウントされたフォルダーを検索できます。

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

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

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 はボリューム管理関数をサポートしていません。CsvFS は CSV ボリューム上でのマウントポイントの追加をサポートしていません。 ReFS はマウントポイントをインデックス化しません。

メモ

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

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

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool FindNextVolumeMountPointW(
    IntPtr hFindVolumeMountPoint,   // HANDLE
    [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 FindNextVolumeMountPointW(
    hFindVolumeMountPoint As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> lpszVolumeMountPoint As System.Text.StringBuilder,   ' LPWSTR out
    cchBufferLength As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

FindNextVolumeMountPointW = ctypes.windll.kernel32.FindNextVolumeMountPointW
FindNextVolumeMountPointW.restype = wintypes.BOOL
FindNextVolumeMountPointW.argtypes = [
    wintypes.HANDLE,  # hFindVolumeMountPoint : HANDLE
    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')
FindNextVolumeMountPointW = Fiddle::Function.new(
  lib['FindNextVolumeMountPointW'],
  [
    Fiddle::TYPE_VOIDP,  # hFindVolumeMountPoint : HANDLE
    Fiddle::TYPE_VOIDP,  # lpszVolumeMountPoint : 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 FindNextVolumeMountPointW(
        hFindVolumeMountPoint: *mut core::ffi::c_void,  // HANDLE
        lpszVolumeMountPoint: *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 FindNextVolumeMountPointW(IntPtr hFindVolumeMountPoint, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszVolumeMountPoint, uint cchBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FindNextVolumeMountPointW' -Namespace Win32 -PassThru
# $api::FindNextVolumeMountPointW(hFindVolumeMountPoint, lpszVolumeMountPoint, cchBufferLength)

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

出力引数:

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