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

UrlCombineA

関数
基底URLと相対URLを連結し1つのURLを生成する。
DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT UrlCombineA(
    LPCSTR pszBase,
    LPCSTR pszRelative,
    LPSTR pszCombined,   // optional
    DWORD* pcchCombined,
    DWORD dwFlags
);

パラメーター

名前方向説明
pszBaseLPCSTRinベース URL を格納する、最大長 INTERNET_MAX_URL_LENGTH の null 終端文字列へのポインター。
pszRelativeLPCSTRin相対 URL を格納する、最大長 INTERNET_MAX_URL_LENGTH の null 終端文字列へのポインター。
pszCombinedLPSTRoutoptionalこの関数が正常に終了したときに、結合された URL を格納する null 終端文字列を受け取るバッファーへのポインター。
pcchCombinedDWORD*inout値へのポインター。入力時には pszCombined バッファー内の文字数を設定します。関数が正常に終了した場合、その値は関数が成功したか E_POINTER を返したかによって異なります。その他の戻り値の場合、このパラメーターの値は意味を持ちません。
dwFlagsDWORDin

URL を正規形式に変換する方法を指定するフラグ。次のフラグを組み合わせることができます。

URL_DONT_SIMPLIFY (0x08000000)

URL 文字列内の '/./' および '/../' を、ナビゲーションの省略表記としてではなく、リテラル文字として扱います。詳細については「解説」を参照してください。

URL_ESCAPE_PERCENT (0x00001000)

出現するすべての '%' をエスケープシーケンスに変換します。

URL_ESCAPE_SPACES_ONLY (0x04000000)

スペースのみをエスケープシーケンスに置き換えます。このフラグは URL_ESCAPE_UNSAFE より優先されますが、不透明な (opaque) URL には適用されません。

URL_ESCAPE_UNSAFE (0x20000000)

安全でない文字をエスケープシーケンスに置き換えます。安全でない文字とは、インターネット上の転送中に変化する可能性のある文字であり、(<、>、"、#、{、}、|、\、^、~、[、]、および ') の各文字が含まれます。このフラグは、不透明な URL を含むすべての URL に適用されます。

URL_NO_META

URL_DONT_SIMPLIFY と同じものとして定義されています。

URL_PLUGGABLE_PROTOCOL (0x40000000)

W3C 仕様に従って、クライアント定義のプラグ可能なプロトコルで URL を結合します。このフラグは、ftp、http、gopher などの標準プロトコルには適用されません。このフラグが設定されている場合、UrlCombine は URL を単純化しないため、URL_DONT_SIMPLIFY を併せて設定する必要はありません。

URL_UNESCAPE (0x10000000)

URL に含まれるエスケープシーケンスをアンエスケープします。ただし 2 つの例外があります。'?' および '#' のエスケープシーケンスはアンエスケープされません。URL_ESCAPE_XXX フラグのいずれかも設定されている場合、2 つの URL はまずアンエスケープされ、次に結合され、その後エスケープされます。

URL_ESCAPE_AS_UTF8 (0x00040000)

Windows 7 以降。すべての非 ASCII 文字を、その UTF-8 相当としてパーセントエンコードします。

戻り値の型: HRESULT

公式ドキュメント

相対 URL とそのベース URL を指定すると、正規形式の URL を返します。(ANSI)

戻り値

型: HRESULT

標準的な COM エラーコードを返します。次のものが含まれます。

戻り値 説明
S_OK
pszCombined は、結合された URL を格納する文字列を指します。pcchCombined の値は、終端の NULL 文字を含まない文字列内の文字数に設定されます。
E_POINTER
バッファーが小さすぎました。pcchCombined の値は、終端の NULL 文字を含めて、バッファーが格納できる必要のある最小文字数に設定されます。

解説(Remarks)

スラッシュで区切られた項目は階層識別子として扱われ、最後の項目がドキュメント自体を指定します。さらに項目を追加するには、ドキュメント名の後にスラッシュ (/) を入力する必要があります。そうしないと、UrlCombine は一方のドキュメントを別のものに置き換えてしまいます。次に例を示します。


hRetVal = UrlCombine(TEXT("http://xyz/test/abc"), 
                     TEXT("bar"), 
                     lpszCombined, 
                     &dwLength, 0);

上記のコードは URL http://xyz/test/bar を返します。結合後の URL を http://xyz/test/abc/bar にしたい場合は、次のように UrlCombine を呼び出します。


hRetVal = UrlCombine(TEXT("http://xyz/test/abc/"), 
                     TEXT("bar"), 
                     lpszCombined, 
                     &dwLength, 0);

URL 文字列に '/../' または '/./' が含まれる場合、UrlCombine は通常、これらの文字を URL 階層内のナビゲーションを示すものとして扱います。この関数は、URL を結合する前に単純化します。たとえば "/hello/cruel/../world" は "/hello/world" に単純化されます。dwFlagsURL_DONT_SIMPLIFY フラグが設定されている場合、この関数は URL を単純化しません。この場合、"/hello/cruel/../world" はそのまま残ります。

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして UrlCombine を定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については「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>

HRESULT UrlCombineA(
    LPCSTR pszBase,
    LPCSTR pszRelative,
    LPSTR pszCombined,   // optional
    DWORD* pcchCombined,
    DWORD dwFlags
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int UrlCombineA(
    [MarshalAs(UnmanagedType.LPStr)] string pszBase,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string pszRelative,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszCombined,   // LPSTR optional, out
    ref uint pcchCombined,   // DWORD* in/out
    uint dwFlags   // DWORD
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function UrlCombineA(
    <MarshalAs(UnmanagedType.LPStr)> pszBase As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pszRelative As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pszCombined As System.Text.StringBuilder,   ' LPSTR optional, out
    ByRef pcchCombined As UInteger,   ' DWORD* in/out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' pszBase : LPCSTR
' pszRelative : LPCSTR
' pszCombined : LPSTR optional, out
' pcchCombined : DWORD* in/out
' dwFlags : DWORD
Declare PtrSafe Function UrlCombineA Lib "shlwapi" ( _
    ByVal pszBase As String, _
    ByVal pszRelative As String, _
    ByVal pszCombined As String, _
    ByRef pcchCombined 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

UrlCombineA = ctypes.windll.shlwapi.UrlCombineA
UrlCombineA.restype = ctypes.c_int
UrlCombineA.argtypes = [
    wintypes.LPCSTR,  # pszBase : LPCSTR
    wintypes.LPCSTR,  # pszRelative : LPCSTR
    wintypes.LPSTR,  # pszCombined : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchCombined : DWORD* in/out
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
UrlCombineA = Fiddle::Function.new(
  lib['UrlCombineA'],
  [
    Fiddle::TYPE_VOIDP,  # pszBase : LPCSTR
    Fiddle::TYPE_VOIDP,  # pszRelative : LPCSTR
    Fiddle::TYPE_VOIDP,  # pszCombined : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchCombined : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn UrlCombineA(
        pszBase: *const u8,  // LPCSTR
        pszRelative: *const u8,  // LPCSTR
        pszCombined: *mut u8,  // LPSTR optional, out
        pcchCombined: *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 UrlCombineA([MarshalAs(UnmanagedType.LPStr)] string pszBase, [MarshalAs(UnmanagedType.LPStr)] string pszRelative, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszCombined, ref uint pcchCombined, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_UrlCombineA' -Namespace Win32 -PassThru
# $api::UrlCombineA(pszBase, pszRelative, pszCombined, pcchCombined, dwFlags)
#uselib "SHLWAPI.dll"
#func global UrlCombineA "UrlCombineA" sptr, sptr, sptr, sptr, sptr
; UrlCombineA pszBase, pszRelative, varptr(pszCombined), varptr(pcchCombined), dwFlags   ; 戻り値は stat
; pszBase : LPCSTR -> "sptr"
; pszRelative : LPCSTR -> "sptr"
; pszCombined : LPSTR optional, out -> "sptr"
; pcchCombined : DWORD* in/out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global UrlCombineA "UrlCombineA" str, str, var, var, int
; res = UrlCombineA(pszBase, pszRelative, pszCombined, pcchCombined, dwFlags)
; pszBase : LPCSTR -> "str"
; pszRelative : LPCSTR -> "str"
; pszCombined : LPSTR optional, out -> "var"
; pcchCombined : DWORD* in/out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT UrlCombineA(LPCSTR pszBase, LPCSTR pszRelative, LPSTR pszCombined, DWORD* pcchCombined, DWORD dwFlags)
#uselib "SHLWAPI.dll"
#cfunc global UrlCombineA "UrlCombineA" str, str, var, var, int
; res = UrlCombineA(pszBase, pszRelative, pszCombined, pcchCombined, dwFlags)
; pszBase : LPCSTR -> "str"
; pszRelative : LPCSTR -> "str"
; pszCombined : LPSTR optional, out -> "var"
; pcchCombined : DWORD* in/out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procUrlCombineA = shlwapi.NewProc("UrlCombineA")
)

// pszBase (LPCSTR), pszRelative (LPCSTR), pszCombined (LPSTR optional, out), pcchCombined (DWORD* in/out), dwFlags (DWORD)
r1, _, err := procUrlCombineA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszBase))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszRelative))),
	uintptr(pszCombined),
	uintptr(pcchCombined),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function UrlCombineA(
  pszBase: PAnsiChar;   // LPCSTR
  pszRelative: PAnsiChar;   // LPCSTR
  pszCombined: PAnsiChar;   // LPSTR optional, out
  pcchCombined: Pointer;   // DWORD* in/out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'UrlCombineA';
result := DllCall("SHLWAPI\UrlCombineA"
    , "AStr", pszBase   ; LPCSTR
    , "AStr", pszRelative   ; LPCSTR
    , "Ptr", pszCombined   ; LPSTR optional, out
    , "Ptr", pcchCombined   ; DWORD* in/out
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: HRESULT
●UrlCombineA(pszBase, pszRelative, pszCombined, pcchCombined, dwFlags) = DLL("SHLWAPI.dll", "int UrlCombineA(char*, char*, char*, void*, dword)")
# 呼び出し: UrlCombineA(pszBase, pszRelative, pszCombined, pcchCombined, dwFlags)
# pszBase : LPCSTR -> "char*"
# pszRelative : LPCSTR -> "char*"
# pszCombined : LPSTR optional, out -> "char*"
# pcchCombined : DWORD* in/out -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shlwapi" fn UrlCombineA(
    pszBase: [*c]const u8, // LPCSTR
    pszRelative: [*c]const u8, // LPCSTR
    pszCombined: [*c]u8, // LPSTR optional, out
    pcchCombined: [*c]u32, // DWORD* in/out
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc UrlCombineA(
    pszBase: cstring,  # LPCSTR
    pszRelative: cstring,  # LPCSTR
    pszCombined: ptr char,  # LPSTR optional, out
    pcchCombined: ptr uint32,  # DWORD* in/out
    dwFlags: uint32  # DWORD
): int32 {.importc: "UrlCombineA", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
int UrlCombineA(
    const(char)* pszBase,   // LPCSTR
    const(char)* pszRelative,   // LPCSTR
    char* pszCombined,   // LPSTR optional, out
    uint* pcchCombined,   // DWORD* in/out
    uint dwFlags   // DWORD
);
ccall((:UrlCombineA, "SHLWAPI.dll"), stdcall, Int32,
      (Cstring, Cstring, Ptr{UInt8}, Ptr{UInt32}, UInt32),
      pszBase, pszRelative, pszCombined, pcchCombined, dwFlags)
# pszBase : LPCSTR -> Cstring
# pszRelative : LPCSTR -> Cstring
# pszCombined : LPSTR optional, out -> Ptr{UInt8}
# pcchCombined : DWORD* in/out -> Ptr{UInt32}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t UrlCombineA(
    const char* pszBase,
    const char* pszRelative,
    char* pszCombined,
    uint32_t* pcchCombined,
    uint32_t dwFlags);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.UrlCombineA(pszBase, pszRelative, pszCombined, pcchCombined, dwFlags)
-- pszBase : LPCSTR
-- pszRelative : LPCSTR
-- pszCombined : LPSTR optional, out
-- pcchCombined : DWORD* in/out
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const UrlCombineA = lib.func('__stdcall', 'UrlCombineA', 'int32_t', ['str', 'str', 'char *', 'uint32_t *', 'uint32_t']);
// UrlCombineA(pszBase, pszRelative, pszCombined, pcchCombined, dwFlags)
// pszBase : LPCSTR -> 'str'
// pszRelative : LPCSTR -> 'str'
// pszCombined : LPSTR optional, out -> 'char *'
// pcchCombined : DWORD* in/out -> 'uint32_t *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  UrlCombineA: { parameters: ["buffer", "buffer", "buffer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.UrlCombineA(pszBase, pszRelative, pszCombined, pcchCombined, dwFlags)
// pszBase : LPCSTR -> "buffer"
// pszRelative : LPCSTR -> "buffer"
// pszCombined : LPSTR optional, out -> "buffer"
// pcchCombined : DWORD* in/out -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t UrlCombineA(
    const char* pszBase,
    const char* pszRelative,
    char* pszCombined,
    uint32_t* pcchCombined,
    uint32_t dwFlags);
C, "SHLWAPI.dll");
// $ffi->UrlCombineA(pszBase, pszRelative, pszCombined, pcchCombined, dwFlags);
// pszBase : LPCSTR
// pszRelative : LPCSTR
// pszCombined : LPSTR optional, out
// pcchCombined : 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.ASCII_OPTIONS);
    int UrlCombineA(
        String pszBase,   // LPCSTR
        String pszRelative,   // LPCSTR
        byte[] pszCombined,   // LPSTR optional, out
        IntByReference pcchCombined,   // DWORD* in/out
        int dwFlags   // DWORD
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun UrlCombineA = UrlCombineA(
    pszBase : UInt8*,   # LPCSTR
    pszRelative : UInt8*,   # LPCSTR
    pszCombined : UInt8*,   # LPSTR optional, out
    pcchCombined : 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 UrlCombineANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>, Uint32);
typedef UrlCombineADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>, int);
final UrlCombineA = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<UrlCombineANative, UrlCombineADart>('UrlCombineA');
// pszBase : LPCSTR -> Pointer<Utf8>
// pszRelative : LPCSTR -> Pointer<Utf8>
// pszCombined : LPSTR optional, out -> Pointer<Utf8>
// pcchCombined : DWORD* in/out -> Pointer<Uint32>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UrlCombineA(
  pszBase: PAnsiChar;   // LPCSTR
  pszRelative: PAnsiChar;   // LPCSTR
  pszCombined: PAnsiChar;   // LPSTR optional, out
  pcchCombined: Pointer;   // DWORD* in/out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'UrlCombineA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UrlCombineA"
  c_UrlCombineA :: CString -> CString -> CString -> Ptr Word32 -> Word32 -> IO Int32
-- pszBase : LPCSTR -> CString
-- pszRelative : LPCSTR -> CString
-- pszCombined : LPSTR optional, out -> CString
-- pcchCombined : DWORD* in/out -> Ptr Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let urlcombinea =
  foreign "UrlCombineA"
    (string @-> string @-> string @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* pszBase : LPCSTR -> string *)
(* pszRelative : LPCSTR -> string *)
(* pszCombined : LPSTR optional, out -> string *)
(* pcchCombined : 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 ("UrlCombineA" url-combine-a :convention :stdcall) :int32
  (psz-base :string)   ; LPCSTR
  (psz-relative :string)   ; LPCSTR
  (psz-combined :pointer)   ; LPSTR optional, out
  (pcch-combined :pointer)   ; DWORD* in/out
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UrlCombineA = Win32::API::More->new('SHLWAPI',
    'int UrlCombineA(LPCSTR pszBase, LPCSTR pszRelative, LPSTR pszCombined, LPVOID pcchCombined, DWORD dwFlags)');
# my $ret = $UrlCombineA->Call($pszBase, $pszRelative, $pszCombined, $pcchCombined, $dwFlags);
# pszBase : LPCSTR -> LPCSTR
# pszRelative : LPCSTR -> LPCSTR
# pszCombined : LPSTR optional, out -> LPSTR
# pcchCombined : DWORD* in/out -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目