ホーム › Storage.FileSystem › QueryDosDeviceW

QueryDosDeviceW

関数

MS-DOSデバイス名に対応するターゲットパスを取得する。

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

シグネチャ

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

DWORD QueryDosDeviceW(
    LPCWSTR lpDeviceName,   // optional
    LPWSTR lpTargetPath,   // optional
    DWORD ucchMax
);

パラメーター

名前	型	方向	説明
lpDeviceName	LPCWSTR	inoptional	クエリの対象を指定する MS-DOS デバイス名文字列です。デバイス名の末尾にバックスラッシュを付けることはできません。たとえば "C:\" ではなく "C:" を使用します。このパラメーターは NULL にすることができます。その場合、 QueryDosDevice 関数は既存のすべての MS-DOS デバイス名の一覧を lpTargetPath が指すバッファーに格納します。
lpTargetPath	LPWSTR	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

LPCWSTR

inoptional

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

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

lpTargetPath

LPWSTR

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 デバイス名に関する情報を取得します。(QueryDosDeviceW)

戻り値

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

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

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

解説(Remarks)

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

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

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

グローバルおよびローカル MS-DOS デバイス名前空間と、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  (Unicode / -W)
#include <windows.h>

DWORD QueryDosDeviceW(
    LPCWSTR lpDeviceName,   // optional
    LPWSTR lpTargetPath,   // optional
    DWORD ucchMax
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint QueryDosDeviceW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpDeviceName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpTargetPath,   // LPWSTR optional, out
    uint ucchMax   // DWORD
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function QueryDosDeviceW(
    <MarshalAs(UnmanagedType.LPWStr)> lpDeviceName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpTargetPath As System.Text.StringBuilder,   ' LPWSTR optional, out
    ucchMax As UInteger   ' DWORD
) As UInteger
End Function

' lpDeviceName : LPCWSTR optional
' lpTargetPath : LPWSTR optional, out
' ucchMax : DWORD
Declare PtrSafe Function QueryDosDeviceW Lib "kernel32" ( _
    ByVal lpDeviceName As LongPtr, _
    ByVal lpTargetPath As LongPtr, _
    ByVal ucchMax As Long) 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

QueryDosDeviceW = ctypes.windll.kernel32.QueryDosDeviceW
QueryDosDeviceW.restype = wintypes.DWORD
QueryDosDeviceW.argtypes = [
    wintypes.LPCWSTR,  # lpDeviceName : LPCWSTR optional
    wintypes.LPWSTR,  # lpTargetPath : LPWSTR 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')
QueryDosDeviceW = Fiddle::Function.new(
  lib['QueryDosDeviceW'],
  [
    Fiddle::TYPE_VOIDP,  # lpDeviceName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpTargetPath : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # ucchMax : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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