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

UrlCreateFromPathW

関数
ファイルパスを対応するfile形式のURLに変換する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT UrlCreateFromPathW(
    LPCWSTR pszPath,
    LPWSTR pszUrl,
    DWORD* pcchUrl,
    DWORD dwFlags
);

パラメーター

名前方向説明
pszPathLPCWSTRinMS-DOS パスを格納する、最大長 INTERNET_MAX_URL_LENGTH の null 終端文字列。
pszUrlLPWSTRoutこの関数が正常に終了したときに URL を受け取るバッファーへのポインター。
pcchUrlDWORD*inoutpszUrl の文字数。
dwFlagsDWORDin予約済み。このパラメーターには NULL を設定します。

戻り値の型: HRESULT

公式ドキュメント

Microsoft MS-DOS パスを正規化された URL に変換します。(Unicode)

戻り値

型: HRESULT

pszPath が既に URL 形式である場合は S_FALSE を返します。この場合、pszPath は単に pszUrl にコピーされます。それ以外の場合は、成功時に S_OK を返し、失敗時には標準の COM エラー値を返します。

解説(Remarks)

注意 UrlCreateFromPath は拡張パスをサポートしていません。これは、拡張長パスのプレフィックス "\\?\" を含むパスです。
メモ

shlwapi.h ヘッダーは UrlCreateFromPath をエイリアスとして定義しており、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>

HRESULT UrlCreateFromPathW(
    LPCWSTR pszPath,
    LPWSTR pszUrl,
    DWORD* pcchUrl,
    DWORD dwFlags
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int UrlCreateFromPathW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszPath,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszUrl,   // LPWSTR out
    ref uint pcchUrl,   // DWORD* in/out
    uint dwFlags   // DWORD
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function UrlCreateFromPathW(
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszUrl As System.Text.StringBuilder,   ' LPWSTR out
    ByRef pcchUrl As UInteger,   ' DWORD* in/out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' pszPath : LPCWSTR
' pszUrl : LPWSTR out
' pcchUrl : DWORD* in/out
' dwFlags : DWORD
Declare PtrSafe Function UrlCreateFromPathW Lib "shlwapi" ( _
    ByVal pszPath As LongPtr, _
    ByVal pszUrl As LongPtr, _
    ByRef pcchUrl As Long, _
    ByVal dwFlags 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

UrlCreateFromPathW = ctypes.windll.shlwapi.UrlCreateFromPathW
UrlCreateFromPathW.restype = ctypes.c_int
UrlCreateFromPathW.argtypes = [
    wintypes.LPCWSTR,  # pszPath : LPCWSTR
    wintypes.LPWSTR,  # pszUrl : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # pcchUrl : DWORD* in/out
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
UrlCreateFromPathW = Fiddle::Function.new(
  lib['UrlCreateFromPathW'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszUrl : LPWSTR out
    Fiddle::TYPE_VOIDP,  # pcchUrl : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn UrlCreateFromPathW(
        pszPath: *const u16,  // LPCWSTR
        pszUrl: *mut u16,  // LPWSTR out
        pcchUrl: *mut u32,  // DWORD* in/out
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern int UrlCreateFromPathW([MarshalAs(UnmanagedType.LPWStr)] string pszPath, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszUrl, ref uint pcchUrl, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_UrlCreateFromPathW' -Namespace Win32 -PassThru
# $api::UrlCreateFromPathW(pszPath, pszUrl, pcchUrl, dwFlags)
#uselib "SHLWAPI.dll"
#func global UrlCreateFromPathW "UrlCreateFromPathW" wptr, wptr, wptr, wptr
; UrlCreateFromPathW pszPath, varptr(pszUrl), varptr(pcchUrl), dwFlags   ; 戻り値は stat
; pszPath : LPCWSTR -> "wptr"
; pszUrl : LPWSTR out -> "wptr"
; pcchUrl : DWORD* in/out -> "wptr"
; dwFlags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global UrlCreateFromPathW "UrlCreateFromPathW" wstr, var, var, int
; res = UrlCreateFromPathW(pszPath, pszUrl, pcchUrl, dwFlags)
; pszPath : LPCWSTR -> "wstr"
; pszUrl : LPWSTR out -> "var"
; pcchUrl : DWORD* in/out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT UrlCreateFromPathW(LPCWSTR pszPath, LPWSTR pszUrl, DWORD* pcchUrl, DWORD dwFlags)
#uselib "SHLWAPI.dll"
#cfunc global UrlCreateFromPathW "UrlCreateFromPathW" wstr, var, var, int
; res = UrlCreateFromPathW(pszPath, pszUrl, pcchUrl, dwFlags)
; pszPath : LPCWSTR -> "wstr"
; pszUrl : LPWSTR out -> "var"
; pcchUrl : DWORD* in/out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procUrlCreateFromPathW = shlwapi.NewProc("UrlCreateFromPathW")
)

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

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

typedef UrlCreateFromPathWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint32>, Uint32);
typedef UrlCreateFromPathWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint32>, int);
final UrlCreateFromPathW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<UrlCreateFromPathWNative, UrlCreateFromPathWDart>('UrlCreateFromPathW');
// pszPath : LPCWSTR -> Pointer<Utf16>
// pszUrl : LPWSTR out -> Pointer<Utf16>
// pcchUrl : DWORD* in/out -> Pointer<Uint32>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UrlCreateFromPathW(
  pszPath: PWideChar;   // LPCWSTR
  pszUrl: PWideChar;   // LPWSTR out
  pcchUrl: Pointer;   // DWORD* in/out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'UrlCreateFromPathW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UrlCreateFromPathW"
  c_UrlCreateFromPathW :: CWString -> CWString -> Ptr Word32 -> Word32 -> IO Int32
-- pszPath : LPCWSTR -> CWString
-- pszUrl : LPWSTR out -> CWString
-- pcchUrl : DWORD* in/out -> Ptr Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let urlcreatefrompathw =
  foreign "UrlCreateFromPathW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* pszPath : LPCWSTR -> (ptr uint16_t) *)
(* pszUrl : LPWSTR out -> (ptr uint16_t) *)
(* pcchUrl : DWORD* in/out -> (ptr uint32_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("UrlCreateFromPathW" url-create-from-path-w :convention :stdcall) :int32
  (psz-path (:string :encoding :utf-16le))   ; LPCWSTR
  (psz-url :pointer)   ; LPWSTR out
  (pcch-url :pointer)   ; DWORD* in/out
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UrlCreateFromPathW = Win32::API::More->new('SHLWAPI',
    'int UrlCreateFromPathW(LPCWSTR pszPath, LPWSTR pszUrl, LPVOID pcchUrl, DWORD dwFlags)');
# my $ret = $UrlCreateFromPathW->Call($pszPath, $pszUrl, $pcchUrl, $dwFlags);
# pszPath : LPCWSTR -> LPCWSTR
# pszUrl : LPWSTR out -> LPWSTR
# pcchUrl : DWORD* in/out -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い