ホーム › Networking.HttpServer › HttpPrepareUrl
HttpPrepareUrl
関数URLを正規化して使用可能な形式に変換する。
シグネチャ
// HTTPAPI.dll
#include <windows.h>
DWORD HttpPrepareUrl(
void* Reserved, // optional
DWORD Flags, // optional
LPCWSTR Url,
LPWSTR* PreparedUrl
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| Reserved | void* | optional | 予約済み。NULL を指定する必要があります。 |
| Flags | DWORD | optional | 予約済み。ゼロを指定する必要があります。 |
| Url | LPCWSTR | in | 準備対象となる、正規化されていない Unicode または punycode の URL を表す文字列へのポインターです。 |
| PreparedUrl | LPWSTR* | out | 正常に出力された場合、正規化された URL を表す文字列へのポインターです。 メモ PreparedUrl は HeapFree を使用して解放してください。
|
戻り値の型: DWORD
公式ドキュメント
正規化されていない Unicode または punycode の URL を解析、分析、正規化し、他の HTTP 関数で安全かつ有効に使用できるようにします。
戻り値
関数が成功した場合、ERROR_SUCCESS を返します。
関数が失敗した場合、次のいずれか、または WinError.h で定義されている システムエラーコード を返します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// HTTPAPI.dll
#include <windows.h>
DWORD HttpPrepareUrl(
void* Reserved, // optional
DWORD Flags, // optional
LPCWSTR Url,
LPWSTR* PreparedUrl
);[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpPrepareUrl(
IntPtr Reserved, // void* optional
uint Flags, // DWORD optional
[MarshalAs(UnmanagedType.LPWStr)] string Url, // LPCWSTR
IntPtr PreparedUrl // LPWSTR* out
);<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpPrepareUrl(
Reserved As IntPtr, ' void* optional
Flags As UInteger, ' DWORD optional
<MarshalAs(UnmanagedType.LPWStr)> Url As String, ' LPCWSTR
PreparedUrl As IntPtr ' LPWSTR* out
) As UInteger
End Function' Reserved : void* optional
' Flags : DWORD optional
' Url : LPCWSTR
' PreparedUrl : LPWSTR* out
Declare PtrSafe Function HttpPrepareUrl Lib "httpapi" ( _
ByVal Reserved As LongPtr, _
ByVal Flags As Long, _
ByVal Url As LongPtr, _
ByVal PreparedUrl As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
HttpPrepareUrl = ctypes.windll.httpapi.HttpPrepareUrl
HttpPrepareUrl.restype = wintypes.DWORD
HttpPrepareUrl.argtypes = [
ctypes.POINTER(None), # Reserved : void* optional
wintypes.DWORD, # Flags : DWORD optional
wintypes.LPCWSTR, # Url : LPCWSTR
ctypes.c_void_p, # PreparedUrl : LPWSTR* out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('HTTPAPI.dll')
HttpPrepareUrl = Fiddle::Function.new(
lib['HttpPrepareUrl'],
[
Fiddle::TYPE_VOIDP, # Reserved : void* optional
-Fiddle::TYPE_INT, # Flags : DWORD optional
Fiddle::TYPE_VOIDP, # Url : LPCWSTR
Fiddle::TYPE_VOIDP, # PreparedUrl : LPWSTR* out
],
-Fiddle::TYPE_INT)#[link(name = "httpapi")]
extern "system" {
fn HttpPrepareUrl(
Reserved: *mut (), // void* optional
Flags: u32, // DWORD optional
Url: *const u16, // LPCWSTR
PreparedUrl: *mut *mut u16 // LPWSTR* out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("HTTPAPI.dll")]
public static extern uint HttpPrepareUrl(IntPtr Reserved, uint Flags, [MarshalAs(UnmanagedType.LPWStr)] string Url, IntPtr PreparedUrl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpPrepareUrl' -Namespace Win32 -PassThru
# $api::HttpPrepareUrl(Reserved, Flags, Url, PreparedUrl)#uselib "HTTPAPI.dll"
#func global HttpPrepareUrl "HttpPrepareUrl" sptr, sptr, sptr, sptr
; HttpPrepareUrl Reserved, Flags, Url, varptr(PreparedUrl) ; 戻り値は stat
; Reserved : void* optional -> "sptr"
; Flags : DWORD optional -> "sptr"
; Url : LPCWSTR -> "sptr"
; PreparedUrl : LPWSTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "HTTPAPI.dll" #cfunc global HttpPrepareUrl "HttpPrepareUrl" sptr, int, wstr, var ; res = HttpPrepareUrl(Reserved, Flags, Url, PreparedUrl) ; Reserved : void* optional -> "sptr" ; Flags : DWORD optional -> "int" ; Url : LPCWSTR -> "wstr" ; PreparedUrl : LPWSTR* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "HTTPAPI.dll" #cfunc global HttpPrepareUrl "HttpPrepareUrl" sptr, int, wstr, sptr ; res = HttpPrepareUrl(Reserved, Flags, Url, varptr(PreparedUrl)) ; Reserved : void* optional -> "sptr" ; Flags : DWORD optional -> "int" ; Url : LPCWSTR -> "wstr" ; PreparedUrl : LPWSTR* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; DWORD HttpPrepareUrl(void* Reserved, DWORD Flags, LPCWSTR Url, LPWSTR* PreparedUrl) #uselib "HTTPAPI.dll" #cfunc global HttpPrepareUrl "HttpPrepareUrl" intptr, int, wstr, var ; res = HttpPrepareUrl(Reserved, Flags, Url, PreparedUrl) ; Reserved : void* optional -> "intptr" ; Flags : DWORD optional -> "int" ; Url : LPCWSTR -> "wstr" ; PreparedUrl : LPWSTR* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD HttpPrepareUrl(void* Reserved, DWORD Flags, LPCWSTR Url, LPWSTR* PreparedUrl) #uselib "HTTPAPI.dll" #cfunc global HttpPrepareUrl "HttpPrepareUrl" intptr, int, wstr, intptr ; res = HttpPrepareUrl(Reserved, Flags, Url, varptr(PreparedUrl)) ; Reserved : void* optional -> "intptr" ; Flags : DWORD optional -> "int" ; Url : LPCWSTR -> "wstr" ; PreparedUrl : LPWSTR* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
httpapi = windows.NewLazySystemDLL("HTTPAPI.dll")
procHttpPrepareUrl = httpapi.NewProc("HttpPrepareUrl")
)
// Reserved (void* optional), Flags (DWORD optional), Url (LPCWSTR), PreparedUrl (LPWSTR* out)
r1, _, err := procHttpPrepareUrl.Call(
uintptr(Reserved),
uintptr(Flags),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(Url))),
uintptr(PreparedUrl),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction HttpPrepareUrl(
Reserved: Pointer; // void* optional
Flags: DWORD; // DWORD optional
Url: PWideChar; // LPCWSTR
PreparedUrl: PPWideChar // LPWSTR* out
): DWORD; stdcall;
external 'HTTPAPI.dll' name 'HttpPrepareUrl';result := DllCall("HTTPAPI\HttpPrepareUrl"
, "Ptr", Reserved ; void* optional
, "UInt", Flags ; DWORD optional
, "WStr", Url ; LPCWSTR
, "Ptr", PreparedUrl ; LPWSTR* out
, "UInt") ; return: DWORD●HttpPrepareUrl(Reserved, Flags, Url, PreparedUrl) = DLL("HTTPAPI.dll", "dword HttpPrepareUrl(void*, dword, char*, void*)")
# 呼び出し: HttpPrepareUrl(Reserved, Flags, Url, PreparedUrl)
# Reserved : void* optional -> "void*"
# Flags : DWORD optional -> "dword"
# Url : LPCWSTR -> "char*"
# PreparedUrl : LPWSTR* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "httpapi" fn HttpPrepareUrl(
Reserved: ?*anyopaque, // void* optional
Flags: u32, // DWORD optional
Url: [*c]const u16, // LPCWSTR
PreparedUrl: [*c][*c]u16 // LPWSTR* out
) callconv(std.os.windows.WINAPI) u32;proc HttpPrepareUrl(
Reserved: pointer, # void* optional
Flags: uint32, # DWORD optional
Url: WideCString, # LPCWSTR
PreparedUrl: ptr WideCString # LPWSTR* out
): uint32 {.importc: "HttpPrepareUrl", stdcall, dynlib: "HTTPAPI.dll".}pragma(lib, "httpapi");
extern(Windows)
uint HttpPrepareUrl(
void* Reserved, // void* optional
uint Flags, // DWORD optional
const(wchar)* Url, // LPCWSTR
wchar** PreparedUrl // LPWSTR* out
);ccall((:HttpPrepareUrl, "HTTPAPI.dll"), stdcall, UInt32,
(Ptr{Cvoid}, UInt32, Cwstring, Ptr{Ptr{UInt16}}),
Reserved, Flags, Url, PreparedUrl)
# Reserved : void* optional -> Ptr{Cvoid}
# Flags : DWORD optional -> UInt32
# Url : LPCWSTR -> Cwstring
# PreparedUrl : LPWSTR* out -> Ptr{Ptr{UInt16}}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t HttpPrepareUrl(
void* Reserved,
uint32_t Flags,
const uint16_t* Url,
uint16_t** PreparedUrl);
]]
local httpapi = ffi.load("httpapi")
-- httpapi.HttpPrepareUrl(Reserved, Flags, Url, PreparedUrl)
-- Reserved : void* optional
-- Flags : DWORD optional
-- Url : LPCWSTR
-- PreparedUrl : LPWSTR* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('HTTPAPI.dll');
const HttpPrepareUrl = lib.func('__stdcall', 'HttpPrepareUrl', 'uint32_t', ['void *', 'uint32_t', 'str16', 'void *']);
// HttpPrepareUrl(Reserved, Flags, Url, PreparedUrl)
// Reserved : void* optional -> 'void *'
// Flags : DWORD optional -> 'uint32_t'
// Url : LPCWSTR -> 'str16'
// PreparedUrl : LPWSTR* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("HTTPAPI.dll", {
HttpPrepareUrl: { parameters: ["pointer", "u32", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.HttpPrepareUrl(Reserved, Flags, Url, PreparedUrl)
// Reserved : void* optional -> "pointer"
// Flags : DWORD optional -> "u32"
// Url : LPCWSTR -> "buffer"
// PreparedUrl : LPWSTR* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t HttpPrepareUrl(
void* Reserved,
uint32_t Flags,
const uint16_t* Url,
uint16_t** PreparedUrl);
C, "HTTPAPI.dll");
// $ffi->HttpPrepareUrl(Reserved, Flags, Url, PreparedUrl);
// Reserved : void* optional
// Flags : DWORD optional
// Url : LPCWSTR
// PreparedUrl : LPWSTR* out
// 構造体/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 Httpapi extends StdCallLibrary {
Httpapi INSTANCE = Native.load("httpapi", Httpapi.class);
int HttpPrepareUrl(
Pointer Reserved, // void* optional
int Flags, // DWORD optional
WString Url, // LPCWSTR
PointerByReference PreparedUrl // LPWSTR* out
);
}@[Link("httpapi")]
lib LibHTTPAPI
fun HttpPrepareUrl = HttpPrepareUrl(
Reserved : Void*, # void* optional
Flags : UInt32, # DWORD optional
Url : UInt16*, # LPCWSTR
PreparedUrl : UInt16** # LPWSTR* out
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef HttpPrepareUrlNative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Utf16>, Pointer<Pointer<Utf16>>);
typedef HttpPrepareUrlDart = int Function(Pointer<Void>, int, Pointer<Utf16>, Pointer<Pointer<Utf16>>);
final HttpPrepareUrl = DynamicLibrary.open('HTTPAPI.dll')
.lookupFunction<HttpPrepareUrlNative, HttpPrepareUrlDart>('HttpPrepareUrl');
// Reserved : void* optional -> Pointer<Void>
// Flags : DWORD optional -> Uint32
// Url : LPCWSTR -> Pointer<Utf16>
// PreparedUrl : LPWSTR* out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function HttpPrepareUrl(
Reserved: Pointer; // void* optional
Flags: DWORD; // DWORD optional
Url: PWideChar; // LPCWSTR
PreparedUrl: PPWideChar // LPWSTR* out
): DWORD; stdcall;
external 'HTTPAPI.dll' name 'HttpPrepareUrl';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "HttpPrepareUrl"
c_HttpPrepareUrl :: Ptr () -> Word32 -> CWString -> Ptr CWString -> IO Word32
-- Reserved : void* optional -> Ptr ()
-- Flags : DWORD optional -> Word32
-- Url : LPCWSTR -> CWString
-- PreparedUrl : LPWSTR* out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let httpprepareurl =
foreign "HttpPrepareUrl"
((ptr void) @-> uint32_t @-> (ptr uint16_t) @-> (ptr (ptr uint16_t)) @-> returning uint32_t)
(* Reserved : void* optional -> (ptr void) *)
(* Flags : DWORD optional -> uint32_t *)
(* Url : LPCWSTR -> (ptr uint16_t) *)
(* PreparedUrl : LPWSTR* out -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library httpapi (t "HTTPAPI.dll"))
(cffi:use-foreign-library httpapi)
(cffi:defcfun ("HttpPrepareUrl" http-prepare-url :convention :stdcall) :uint32
(reserved :pointer) ; void* optional
(flags :uint32) ; DWORD optional
(url (:string :encoding :utf-16le)) ; LPCWSTR
(prepared-url :pointer)) ; LPWSTR* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $HttpPrepareUrl = Win32::API::More->new('HTTPAPI',
'DWORD HttpPrepareUrl(LPVOID Reserved, DWORD Flags, LPCWSTR Url, LPVOID PreparedUrl)');
# my $ret = $HttpPrepareUrl->Call($Reserved, $Flags, $Url, $PreparedUrl);
# Reserved : void* optional -> LPVOID
# Flags : DWORD optional -> DWORD
# Url : LPCWSTR -> LPCWSTR
# PreparedUrl : LPWSTR* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。