ホーム › Storage.FileSystem › GetLogicalDriveStringsA

GetLogicalDriveStringsA

関数

システム上の有効な論理ドライブの文字列一覧を取得する(ANSI版)。

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

シグネチャ

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

DWORD GetLogicalDriveStringsA(
    DWORD nBufferLength,
    LPSTR lpBuffer   // optional
);

パラメーター

名前	型	方向	説明
nBufferLength	DWORD	in	lpBuffer が指す buffer の最大サイズ(TCHAR 単位)。このサイズには終端の null 文字は含まれません。このパラメーターが 0 の場合、lpBuffer は使用されません。
lpBuffer	LPSTR	outoptional	システム内の各有効ドライブに対応する一連の null 終端文字列に加えて、さらに 1 つの null 文字を受け取る buffer へのポインター。各文字列はデバイス名です。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は buffer にコピーされた文字列の長さ(文字数)で、終端の null 文字は含まれません。なお、ANSI-ASCII の null 文字は 1 バイトを使用しますが、Unicode (UTF-16) の null 文字は 2 バイトを使用します。

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

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

解説(Remarks)

buffer 内の各文字列は、GetDriveType 関数や GetDiskFreeSpace 関数のように、ルートディレクトリが必要となる任意の場所で使用できます。

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

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

例

例については、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  (ANSI / -A)
#include <windows.h>

DWORD GetLogicalDriveStringsA(
    DWORD nBufferLength,
    LPSTR lpBuffer   // optional
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint GetLogicalDriveStringsA(
    uint nBufferLength,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpBuffer   // LPSTR optional, out
);

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetLogicalDriveStringsA = Fiddle::Function.new(
  lib['GetLogicalDriveStringsA'],
  [
    -Fiddle::TYPE_INT,  # nBufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPSTR optional, out
  ],
  -Fiddle::TYPE_INT)

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

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

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

出力引数:

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