ホーム › Networking.WindowsWebServices › WsAsyncExecute

WsAsyncExecute

関数

非同期操作を実行する。

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

シグネチャ

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

HRESULT WsAsyncExecute(
    WS_ASYNC_STATE* asyncState,
    WS_ASYNC_FUNCTION operation,
    WS_CALLBACK_MODEL callbackModel,
    void* callbackState,   // optional
    const WS_ASYNC_CONTEXT* asyncContext,   // optional
    WS_ERROR* error   // optional
);

パラメーター

名前	型	方向	説明
asyncState	WS_ASYNC_STATE*	in	非同期操作中に使用される WS_ASYNC_STATE 構造体へのポインターです。これは状態を管理するためのパラメーターであり、直接使用することを意図したものではありません。アプリケーションは WS_ASYNC_STATE 構造体を割り当て、非同期操作全体の間、それが有効な状態で保たれるようにする必要があります。WS_ASYNC_STATE 構造体は、非同期操作の完了後に再利用できます。
operation	WS_ASYNC_FUNCTION	in	実行する最初の非同期操作を表します。
callbackModel	WS_CALLBACK_MODEL	in	コールバックが long と short のどちらで呼び出されるかを示します。詳細については、WS_CALLBACK_MODEL を参照してください。
callbackState	void*	inoptional	各 WS_ASYNC_FUNCTION に渡される、ユーザー定義の値への void ポインターです。
asyncContext	WS_ASYNC_CONTEXT*	inoptional	関数を非同期に呼び出すための情報へのポインターです。関数を同期的に呼び出すには NULL を渡します。
error	WS_ERROR*	inoptional	関数が失敗した場合に、追加のエラー情報を受け取る WS_ERROR 構造体へのポインターです。

戻り値の型: HRESULT

公式ドキュメント

非同期操作を実装するためのヘルパー関数です。

戻り値

関数が成功した場合は NO_ERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

WWSAPI が非同期操作をどのように扱うかについては、Asynchronous Model のトピックを参照してください。

多くの場合、非同期操作は他の非同期操作から構成されます。各非同期操作は、コールバックが呼び出されることを示す WS_S_ASYNC を返すか、あるいはその他の成功コードまたは失敗コードを返します。後者の場合、コールバックは呼び出されません。操作は、呼び出し元が同期的な実行を要求していることを示す NULL の WS_ASYNC_CONTEXT を受け入れられるようにしておく必要があります。また、コールバックが適切に呼び出されるようにする必要もあります。複雑な非同期操作では、WsAsyncExecute がこれらの詳細を簡略化します。

WsAsyncExecute は、ユーザー定義のコールバックを呼び出すことによって動作します。このコールバックは非同期操作を開始し、その非同期操作の完了時に呼び出す関数を指定できます。この流れは、コールバックが次に呼び出す関数を設定しなくなるまで続きます。その時点で、いずれかの操作が非同期に完了していた場合は、WS_ASYNC_CONTEXT で指定されたコールバックが呼び出されます。

WS_ASYNC_STATE パラメーターは WsAsyncExecute が自身の状態を保持するために使用するものであり、呼び出し元が初期化したり、内容を調べたり、使用したりすることを意図したものではありません。ただし呼び出し元は、WS_ASYNC_STATE を割り当て、非同期操作全体の間、それが有効な状態で保たれるようにする必要があります。WS_ASYNC_STATE は、非同期操作の完了後に再利用できます。

AsyncAdd3ExplicitExample および AsyncAdd3ImplicitExample の例では、同じ非同期関数を手動で実装する場合と WsAsyncExecute を使用して実装する場合を示しています。

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

各言語での呼び出し定義

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

HRESULT WsAsyncExecute(
    WS_ASYNC_STATE* asyncState,
    WS_ASYNC_FUNCTION operation,
    WS_CALLBACK_MODEL callbackModel,
    void* callbackState,   // optional
    const WS_ASYNC_CONTEXT* asyncContext,   // optional
    WS_ERROR* error   // optional
);

[DllImport("webservices.dll", ExactSpelling = true)]
static extern int WsAsyncExecute(
    IntPtr asyncState,   // WS_ASYNC_STATE*
    IntPtr operation,   // WS_ASYNC_FUNCTION
    int callbackModel,   // WS_CALLBACK_MODEL
    IntPtr callbackState,   // void* optional
    IntPtr asyncContext,   // WS_ASYNC_CONTEXT* optional
    IntPtr error   // WS_ERROR* optional
);

<DllImport("webservices.dll", ExactSpelling:=True)>
Public Shared Function WsAsyncExecute(
    asyncState As IntPtr,   ' WS_ASYNC_STATE*
    operation As IntPtr,   ' WS_ASYNC_FUNCTION
    callbackModel As Integer,   ' WS_CALLBACK_MODEL
    callbackState As IntPtr,   ' void* optional
    asyncContext As IntPtr,   ' WS_ASYNC_CONTEXT* optional
    [error] As IntPtr   ' WS_ERROR* optional
) As Integer
End Function

' asyncState : WS_ASYNC_STATE*
' operation : WS_ASYNC_FUNCTION
' callbackModel : WS_CALLBACK_MODEL
' callbackState : void* optional
' asyncContext : WS_ASYNC_CONTEXT* optional
' error : WS_ERROR* optional
Declare PtrSafe Function WsAsyncExecute Lib "webservices" ( _
    ByVal asyncState As LongPtr, _
    ByVal operation As LongPtr, _
    ByVal callbackModel As Long, _
    ByVal callbackState As LongPtr, _
    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

WsAsyncExecute = ctypes.windll.webservices.WsAsyncExecute
WsAsyncExecute.restype = ctypes.c_int
WsAsyncExecute.argtypes = [
    ctypes.c_void_p,  # asyncState : WS_ASYNC_STATE*
    ctypes.c_void_p,  # operation : WS_ASYNC_FUNCTION
    ctypes.c_int,  # callbackModel : WS_CALLBACK_MODEL
    ctypes.POINTER(None),  # callbackState : void* optional
    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')
WsAsyncExecute = Fiddle::Function.new(
  lib['WsAsyncExecute'],
  [
    Fiddle::TYPE_VOIDP,  # asyncState : WS_ASYNC_STATE*
    Fiddle::TYPE_VOIDP,  # operation : WS_ASYNC_FUNCTION
    Fiddle::TYPE_INT,  # callbackModel : WS_CALLBACK_MODEL
    Fiddle::TYPE_VOIDP,  # callbackState : void* optional
    Fiddle::TYPE_VOIDP,  # asyncContext : WS_ASYNC_CONTEXT* optional
    Fiddle::TYPE_VOIDP,  # error : WS_ERROR* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "webservices")]
extern "system" {
    fn WsAsyncExecute(
        asyncState: *mut WS_ASYNC_STATE,  // WS_ASYNC_STATE*
        operation: *const core::ffi::c_void,  // WS_ASYNC_FUNCTION
        callbackModel: i32,  // WS_CALLBACK_MODEL
        callbackState: *mut (),  // void* optional
        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 WsAsyncExecute(IntPtr asyncState, IntPtr operation, int callbackModel, IntPtr callbackState, IntPtr asyncContext, IntPtr error);
"@
$api = Add-Type -MemberDefinition $sig -Name 'webservices_WsAsyncExecute' -Namespace Win32 -PassThru
# $api::WsAsyncExecute(asyncState, operation, callbackModel, callbackState, asyncContext, error)

#uselib "webservices.dll"
#func global WsAsyncExecute "WsAsyncExecute" sptr, sptr, sptr, sptr, sptr, sptr
; WsAsyncExecute varptr(asyncState), operation, callbackModel, callbackState, varptr(asyncContext), varptr(error)   ; 戻り値は stat
; asyncState : WS_ASYNC_STATE* -> "sptr"
; operation : WS_ASYNC_FUNCTION -> "sptr"
; callbackModel : WS_CALLBACK_MODEL -> "sptr"
; callbackState : void* optional -> "sptr"
; asyncContext : WS_ASYNC_CONTEXT* optional -> "sptr"
; error : WS_ERROR* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "webservices.dll"
#cfunc global WsAsyncExecute "WsAsyncExecute" var, sptr, int, sptr, var, var
; res = WsAsyncExecute(asyncState, operation, callbackModel, callbackState, asyncContext, error)
; asyncState : WS_ASYNC_STATE* -> "var"
; operation : WS_ASYNC_FUNCTION -> "sptr"
; callbackModel : WS_CALLBACK_MODEL -> "int"
; callbackState : void* optional -> "sptr"
; asyncContext : WS_ASYNC_CONTEXT* optional -> "var"
; error : WS_ERROR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "webservices.dll"
#cfunc global WsAsyncExecute "WsAsyncExecute" sptr, sptr, int, sptr, sptr, sptr
; res = WsAsyncExecute(varptr(asyncState), operation, callbackModel, callbackState, varptr(asyncContext), varptr(error))
; asyncState : WS_ASYNC_STATE* -> "sptr"
; operation : WS_ASYNC_FUNCTION -> "sptr"
; callbackModel : WS_CALLBACK_MODEL -> "int"
; callbackState : void* optional -> "sptr"
; asyncContext : WS_ASYNC_CONTEXT* optional -> "sptr"
; error : WS_ERROR* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。