ホーム › UI.Shell › UrlCreateFromPathA

UrlCreateFromPathA

関数

ファイルパスを対応するfile形式のURLに変換する。

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

シグネチャ

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

HRESULT UrlCreateFromPathA(
    LPCSTR pszPath,
    LPSTR pszUrl,
    DWORD* pcchUrl,
    DWORD dwFlags
);

パラメーター

名前	型	方向	説明
pszPath	LPCSTR	in	MS-DOS パスを含む、最大長 INTERNET_MAX_URL_LENGTH の null 終端文字列です。
pszUrl	LPSTR	out	この関数が正常に終了したときに URL を受け取るバッファーへのポインターです。
pcchUrl	DWORD*	inout	pszUrl 内の文字数です。
dwFlags	DWORD	in	予約済みです。このパラメーターには NULL を設定してください。

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

型: HRESULT

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

解説(Remarks)

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

メモ

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

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

HRESULT UrlCreateFromPathA(
    LPCSTR pszPath,
    LPSTR pszUrl,
    DWORD* pcchUrl,
    DWORD dwFlags
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int UrlCreateFromPathA(
    [MarshalAs(UnmanagedType.LPStr)] string pszPath,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszUrl,   // LPSTR out
    ref uint pcchUrl,   // DWORD* in/out
    uint dwFlags   // DWORD
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function UrlCreateFromPathA(
    <MarshalAs(UnmanagedType.LPStr)> pszPath As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pszUrl As System.Text.StringBuilder,   ' LPSTR out
    ByRef pcchUrl As UInteger,   ' DWORD* in/out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function

' pszPath : LPCSTR
' pszUrl : LPSTR out
' pcchUrl : DWORD* in/out
' dwFlags : DWORD
Declare PtrSafe Function UrlCreateFromPathA Lib "shlwapi" ( _
    ByVal pszPath As String, _
    ByVal pszUrl As String, _
    ByRef pcchUrl As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

UrlCreateFromPathA = ctypes.windll.shlwapi.UrlCreateFromPathA
UrlCreateFromPathA.restype = ctypes.c_int
UrlCreateFromPathA.argtypes = [
    wintypes.LPCSTR,  # pszPath : LPCSTR
    wintypes.LPSTR,  # pszUrl : LPSTR out
    ctypes.POINTER(wintypes.DWORD),  # pcchUrl : DWORD* in/out
    wintypes.DWORD,  # dwFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
UrlCreateFromPathA = Fiddle::Function.new(
  lib['UrlCreateFromPathA'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPCSTR
    Fiddle::TYPE_VOIDP,  # pszUrl : LPSTR out
    Fiddle::TYPE_VOIDP,  # pcchUrl : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn UrlCreateFromPathA(
        pszPath: *const u8,  // LPCSTR
        pszUrl: *mut u8,  // LPSTR 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.Ansi)]
public static extern int UrlCreateFromPathA([MarshalAs(UnmanagedType.LPStr)] string pszPath, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszUrl, ref uint pcchUrl, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_UrlCreateFromPathA' -Namespace Win32 -PassThru
# $api::UrlCreateFromPathA(pszPath, pszUrl, pcchUrl, dwFlags)

#uselib "SHLWAPI.dll"
#func global UrlCreateFromPathA "UrlCreateFromPathA" sptr, sptr, sptr, sptr
; UrlCreateFromPathA pszPath, varptr(pszUrl), varptr(pcchUrl), dwFlags   ; 戻り値は stat
; pszPath : LPCSTR -> "sptr"
; pszUrl : LPSTR out -> "sptr"
; pcchUrl : DWORD* in/out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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