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

PathSetDlgItemPathW

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

シグネチャ

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

void PathSetDlgItemPathW(
    HWND hDlg,
    INT id,
    LPCWSTR pszPath
);

パラメーター

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

戻り値の型: void

公式ドキュメント

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

解説(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  (Unicode / -W)
#include <windows.h>

void PathSetDlgItemPathW(
    HWND hDlg,
    INT id,
    LPCWSTR pszPath
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern void PathSetDlgItemPathW(
    IntPtr hDlg,   // HWND
    int id,   // INT
    [MarshalAs(UnmanagedType.LPWStr)] string pszPath   // LPCWSTR
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Sub PathSetDlgItemPathW(
    hDlg As IntPtr,   ' HWND
    id As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As String   ' LPCWSTR
)
End Sub
' hDlg : HWND
' id : INT
' pszPath : LPCWSTR
Declare PtrSafe Sub PathSetDlgItemPathW Lib "shlwapi" ( _
    ByVal hDlg As LongPtr, _
    ByVal id As Long, _
    ByVal pszPath As LongPtr)
' 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

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

lib = Fiddle.dlopen('SHLWAPI.dll')
PathSetDlgItemPathW = Fiddle::Function.new(
  lib['PathSetDlgItemPathW'],
  [
    Fiddle::TYPE_VOIDP,  # hDlg : HWND
    Fiddle::TYPE_INT,  # id : INT
    Fiddle::TYPE_VOIDP,  # pszPath : LPCWSTR
  ],
  Fiddle::TYPE_VOID)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn PathSetDlgItemPathW(
        hDlg: *mut core::ffi::c_void,  // HWND
        id: i32,  // INT
        pszPath: *const u16  // LPCWSTR
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern void PathSetDlgItemPathW(IntPtr hDlg, int id, [MarshalAs(UnmanagedType.LPWStr)] string pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathSetDlgItemPathW' -Namespace Win32 -PassThru
# $api::PathSetDlgItemPathW(hDlg, id, pszPath)
#uselib "SHLWAPI.dll"
#func global PathSetDlgItemPathW "PathSetDlgItemPathW" wptr, wptr, wptr
; PathSetDlgItemPathW hDlg, id, pszPath
; hDlg : HWND -> "wptr"
; id : INT -> "wptr"
; pszPath : LPCWSTR -> "wptr"
#uselib "SHLWAPI.dll"
#func global PathSetDlgItemPathW "PathSetDlgItemPathW" sptr, int, wstr
; PathSetDlgItemPathW hDlg, id, pszPath
; hDlg : HWND -> "sptr"
; id : INT -> "int"
; pszPath : LPCWSTR -> "wstr"
; void PathSetDlgItemPathW(HWND hDlg, INT id, LPCWSTR pszPath)
#uselib "SHLWAPI.dll"
#func global PathSetDlgItemPathW "PathSetDlgItemPathW" intptr, int, wstr
; PathSetDlgItemPathW hDlg, id, pszPath
; hDlg : HWND -> "intptr"
; id : INT -> "int"
; pszPath : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procPathSetDlgItemPathW = shlwapi.NewProc("PathSetDlgItemPathW")
)

// hDlg (HWND), id (INT), pszPath (LPCWSTR)
r1, _, err := procPathSetDlgItemPathW.Call(
	uintptr(hDlg),
	uintptr(id),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszPath))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure PathSetDlgItemPathW(
  hDlg: THandle;   // HWND
  id: Integer;   // INT
  pszPath: PWideChar   // LPCWSTR
); stdcall;
  external 'SHLWAPI.dll' name 'PathSetDlgItemPathW';
result := DllCall("SHLWAPI\PathSetDlgItemPathW"
    , "Ptr", hDlg   ; HWND
    , "Int", id   ; INT
    , "WStr", pszPath   ; LPCWSTR
    , "Int")   ; return: void
●PathSetDlgItemPathW(hDlg, id, pszPath) = DLL("SHLWAPI.dll", "int PathSetDlgItemPathW(void*, int, char*)")
# 呼び出し: PathSetDlgItemPathW(hDlg, id, pszPath)
# hDlg : HWND -> "void*"
# id : INT -> "int"
# pszPath : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shlwapi" fn PathSetDlgItemPathW(
    hDlg: ?*anyopaque, // HWND
    id: i32, // INT
    pszPath: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) void;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc PathSetDlgItemPathW(
    hDlg: pointer,  # HWND
    id: int32,  # INT
    pszPath: WideCString  # LPCWSTR
) {.importc: "PathSetDlgItemPathW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
void PathSetDlgItemPathW(
    void* hDlg,   // HWND
    int id,   // INT
    const(wchar)* pszPath   // LPCWSTR
);
ccall((:PathSetDlgItemPathW, "SHLWAPI.dll"), stdcall, Cvoid,
      (Ptr{Cvoid}, Int32, Cwstring),
      hDlg, id, pszPath)
# hDlg : HWND -> Ptr{Cvoid}
# id : INT -> Int32
# pszPath : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void PathSetDlgItemPathW(
    void* hDlg,
    int32_t id,
    const uint16_t* pszPath);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathSetDlgItemPathW(hDlg, id, pszPath)
-- hDlg : HWND
-- id : INT
-- pszPath : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const PathSetDlgItemPathW = lib.func('__stdcall', 'PathSetDlgItemPathW', 'void', ['void *', 'int32_t', 'str16']);
// PathSetDlgItemPathW(hDlg, id, pszPath)
// hDlg : HWND -> 'void *'
// id : INT -> 'int32_t'
// pszPath : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  PathSetDlgItemPathW: { parameters: ["pointer", "i32", "buffer"], result: "void" },
});
// lib.symbols.PathSetDlgItemPathW(hDlg, id, pszPath)
// hDlg : HWND -> "pointer"
// id : INT -> "i32"
// pszPath : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void PathSetDlgItemPathW(
    void* hDlg,
    int32_t id,
    const uint16_t* pszPath);
C, "SHLWAPI.dll");
// $ffi->PathSetDlgItemPathW(hDlg, id, pszPath);
// hDlg : HWND
// id : INT
// pszPath : LPCWSTR
// 構造体/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.UNICODE_OPTIONS);
    void PathSetDlgItemPathW(
        Pointer hDlg,   // HWND
        int id,   // INT
        WString pszPath   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun PathSetDlgItemPathW = PathSetDlgItemPathW(
    hDlg : Void*,   # HWND
    id : Int32,   # INT
    pszPath : UInt16*   # LPCWSTR
  ) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("PathSetDlgItemPathW" path-set-dlg-item-path-w :convention :stdcall) :void
  (h-dlg :pointer)   ; HWND
  (id :int32)   ; INT
  (psz-path (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PathSetDlgItemPathW = Win32::API::More->new('SHLWAPI',
    'void PathSetDlgItemPathW(HANDLE hDlg, int id, LPCWSTR pszPath)');
# my $ret = $PathSetDlgItemPathW->Call($hDlg, $id, $pszPath);
# hDlg : HWND -> HANDLE
# id : INT -> int
# pszPath : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い