ホーム › Networking.WindowsWebServices › WsRequestReply

WsRequestReply

関数

チャネルで要求を送り応答を受信する。

DLLwebservices.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WsRequestReply(
    WS_CHANNEL* channel,
    WS_MESSAGE* requestMessage,
    const WS_MESSAGE_DESCRIPTION* requestMessageDescription,
    WS_WRITE_OPTION writeOption,
    const void* requestBodyValue,   // optional
    DWORD requestBodyValueSize,
    WS_MESSAGE* replyMessage,
    const WS_MESSAGE_DESCRIPTION* replyMessageDescription,
    WS_READ_OPTION readOption,
    WS_HEAP* heap,   // optional
    void* value,   // optional
    DWORD valueSize,
    const WS_ASYNC_CONTEXT* asyncContext,   // optional
    WS_ERROR* error   // optional
);

パラメーター

名前	型	方向	説明
channel	WS_CHANNEL*	in	要求-応答操作を実行するチャネル。
requestMessage	WS_MESSAGE*	in	要求の送信に使用するメッセージオブジェクト。メッセージオブジェクトは WS_MESSAGE_STATE_EMPTY または WS_MESSAGE_STATE_INITIALIZED の状態である必要があります。
requestMessageDescription	WS_MESSAGE_DESCRIPTION*	in	WS_MESSAGE_DESCRIPTION の action フィールドは、要求メッセージの action ヘッダーとして使用されます。action が不要な場合、このフィールドは NULL でもかまいません。 WS_MESSAGE_DESCRIPTION の bodyElementDescription フィールドは、要求メッセージの本文をシリアル化するために使用されます。本文要素が不要な場合、このフィールドは NULL でもかまいません。bodyElementDescription に従って本文がどのようにシリアル化されるかについては、WsWriteBody を参照してください。
writeOption	WS_WRITE_OPTION	in	本文要素が必須かどうか、および値をどのように割り当てるかを指定します。詳細については WS_WRITE_OPTION を参照してください。
requestBodyValue	void*	inoptional	要求オブジェクトの本文にシリアル化する値へのポインター。
requestBodyValueSize	DWORD	in	シリアル化する要求値のサイズ (バイト単位)。
replyMessage	WS_MESSAGE*	in	応答の受信に使用するメッセージオブジェクト。メッセージオブジェクトは WS_MESSAGE_STATE_EMPTY の状態である必要があります。
replyMessageDescription	WS_MESSAGE_DESCRIPTION*	in	WS_MESSAGE_DESCRIPTION の action フィールドは、受信した応答メッセージの action ヘッダーを検証するために使用されます。action が不要な場合、このフィールドは NULL でもかまいません。NULL の場合、受信したメッセージに action ヘッダーが存在していても無視されます。 WS_MESSAGE_DESCRIPTION の bodyElementDescription フィールドは、応答メッセージの本文を逆シリアル化するために使用されます。本文要素が不要な場合、このフィールドは NULL でもかまいません。bodyElementDescription に従って本文がどのように逆シリアル化されるかについては、WsReadBody を参照してください。
readOption	WS_READ_OPTION	in	応答の本文要素が必須かどうか、および値をどのように割り当てるかを指定します。詳細については、WS_READ_OPTION および WsReadBody を参照してください。
heap	WS_HEAP*	inoptional	逆シリアル化された応答本文の値を割り当てるために使用するヒープ。指定された型でヒープが不要な場合、このパラメーターは NULL でもかまいません。
value	void*	outoptional	逆シリアル化された本文の値を格納する場所。このパラメーターの解釈は WS_READ_OPTION によって異なります。応答の WS_MESSAGE_DESCRIPTION の bodyElementDescription が NULL の場合、このパラメーターは変更されません。この場合、パラメーターを指定する必要はありません。
valueSize	DWORD	in	このパラメーターの解釈は WS_READ_OPTION によって異なります。
asyncContext	WS_ASYNC_CONTEXT*	inoptional	関数を非同期に呼び出す方法に関する情報。同期的に呼び出す場合は NULL。
error	WS_ERROR*	inoptional	関数が失敗した場合に、追加のエラー情報を格納する場所を指定します。

戻り値の型: HRESULT

公式ドキュメント

要求メッセージを送信し、それに対応する応答メッセージを受信するために使用します。

戻り値

この関数は、次のいずれかの値を返すことがあります。

戻り値	説明
WS_E_ENDPOINT_FAULT_RECEIVED	応答メッセージにフォールトが含まれていました。フォールトは WS_ERROR から WsGetErrorProperty を使用して取得できます。
WS_S_ASYNC	非同期操作はまだ保留中です。
WS_E_OPERATION_ABORTED	操作が中止されました。
WS_E_INVALID_OPERATION	オブジェクトの現在の状態では、この操作は許可されていません。
WS_E_ENDPOINT_NOT_FOUND	リモートエンドポイントが存在しないか、見つかりませんでした。
WS_E_ENDPOINT_ACCESS_DENIED	リモートエンドポイントによってアクセスが拒否されました。
WS_E_ENDPOINT_DISCONNECTED	リモートエンドポイントとの接続が終了しました。
WS_E_ENDPOINT_FAILURE	リモートエンドポイントが要求を処理できませんでした。
WS_E_ENDPOINT_NOT_AVAILABLE	リモートエンドポイントは、現在この場所ではサービスを提供していません。
WS_E_ENDPOINT_TOO_BUSY	リモートエンドポイントは過負荷のため、要求を処理できません。
WS_E_ENDPOINT_UNREACHABLE	リモートエンドポイントに到達できませんでした。
WS_E_INVALID_ENDPOINT_URL	エンドポイントアドレスの URL が無効です。
WS_E_INVALID_FORMAT	入力データが予期された形式ではないか、予期された値ではありませんでした。
WS_E_OPERATION_TIMED_OUT	操作が、割り当てられた時間内に完了しませんでした。
WS_E_PROXY_ACCESS_DENIED	HTTP プロキシサーバーによってアクセスが拒否されました。
WS_E_PROXY_FAILURE	HTTP プロキシサーバーが要求を処理できませんでした。
WS_E_QUOTA_EXCEEDED	クォータを超過しました。
WS_E_SECURITY_VERIFICATION_FAILURE	受信したデータのセキュリティ検証に失敗しました。
WS_E_SECURITY_SYSTEM_FAILURE	Windows Web Services フレームワークでセキュリティ操作が失敗しました。
WS_E_SECURITY_TOKEN_EXPIRED	セキュリティトークンの有効期限が切れているため、サーバーによって拒否されました。
WS_E_PROXY_REQUIRES_BASIC_AUTH	HTTP プロキシサーバーは、HTTP 認証方式 'basic' を必要とします。
WS_E_PROXY_REQUIRES_DIGEST_AUTH	HTTP プロキシサーバーは、HTTP 認証方式 'digest' を必要とします。
WS_E_PROXY_REQUIRES_NEGOTIATE_AUTH	HTTP プロキシサーバーは、HTTP 認証方式 'negotiate' を必要とします。
WS_E_PROXY_REQUIRES_NTLM_AUTH	HTTP プロキシサーバーは、HTTP 認証方式 'NTLM' を必要とします。
WS_E_SERVER_REQUIRES_BASIC_AUTH	リモートエンドポイントは、HTTP 認証方式 'basic' を必要とします。
WS_E_SERVER_REQUIRES_DIGEST_AUTH	リモートエンドポイントは、HTTP 認証方式 'digest' を必要とします。
WS_E_SERVER_REQUIRES_NEGOTIATE_AUTH	リモートエンドポイントは、HTTP 認証方式 'negotiate' を必要とします。
WS_E_SERVER_REQUIRES_NTLM_AUTH	リモートエンドポイントは、HTTP 認証方式 'NTLM' を必要とします。
CERT_E_EXPIRED	現在のシステムクロックまたは署名済みファイル内のタイムスタンプに対して検証したときに、必要な証明書が有効期間内にありません。
CERT_E_CN_NO_MATCH	証明書の CN 名が、渡された値と一致しません。
CERT_E_UNTRUSTEDROOT	証明書チェーンは処理されましたが、信頼プロバイダーが信頼していないルート証明書で終了しました。
CERT_E_WRONG_USAGE	この証明書は、要求された用途には有効ではありません。
CRYPT_E_REVOCATION_OFFLINE	失効サーバーがオフラインであったため、失効確認の関数は失効を確認できませんでした。
E_OUTOFMEMORY	メモリが不足しました。
E_INVALIDARG	1 つ以上の引数が無効です。
その他のエラー	この関数は、上記以外のエラーを返すことがあります。

解説(Remarks)

メッセージは WS_ADDRESSING_VERSION に応じて適切に関連付けられます。要求と応答のメッセージの関連付けの詳細については、チャネル層の概要を参照してください。

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

各言語での呼び出し定義

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

HRESULT WsRequestReply(
    WS_CHANNEL* channel,
    WS_MESSAGE* requestMessage,
    const WS_MESSAGE_DESCRIPTION* requestMessageDescription,
    WS_WRITE_OPTION writeOption,
    const void* requestBodyValue,   // optional
    DWORD requestBodyValueSize,
    WS_MESSAGE* replyMessage,
    const WS_MESSAGE_DESCRIPTION* replyMessageDescription,
    WS_READ_OPTION readOption,
    WS_HEAP* heap,   // optional
    void* value,   // optional
    DWORD valueSize,
    const WS_ASYNC_CONTEXT* asyncContext,   // optional
    WS_ERROR* error   // optional
);

[DllImport("webservices.dll", ExactSpelling = true)]
static extern int WsRequestReply(
    ref IntPtr channel,   // WS_CHANNEL*
    ref IntPtr requestMessage,   // WS_MESSAGE*
    IntPtr requestMessageDescription,   // WS_MESSAGE_DESCRIPTION*
    int writeOption,   // WS_WRITE_OPTION
    IntPtr requestBodyValue,   // void* optional
    uint requestBodyValueSize,   // DWORD
    ref IntPtr replyMessage,   // WS_MESSAGE*
    IntPtr replyMessageDescription,   // WS_MESSAGE_DESCRIPTION*
    int readOption,   // WS_READ_OPTION
    IntPtr heap,   // WS_HEAP* optional
    IntPtr value,   // void* optional, out
    uint valueSize,   // DWORD
    IntPtr asyncContext,   // WS_ASYNC_CONTEXT* optional
    IntPtr error   // WS_ERROR* optional
);

<DllImport("webservices.dll", ExactSpelling:=True)>
Public Shared Function WsRequestReply(
    ByRef channel As IntPtr,   ' WS_CHANNEL*
    ByRef requestMessage As IntPtr,   ' WS_MESSAGE*
    requestMessageDescription As IntPtr,   ' WS_MESSAGE_DESCRIPTION*
    writeOption As Integer,   ' WS_WRITE_OPTION
    requestBodyValue As IntPtr,   ' void* optional
    requestBodyValueSize As UInteger,   ' DWORD
    ByRef replyMessage As IntPtr,   ' WS_MESSAGE*
    replyMessageDescription As IntPtr,   ' WS_MESSAGE_DESCRIPTION*
    readOption As Integer,   ' WS_READ_OPTION
    heap As IntPtr,   ' WS_HEAP* optional
    value As IntPtr,   ' void* optional, out
    valueSize As UInteger,   ' DWORD
    asyncContext As IntPtr,   ' WS_ASYNC_CONTEXT* optional
    [error] As IntPtr   ' WS_ERROR* optional
) As Integer
End Function

' channel : WS_CHANNEL*
' requestMessage : WS_MESSAGE*
' requestMessageDescription : WS_MESSAGE_DESCRIPTION*
' writeOption : WS_WRITE_OPTION
' requestBodyValue : void* optional
' requestBodyValueSize : DWORD
' replyMessage : WS_MESSAGE*
' replyMessageDescription : WS_MESSAGE_DESCRIPTION*
' readOption : WS_READ_OPTION
' heap : WS_HEAP* optional
' value : void* optional, out
' valueSize : DWORD
' asyncContext : WS_ASYNC_CONTEXT* optional
' error : WS_ERROR* optional
Declare PtrSafe Function WsRequestReply Lib "webservices" ( _
    ByRef channel As LongPtr, _
    ByRef requestMessage As LongPtr, _
    ByVal requestMessageDescription As LongPtr, _
    ByVal writeOption As Long, _
    ByVal requestBodyValue As LongPtr, _
    ByVal requestBodyValueSize As Long, _
    ByRef replyMessage As LongPtr, _
    ByVal replyMessageDescription As LongPtr, _
    ByVal readOption As Long, _
    ByVal heap As LongPtr, _
    ByVal value As LongPtr, _
    ByVal valueSize As Long, _
    ByVal asyncContext 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

WsRequestReply = ctypes.windll.webservices.WsRequestReply
WsRequestReply.restype = ctypes.c_int
WsRequestReply.argtypes = [
    ctypes.c_void_p,  # channel : WS_CHANNEL*
    ctypes.c_void_p,  # requestMessage : WS_MESSAGE*
    ctypes.c_void_p,  # requestMessageDescription : WS_MESSAGE_DESCRIPTION*
    ctypes.c_int,  # writeOption : WS_WRITE_OPTION
    ctypes.POINTER(None),  # requestBodyValue : void* optional
    wintypes.DWORD,  # requestBodyValueSize : DWORD
    ctypes.c_void_p,  # replyMessage : WS_MESSAGE*
    ctypes.c_void_p,  # replyMessageDescription : WS_MESSAGE_DESCRIPTION*
    ctypes.c_int,  # readOption : WS_READ_OPTION
    ctypes.c_void_p,  # heap : WS_HEAP* optional
    ctypes.POINTER(None),  # value : void* optional, out
    wintypes.DWORD,  # valueSize : DWORD
    ctypes.c_void_p,  # asyncContext : WS_ASYNC_CONTEXT* optional
    ctypes.c_void_p,  # error : WS_ERROR* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('webservices.dll')
WsRequestReply = Fiddle::Function.new(
  lib['WsRequestReply'],
  [
    Fiddle::TYPE_VOIDP,  # channel : WS_CHANNEL*
    Fiddle::TYPE_VOIDP,  # requestMessage : WS_MESSAGE*
    Fiddle::TYPE_VOIDP,  # requestMessageDescription : WS_MESSAGE_DESCRIPTION*
    Fiddle::TYPE_INT,  # writeOption : WS_WRITE_OPTION
    Fiddle::TYPE_VOIDP,  # requestBodyValue : void* optional
    -Fiddle::TYPE_INT,  # requestBodyValueSize : DWORD
    Fiddle::TYPE_VOIDP,  # replyMessage : WS_MESSAGE*
    Fiddle::TYPE_VOIDP,  # replyMessageDescription : WS_MESSAGE_DESCRIPTION*
    Fiddle::TYPE_INT,  # readOption : WS_READ_OPTION
    Fiddle::TYPE_VOIDP,  # heap : WS_HEAP* optional
    Fiddle::TYPE_VOIDP,  # value : void* optional, out
    -Fiddle::TYPE_INT,  # valueSize : DWORD
    Fiddle::TYPE_VOIDP,  # asyncContext : WS_ASYNC_CONTEXT* optional
    Fiddle::TYPE_VOIDP,  # error : WS_ERROR* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "webservices")]
extern "system" {
    fn WsRequestReply(
        channel: *mut isize,  // WS_CHANNEL*
        requestMessage: *mut isize,  // WS_MESSAGE*
        requestMessageDescription: *const WS_MESSAGE_DESCRIPTION,  // WS_MESSAGE_DESCRIPTION*
        writeOption: i32,  // WS_WRITE_OPTION
        requestBodyValue: *const (),  // void* optional
        requestBodyValueSize: u32,  // DWORD
        replyMessage: *mut isize,  // WS_MESSAGE*
        replyMessageDescription: *const WS_MESSAGE_DESCRIPTION,  // WS_MESSAGE_DESCRIPTION*
        readOption: i32,  // WS_READ_OPTION
        heap: *mut isize,  // WS_HEAP* optional
        value: *mut (),  // void* optional, out
        valueSize: u32,  // DWORD
        asyncContext: *const WS_ASYNC_CONTEXT,  // WS_ASYNC_CONTEXT* optional
        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 WsRequestReply(ref IntPtr channel, ref IntPtr requestMessage, IntPtr requestMessageDescription, int writeOption, IntPtr requestBodyValue, uint requestBodyValueSize, ref IntPtr replyMessage, IntPtr replyMessageDescription, int readOption, IntPtr heap, IntPtr value, uint valueSize, IntPtr asyncContext, IntPtr error);
"@
$api = Add-Type -MemberDefinition $sig -Name 'webservices_WsRequestReply' -Namespace Win32 -PassThru
# $api::WsRequestReply(channel, requestMessage, requestMessageDescription, writeOption, requestBodyValue, requestBodyValueSize, replyMessage, replyMessageDescription, readOption, heap, value, valueSize, asyncContext, error)

#uselib "webservices.dll"
#func global WsRequestReply "WsRequestReply" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WsRequestReply varptr(channel), varptr(requestMessage), varptr(requestMessageDescription), writeOption, requestBodyValue, requestBodyValueSize, varptr(replyMessage), varptr(replyMessageDescription), readOption, varptr(heap), value, valueSize, varptr(asyncContext), varptr(error)   ; 戻り値は stat
; channel : WS_CHANNEL* -> "sptr"
; requestMessage : WS_MESSAGE* -> "sptr"
; requestMessageDescription : WS_MESSAGE_DESCRIPTION* -> "sptr"
; writeOption : WS_WRITE_OPTION -> "sptr"
; requestBodyValue : void* optional -> "sptr"
; requestBodyValueSize : DWORD -> "sptr"
; replyMessage : WS_MESSAGE* -> "sptr"
; replyMessageDescription : WS_MESSAGE_DESCRIPTION* -> "sptr"
; readOption : WS_READ_OPTION -> "sptr"
; heap : WS_HEAP* optional -> "sptr"
; value : void* optional, out -> "sptr"
; valueSize : DWORD -> "sptr"
; asyncContext : WS_ASYNC_CONTEXT* optional -> "sptr"
; error : WS_ERROR* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "webservices.dll"
#cfunc global WsRequestReply "WsRequestReply" var, var, var, int, sptr, int, var, var, int, var, sptr, int, var, var
; res = WsRequestReply(channel, requestMessage, requestMessageDescription, writeOption, requestBodyValue, requestBodyValueSize, replyMessage, replyMessageDescription, readOption, heap, value, valueSize, asyncContext, error)
; channel : WS_CHANNEL* -> "var"
; requestMessage : WS_MESSAGE* -> "var"
; requestMessageDescription : WS_MESSAGE_DESCRIPTION* -> "var"
; writeOption : WS_WRITE_OPTION -> "int"
; requestBodyValue : void* optional -> "sptr"
; requestBodyValueSize : DWORD -> "int"
; replyMessage : WS_MESSAGE* -> "var"
; replyMessageDescription : WS_MESSAGE_DESCRIPTION* -> "var"
; readOption : WS_READ_OPTION -> "int"
; heap : WS_HEAP* optional -> "var"
; value : void* optional, out -> "sptr"
; valueSize : DWORD -> "int"
; asyncContext : WS_ASYNC_CONTEXT* optional -> "var"
; error : WS_ERROR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "webservices.dll"
#cfunc global WsRequestReply "WsRequestReply" sptr, sptr, sptr, int, sptr, int, sptr, sptr, int, sptr, sptr, int, sptr, sptr
; res = WsRequestReply(varptr(channel), varptr(requestMessage), varptr(requestMessageDescription), writeOption, requestBodyValue, requestBodyValueSize, varptr(replyMessage), varptr(replyMessageDescription), readOption, varptr(heap), value, valueSize, varptr(asyncContext), varptr(error))
; channel : WS_CHANNEL* -> "sptr"
; requestMessage : WS_MESSAGE* -> "sptr"
; requestMessageDescription : WS_MESSAGE_DESCRIPTION* -> "sptr"
; writeOption : WS_WRITE_OPTION -> "int"
; requestBodyValue : void* optional -> "sptr"
; requestBodyValueSize : DWORD -> "int"
; replyMessage : WS_MESSAGE* -> "sptr"
; replyMessageDescription : WS_MESSAGE_DESCRIPTION* -> "sptr"
; readOption : WS_READ_OPTION -> "int"
; heap : WS_HEAP* optional -> "sptr"
; value : void* optional, out -> "sptr"
; valueSize : DWORD -> "int"
; asyncContext : WS_ASYNC_CONTEXT* optional -> "sptr"
; error : WS_ERROR* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。