Win32 API 日本語リファレンス
ホームUI.Shell › PathSetDlgItemPathA

PathSetDlgItemPathA

関数
ダイアログ項目に省略表示でパス文字列を設定する。
DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

void PathSetDlgItemPathA(
    HWND hDlg,
    INT id,
    LPCSTR pszPath
);

パラメーター

名前方向説明
hDlgHWNDinダイアログボックスまたはウィンドウへのハンドルです。
idINTinコントロールの識別子です。
pszPathLPCSTRinコントロールに設定するパスを格納した、最大長 MAX_PATH の null 終端文字列へのポインターです。

戻り値の型: void

公式ドキュメント

ウィンドウまたはダイアログボックス内の子コントロールのテキストを設定します。PathCompactPath を使用して、パスがコントロールに収まるようにします。(ANSI)

解説(Remarks)

メモ

shlwapi.h ヘッダーは PathSetDlgItemPath をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

void PathSetDlgItemPathA(
    HWND hDlg,
    INT id,
    LPCSTR pszPath
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern void PathSetDlgItemPathA(
    IntPtr hDlg,   // HWND
    int id,   // INT
    [MarshalAs(UnmanagedType.LPStr)] string pszPath   // LPCSTR
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Sub PathSetDlgItemPathA(
    hDlg As IntPtr,   ' HWND
    id As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPStr)> pszPath As String   ' LPCSTR
)
End Sub
' hDlg : HWND
' id : INT
' pszPath : LPCSTR
Declare PtrSafe Sub PathSetDlgItemPathA Lib "shlwapi" ( _
    ByVal hDlg As LongPtr, _
    ByVal id As Long, _
    ByVal pszPath As String)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PathSetDlgItemPathA = ctypes.windll.shlwapi.PathSetDlgItemPathA
PathSetDlgItemPathA.restype = None
PathSetDlgItemPathA.argtypes = [
    wintypes.HANDLE,  # hDlg : HWND
    ctypes.c_int,  # id : INT
    wintypes.LPCSTR,  # pszPath : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathSetDlgItemPathA = Fiddle::Function.new(
  lib['PathSetDlgItemPathA'],
  [
    Fiddle::TYPE_VOIDP,  # hDlg : HWND
    Fiddle::TYPE_INT,  # id : INT
    Fiddle::TYPE_VOIDP,  # pszPath : LPCSTR
  ],
  Fiddle::TYPE_VOID)
#[link(name = "shlwapi")]
extern "system" {
    fn PathSetDlgItemPathA(
        hDlg: *mut core::ffi::c_void,  // HWND
        id: i32,  // INT
        pszPath: *const u8  // LPCSTR
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern void PathSetDlgItemPathA(IntPtr hDlg, int id, [MarshalAs(UnmanagedType.LPStr)] string pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathSetDlgItemPathA' -Namespace Win32 -PassThru
# $api::PathSetDlgItemPathA(hDlg, id, pszPath)
#uselib "SHLWAPI.dll"
#func global PathSetDlgItemPathA "PathSetDlgItemPathA" sptr, sptr, sptr
; PathSetDlgItemPathA hDlg, id, pszPath
; hDlg : HWND -> "sptr"
; id : INT -> "sptr"
; pszPath : LPCSTR -> "sptr"
#uselib "SHLWAPI.dll"
#func global PathSetDlgItemPathA "PathSetDlgItemPathA" sptr, int, str
; PathSetDlgItemPathA hDlg, id, pszPath
; hDlg : HWND -> "sptr"
; id : INT -> "int"
; pszPath : LPCSTR -> "str"
; void PathSetDlgItemPathA(HWND hDlg, INT id, LPCSTR pszPath)
#uselib "SHLWAPI.dll"
#func global PathSetDlgItemPathA "PathSetDlgItemPathA" intptr, int, str
; PathSetDlgItemPathA hDlg, id, pszPath
; hDlg : HWND -> "intptr"
; id : INT -> "int"
; pszPath : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procPathSetDlgItemPathA = shlwapi.NewProc("PathSetDlgItemPathA")
)

// hDlg (HWND), id (INT), pszPath (LPCSTR)
r1, _, err := procPathSetDlgItemPathA.Call(
	uintptr(hDlg),
	uintptr(id),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszPath))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure PathSetDlgItemPathA(
  hDlg: THandle;   // HWND
  id: Integer;   // INT
  pszPath: PAnsiChar   // LPCSTR
); stdcall;
  external 'SHLWAPI.dll' name 'PathSetDlgItemPathA';
result := DllCall("SHLWAPI\PathSetDlgItemPathA"
    , "Ptr", hDlg   ; HWND
    , "Int", id   ; INT
    , "AStr", pszPath   ; LPCSTR
    , "Int")   ; return: void
●PathSetDlgItemPathA(hDlg, id, pszPath) = DLL("SHLWAPI.dll", "int PathSetDlgItemPathA(void*, int, char*)")
# 呼び出し: PathSetDlgItemPathA(hDlg, id, pszPath)
# hDlg : HWND -> "void*"
# id : INT -> "int"
# pszPath : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shlwapi" fn PathSetDlgItemPathA(
    hDlg: ?*anyopaque, // HWND
    id: i32, // INT
    pszPath: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) void;
proc PathSetDlgItemPathA(
    hDlg: pointer,  # HWND
    id: int32,  # INT
    pszPath: cstring  # LPCSTR
) {.importc: "PathSetDlgItemPathA", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
void PathSetDlgItemPathA(
    void* hDlg,   // HWND
    int id,   // INT
    const(char)* pszPath   // LPCSTR
);
ccall((:PathSetDlgItemPathA, "SHLWAPI.dll"), stdcall, Cvoid,
      (Ptr{Cvoid}, Int32, Cstring),
      hDlg, id, pszPath)
# hDlg : HWND -> Ptr{Cvoid}
# id : INT -> Int32
# pszPath : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void PathSetDlgItemPathA(
    void* hDlg,
    int32_t id,
    const char* pszPath);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathSetDlgItemPathA(hDlg, id, pszPath)
-- hDlg : HWND
-- id : INT
-- pszPath : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const PathSetDlgItemPathA = lib.func('__stdcall', 'PathSetDlgItemPathA', 'void', ['void *', 'int32_t', 'str']);
// PathSetDlgItemPathA(hDlg, id, pszPath)
// hDlg : HWND -> 'void *'
// id : INT -> 'int32_t'
// pszPath : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  PathSetDlgItemPathA: { parameters: ["pointer", "i32", "buffer"], result: "void" },
});
// lib.symbols.PathSetDlgItemPathA(hDlg, id, pszPath)
// hDlg : HWND -> "pointer"
// id : INT -> "i32"
// pszPath : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void PathSetDlgItemPathA(
    void* hDlg,
    int32_t id,
    const char* pszPath);
C, "SHLWAPI.dll");
// $ffi->PathSetDlgItemPathA(hDlg, id, pszPath);
// hDlg : HWND
// id : INT
// pszPath : LPCSTR
// 構造体/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 Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.ASCII_OPTIONS);
    void PathSetDlgItemPathA(
        Pointer hDlg,   // HWND
        int id,   // INT
        String pszPath   // LPCSTR
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun PathSetDlgItemPathA = PathSetDlgItemPathA(
    hDlg : Void*,   # HWND
    id : Int32,   # INT
    pszPath : UInt8*   # LPCSTR
  ) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PathSetDlgItemPathANative = Void Function(Pointer<Void>, Int32, Pointer<Utf8>);
typedef PathSetDlgItemPathADart = void Function(Pointer<Void>, int, Pointer<Utf8>);
final PathSetDlgItemPathA = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<PathSetDlgItemPathANative, PathSetDlgItemPathADart>('PathSetDlgItemPathA');
// hDlg : HWND -> Pointer<Void>
// id : INT -> Int32
// pszPath : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure PathSetDlgItemPathA(
  hDlg: THandle;   // HWND
  id: Integer;   // INT
  pszPath: PAnsiChar   // LPCSTR
); stdcall;
  external 'SHLWAPI.dll' name 'PathSetDlgItemPathA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PathSetDlgItemPathA"
  c_PathSetDlgItemPathA :: Ptr () -> Int32 -> CString -> IO ()
-- hDlg : HWND -> Ptr ()
-- id : INT -> Int32
-- pszPath : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pathsetdlgitempatha =
  foreign "PathSetDlgItemPathA"
    ((ptr void) @-> int32_t @-> string @-> returning void)
(* hDlg : HWND -> (ptr void) *)
(* id : INT -> int32_t *)
(* pszPath : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("PathSetDlgItemPathA" path-set-dlg-item-path-a :convention :stdcall) :void
  (h-dlg :pointer)   ; HWND
  (id :int32)   ; INT
  (psz-path :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PathSetDlgItemPathA = Win32::API::More->new('SHLWAPI',
    'void PathSetDlgItemPathA(HANDLE hDlg, int id, LPCSTR pszPath)');
# my $ret = $PathSetDlgItemPathA->Call($hDlg, $id, $pszPath);
# hDlg : HWND -> HANDLE
# id : INT -> int
# pszPath : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い