Win32 API 日本語リファレンス
ホーム › Networking.WindowsWebServices › WsEncodeUrl

WsEncodeUrl

関数
URL構造体をエンコードしてURL文字列を生成する。
DLLwebservices.dll呼出規約winapi対応OSWindows 7 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HRESULT WsEncodeUrl(
    const WS_URL* url,
    DWORD flags,
    WS_HEAP* heap,
    WS_STRING* outUrl,
    WS_ERROR* error   // optional
);

パラメーター

名前型方向説明
urlWS_URL*in符号化する構成要素を含むWS_URL構造体。
flagsDWORDin符号化動作を制御するフラグ。通常は0を指定する。
heapWS_HEAP*in生成文字列の確保に使うWS_HEAP。
outUrlWS_STRING*out符号化されたURL文字列を受け取る出力WS_STRING。
errorWS_ERROR*inoptional詳細なエラー情報を格納するWS_ERRORオブジェクト。NULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WsEncodeUrl(
    const WS_URL* url,
    DWORD flags,
    WS_HEAP* heap,
    WS_STRING* outUrl,
    WS_ERROR* error   // optional
);
[DllImport("webservices.dll", ExactSpelling = true)]
static extern int WsEncodeUrl(
    IntPtr url,   // WS_URL*
    uint flags,   // DWORD
    ref IntPtr heap,   // WS_HEAP*
    IntPtr outUrl,   // WS_STRING* out
    IntPtr error   // WS_ERROR* optional
);
<DllImport("webservices.dll", ExactSpelling:=True)>
Public Shared Function WsEncodeUrl(
    url As IntPtr,   ' WS_URL*
    flags As UInteger,   ' DWORD
    ByRef heap As IntPtr,   ' WS_HEAP*
    outUrl As IntPtr,   ' WS_STRING* out
    [error] As IntPtr   ' WS_ERROR* optional
) As Integer
End Function
' url : WS_URL*
' flags : DWORD
' heap : WS_HEAP*
' outUrl : WS_STRING* out
' error : WS_ERROR* optional
Declare PtrSafe Function WsEncodeUrl Lib "webservices" ( _
    ByVal url As LongPtr, _
    ByVal flags As Long, _
    ByRef heap As LongPtr, _
    ByVal outUrl As LongPtr, _
    ByVal error As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WsEncodeUrl = ctypes.windll.webservices.WsEncodeUrl
WsEncodeUrl.restype = ctypes.c_int
WsEncodeUrl.argtypes = [
    ctypes.c_void_p,  # url : WS_URL*
    wintypes.DWORD,  # flags : DWORD
    ctypes.c_void_p,  # heap : WS_HEAP*
    ctypes.c_void_p,  # outUrl : WS_STRING* out
    ctypes.c_void_p,  # error : WS_ERROR* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('webservices.dll')
WsEncodeUrl = Fiddle::Function.new(
  lib['WsEncodeUrl'],
  [
    Fiddle::TYPE_VOIDP,  # url : WS_URL*
    -Fiddle::TYPE_INT,  # flags : DWORD
    Fiddle::TYPE_VOIDP,  # heap : WS_HEAP*
    Fiddle::TYPE_VOIDP,  # outUrl : WS_STRING* out
    Fiddle::TYPE_VOIDP,  # error : WS_ERROR* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "webservices")]
extern "system" {
    fn WsEncodeUrl(
        url: *const WS_URL,  // WS_URL*
        flags: u32,  // DWORD
        heap: *mut isize,  // WS_HEAP*
        outUrl: *mut WS_STRING,  // WS_STRING* out
        error: *mut isize  // WS_ERROR* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("webservices.dll")]
public static extern int WsEncodeUrl(IntPtr url, uint flags, ref IntPtr heap, IntPtr outUrl, IntPtr error);
"@
$api = Add-Type -MemberDefinition $sig -Name 'webservices_WsEncodeUrl' -Namespace Win32 -PassThru
# $api::WsEncodeUrl(url, flags, heap, outUrl, error)
#uselib "webservices.dll"
#func global WsEncodeUrl "WsEncodeUrl" sptr, sptr, sptr, sptr, sptr
; WsEncodeUrl varptr(url), flags, varptr(heap), varptr(outUrl), varptr(error)   ; 戻り値は stat
; url : WS_URL* -> "sptr"
; flags : DWORD -> "sptr"
; heap : WS_HEAP* -> "sptr"
; outUrl : WS_STRING* out -> "sptr"
; error : WS_ERROR* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "webservices.dll"
#cfunc global WsEncodeUrl "WsEncodeUrl" var, int, var, var, var
; res = WsEncodeUrl(url, flags, heap, outUrl, error)
; url : WS_URL* -> "var"
; flags : DWORD -> "int"
; heap : WS_HEAP* -> "var"
; outUrl : WS_STRING* out -> "var"
; error : WS_ERROR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; HRESULT WsEncodeUrl(WS_URL* url, DWORD flags, WS_HEAP* heap, WS_STRING* outUrl, WS_ERROR* error)
#uselib "webservices.dll"
#cfunc global WsEncodeUrl "WsEncodeUrl" var, int, var, var, var
; res = WsEncodeUrl(url, flags, heap, outUrl, error)
; url : WS_URL* -> "var"
; flags : DWORD -> "int"
; heap : WS_HEAP* -> "var"
; outUrl : WS_STRING* out -> "var"
; error : WS_ERROR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	webservices = windows.NewLazySystemDLL("webservices.dll")
	procWsEncodeUrl = webservices.NewProc("WsEncodeUrl")
)

// url (WS_URL*), flags (DWORD), heap (WS_HEAP*), outUrl (WS_STRING* out), error (WS_ERROR* optional)
r1, _, err := procWsEncodeUrl.Call(
	uintptr(url),
	uintptr(flags),
	uintptr(heap),
	uintptr(outUrl),
	uintptr(error),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WsEncodeUrl(
  url: Pointer;   // WS_URL*
  flags: DWORD;   // DWORD
  heap: Pointer;   // WS_HEAP*
  outUrl: Pointer;   // WS_STRING* out
  error: Pointer   // WS_ERROR* optional
): Integer; stdcall;
  external 'webservices.dll' name 'WsEncodeUrl';
result := DllCall("webservices\WsEncodeUrl"
    , "Ptr", url   ; WS_URL*
    , "UInt", flags   ; DWORD
    , "Ptr", heap   ; WS_HEAP*
    , "Ptr", outUrl   ; WS_STRING* out
    , "Ptr", error   ; WS_ERROR* optional
    , "Int")   ; return: HRESULT
●WsEncodeUrl(url, flags, heap, outUrl, error) = DLL("webservices.dll", "int WsEncodeUrl(void*, dword, void*, void*, void*)")
# 呼び出し: WsEncodeUrl(url, flags, heap, outUrl, error)
# url : WS_URL* -> "void*"
# flags : DWORD -> "dword"
# heap : WS_HEAP* -> "void*"
# outUrl : WS_STRING* out -> "void*"
# error : WS_ERROR* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "webservices" fn WsEncodeUrl(
    url: [*c]WS_URL, // WS_URL*
    flags: u32, // DWORD
    heap: [*c]isize, // WS_HEAP*
    outUrl: [*c]WS_STRING, // WS_STRING* out
    error: [*c]isize // WS_ERROR* optional
) callconv(std.os.windows.WINAPI) i32;
proc WsEncodeUrl(
    url: ptr WS_URL,  # WS_URL*
    flags: uint32,  # DWORD
    heap: ptr int,  # WS_HEAP*
    outUrl: ptr WS_STRING,  # WS_STRING* out
    error: ptr int  # WS_ERROR* optional
): int32 {.importc: "WsEncodeUrl", stdcall, dynlib: "webservices.dll".}
pragma(lib, "webservices");
extern(Windows)
int WsEncodeUrl(
    WS_URL* url,   // WS_URL*
    uint flags,   // DWORD
    ptrdiff_t* heap,   // WS_HEAP*
    WS_STRING* outUrl,   // WS_STRING* out
    ptrdiff_t* error   // WS_ERROR* optional
);
ccall((:WsEncodeUrl, "webservices.dll"), stdcall, Int32,
      (Ptr{WS_URL}, UInt32, Ptr{Int}, Ptr{WS_STRING}, Ptr{Int}),
      url, flags, heap, outUrl, error)
# url : WS_URL* -> Ptr{WS_URL}
# flags : DWORD -> UInt32
# heap : WS_HEAP* -> Ptr{Int}
# outUrl : WS_STRING* out -> Ptr{WS_STRING}
# error : WS_ERROR* optional -> Ptr{Int}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WsEncodeUrl(
    void* url,
    uint32_t flags,
    intptr_t* heap,
    void* outUrl,
    intptr_t* error);
]]
local webservices = ffi.load("webservices")
-- webservices.WsEncodeUrl(url, flags, heap, outUrl, error)
-- url : WS_URL*
-- flags : DWORD
-- heap : WS_HEAP*
-- outUrl : WS_STRING* out
-- error : WS_ERROR* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('webservices.dll');
const WsEncodeUrl = lib.func('__stdcall', 'WsEncodeUrl', 'int32_t', ['void *', 'uint32_t', 'intptr_t *', 'void *', 'intptr_t *']);
// WsEncodeUrl(url, flags, heap, outUrl, error)
// url : WS_URL* -> 'void *'
// flags : DWORD -> 'uint32_t'
// heap : WS_HEAP* -> 'intptr_t *'
// outUrl : WS_STRING* out -> 'void *'
// error : WS_ERROR* optional -> 'intptr_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("webservices.dll", {
  WsEncodeUrl: { parameters: ["pointer", "u32", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WsEncodeUrl(url, flags, heap, outUrl, error)
// url : WS_URL* -> "pointer"
// flags : DWORD -> "u32"
// heap : WS_HEAP* -> "pointer"
// outUrl : WS_STRING* out -> "pointer"
// error : WS_ERROR* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WsEncodeUrl(
    void* url,
    uint32_t flags,
    intptr_t* heap,
    void* outUrl,
    intptr_t* error);
C, "webservices.dll");
// $ffi->WsEncodeUrl(url, flags, heap, outUrl, error);
// url : WS_URL*
// flags : DWORD
// heap : WS_HEAP*
// outUrl : WS_STRING* out
// error : WS_ERROR* optional
// 構造体/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 Webservices extends StdCallLibrary {
    Webservices INSTANCE = Native.load("webservices", Webservices.class);
    int WsEncodeUrl(
        Pointer url,   // WS_URL*
        int flags,   // DWORD
        LongByReference heap,   // WS_HEAP*
        Pointer outUrl,   // WS_STRING* out
        LongByReference error   // WS_ERROR* optional
    );
}
@[Link("webservices")]
lib Libwebservices
  fun WsEncodeUrl = WsEncodeUrl(
    url : WS_URL*,   # WS_URL*
    flags : UInt32,   # DWORD
    heap : LibC::SSizeT*,   # WS_HEAP*
    outUrl : WS_STRING*,   # WS_STRING* out
    error : LibC::SSizeT*   # WS_ERROR* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WsEncodeUrlNative = Int32 Function(Pointer<Void>, Uint32, Pointer<IntPtr>, Pointer<Void>, Pointer<IntPtr>);
typedef WsEncodeUrlDart = int Function(Pointer<Void>, int, Pointer<IntPtr>, Pointer<Void>, Pointer<IntPtr>);
final WsEncodeUrl = DynamicLibrary.open('webservices.dll')
    .lookupFunction<WsEncodeUrlNative, WsEncodeUrlDart>('WsEncodeUrl');
// url : WS_URL* -> Pointer<Void>
// flags : DWORD -> Uint32
// heap : WS_HEAP* -> Pointer<IntPtr>
// outUrl : WS_STRING* out -> Pointer<Void>
// error : WS_ERROR* optional -> Pointer<IntPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WsEncodeUrl(
  url: Pointer;   // WS_URL*
  flags: DWORD;   // DWORD
  heap: Pointer;   // WS_HEAP*
  outUrl: Pointer;   // WS_STRING* out
  error: Pointer   // WS_ERROR* optional
): Integer; stdcall;
  external 'webservices.dll' name 'WsEncodeUrl';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WsEncodeUrl"
  c_WsEncodeUrl :: Ptr () -> Word32 -> Ptr CIntPtr -> Ptr () -> Ptr CIntPtr -> IO Int32
-- url : WS_URL* -> Ptr ()
-- flags : DWORD -> Word32
-- heap : WS_HEAP* -> Ptr CIntPtr
-- outUrl : WS_STRING* out -> Ptr ()
-- error : WS_ERROR* optional -> Ptr CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsencodeurl =
  foreign "WsEncodeUrl"
    ((ptr void) @-> uint32_t @-> (ptr intptr_t) @-> (ptr void) @-> (ptr intptr_t) @-> returning int32_t)
(* url : WS_URL* -> (ptr void) *)
(* flags : DWORD -> uint32_t *)
(* heap : WS_HEAP* -> (ptr intptr_t) *)
(* outUrl : WS_STRING* out -> (ptr void) *)
(* error : WS_ERROR* optional -> (ptr intptr_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library webservices (t "webservices.dll"))
(cffi:use-foreign-library webservices)

(cffi:defcfun ("WsEncodeUrl" ws-encode-url :convention :stdcall) :int32
  (url :pointer)   ; WS_URL*
  (flags :uint32)   ; DWORD
  (heap :pointer)   ; WS_HEAP*
  (out-url :pointer)   ; WS_STRING* out
  (error :pointer))   ; WS_ERROR* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WsEncodeUrl = Win32::API::More->new('webservices',
    'int WsEncodeUrl(LPVOID url, DWORD flags, LPVOID heap, LPVOID outUrl, LPVOID error)');
# my $ret = $WsEncodeUrl->Call($url, $flags, $heap, $outUrl, $error);
# url : WS_URL* -> LPVOID
# flags : DWORD -> DWORD
# heap : WS_HEAP* -> LPVOID
# outUrl : WS_STRING* out -> LPVOID
# error : WS_ERROR* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型