ホーム › Networking.WinInet › InternetCombineUrlA

InternetCombineUrlA

関数

基準URLと相対URLを結合して絶対URLを生成する(ANSI)。

DLLWININET.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL InternetCombineUrlA(
    LPCSTR lpszBaseUrl,
    LPCSTR lpszRelativeUrl,
    LPSTR lpszBuffer,
    DWORD* lpdwBufferLength,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

lpszBaseUrl

LPCSTR

ベース URL を含む null 終端文字列へのポインター。

lpszRelativeUrl

LPCSTR

相対 URL を含む null 終端文字列へのポインター。

lpszBuffer

LPSTR

out

結合された URL を受け取るバッファーへのポインター。

lpdwBufferLength

DWORD*

inout

lpszBuffer バッファーのサイズ(文字単位)を格納する変数へのポインター。関数が成功した場合、このパラメーターは結合された URL のサイズ(文字単位、null 終端文字を含まない)を受け取ります。関数が失敗した場合、このパラメーターは必要なバッファーのサイズ(文字単位、null 終端文字を含む)を受け取ります。

dwFlags

DWORD

関数の動作を制御します。このパラメーターには次のいずれかの値を指定できます。

値	意味
ICU_BROWSER_MODE	"#" または "?" の後の文字をエンコードまたはデコードせず、"?" の後の末尾の空白も削除しません。この値が指定されていない場合、URL 全体がエンコードされ、末尾の空白が削除されます。
ICU_DECODE	URL が解析される前に、エスケープシーケンスを含むすべての %XX シーケンスを文字に変換します。
ICU_ENCODE_PERCENT	検出されたパーセント記号をエンコードします。既定では、パーセント記号はエンコードされません。この値は Microsoft Internet Explorer 5 以降で使用できます。
ICU_ENCODE_SPACES_ONLY	スペースのみをエンコードします。
ICU_NO_ENCODE	安全でない文字をエスケープシーケンスに変換しません。
ICU_NO_META	URL からメタシーケンス("." や ".." など)を削除しません。

戻り値の型: BOOL

公式ドキュメント

ベース URL と相対 URL を 1 つの URL に結合します。結合された URL は正規化されます(InternetCanonicalizeUrl を参照)。(ANSI)

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。発生し得るエラーには次のものがあります。

戻り値	説明
ERROR_BAD_PATHNAME	URL を結合できませんでした。
ERROR_INSUFFICIENT_BUFFER	関数に渡されたバッファーが不十分であるか、NULL でした。 lpdwBufferLength パラメーターが示す値には、結合された URL を保持するために必要なバイト数が格納されます。
ERROR_INTERNET_INVALID_URL	URL の形式が無効です。
ERROR_INVALID_PARAMETER	文字列、バッファー、バッファーサイズ、またはフラグパラメーターが無効です。

解説(Remarks)

注意 WinINet はサーバー実装をサポートしていません。また、サービスから使用しないでください。サーバー実装またはサービスでは、Microsoft Windows HTTP Services (WinHTTP) を使用してください。

メモ

wininet.h ヘッダーは InternetCombineUrl を、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)

各言語での呼び出し定義

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

BOOL InternetCombineUrlA(
    LPCSTR lpszBaseUrl,
    LPCSTR lpszRelativeUrl,
    LPSTR lpszBuffer,
    DWORD* lpdwBufferLength,
    DWORD dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool InternetCombineUrlA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszBaseUrl,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpszRelativeUrl,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszBuffer,   // LPSTR out
    ref uint lpdwBufferLength,   // DWORD* in/out
    uint dwFlags   // DWORD
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetCombineUrlA(
    <MarshalAs(UnmanagedType.LPStr)> lpszBaseUrl As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszRelativeUrl As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszBuffer As System.Text.StringBuilder,   ' LPSTR out
    ByRef lpdwBufferLength As UInteger,   ' DWORD* in/out
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpszBaseUrl : LPCSTR
' lpszRelativeUrl : LPCSTR
' lpszBuffer : LPSTR out
' lpdwBufferLength : DWORD* in/out
' dwFlags : DWORD
Declare PtrSafe Function InternetCombineUrlA Lib "wininet" ( _
    ByVal lpszBaseUrl As String, _
    ByVal lpszRelativeUrl As String, _
    ByVal lpszBuffer As String, _
    ByRef lpdwBufferLength 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

InternetCombineUrlA = ctypes.windll.wininet.InternetCombineUrlA
InternetCombineUrlA.restype = wintypes.BOOL
InternetCombineUrlA.argtypes = [
    wintypes.LPCSTR,  # lpszBaseUrl : LPCSTR
    wintypes.LPCSTR,  # lpszRelativeUrl : LPCSTR
    wintypes.LPSTR,  # lpszBuffer : LPSTR out
    ctypes.POINTER(wintypes.DWORD),  # lpdwBufferLength : DWORD* in/out
    wintypes.DWORD,  # dwFlags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetCombineUrlA = Fiddle::Function.new(
  lib['InternetCombineUrlA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszBaseUrl : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszRelativeUrl : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszBuffer : LPSTR out
    Fiddle::TYPE_VOIDP,  # lpdwBufferLength : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn InternetCombineUrlA(
        lpszBaseUrl: *const u8,  // LPCSTR
        lpszRelativeUrl: *const u8,  // LPCSTR
        lpszBuffer: *mut u8,  // LPSTR out
        lpdwBufferLength: *mut u32,  // DWORD* in/out
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool InternetCombineUrlA([MarshalAs(UnmanagedType.LPStr)] string lpszBaseUrl, [MarshalAs(UnmanagedType.LPStr)] string lpszRelativeUrl, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszBuffer, ref uint lpdwBufferLength, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetCombineUrlA' -Namespace Win32 -PassThru
# $api::InternetCombineUrlA(lpszBaseUrl, lpszRelativeUrl, lpszBuffer, lpdwBufferLength, dwFlags)

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

出力引数:

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