ホーム › Storage.FileSystem › QueryDosDeviceA

QueryDosDeviceA

関数

MS-DOSデバイス名に対応するパス情報を取得する(ANSI版)。

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

シグネチャ

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

DWORD QueryDosDeviceA(
    LPCSTR lpDeviceName,   // optional
    LPSTR lpTargetPath,   // optional
    DWORD ucchMax
);

パラメーター

名前	型	方向	説明
lpDeviceName	LPCSTR	inoptional	クエリの対象を指定する MS-DOS デバイス名の文字列です。デバイス名の末尾にバックスラッシュを付けることはできません。たとえば、"C:\" ではなく "C:" を使用します。このパラメーターは NULL にできます。その場合、 QueryDosDevice 関数は、既存のすべての MS-DOS デバイス名の一覧を lpTargetPath が指すバッファーに格納します。
lpTargetPath	LPSTR	outoptional	クエリの結果を受け取るバッファーへのポインターです。関数はこのバッファーに、1 つ以上の NULL 終端文字列を格納します。最後の NULL 終端文字列の後には、さらに NULL が続きます。 lpDeviceName が NULL 以外の場合、関数は lpDeviceName で指定された特定の MS-DOS デバイスに関する情報を取得します。バッファーに格納される最初の NULL 終端文字列は、そのデバイスの現在のマッピングです。それ以外の NULL 終端文字列は、そのデバイスに対する未削除の以前のマッピングを表します。 lpDeviceName が NULL の場合、関数は既存のすべての MS-DOS デバイス名の一覧を取得します。バッファーに格納される各 NULL 終端文字列は、既存の MS-DOS デバイスの名前です。たとえば \Device\HarddiskVolume1 や \Device\Floppy0 などです。
ucchMax	DWORD	in	lpTargetPath が指すバッファーに格納できる TCHAR の最大数です。

名前

型

方向

説明

lpDeviceName

LPCSTR

inoptional

クエリの対象を指定する MS-DOS デバイス名の文字列です。デバイス名の末尾にバックスラッシュを付けることはできません。たとえば、"C:\" ではなく "C:" を使用します。

このパラメーターは NULL にできます。その場合、 QueryDosDevice 関数は、既存のすべての MS-DOS デバイス名の一覧を lpTargetPath が指すバッファーに格納します。

lpTargetPath

LPSTR

outoptional

クエリの結果を受け取るバッファーへのポインターです。関数はこのバッファーに、1 つ以上の NULL 終端文字列を格納します。最後の NULL 終端文字列の後には、さらに NULL が続きます。

lpDeviceName が NULL 以外の場合、関数は lpDeviceName で指定された特定の MS-DOS デバイスに関する情報を取得します。バッファーに格納される最初の NULL 終端文字列は、そのデバイスの現在のマッピングです。それ以外の NULL 終端文字列は、そのデバイスに対する未削除の以前のマッピングを表します。

lpDeviceName が NULL の場合、関数は既存のすべての MS-DOS デバイス名の一覧を取得します。バッファーに格納される各 NULL 終端文字列は、既存の MS-DOS デバイスの名前です。たとえば \Device\HarddiskVolume1 や \Device\Floppy0 などです。

ucchMax

DWORD

lpTargetPath が指すバッファーに格納できる TCHAR の最大数です。

戻り値の型: DWORD

公式ドキュメント

MS-DOS デバイス名に関する情報を取得します。(QueryDosDeviceA)

戻り値

関数が成功した場合、戻り値は lpTargetPath が指すバッファーに格納された TCHAR の数です。

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

バッファーが小さすぎる場合、関数は失敗し、最後のエラーコードは ERROR_INSUFFICIENT_BUFFER になります。

解説(Remarks)

DefineDosDevice 関数を使用すると、アプリケーションは MS-DOS デバイス名前空間を実装するために使用されるジャンクションを作成および変更できます。

Windows Server 2003 および Windows XP: QueryDosDevice は、指定されたデバイス名について最初に Local MS-DOS Device 名前空間を検索します。デバイス名が見つからない場合、関数は次に Global MS-DOS Device 名前空間を検索します。

既存のすべての MS-DOS デバイス名を照会する場合、返されるデバイス名の一覧は、 "LocalSystem" コンテキストで実行されているかどうかに依存します。実行されている場合は、Global MS-DOS Device 名前空間に含まれるデバイス名のみが返されます。実行されていない場合は、Global および Local MS-DOS Device 名前空間のデバイス名を連結したものが返されます。デバイス名が両方の名前空間に存在する場合、 QueryDosDevice は Local MS-DOS Device 名前空間のエントリを返します。

Global および Local MS-DOS Device 名前空間と、MS-DOS デバイス名のアクセス可能性に対する変更の詳細については、 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 または Displaying Volume Paths を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 QueryDosDeviceA(
    LPCSTR lpDeviceName,   // optional
    LPSTR lpTargetPath,   // optional
    DWORD ucchMax
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint QueryDosDeviceA(
    [MarshalAs(UnmanagedType.LPStr)] string lpDeviceName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpTargetPath,   // LPSTR optional, out
    uint ucchMax   // DWORD
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function QueryDosDeviceA(
    <MarshalAs(UnmanagedType.LPStr)> lpDeviceName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpTargetPath As System.Text.StringBuilder,   ' LPSTR optional, out
    ucchMax As UInteger   ' DWORD
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

QueryDosDeviceA = ctypes.windll.kernel32.QueryDosDeviceA
QueryDosDeviceA.restype = wintypes.DWORD
QueryDosDeviceA.argtypes = [
    wintypes.LPCSTR,  # lpDeviceName : LPCSTR optional
    wintypes.LPSTR,  # lpTargetPath : LPSTR optional, out
    wintypes.DWORD,  # ucchMax : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
QueryDosDeviceA = Fiddle::Function.new(
  lib['QueryDosDeviceA'],
  [
    Fiddle::TYPE_VOIDP,  # lpDeviceName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpTargetPath : LPSTR optional, out
    -Fiddle::TYPE_INT,  # ucchMax : DWORD
  ],
  -Fiddle::TYPE_INT)

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

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

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

出力引数:

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