Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向
lpUrlComponentsURL_COMPONENTS*in
dwFlagsWIN_HTTP_CREATE_URL_FLAGSin
pwszUrlLPWSTRoutoptional
pdwUrlLengthDWORD*inout

戻り値の型: BOOL

各言語での呼び出し定義

// 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 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 方式にも切替可。
出力引数:
; BOOL WinHttpCreateUrl(URL_COMPONENTS* lpUrlComponents, WIN_HTTP_CREATE_URL_FLAGS dwFlags, LPWSTR pwszUrl, DWORD* pdwUrlLength)
#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 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winhttp = windows.NewLazySystemDLL("WINHTTP.dll")
	procWinHttpCreateUrl = winhttp.NewProc("WinHttpCreateUrl")
)

// lpUrlComponents (URL_COMPONENTS*), dwFlags (WIN_HTTP_CREATE_URL_FLAGS), pwszUrl (LPWSTR optional, out), pdwUrlLength (DWORD* in/out)
r1, _, err := procWinHttpCreateUrl.Call(
	uintptr(lpUrlComponents),
	uintptr(dwFlags),
	uintptr(pwszUrl),
	uintptr(pdwUrlLength),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WinHttpCreateUrl(
  lpUrlComponents: Pointer;   // URL_COMPONENTS*
  dwFlags: DWORD;   // WIN_HTTP_CREATE_URL_FLAGS
  pwszUrl: PWideChar;   // LPWSTR optional, out
  pdwUrlLength: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'WINHTTP.dll' name 'WinHttpCreateUrl';
result := DllCall("WINHTTP\WinHttpCreateUrl"
    , "Ptr", lpUrlComponents   ; URL_COMPONENTS*
    , "UInt", dwFlags   ; WIN_HTTP_CREATE_URL_FLAGS
    , "Ptr", pwszUrl   ; LPWSTR optional, out
    , "Ptr", pdwUrlLength   ; DWORD* in/out
    , "Int")   ; return: BOOL
●WinHttpCreateUrl(lpUrlComponents, dwFlags, pwszUrl, pdwUrlLength) = DLL("WINHTTP.dll", "bool WinHttpCreateUrl(void*, dword, char*, void*)")
# 呼び出し: WinHttpCreateUrl(lpUrlComponents, dwFlags, pwszUrl, pdwUrlLength)
# lpUrlComponents : URL_COMPONENTS* -> "void*"
# dwFlags : WIN_HTTP_CREATE_URL_FLAGS -> "dword"
# pwszUrl : LPWSTR optional, out -> "char*"
# pdwUrlLength : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。