ホーム › Storage.FileSystem › GetVolumeNameForVolumeMountPointA

GetVolumeNameForVolumeMountPointA

関数

マウントポイントから一意のボリューム名を取得する(ANSI版)。

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

シグネチャ

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

BOOL GetVolumeNameForVolumeMountPointA(
    LPCSTR lpszVolumeMountPoint,
    LPSTR lpszVolumeName,
    DWORD cchBufferLength
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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 はボリューム管理関数をサポートしていません。

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

BOOL GetVolumeNameForVolumeMountPointA(
    LPCSTR lpszVolumeMountPoint,
    LPSTR lpszVolumeName,
    DWORD cchBufferLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetVolumeNameForVolumeMountPointA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszVolumeMountPoint,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszVolumeName,   // LPSTR out
    uint cchBufferLength   // DWORD
);

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

' lpszVolumeMountPoint : LPCSTR
' lpszVolumeName : LPSTR out
' cchBufferLength : DWORD
Declare PtrSafe Function GetVolumeNameForVolumeMountPointA Lib "kernel32" ( _
    ByVal lpszVolumeMountPoint As String, _
    ByVal lpszVolumeName As String, _
    ByVal cchBufferLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

#[link(name = "kernel32")]
extern "system" {
    fn GetVolumeNameForVolumeMountPointA(
        lpszVolumeMountPoint: *const u8,  // LPCSTR
        lpszVolumeName: *mut u8,  // LPSTR 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.Ansi, SetLastError = true)]
public static extern bool GetVolumeNameForVolumeMountPointA([MarshalAs(UnmanagedType.LPStr)] string lpszVolumeMountPoint, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszVolumeName, uint cchBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetVolumeNameForVolumeMountPointA' -Namespace Win32 -PassThru
# $api::GetVolumeNameForVolumeMountPointA(lpszVolumeMountPoint, lpszVolumeName, cchBufferLength)

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

出力引数:

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