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

GetLogicalDrives

関数
利用可能な論理ドライブをビットマスクで取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

DWORD GetLogicalDrives(void);

パラメーターなし。戻り値: DWORD

公式ドキュメント

現在使用可能なディスクドライブを表すビットマスクを取得します。

戻り値

関数が成功した場合、戻り値は現在使用可能なディスクドライブを表すビットマスクです。ビット位置 0(最下位ビット)はドライブ A、ビット位置 1 はドライブ B、ビット位置 2 はドライブ C、というように対応します。

関数が失敗した場合、戻り値は 0 です。詳細なエラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

なお、ここで言う「使用可能(available)」とは、ドライブ文字が既存の論理ドライブ(例: ローカルボリューム、リムーバブルメディア、マップされたネットワーク共有)に現在割り当てられていることを意味します。クリアされているビットは、現在割り当てられておらず、したがって将来のマウントポイントとして利用できるドライブ文字を示します。

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

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

DWORD GetLogicalDrives(void);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint GetLogicalDrives();
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetLogicalDrives() As UInteger
End Function
Declare PtrSafe Function GetLogicalDrives Lib "kernel32" () As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetLogicalDrives = ctypes.windll.kernel32.GetLogicalDrives
GetLogicalDrives.restype = wintypes.DWORD
GetLogicalDrives.argtypes = []
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetLogicalDrives = Fiddle::Function.new(
  lib['GetLogicalDrives'],
  [],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetLogicalDrives() -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern uint GetLogicalDrives();
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetLogicalDrives' -Namespace Win32 -PassThru
# $api::GetLogicalDrives()
#uselib "KERNEL32.dll"
#func global GetLogicalDrives "GetLogicalDrives"
; GetLogicalDrives   ; 戻り値は stat
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global GetLogicalDrives "GetLogicalDrives"
; res = GetLogicalDrives()
; DWORD GetLogicalDrives()
#uselib "KERNEL32.dll"
#cfunc global GetLogicalDrives "GetLogicalDrives"
; res = GetLogicalDrives()
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetLogicalDrives = kernel32.NewProc("GetLogicalDrives")
)

r1, _, err := procGetLogicalDrives.Call()
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetLogicalDrives: DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetLogicalDrives';
result := DllCall("KERNEL32\GetLogicalDrives", "UInt")
●GetLogicalDrives() = DLL("KERNEL32.dll", "dword GetLogicalDrives()")
# 呼び出し: GetLogicalDrives()
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn GetLogicalDrives() callconv(std.os.windows.WINAPI) u32;
proc GetLogicalDrives(): uint32 {.importc: "GetLogicalDrives", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint GetLogicalDrives();
ccall((:GetLogicalDrives, "KERNEL32.dll"), stdcall, UInt32,
      (),
      )
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetLogicalDrives(void);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetLogicalDrives()
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetLogicalDrives = lib.func('__stdcall', 'GetLogicalDrives', 'uint32_t', []);
// GetLogicalDrives()
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetLogicalDrives: { parameters: [], result: "u32" },
});
// lib.symbols.GetLogicalDrives()
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetLogicalDrives(void);
C, "KERNEL32.dll");
// $ffi->GetLogicalDrives();
// 構造体/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);
    int GetLogicalDrives();
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetLogicalDrives = GetLogicalDrives() : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetLogicalDrivesNative = Uint32 Function();
typedef GetLogicalDrivesDart = int Function();
final GetLogicalDrives = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetLogicalDrivesNative, GetLogicalDrivesDart>('GetLogicalDrives');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetLogicalDrives: DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetLogicalDrives';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetLogicalDrives"
  c_GetLogicalDrives :: IO Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getlogicaldrives =
  foreign "GetLogicalDrives"
    (void @-> returning uint32_t)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetLogicalDrives" get-logical-drives :convention :stdcall) :uint32)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetLogicalDrives = Win32::API::More->new('KERNEL32',
    'DWORD GetLogicalDrives()');
# my $ret = $GetLogicalDrives->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。