ホーム › Networking.WindowsWebServices › WsCloseChannel

WsCloseChannel

関数

チャネルを閉じる。

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

シグネチャ

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

HRESULT WsCloseChannel(
    WS_CHANNEL* channel,
    const WS_ASYNC_CONTEXT* asyncContext,   // optional
    WS_ERROR* error   // optional
);

パラメーター

名前	型	方向	説明
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	チャネルのクローズ処理中に WsAbortChannel が呼び出されたため、クローズ処理が中止されました。
WS_E_INVALID_OPERATION	チャネルが不適切な状態でした (「解説」を参照してください)。
WS_E_ENDPOINT_DISCONNECTED	リモートエンドポイントとの接続が切断されました。
WS_E_ENDPOINT_FAILURE	リモートエンドポイントが要求を処理できませんでした。
WS_E_INVALID_FORMAT	入力データが期待される形式ではないか、期待される値を持っていませんでした。
WS_E_OPERATION_TIMED_OUT	操作が割り当てられた時間内に完了しませんでした。
WS_E_QUOTA_EXCEEDED	クォータを超過しました。
E_OUTOFMEMORY	操作を完了するためのメモリが不足しています。
E_INVALIDARG	1 つ以上の引数が無効です。
その他のエラー	この関数は、上記以外のエラーを返すことがあります。

解説(Remarks)

チャネルを開いた場合、またはチャネルの受け入れに成功した場合は、不要になった時点でそのチャネルを閉じる必要があります。チャネルを閉じた後は、関連するリソースを安全に解放できます。

チャネルのクローズ処理では、既に開始されている保留中の I/O が完了するまで待機します。

そのチャネルで現在読み取りまたは書き込み中のメッセージがない場合、チャネルはグレースフルシャットダウン (正常な切断) を試みます。それ以外の場合は、チャネル上で保留中のすべての I/O が中止され、チャネルはラフシャットダウン (強制的な切断) を行います。

チャネルがグレースフルシャットダウンを試みてエラーが発生した場合、WsCloseChannel はエラーを返しますが、チャネル自体は閉じられます。

この操作は、チャネルが WS_CHANNEL_STATE_OPEN または WS_CHANNEL_STATE_FAULTED の状態にある場合にのみ許可されます。

チャネルを閉じると、読み取りまたは書き込みの処理中であるメッセージは自動的に関連付けが解除されます。したがって、WsCloseChannel を呼び出す前に WsAbandonMessage を呼び出す必要はありません)。

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

各言語での呼び出し定義

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

HRESULT WsCloseChannel(
    WS_CHANNEL* channel,
    const WS_ASYNC_CONTEXT* asyncContext,   // optional
    WS_ERROR* error   // optional
);

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

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

' channel : WS_CHANNEL*
' asyncContext : WS_ASYNC_CONTEXT* optional
' error : WS_ERROR* optional
Declare PtrSafe Function WsCloseChannel Lib "webservices" ( _
    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

WsCloseChannel = ctypes.windll.webservices.WsCloseChannel
WsCloseChannel.restype = ctypes.c_int
WsCloseChannel.argtypes = [
    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')
WsCloseChannel = Fiddle::Function.new(
  lib['WsCloseChannel'],
  [
    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 WsCloseChannel(
        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 WsCloseChannel(ref IntPtr channel, IntPtr asyncContext, IntPtr error);
"@
$api = Add-Type -MemberDefinition $sig -Name 'webservices_WsCloseChannel' -Namespace Win32 -PassThru
# $api::WsCloseChannel(channel, asyncContext, error)

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

出力引数:

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