ホーム › Networking.WindowsWebServices › WsAcceptChannel

WsAcceptChannel

関数

リスナーで着信チャネルを受け入れる。

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

シグネチャ

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

HRESULT WsAcceptChannel(
    WS_LISTENER* listener,
    WS_CHANNEL* channel,
    const WS_ASYNC_CONTEXT* asyncContext,   // optional
    WS_ERROR* error   // optional
);

パラメーター

名前	型	方向	説明
listener	WS_LISTENER*	in	リスナーを表す WS_LISTENER 構造体へのポインター。これは、チャネルの作成時に WsCreateChannelForListener に渡したリスナーです。
channel	WS_CHANNEL*	in	受け入れるチャネルを表す WS_CHANNEL 構造体へのポインター。
asyncContext	WS_ASYNC_CONTEXT*	inoptional	関数を非同期的に呼び出すための情報を格納した WS_ASYNC_CONTEXT データ構造体へのポインター。同期操作の場合は NULL を渡します。
error	WS_ERROR*	inoptional	関数が失敗した場合に追加のエラー情報を受け取る WS_ERROR 構造体へのポインター。

戻り値の型: HRESULT

公式ドキュメント

指定されたリスナーからの次の受信メッセージを受け入れます。

戻り値

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

戻り値	説明
WS_S_ASYNC	非同期操作はまだ保留中です。
WS_E_OPERATION_ABORTED	リスナーまたはチャネルが中止されました。
WS_E_OBJECT_FAULTED	リスナーが障害状態になりました。「解説」セクションを参照してください。
WS_E_INVALID_OPERATION	リスナーまたはチャネル、あるいはその両方が不適切な状態でした。 `「解説」セクションを参照してください。`
WS_E_ENDPOINT_DISCONNECTED	リモートエンドポイントとの接続が切断されました。
WS_E_OPERATION_TIMED_OUT	操作が割り当てられた時間内に完了しませんでした。
WS_E_QUOTA_EXCEEDED	クォータを超過しました。
WS_E_INVALID_FORMAT	入力データが期待される形式ではないか、期待される値ではありませんでした。
E_OUTOFMEMORY	操作を完了するためのメモリが不足しています。
E_INVALIDARG	1 つ以上の引数が有効ではありません。
WS_E_SECURITY_VERIFICATION_FAILURE	受信したデータのセキュリティ検証に失敗しました。
WS_E_SECURITY_SYSTEM_FAILURE	Windows Web Services フレームワークでセキュリティ操作が失敗しました。
その他のエラー	この関数は、上記以外のエラーを返す場合があります。

解説(Remarks)

チャネルを受け入れたら、不要になった時点で WsCloseChannel 関数を呼び出してチャネルを閉じ、続いて WsFreeChannel または WsResetChannel のいずれかを呼び出してリソースを解放する必要があります。

WsAcceptChannel が成功するには、リスナーが WS_LISTENER_STATE_OPEN 状態であり、チャネルが WS_CHANNEL_STATE_CREATED 状態である必要があります。詳細については、WS_LISTENER_STATE 列挙型および WS_CHANNEL_STATE 列挙型を参照してください。

リスナーが WS_LISTENER_STATE_FAULTED 状態の場合、 WsAcceptChannel は直ちに WS_E_OBJECT_FAULTED エラーコードを返します。アプリケーションが WsAcceptChannel をループ内で呼び出している場合は、ループを終了できるように、このエラーを確認する必要があります。

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

各言語での呼び出し定義

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

HRESULT WsAcceptChannel(
    WS_LISTENER* listener,
    WS_CHANNEL* channel,
    const WS_ASYNC_CONTEXT* asyncContext,   // optional
    WS_ERROR* error   // optional
);

[DllImport("webservices.dll", ExactSpelling = true)]
static extern int WsAcceptChannel(
    ref IntPtr listener,   // WS_LISTENER*
    ref IntPtr channel,   // WS_CHANNEL*
    IntPtr asyncContext,   // WS_ASYNC_CONTEXT* optional
    IntPtr error   // WS_ERROR* optional
);

<DllImport("webservices.dll", ExactSpelling:=True)>
Public Shared Function WsAcceptChannel(
    ByRef listener As IntPtr,   ' WS_LISTENER*
    ByRef channel As IntPtr,   ' WS_CHANNEL*
    asyncContext As IntPtr,   ' WS_ASYNC_CONTEXT* optional
    [error] As IntPtr   ' WS_ERROR* optional
) As Integer
End Function

' listener : WS_LISTENER*
' channel : WS_CHANNEL*
' asyncContext : WS_ASYNC_CONTEXT* optional
' error : WS_ERROR* optional
Declare PtrSafe Function WsAcceptChannel Lib "webservices" ( _
    ByRef listener As LongPtr, _
    ByRef channel 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

WsAcceptChannel = ctypes.windll.webservices.WsAcceptChannel
WsAcceptChannel.restype = ctypes.c_int
WsAcceptChannel.argtypes = [
    ctypes.c_void_p,  # listener : WS_LISTENER*
    ctypes.c_void_p,  # channel : WS_CHANNEL*
    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')
WsAcceptChannel = Fiddle::Function.new(
  lib['WsAcceptChannel'],
  [
    Fiddle::TYPE_VOIDP,  # listener : WS_LISTENER*
    Fiddle::TYPE_VOIDP,  # channel : WS_CHANNEL*
    Fiddle::TYPE_VOIDP,  # asyncContext : WS_ASYNC_CONTEXT* optional
    Fiddle::TYPE_VOIDP,  # error : WS_ERROR* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "webservices")]
extern "system" {
    fn WsAcceptChannel(
        listener: *mut isize,  // WS_LISTENER*
        channel: *mut isize,  // WS_CHANNEL*
        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 WsAcceptChannel(ref IntPtr listener, ref IntPtr channel, IntPtr asyncContext, IntPtr error);
"@
$api = Add-Type -MemberDefinition $sig -Name 'webservices_WsAcceptChannel' -Namespace Win32 -PassThru
# $api::WsAcceptChannel(listener, channel, asyncContext, error)

#uselib "webservices.dll"
#func global WsAcceptChannel "WsAcceptChannel" sptr, sptr, sptr, sptr
; WsAcceptChannel varptr(listener), varptr(channel), varptr(asyncContext), varptr(error)   ; 戻り値は stat
; listener : WS_LISTENER* -> "sptr"
; channel : WS_CHANNEL* -> "sptr"
; asyncContext : WS_ASYNC_CONTEXT* optional -> "sptr"
; error : WS_ERROR* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "webservices.dll"
#cfunc global WsAcceptChannel "WsAcceptChannel" var, var, var, var
; res = WsAcceptChannel(listener, channel, asyncContext, error)
; listener : WS_LISTENER* -> "var"
; channel : WS_CHANNEL* -> "var"
; asyncContext : WS_ASYNC_CONTEXT* optional -> "var"
; error : WS_ERROR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "webservices.dll"
#cfunc global WsAcceptChannel "WsAcceptChannel" sptr, sptr, sptr, sptr
; res = WsAcceptChannel(varptr(listener), varptr(channel), varptr(asyncContext), varptr(error))
; listener : WS_LISTENER* -> "sptr"
; channel : WS_CHANNEL* -> "sptr"
; asyncContext : WS_ASYNC_CONTEXT* optional -> "sptr"
; error : WS_ERROR* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。