ホーム › Storage.FileSystem › GetLogicalDriveStringsW

GetLogicalDriveStringsW

関数

論理ドライブのルートパス文字列群を取得する。

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

シグネチャ

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

DWORD GetLogicalDriveStringsW(
    DWORD nBufferLength,
    LPWSTR lpBuffer   // optional
);

パラメーター

名前	型	方向	説明
nBufferLength	DWORD	in	lpBuffer が指す先のバッファーの最大サイズ（TCHAR 単位）。この値には終端の null 文字分の領域も含まれます。このパラメーターが 0 の場合、lpBuffer は使用されません。
lpBuffer	LPWSTR	outoptional	システム内の有効な各ドライブに対応する、null 終端文字列の連続を受け取るバッファーへのポインター。末尾にはさらに追加の null 文字が付きます。各文字列はデバイス名です。

戻り値の型: DWORD

公式ドキュメント

システム内の有効なドライブを指定する文字列でバッファーを埋めます。(GetLogicalDriveStringsW)

戻り値

関数が成功した場合、戻り値はバッファーにコピーされた文字列の長さ（文字単位）で、終端の null 文字は含まれません。ANSI-ASCII の null 文字は 1 バイトを使用しますが、Unicode (UTF-16) の null 文字は 2 バイトを使用する点に注意してください。

バッファーが十分な大きさでない場合、戻り値は nBufferLength より大きくなります。これはドライブ文字列を保持するために必要なバッファーのサイズです。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError 関数を使用します。

解説(Remarks)

バッファー内の各文字列は、GetDriveType 関数や GetDiskFreeSpace 関数など、ルートディレクトリが必要とされる場面で使用できます。

この関数は、グローバルおよびローカルの MS-DOS デバイス名前空間にあるドライブを連結して返します。ドライブが両方の名前空間に存在する場合、この関数はローカルの MS-DOS デバイス名前空間のエントリを返します。詳細については、Defining an MS DOS Device Name を参照してください。

Windows 8 および Windows Server 2012 では、この関数は次の技術でサポートされています。

技術	サポート状況
Server Message Block (SMB) 3.0 プロトコル	いいえ
SMB 3.0 トランスペアレントフェールオーバー (TFO)	いいえ
SMB 3.0 スケールアウトファイル共有 (SO)	いいえ
クラスター共有ボリュームファイルシステム (CsvFS)	はい
回復性のあるファイルシステム (ReFS)	はい

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

例

例については、Obtaining a File Name From a File Handle を参照してください。

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

DWORD GetLogicalDriveStringsW(
    DWORD nBufferLength,
    LPWSTR lpBuffer   // optional
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetLogicalDriveStringsW(
    uint nBufferLength,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer   // LPWSTR optional, out
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetLogicalDriveStringsW(
    nBufferLength As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpBuffer As System.Text.StringBuilder   ' LPWSTR optional, out
) As UInteger
End Function

' nBufferLength : DWORD
' lpBuffer : LPWSTR optional, out
Declare PtrSafe Function GetLogicalDriveStringsW Lib "kernel32" ( _
    ByVal nBufferLength As Long, _
    ByVal lpBuffer As LongPtr) 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

GetLogicalDriveStringsW = ctypes.windll.kernel32.GetLogicalDriveStringsW
GetLogicalDriveStringsW.restype = wintypes.DWORD
GetLogicalDriveStringsW.argtypes = [
    wintypes.DWORD,  # nBufferLength : DWORD
    wintypes.LPWSTR,  # lpBuffer : LPWSTR optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetLogicalDriveStringsW = Fiddle::Function.new(
  lib['GetLogicalDriveStringsW'],
  [
    -Fiddle::TYPE_INT,  # nBufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPWSTR optional, out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn GetLogicalDriveStringsW(
        nBufferLength: u32,  // DWORD
        lpBuffer: *mut u16  // LPWSTR optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint GetLogicalDriveStringsW(uint nBufferLength, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetLogicalDriveStringsW' -Namespace Win32 -PassThru
# $api::GetLogicalDriveStringsW(nBufferLength, lpBuffer)

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

出力引数:

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