Win32 API 日本語リファレンス
ホーム › Devices.Tapi › lineDrop

lineDrop

関数
通話を切断して終了する。
DLLTAPI32.dll呼出規約winapi

シグネチャ

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

INT lineDrop(
    DWORD hCall,
    LPCSTR lpsUserUserInfo,
    DWORD dwSize
);

パラメーター

名前型方向説明
hCallDWORDinドロップする通話のハンドル。アプリケーションはその通話の所有者である必要があります。hCall の通話状態は、idle 以外の任意の状態で構いません。
lpsUserUserInfoLPCSTRin通話の切断の一部としてリモート側に送信するユーザー ユーザー情報を格納した文字列へのポインター。ユーザー ユーザー情報を送信しない場合、このポインターは NULL のままにできます。ユーザー ユーザー情報は、基盤となるネットワークがサポートしている場合にのみ送信されます ( LINEDEVCAPS を参照してください)。ユーザー ユーザー情報のプロトコル識別子フィールドは、必要な場合は lpsUserUserInfo が指すバッファーの先頭バイトに配置する必要があり、dwSize にもその分を含める必要があります。
dwSizeDWORDinlpsUserUserInfo 内のユーザー ユーザー情報のサイズ (バイト単位)。lpsUserUserInfo が NULL の場合、ユーザー ユーザー情報は発信側に送信されず、dwSize は無視されます。

戻り値の型: INT

公式ドキュメント

lineDrop 関数は、指定された通話をドロップ (切断) します。アプリケーションは、通話の切断の一部として送信するユーザー ユーザー情報を指定することもできます。

戻り値

関数が非同期に完了する場合は正の要求識別子を返し、エラーが発生した場合は負のエラー番号を返します。対応する LINE_REPLY メッセージの dwParam2 パラメーターは、関数が成功した場合は 0 になり、エラーが発生した場合は負のエラー番号になります。返される可能性のある値は次のとおりです。

LINEERR_INVALCALLHANDLE、LINEERR_OPERATIONUNAVAIL、LINEERR_NOMEM、LINEERR_OPERATIONFAILED、LINEERR_NOTOWNER、LINEERR_RESOURCEUNAVAIL、LINEERR_INVALPOINTER、LINEERR_USERUSERINFOTOOBIG、LINEERR_INVALCALLSTATE、LINEERR_UNINITIALIZED。

解説(Remarks)

lineDrop を呼び出すと、関連する通話も影響を受ける場合があります。たとえば、会議通話をドロップすると、参加している個々の通話がすべてドロップされることがあります。通話状態が影響を受けたすべての通話について、 LINE_CALLSTATE メッセージがアプリケーションに送信されます。ドロップされた通話は、通常 idle 状態に遷移します。offering 状態の通話に対して lineDrop を呼び出すと、その通話は拒否されます。すべての電話網がこの機能を提供しているわけではありません。

onholdpending 状態の通話は、通常 connected 状態に戻ります。会議通話のために第三者への相談通話をドロップする場合、または既に確立された会議通話から第三者を除外する場合、プロバイダー (および交換機) は会議ブリッジを解放し、通話を通常の 2 者間通話に戻すことがあります。この場合、hConfCall は idle 状態に遷移し、残った唯一の参加通話は connected 状態に遷移します。一部の交換機では、もう一方の通話の保留が自動的に解除されます。

アプリケーションは、ドロップ時にユーザー ユーザー情報を送信することもできます。ユーザー ユーザー情報を送信できる場合でも、ネットワークがその情報をリモート側に配信する保証はありません。

複数の相手が通話に参加しているさまざまなブリッジ構成やパーティ ライン構成では、 lineDrop によって実際には通話がクリアされないことがあります。たとえばブリッジ構成では、通話中の他のステーションの状態が優先されることがあるため、 lineDrop 操作を行っても実際には通話がドロップされない場合があります。その場合、通話が他のステーションで connected のままであれば、通話は単に LINECONNECTEDMODE_INACTIVE モードに変更されるだけになることがあります。

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

各言語での呼び出し定義

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

INT lineDrop(
    DWORD hCall,
    LPCSTR lpsUserUserInfo,
    DWORD dwSize
);
[DllImport("TAPI32.dll", ExactSpelling = true)]
static extern int lineDrop(
    uint hCall,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpsUserUserInfo,   // LPCSTR
    uint dwSize   // DWORD
);
<DllImport("TAPI32.dll", ExactSpelling:=True)>
Public Shared Function lineDrop(
    hCall As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpsUserUserInfo As String,   ' LPCSTR
    dwSize As UInteger   ' DWORD
) As Integer
End Function
' hCall : DWORD
' lpsUserUserInfo : LPCSTR
' dwSize : DWORD
Declare PtrSafe Function lineDrop Lib "tapi32" ( _
    ByVal hCall As Long, _
    ByVal lpsUserUserInfo As String, _
    ByVal dwSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

lineDrop = ctypes.windll.tapi32.lineDrop
lineDrop.restype = ctypes.c_int
lineDrop.argtypes = [
    wintypes.DWORD,  # hCall : DWORD
    wintypes.LPCSTR,  # lpsUserUserInfo : LPCSTR
    wintypes.DWORD,  # dwSize : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineDrop = Fiddle::Function.new(
  lib['lineDrop'],
  [
    -Fiddle::TYPE_INT,  # hCall : DWORD
    Fiddle::TYPE_VOIDP,  # lpsUserUserInfo : LPCSTR
    -Fiddle::TYPE_INT,  # dwSize : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "tapi32")]
extern "system" {
    fn lineDrop(
        hCall: u32,  // DWORD
        lpsUserUserInfo: *const u8,  // LPCSTR
        dwSize: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("TAPI32.dll")]
public static extern int lineDrop(uint hCall, [MarshalAs(UnmanagedType.LPStr)] string lpsUserUserInfo, uint dwSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineDrop' -Namespace Win32 -PassThru
# $api::lineDrop(hCall, lpsUserUserInfo, dwSize)
#uselib "TAPI32.dll"
#func global lineDrop "lineDrop" sptr, sptr, sptr
; lineDrop hCall, lpsUserUserInfo, dwSize   ; 戻り値は stat
; hCall : DWORD -> "sptr"
; lpsUserUserInfo : LPCSTR -> "sptr"
; dwSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "TAPI32.dll"
#cfunc global lineDrop "lineDrop" int, str, int
; res = lineDrop(hCall, lpsUserUserInfo, dwSize)
; hCall : DWORD -> "int"
; lpsUserUserInfo : LPCSTR -> "str"
; dwSize : DWORD -> "int"
; INT lineDrop(DWORD hCall, LPCSTR lpsUserUserInfo, DWORD dwSize)
#uselib "TAPI32.dll"
#cfunc global lineDrop "lineDrop" int, str, int
; res = lineDrop(hCall, lpsUserUserInfo, dwSize)
; hCall : DWORD -> "int"
; lpsUserUserInfo : LPCSTR -> "str"
; dwSize : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	tapi32 = windows.NewLazySystemDLL("TAPI32.dll")
	proclineDrop = tapi32.NewProc("lineDrop")
)

// hCall (DWORD), lpsUserUserInfo (LPCSTR), dwSize (DWORD)
r1, _, err := proclineDrop.Call(
	uintptr(hCall),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpsUserUserInfo))),
	uintptr(dwSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function lineDrop(
  hCall: DWORD;   // DWORD
  lpsUserUserInfo: PAnsiChar;   // LPCSTR
  dwSize: DWORD   // DWORD
): Integer; stdcall;
  external 'TAPI32.dll' name 'lineDrop';
result := DllCall("TAPI32\lineDrop"
    , "UInt", hCall   ; DWORD
    , "AStr", lpsUserUserInfo   ; LPCSTR
    , "UInt", dwSize   ; DWORD
    , "Int")   ; return: INT
●lineDrop(hCall, lpsUserUserInfo, dwSize) = DLL("TAPI32.dll", "int lineDrop(dword, char*, dword)")
# 呼び出し: lineDrop(hCall, lpsUserUserInfo, dwSize)
# hCall : DWORD -> "dword"
# lpsUserUserInfo : LPCSTR -> "char*"
# dwSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "tapi32" fn lineDrop(
    hCall: u32, // DWORD
    lpsUserUserInfo: [*c]const u8, // LPCSTR
    dwSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc lineDrop(
    hCall: uint32,  # DWORD
    lpsUserUserInfo: cstring,  # LPCSTR
    dwSize: uint32  # DWORD
): int32 {.importc: "lineDrop", stdcall, dynlib: "TAPI32.dll".}
pragma(lib, "tapi32");
extern(Windows)
int lineDrop(
    uint hCall,   // DWORD
    const(char)* lpsUserUserInfo,   // LPCSTR
    uint dwSize   // DWORD
);
ccall((:lineDrop, "TAPI32.dll"), stdcall, Int32,
      (UInt32, Cstring, UInt32),
      hCall, lpsUserUserInfo, dwSize)
# hCall : DWORD -> UInt32
# lpsUserUserInfo : LPCSTR -> Cstring
# dwSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t lineDrop(
    uint32_t hCall,
    const char* lpsUserUserInfo,
    uint32_t dwSize);
]]
local tapi32 = ffi.load("tapi32")
-- tapi32.lineDrop(hCall, lpsUserUserInfo, dwSize)
-- hCall : DWORD
-- lpsUserUserInfo : LPCSTR
-- dwSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('TAPI32.dll');
const lineDrop = lib.func('__stdcall', 'lineDrop', 'int32_t', ['uint32_t', 'str', 'uint32_t']);
// lineDrop(hCall, lpsUserUserInfo, dwSize)
// hCall : DWORD -> 'uint32_t'
// lpsUserUserInfo : LPCSTR -> 'str'
// dwSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("TAPI32.dll", {
  lineDrop: { parameters: ["u32", "buffer", "u32"], result: "i32" },
});
// lib.symbols.lineDrop(hCall, lpsUserUserInfo, dwSize)
// hCall : DWORD -> "u32"
// lpsUserUserInfo : LPCSTR -> "buffer"
// dwSize : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t lineDrop(
    uint32_t hCall,
    const char* lpsUserUserInfo,
    uint32_t dwSize);
C, "TAPI32.dll");
// $ffi->lineDrop(hCall, lpsUserUserInfo, dwSize);
// hCall : DWORD
// lpsUserUserInfo : LPCSTR
// dwSize : DWORD
// 構造体/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 Tapi32 extends StdCallLibrary {
    Tapi32 INSTANCE = Native.load("tapi32", Tapi32.class);
    int lineDrop(
        int hCall,   // DWORD
        String lpsUserUserInfo,   // LPCSTR
        int dwSize   // DWORD
    );
}
@[Link("tapi32")]
lib LibTAPI32
  fun lineDrop = lineDrop(
    hCall : UInt32,   # DWORD
    lpsUserUserInfo : UInt8*,   # LPCSTR
    dwSize : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef lineDropNative = Int32 Function(Uint32, Pointer<Utf8>, Uint32);
typedef lineDropDart = int Function(int, Pointer<Utf8>, int);
final lineDrop = DynamicLibrary.open('TAPI32.dll')
    .lookupFunction<lineDropNative, lineDropDart>('lineDrop');
// hCall : DWORD -> Uint32
// lpsUserUserInfo : LPCSTR -> Pointer<Utf8>
// dwSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function lineDrop(
  hCall: DWORD;   // DWORD
  lpsUserUserInfo: PAnsiChar;   // LPCSTR
  dwSize: DWORD   // DWORD
): Integer; stdcall;
  external 'TAPI32.dll' name 'lineDrop';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "lineDrop"
  c_lineDrop :: Word32 -> CString -> Word32 -> IO Int32
-- hCall : DWORD -> Word32
-- lpsUserUserInfo : LPCSTR -> CString
-- dwSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let linedrop =
  foreign "lineDrop"
    (uint32_t @-> string @-> uint32_t @-> returning int32_t)
(* hCall : DWORD -> uint32_t *)
(* lpsUserUserInfo : LPCSTR -> string *)
(* dwSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library tapi32 (t "TAPI32.dll"))
(cffi:use-foreign-library tapi32)

(cffi:defcfun ("lineDrop" line-drop :convention :stdcall) :int32
  (h-call :uint32)   ; DWORD
  (lps-user-user-info :string)   ; LPCSTR
  (dw-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $lineDrop = Win32::API::More->new('TAPI32',
    'int lineDrop(DWORD hCall, LPCSTR lpsUserUserInfo, DWORD dwSize)');
# my $ret = $lineDrop->Call($hCall, $lpsUserUserInfo, $dwSize);
# hCall : DWORD -> DWORD
# lpsUserUserInfo : LPCSTR -> LPCSTR
# dwSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。