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

GetVolumePathNamesForVolumeNameW

関数
ボリューム名に対応するマウントパス一覧を取得する。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL GetVolumePathNamesForVolumeNameW(
    LPCWSTR lpszVolumeName,
    LPWSTR lpszVolumePathNames,   // optional
    DWORD cchBufferLength,
    DWORD* lpcchReturnLength
);

パラメーター

名前方向説明
lpszVolumeNameLPCWSTRinボリュームを表すボリューム GUID パス。ボリューム GUID パスは "\\?\Volume{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}\" の形式です。
lpszVolumePathNamesLPWSTRoutoptionalドライブ文字とマウントされたフォルダーパスの一覧を受け取るバッファーへのポインター。一覧は null 終端文字列の配列で、末尾にもう 1 つの NULL 文字が付加されて終端されます。バッファーが一覧全体を保持するのに十分な大きさでない場合、バッファーには可能な限りの一覧が保持されます。
cchBufferLengthDWORDinlpszVolumePathNames バッファーの長さ。すべての NULL 文字を含み、 WCHAR 単位で指定します。
lpcchReturnLengthDWORD*out呼び出しが成功した場合、このパラメーターには lpszVolumePathNames バッファーに コピーされた WCHAR の数が格納されます。それ以外の場合、このパラメーターには一覧全体を保持するために 必要なバッファーのサイズが WCHAR 単位で格納されます。

戻り値の型: BOOL

公式ドキュメント

指定したボリュームのドライブ文字とマウントされたフォルダーパスの一覧を取得します。(GetVolumePathNamesForVolumeNameW)

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。バッファーが一覧全体を保持するのに十分な大きさでない場合、 エラーコードは ERROR_MORE_DATA となり、 lpcchReturnLength パラメーターには必要なバッファーサイズが格納されます。

解説(Remarks)

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  (Unicode / -W)
#include <windows.h>

BOOL GetVolumePathNamesForVolumeNameW(
    LPCWSTR lpszVolumeName,
    LPWSTR lpszVolumePathNames,   // optional
    DWORD cchBufferLength,
    DWORD* lpcchReturnLength
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetVolumePathNamesForVolumeNameW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszVolumeName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszVolumePathNames,   // LPWSTR optional, out
    uint cchBufferLength,   // DWORD
    out uint lpcchReturnLength   // DWORD* out
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetVolumePathNamesForVolumeNameW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszVolumeName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpszVolumePathNames As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchBufferLength As UInteger,   ' DWORD
    <Out> ByRef lpcchReturnLength As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpszVolumeName : LPCWSTR
' lpszVolumePathNames : LPWSTR optional, out
' cchBufferLength : DWORD
' lpcchReturnLength : DWORD* out
Declare PtrSafe Function GetVolumePathNamesForVolumeNameW Lib "kernel32" ( _
    ByVal lpszVolumeName As LongPtr, _
    ByVal lpszVolumePathNames As LongPtr, _
    ByVal cchBufferLength As Long, _
    ByRef lpcchReturnLength 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

GetVolumePathNamesForVolumeNameW = ctypes.windll.kernel32.GetVolumePathNamesForVolumeNameW
GetVolumePathNamesForVolumeNameW.restype = wintypes.BOOL
GetVolumePathNamesForVolumeNameW.argtypes = [
    wintypes.LPCWSTR,  # lpszVolumeName : LPCWSTR
    wintypes.LPWSTR,  # lpszVolumePathNames : LPWSTR optional, out
    wintypes.DWORD,  # cchBufferLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpcchReturnLength : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetVolumePathNamesForVolumeNameW = Fiddle::Function.new(
  lib['GetVolumePathNamesForVolumeNameW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszVolumeName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpszVolumePathNames : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # cchBufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # lpcchReturnLength : DWORD* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn GetVolumePathNamesForVolumeNameW(
        lpszVolumeName: *const u16,  // LPCWSTR
        lpszVolumePathNames: *mut u16,  // LPWSTR optional, out
        cchBufferLength: u32,  // DWORD
        lpcchReturnLength: *mut u32  // DWORD* out
    ) -> 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 GetVolumePathNamesForVolumeNameW([MarshalAs(UnmanagedType.LPWStr)] string lpszVolumeName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszVolumePathNames, uint cchBufferLength, out uint lpcchReturnLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetVolumePathNamesForVolumeNameW' -Namespace Win32 -PassThru
# $api::GetVolumePathNamesForVolumeNameW(lpszVolumeName, lpszVolumePathNames, cchBufferLength, lpcchReturnLength)
#uselib "KERNEL32.dll"
#func global GetVolumePathNamesForVolumeNameW "GetVolumePathNamesForVolumeNameW" wptr, wptr, wptr, wptr
; GetVolumePathNamesForVolumeNameW lpszVolumeName, varptr(lpszVolumePathNames), cchBufferLength, varptr(lpcchReturnLength)   ; 戻り値は stat
; lpszVolumeName : LPCWSTR -> "wptr"
; lpszVolumePathNames : LPWSTR optional, out -> "wptr"
; cchBufferLength : DWORD -> "wptr"
; lpcchReturnLength : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetVolumePathNamesForVolumeNameW "GetVolumePathNamesForVolumeNameW" wstr, var, int, var
; res = GetVolumePathNamesForVolumeNameW(lpszVolumeName, lpszVolumePathNames, cchBufferLength, lpcchReturnLength)
; lpszVolumeName : LPCWSTR -> "wstr"
; lpszVolumePathNames : LPWSTR optional, out -> "var"
; cchBufferLength : DWORD -> "int"
; lpcchReturnLength : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetVolumePathNamesForVolumeNameW(LPCWSTR lpszVolumeName, LPWSTR lpszVolumePathNames, DWORD cchBufferLength, DWORD* lpcchReturnLength)
#uselib "KERNEL32.dll"
#cfunc global GetVolumePathNamesForVolumeNameW "GetVolumePathNamesForVolumeNameW" wstr, var, int, var
; res = GetVolumePathNamesForVolumeNameW(lpszVolumeName, lpszVolumePathNames, cchBufferLength, lpcchReturnLength)
; lpszVolumeName : LPCWSTR -> "wstr"
; lpszVolumePathNames : LPWSTR optional, out -> "var"
; cchBufferLength : DWORD -> "int"
; lpcchReturnLength : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetVolumePathNamesForVolumeNameW = kernel32.NewProc("GetVolumePathNamesForVolumeNameW")
)

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

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

typedef GetVolumePathNamesForVolumeNameWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32, Pointer<Uint32>);
typedef GetVolumePathNamesForVolumeNameWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int, Pointer<Uint32>);
final GetVolumePathNamesForVolumeNameW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetVolumePathNamesForVolumeNameWNative, GetVolumePathNamesForVolumeNameWDart>('GetVolumePathNamesForVolumeNameW');
// lpszVolumeName : LPCWSTR -> Pointer<Utf16>
// lpszVolumePathNames : LPWSTR optional, out -> Pointer<Utf16>
// cchBufferLength : DWORD -> Uint32
// lpcchReturnLength : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetVolumePathNamesForVolumeNameW(
  lpszVolumeName: PWideChar;   // LPCWSTR
  lpszVolumePathNames: PWideChar;   // LPWSTR optional, out
  cchBufferLength: DWORD;   // DWORD
  lpcchReturnLength: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetVolumePathNamesForVolumeNameW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetVolumePathNamesForVolumeNameW"
  c_GetVolumePathNamesForVolumeNameW :: CWString -> CWString -> Word32 -> Ptr Word32 -> IO CInt
-- lpszVolumeName : LPCWSTR -> CWString
-- lpszVolumePathNames : LPWSTR optional, out -> CWString
-- cchBufferLength : DWORD -> Word32
-- lpcchReturnLength : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getvolumepathnamesforvolumenamew =
  foreign "GetVolumePathNamesForVolumeNameW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* lpszVolumeName : LPCWSTR -> (ptr uint16_t) *)
(* lpszVolumePathNames : LPWSTR optional, out -> (ptr uint16_t) *)
(* cchBufferLength : DWORD -> uint32_t *)
(* lpcchReturnLength : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetVolumePathNamesForVolumeNameW" get-volume-path-names-for-volume-name-w :convention :stdcall) :int32
  (lpsz-volume-name (:string :encoding :utf-16le))   ; LPCWSTR
  (lpsz-volume-path-names :pointer)   ; LPWSTR optional, out
  (cch-buffer-length :uint32)   ; DWORD
  (lpcch-return-length :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetVolumePathNamesForVolumeNameW = Win32::API::More->new('KERNEL32',
    'BOOL GetVolumePathNamesForVolumeNameW(LPCWSTR lpszVolumeName, LPWSTR lpszVolumePathNames, DWORD cchBufferLength, LPVOID lpcchReturnLength)');
# my $ret = $GetVolumePathNamesForVolumeNameW->Call($lpszVolumeName, $lpszVolumePathNames, $cchBufferLength, $lpcchReturnLength);
# lpszVolumeName : LPCWSTR -> LPCWSTR
# lpszVolumePathNames : LPWSTR optional, out -> LPWSTR
# cchBufferLength : DWORD -> DWORD
# lpcchReturnLength : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い