ホーム › Storage.FileSystem › GetVolumeNameForVolumeMountPointW

GetVolumeNameForVolumeMountPointW

関数

マウントポイントから一意なボリューム名を取得する。

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

シグネチャ

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

BOOL GetVolumeNameForVolumeMountPointW(
    LPCWSTR lpszVolumeMountPoint,
    LPWSTR lpszVolumeName,
    DWORD cchBufferLength
);

パラメーター

名前	型	方向	説明
lpszVolumeMountPoint	LPCWSTR	in	マウントされたフォルダーのパス(例: "Y:\MountX\")またはドライブ文字(例: "X:\")を含む文字列へのポインターです。この文字列は末尾のバックスラッシュ('\')で終わる必要があります。
lpszVolumeName	LPWSTR	out	ボリューム GUID パスを受け取る文字列へのポインターです。このパスは "\\?\Volume{GUID}\" の形式で、GUID はボリュームを識別する GUID です。ボリュームに対して複数のボリューム GUID パスが存在する場合は、マウントマネージャーのキャッシュ内の最初のものだけが返されます。
cchBufferLength	DWORD	in	出力バッファーの長さ(TCHAR 単位)です。最大のボリューム GUID パスを格納できる妥当なバッファーサイズは 50 文字です。

戻り値の型: BOOL

公式ドキュメント

指定したボリュームマウントポイント(ドライブ文字、ボリューム GUID パス、またはマウントされたフォルダー)に関連付けられたボリュームのボリューム GUID パスを取得します。(GetVolumeNameForVolumeMountPointW)

戻り値

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

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

ボリューム GUID パスを入力パラメーターとして必要とする SetVolumeMountPoint や FindFirstVolumeMountPoint などの関数で使用するボリューム GUID パスを取得するには、 GetVolumeNameForVolumeMountPoint を使用します。ボリューム GUID パスの詳細については、ボリュームの名前付けを参照してください。

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

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

SMB はボリューム管理関数をサポートしていません。

マウントポイントは ReFS ボリュームではサポートされていません。

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

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetVolumeNameForVolumeMountPointW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszVolumeMountPoint,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszVolumeName,   // LPWSTR out
    uint cchBufferLength   // DWORD
);

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

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

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

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

出力引数:

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