ホーム › Networking.WinHttp › WinHttpCreateUrl

WinHttpCreateUrl

関数

URL構成要素から完全なURL文字列を生成する。

DLLWINHTTP.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// WINHTTP.dll
#include <windows.h>

BOOL WinHttpCreateUrl(
    URL_COMPONENTS* lpUrlComponents,
    WIN_HTTP_CREATE_URL_FLAGS dwFlags,
    LPWSTR pwszUrl,   // optional
    DWORD* pdwUrlLength
);

パラメーター

名前

型

方向

説明

lpUrlComponents

URL_COMPONENTS*

URL を作成するための構成要素を含む URL_COMPONENTS 構造体へのポインターです。

dwFlags

WIN_HTTP_CREATE_URL_FLAGS

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

値	意味
ICU_ESCAPE	lpUrlComponents パラメーターが指す URL_COMPONENTS 構造体の lpszUrlPath メンバーが指すパス文字列、および lpszExtraInfo メンバーが指す追加情報文字列に含まれるすべての安全でない文字を、対応するエスケープシーケンスに変換します。
ICU_REJECT_USERPWD	ユーザー名、パスワード、またはその両方を含む URL を入力として拒否します。無効な URL が原因で関数が失敗した場合、その後の GetLastError の呼び出しは ERROR_WINHTTP_INVALID_URL を返します。

pwszUrl

LPWSTR

outoptional

URL をワイド文字 (Unicode) 文字列として受け取る文字バッファーへのポインターです。

pdwUrlLength

DWORD*

inout

pwszUrl バッファーの長さをワイド (Unicode) 文字数で受け取る、unsigned long 整数型の変数へのポインターです。関数が戻るとき、このパラメーターは終端文字分の 1 を引いた URL 文字列のワイド文字数を受け取ります。 GetLastError が ERROR_INSUFFICIENT_BUFFER を返した場合、このパラメーターは作成された URL を格納するために必要なワイド文字数を受け取ります。

戻り値の型: BOOL

公式ドキュメント

ホスト名やパスなどの構成要素から URL を作成します。

戻り値

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

エラーコード	説明
ERROR_WINHTTP_INTERNAL_ERROR	内部エラーが発生しました。
ERROR_NOT_ENOUGH_MEMORY	要求された操作を完了するのに十分なメモリがありません。(Windows エラーコード)

解説(Remarks)

WinHTTP が非同期モードで使用されている場合、つまり WinHttpOpen で WINHTTP_FLAG_ASYNC が設定されている場合でも、この関数は同期的に動作します。戻り値は成功または失敗を示します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

注意 Windows XP および Windows 2000 については、WinHttp スタートページの Run-Time Requirements セクションを参照してください。

例

次の例は、URL をサブコンポーネントに分解 (クラック) し、コンポーネントを更新してから、URL を再構築する方法を示しています。


    URL_COMPONENTS urlComp;
    LPCWSTR pwszUrl1 = 
       L"http://search.msn.com/results.asp?RS=CHECKED&FORM=MSNH&v=1&q=wininet";
    DWORD dwUrlLen = 0;

    // Initialize the URL_COMPONENTS structure.
    ZeroMemory(&urlComp, sizeof(urlComp));
    urlComp.dwStructSize = sizeof(urlComp);

    // Set required component lengths to non-zero, 
    // so that they are cracked.
    urlComp.dwSchemeLength    = (DWORD)-1;
    urlComp.dwHostNameLength  = (DWORD)-1;
    urlComp.dwUrlPathLength   = (DWORD)-1;
    urlComp.dwExtraInfoLength = (DWORD)-1;

    // Crack the URL.
    if (!WinHttpCrackUrl( pwszUrl1, (DWORD)wcslen(pwszUrl1), 0, &urlComp))
    {
        printf("Error %u in WinHttpCrackUrl.\n", GetLastError());
    }
    else
    {
        // Change the search data. New data is the same length.
        urlComp.lpszExtraInfo = L"?RS=CHECKED&FORM=MSNH&v=1&q=winhttp";

        // Obtain the size of the new URL and allocate memory.
        WinHttpCreateUrl( &urlComp, 0, NULL, &dwUrlLen);
        LPWSTR pwszUrl2 = new WCHAR[dwUrlLen];

        // Create a new URL.
        if(!WinHttpCreateUrl( &urlComp, 0, pwszUrl2, &dwUrlLen))
        {
            printf( "Error %u in WinHttpCreateUrl.\n", GetLastError());
        }
        else
        {
            // Show both URLs.
            printf( "Old URL:  %S\nNew URL:  %S\n", pwszUrl1, pwszUrl2);
        }

        // Free allocated memory.
        delete [] pwszUrl2;
    }

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WINHTTP.dll
#include <windows.h>

BOOL WinHttpCreateUrl(
    URL_COMPONENTS* lpUrlComponents,
    WIN_HTTP_CREATE_URL_FLAGS dwFlags,
    LPWSTR pwszUrl,   // optional
    DWORD* pdwUrlLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinHttpCreateUrl(
    IntPtr lpUrlComponents,   // URL_COMPONENTS*
    uint dwFlags,   // WIN_HTTP_CREATE_URL_FLAGS
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszUrl,   // LPWSTR optional, out
    ref uint pdwUrlLength   // DWORD* in/out
);

<DllImport("WINHTTP.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinHttpCreateUrl(
    lpUrlComponents As IntPtr,   ' URL_COMPONENTS*
    dwFlags As UInteger,   ' WIN_HTTP_CREATE_URL_FLAGS
    <MarshalAs(UnmanagedType.LPWStr)> pwszUrl As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pdwUrlLength As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpUrlComponents : URL_COMPONENTS*
' dwFlags : WIN_HTTP_CREATE_URL_FLAGS
' pwszUrl : LPWSTR optional, out
' pdwUrlLength : DWORD* in/out
Declare PtrSafe Function WinHttpCreateUrl Lib "winhttp" ( _
    ByVal lpUrlComponents As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pwszUrl As LongPtr, _
    ByRef pdwUrlLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WinHttpCreateUrl = ctypes.windll.winhttp.WinHttpCreateUrl
WinHttpCreateUrl.restype = wintypes.BOOL
WinHttpCreateUrl.argtypes = [
    ctypes.c_void_p,  # lpUrlComponents : URL_COMPONENTS*
    wintypes.DWORD,  # dwFlags : WIN_HTTP_CREATE_URL_FLAGS
    wintypes.LPWSTR,  # pwszUrl : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pdwUrlLength : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpCreateUrl = Fiddle::Function.new(
  lib['WinHttpCreateUrl'],
  [
    Fiddle::TYPE_VOIDP,  # lpUrlComponents : URL_COMPONENTS*
    -Fiddle::TYPE_INT,  # dwFlags : WIN_HTTP_CREATE_URL_FLAGS
    Fiddle::TYPE_VOIDP,  # pwszUrl : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pdwUrlLength : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winhttp")]
extern "system" {
    fn WinHttpCreateUrl(
        lpUrlComponents: *mut URL_COMPONENTS,  // URL_COMPONENTS*
        dwFlags: u32,  // WIN_HTTP_CREATE_URL_FLAGS
        pwszUrl: *mut u16,  // LPWSTR optional, out
        pdwUrlLength: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true)]
public static extern bool WinHttpCreateUrl(IntPtr lpUrlComponents, uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszUrl, ref uint pdwUrlLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpCreateUrl' -Namespace Win32 -PassThru
# $api::WinHttpCreateUrl(lpUrlComponents, dwFlags, pwszUrl, pdwUrlLength)

#uselib "WINHTTP.dll"
#func global WinHttpCreateUrl "WinHttpCreateUrl" sptr, sptr, sptr, sptr
; WinHttpCreateUrl varptr(lpUrlComponents), dwFlags, varptr(pwszUrl), varptr(pdwUrlLength)   ; 戻り値は stat
; lpUrlComponents : URL_COMPONENTS* -> "sptr"
; dwFlags : WIN_HTTP_CREATE_URL_FLAGS -> "sptr"
; pwszUrl : LPWSTR optional, out -> "sptr"
; pdwUrlLength : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINHTTP.dll"
#cfunc global WinHttpCreateUrl "WinHttpCreateUrl" var, int, var, var
; res = WinHttpCreateUrl(lpUrlComponents, dwFlags, pwszUrl, pdwUrlLength)
; lpUrlComponents : URL_COMPONENTS* -> "var"
; dwFlags : WIN_HTTP_CREATE_URL_FLAGS -> "int"
; pwszUrl : LPWSTR optional, out -> "var"
; pdwUrlLength : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINHTTP.dll"
#cfunc global WinHttpCreateUrl "WinHttpCreateUrl" sptr, int, sptr, sptr
; res = WinHttpCreateUrl(varptr(lpUrlComponents), dwFlags, varptr(pwszUrl), varptr(pdwUrlLength))
; lpUrlComponents : URL_COMPONENTS* -> "sptr"
; dwFlags : WIN_HTTP_CREATE_URL_FLAGS -> "int"
; pwszUrl : LPWSTR optional, out -> "sptr"
; pdwUrlLength : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。