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

WsAbandonMessage

関数
チャネル上のメッセージ処理を破棄する。
DLLwebservices.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WsAbandonMessage(
    WS_CHANNEL* channel,
    WS_MESSAGE* message,
    WS_ERROR* error   // optional
);

パラメーター

名前型方向説明
channelWS_CHANNEL*inメッセージの読み取りまたは書き込みが行われているチャネルを表す WS_CHANNEL 構造体へのポインター。
messageWS_MESSAGE*in破棄するメッセージを表す WS_MESSAGE 構造体へのポインター。これは WsWriteMessageStart 関数または WsReadMessageStart 関数に渡したものと同じメッセージである必要があります。
errorWS_ERROR*inoptional関数が失敗した場合に追加のエラー情報を受け取る WS_ERROR 構造体へのポインター。

戻り値の型: HRESULT

公式ドキュメント

指定されたチャネル上の指定されたメッセージの残りをスキップします。

戻り値

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

戻り値 説明
WS_E_INVALID_OPERATION
チャネルが WS_CHANNEL_STATE_OPEN 状態または WS_CHANNEL_STATE_FAULTED 状態ではありません。 (チャネルの状態については、WS_CHANNEL_STATE 列挙型を参照してください。)
E_INVALIDARG
指定されたメッセージは、指定されたチャネル上で現在読み取りまたは書き込みが行われているメッセージではありません。

解説(Remarks)

WsAbandonMessage は、メッセージの残りの内容の読み取りまたは書き込みをスキップし、 そのチャネルで次のメッセージを読み取りまたは書き込みできるようにするために使用します。この点で、次の状態遷移図に示すように、 WsReadMessageEnd 関数または WsWriteMessageEnd 関数の代替手段となります。

:::image type="content" source="./images/AbandonMessage.png" border="false" alt-text="WsAbandonMessage 関数によって生じる状態遷移が、WSReadMessageEnd 関数および WsWriteMessageEnd 関数の場合とどのように異なるかを示す図。":::

読み取り操作の場合、アプリケーションは、メッセージがアプリケーションの要件を満たさない場合など、 メッセージデータの読み取りを続行する必要がないときに、通常 WsAbandonMessage を呼び出します。この関数は、 メッセージに不正な形式の XML が含まれている場合や、XML リーダー が メッセージの読み取り中にエラーを生成した場合にも使用できます。

チャネルがストリーミングされている場合 (WS_TRANSFER_MODE 列挙型の WS_STREAMED_INPUT_TRANSFER_MODE 値を参照してください)、 ストリーミングされたメッセージデータの残りは、そのチャネルに対する次の WsReadMessageStart または WsCloseChannel の呼び出し時に 読み取られ、自動的に破棄されます。チャネルがストリーミングされていない場合は、未読のバッファーされたメッセージデータは 単に破棄されます。

書き込み操作の場合、アプリケーションは、XML ライター から返されたエラーなど、何らかのエラーが発生してメッセージの書き込みを続行できない場合や、その他の理由でメッセージの生成を停止する必要がある場合に、通常 WsAbandonMessage を呼び出します。

チャネルが ストリーミングされている場合 (WS_TRANSFER_MODE 列挙型の WS_STREAMED_INPUT_TRANSFER_MODE 値を参照してください)、メッセージデータは切り詰められ、リモート側で読み取るときにエラーが発生する可能性があります。チャネルがストリーミングされていない場合は、 そのメッセージのバッファーされたデータは (送信されていないため) 単に破棄されます。

この関数を使用すると、エラーが発生した場合でも、チャネルの利用者はチャネルを開いたまま維持し、 追加のメッセージ (フォールトの送信など) を送受信できます。これに対し、WsAbortChannel は チャネルをフォールト状態にします。一般的な使い方としては、まずメッセージの破棄とフォールトの送信を試み、 それが失敗した場合にチャネルを中止します。

この関数はブロッキング I/O を実行しません。

この関数は、チャネルが WS_CHANNEL_STATE_OPEN 状態 または WS_CHANNEL_STATE_FAULTED 状態の場合にのみ有効です。 (チャネルの状態については、WS_CHANNEL_STATE 列挙型を参照してください。)

指定するメッセージは、指定されたチャネルで現在読み取り中のメッセージ、または現在書き込み中のメッセージである 必要があります。

正しく呼び出された場合、この関数は (システムリソースの不足などの理由で) 失敗することはありません。

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

各言語での呼び出し定義

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

HRESULT WsAbandonMessage(
    WS_CHANNEL* channel,
    WS_MESSAGE* message,
    WS_ERROR* error   // optional
);
[DllImport("webservices.dll", ExactSpelling = true)]
static extern int WsAbandonMessage(
    ref IntPtr channel,   // WS_CHANNEL*
    ref IntPtr message,   // WS_MESSAGE*
    IntPtr error   // WS_ERROR* optional
);
<DllImport("webservices.dll", ExactSpelling:=True)>
Public Shared Function WsAbandonMessage(
    ByRef channel As IntPtr,   ' WS_CHANNEL*
    ByRef message As IntPtr,   ' WS_MESSAGE*
    [error] As IntPtr   ' WS_ERROR* optional
) As Integer
End Function
' channel : WS_CHANNEL*
' message : WS_MESSAGE*
' error : WS_ERROR* optional
Declare PtrSafe Function WsAbandonMessage Lib "webservices" ( _
    ByRef channel As LongPtr, _
    ByRef message 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

WsAbandonMessage = ctypes.windll.webservices.WsAbandonMessage
WsAbandonMessage.restype = ctypes.c_int
WsAbandonMessage.argtypes = [
    ctypes.c_void_p,  # channel : WS_CHANNEL*
    ctypes.c_void_p,  # message : WS_MESSAGE*
    ctypes.c_void_p,  # error : WS_ERROR* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('webservices.dll')
WsAbandonMessage = Fiddle::Function.new(
  lib['WsAbandonMessage'],
  [
    Fiddle::TYPE_VOIDP,  # channel : WS_CHANNEL*
    Fiddle::TYPE_VOIDP,  # message : WS_MESSAGE*
    Fiddle::TYPE_VOIDP,  # error : WS_ERROR* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "webservices")]
extern "system" {
    fn WsAbandonMessage(
        channel: *mut isize,  // WS_CHANNEL*
        message: *mut isize,  // WS_MESSAGE*
        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 WsAbandonMessage(ref IntPtr channel, ref IntPtr message, IntPtr error);
"@
$api = Add-Type -MemberDefinition $sig -Name 'webservices_WsAbandonMessage' -Namespace Win32 -PassThru
# $api::WsAbandonMessage(channel, message, error)
#uselib "webservices.dll"
#func global WsAbandonMessage "WsAbandonMessage" sptr, sptr, sptr
; WsAbandonMessage varptr(channel), varptr(message), varptr(error)   ; 戻り値は stat
; channel : WS_CHANNEL* -> "sptr"
; message : WS_MESSAGE* -> "sptr"
; error : WS_ERROR* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "webservices.dll"
#cfunc global WsAbandonMessage "WsAbandonMessage" var, var, var
; res = WsAbandonMessage(channel, message, error)
; channel : WS_CHANNEL* -> "var"
; message : WS_MESSAGE* -> "var"
; error : WS_ERROR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT WsAbandonMessage(WS_CHANNEL* channel, WS_MESSAGE* message, WS_ERROR* error)
#uselib "webservices.dll"
#cfunc global WsAbandonMessage "WsAbandonMessage" var, var, var
; res = WsAbandonMessage(channel, message, error)
; channel : WS_CHANNEL* -> "var"
; message : WS_MESSAGE* -> "var"
; error : WS_ERROR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	webservices = windows.NewLazySystemDLL("webservices.dll")
	procWsAbandonMessage = webservices.NewProc("WsAbandonMessage")
)

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

extern "webservices" fn WsAbandonMessage(
    channel: [*c]isize, // WS_CHANNEL*
    message: [*c]isize, // WS_MESSAGE*
    error: [*c]isize // WS_ERROR* optional
) callconv(std.os.windows.WINAPI) i32;
proc WsAbandonMessage(
    channel: ptr int,  # WS_CHANNEL*
    message: ptr int,  # WS_MESSAGE*
    error: ptr int  # WS_ERROR* optional
): int32 {.importc: "WsAbandonMessage", stdcall, dynlib: "webservices.dll".}
pragma(lib, "webservices");
extern(Windows)
int WsAbandonMessage(
    ptrdiff_t* channel,   // WS_CHANNEL*
    ptrdiff_t* message,   // WS_MESSAGE*
    ptrdiff_t* error   // WS_ERROR* optional
);
ccall((:WsAbandonMessage, "webservices.dll"), stdcall, Int32,
      (Ptr{Int}, Ptr{Int}, Ptr{Int}),
      channel, message, error)
# channel : WS_CHANNEL* -> Ptr{Int}
# message : WS_MESSAGE* -> Ptr{Int}
# error : WS_ERROR* optional -> Ptr{Int}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WsAbandonMessage(
    intptr_t* channel,
    intptr_t* message,
    intptr_t* error);
]]
local webservices = ffi.load("webservices")
-- webservices.WsAbandonMessage(channel, message, error)
-- channel : WS_CHANNEL*
-- message : WS_MESSAGE*
-- error : WS_ERROR* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('webservices.dll');
const WsAbandonMessage = lib.func('__stdcall', 'WsAbandonMessage', 'int32_t', ['intptr_t *', 'intptr_t *', 'intptr_t *']);
// WsAbandonMessage(channel, message, error)
// channel : WS_CHANNEL* -> 'intptr_t *'
// message : WS_MESSAGE* -> 'intptr_t *'
// error : WS_ERROR* optional -> 'intptr_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("webservices.dll", {
  WsAbandonMessage: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WsAbandonMessage(channel, message, error)
// channel : WS_CHANNEL* -> "pointer"
// message : WS_MESSAGE* -> "pointer"
// error : WS_ERROR* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WsAbandonMessage(
    intptr_t* channel,
    intptr_t* message,
    intptr_t* error);
C, "webservices.dll");
// $ffi->WsAbandonMessage(channel, message, error);
// channel : WS_CHANNEL*
// message : WS_MESSAGE*
// 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 WsAbandonMessage(
        LongByReference channel,   // WS_CHANNEL*
        LongByReference message,   // WS_MESSAGE*
        LongByReference error   // WS_ERROR* optional
    );
}
@[Link("webservices")]
lib Libwebservices
  fun WsAbandonMessage = WsAbandonMessage(
    channel : LibC::SSizeT*,   # WS_CHANNEL*
    message : LibC::SSizeT*,   # WS_MESSAGE*
    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 WsAbandonMessageNative = Int32 Function(Pointer<IntPtr>, Pointer<IntPtr>, Pointer<IntPtr>);
typedef WsAbandonMessageDart = int Function(Pointer<IntPtr>, Pointer<IntPtr>, Pointer<IntPtr>);
final WsAbandonMessage = DynamicLibrary.open('webservices.dll')
    .lookupFunction<WsAbandonMessageNative, WsAbandonMessageDart>('WsAbandonMessage');
// channel : WS_CHANNEL* -> Pointer<IntPtr>
// message : WS_MESSAGE* -> Pointer<IntPtr>
// error : WS_ERROR* optional -> Pointer<IntPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WsAbandonMessage(
  channel: Pointer;   // WS_CHANNEL*
  message: Pointer;   // WS_MESSAGE*
  error: Pointer   // WS_ERROR* optional
): Integer; stdcall;
  external 'webservices.dll' name 'WsAbandonMessage';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WsAbandonMessage"
  c_WsAbandonMessage :: Ptr CIntPtr -> Ptr CIntPtr -> Ptr CIntPtr -> IO Int32
-- channel : WS_CHANNEL* -> Ptr CIntPtr
-- message : WS_MESSAGE* -> Ptr CIntPtr
-- error : WS_ERROR* optional -> Ptr CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsabandonmessage =
  foreign "WsAbandonMessage"
    ((ptr intptr_t) @-> (ptr intptr_t) @-> (ptr intptr_t) @-> returning int32_t)
(* channel : WS_CHANNEL* -> (ptr intptr_t) *)
(* message : WS_MESSAGE* -> (ptr intptr_t) *)
(* 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 ("WsAbandonMessage" ws-abandon-message :convention :stdcall) :int32
  (channel :pointer)   ; WS_CHANNEL*
  (message :pointer)   ; WS_MESSAGE*
  (error :pointer))   ; WS_ERROR* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WsAbandonMessage = Win32::API::More->new('webservices',
    'int WsAbandonMessage(LPVOID channel, LPVOID message, LPVOID error)');
# my $ret = $WsAbandonMessage->Call($channel, $message, $error);
# channel : WS_CHANNEL* -> LPVOID
# message : WS_MESSAGE* -> LPVOID
# error : WS_ERROR* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。