PathBuildRootA

関数

ドライブ番号からルートパス文字列を生成する。

DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

LPSTR PathBuildRootA(
    LPSTR pszRoot,
    INT iDrive
);

パラメーター

名前	型	方向	説明
pszRoot	LPSTR	out	構築されたルートパスを受け取る文字列へのポインター。このバッファーは少なくとも 4 文字分のサイズが必要です。
iDrive	INT	in	対象とするドライブ番号を示す int 型の変数。0 から 25 の間である必要があります。

戻り値の型: LPSTR

公式ドキュメント

指定されたドライブ番号からルートパスを作成します。(ANSI)

戻り値

型: LPTSTR

構築されたルートパスのアドレスを返します。何らかの理由(たとえば無効なドライブ番号など)で呼び出しが失敗した場合は、szRoot が変更されずに返されます。

解説(Remarks)

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして PathBuildRoot を定義しています。エンコード中立のエイリアスを、エンコード中立ではないコードと混在して使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

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

LPSTR PathBuildRootA(
    LPSTR pszRoot,
    INT iDrive
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr PathBuildRootA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszRoot,   // LPSTR out
    int iDrive   // INT
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathBuildRootA(
    <MarshalAs(UnmanagedType.LPStr)> pszRoot As System.Text.StringBuilder,   ' LPSTR out
    iDrive As Integer   ' INT
) As IntPtr
End Function

' pszRoot : LPSTR out
' iDrive : INT
Declare PtrSafe Function PathBuildRootA Lib "shlwapi" ( _
    ByVal pszRoot As String, _
    ByVal iDrive As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PathBuildRootA = ctypes.windll.shlwapi.PathBuildRootA
PathBuildRootA.restype = wintypes.LPSTR
PathBuildRootA.argtypes = [
    wintypes.LPSTR,  # pszRoot : LPSTR out
    ctypes.c_int,  # iDrive : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathBuildRootA = Fiddle::Function.new(
  lib['PathBuildRootA'],
  [
    Fiddle::TYPE_VOIDP,  # pszRoot : LPSTR out
    Fiddle::TYPE_INT,  # iDrive : INT
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "shlwapi")]
extern "system" {
    fn PathBuildRootA(
        pszRoot: *mut u8,  // LPSTR out
        iDrive: i32  // INT
    ) -> *mut u8;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern IntPtr PathBuildRootA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszRoot, int iDrive);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathBuildRootA' -Namespace Win32 -PassThru
# $api::PathBuildRootA(pszRoot, iDrive)

#uselib "SHLWAPI.dll"
#func global PathBuildRootA "PathBuildRootA" sptr, sptr
; PathBuildRootA varptr(pszRoot), iDrive   ; 戻り値は stat
; pszRoot : LPSTR out -> "sptr"
; iDrive : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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