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

lineHandoffA

関数
通話の所有権を別アプリに引き渡す(ANSI版)。
DLLTAPI32.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

// TAPI32.dll  (ANSI / -A)
#include <windows.h>

INT lineHandoffA(
    DWORD hCall,
    LPCSTR lpszFileName,
    DWORD dwMediaMode
);

パラメーター

名前型方向説明
hCallDWORDinハンドオフする通話へのハンドル。アプリケーションはその通話の所有者である必要があります。hCall の通話状態はどの状態でもかまいません。
lpszFileNameLPCSTRinnull で終わる文字列へのポインター。このポインターパラメーターが NULL 以外の場合、ハンドオフ先となるアプリケーションのファイル名を格納します。NULL の場合、ハンドオフ先は、指定されたメディアモードに対して所有者特権で回線を開いている、最も優先度の高いアプリケーションになります。有効なファイル名には、ファイルのパスを含めません。
dwMediaModeDWORDin間接ハンドオフの対象を識別するために使用するメディアモード。dwMediaMode パラメーターは、通話の所有権を受け取る対象のアプリケーションを間接的に識別します。lpszFileName が NULL 以外の場合、このパラメーターは無視されます。このパラメーターには、 LINEMEDIAMODE_ 定数のうち 1 つだけを指定します。

戻り値の型: INT

公式ドキュメント

lineHandoff 関数は、指定された通話の所有権を別のアプリケーションに渡します。対象のアプリケーションは、そのファイル名で直接指定するか、指定したメディアモードの通話を処理する最も優先度の高いアプリケーションとして間接的に指定できます。(lineHandoffA)

戻り値

要求が成功した場合は 0 を、エラーが発生した場合は負のエラー番号を返します。返される可能性のある値は次のとおりです。

LINEERR_INVALCALLHANDLE、LINEERR_OPERATIONFAILED、LINEERR_INVALMEDIAMODE、LINEERR_TARGETNOTFOUND、LINEERR_INVALPOINTER、LINEERR_TARGETSELF、LINEERR_NOMEM、LINEERR_UNINITIALIZED、LINEERR_NOTOWNER。

解説(Remarks)

lineHandoff 関数は、呼び出し元のアプリケーションが間接ハンドオフを試み (つまり lpszFileName パラメーターに NULL を指定し)、そのアプリケーション自体が指定されたメディアモードに対して最も優先度の高いアプリケーションであると TAPI が判断した場合に、LINEERR_TARGETSELF を返します。LINEERR_TARGETNOTFOUND が返された場合は、通話のハンドオフ先が見つからなかったことを意味します。これは、指定された名前のアプリケーションが、 lineOpen の dwPrivileges パラメーターに LINECALLPRIVILEGE_OWNER ビットを指定して同じ回線を開いていない場合に発生します。また、メディアモードによるハンドオフの場合は、 lineOpen の dwPrivileges パラメーターに LINECALLPRIVILEGE_OWNER ビットを指定し、かつ lineOpen の dwMediaModes パラメーターに指定されたメディアモードを指定して同じ回線を開いているアプリケーションが 1 つも存在しない場合に発生します。

通話のハンドオフにより、通話の所有権をアプリケーション間で受け渡すことができます。ハンドオフには 2 種類あります。1 つ目は、アプリケーションが対象アプリケーションのファイル名を把握している場合で、単にそのファイル名を指定します。対象アプリケーションのインスタンスが回線デバイスを開いていれば、通話の所有権はそのアプリケーションに渡されます。開いていない場合、ハンドオフは失敗し、エラーが返されます。この形式のハンドオフは、ハンドオフを要求するアプリケーションと同じファイル名に通話ハンドルを渡す場合にも成功します。

2 つ目のハンドオフはメディアモードに基づくものです。この場合、アプリケーションはメディアモードによって対象アプリケーションを間接的に指定します。そのメディアモードで現在回線デバイスを開いている、最も優先度の高いアプリケーションがハンドオフ先となります。該当するアプリケーションが存在しない場合、ハンドオフは失敗し、エラーが返されます。

lineHandoff 関数は、通話のメディアモードを変更しません。通話のメディアモードを変更するには、アプリケーションはその通話に対して lineSetMediaMode を使用し、新しいメディアモードを指定します。これにより、通話の LINECALLINFO 構造体に格納されている通話のメディアモードが変更されます。

ハンドオフが成功すると、受け取り側のアプリケーションはその通話に関する LINE_CALLSTATE メッセージを受け取ります。このメッセージは、受け取り側のアプリケーションがその通話に対する所有者特権を持つことを示します (dwParam3)。さらに、その通話の所有者やモニターの数が変化している場合があります。これは LINE_CALLINFO メッセージによって通知され、受け取り側のアプリケーションは lineGetCallStatus や lineGetCallInfo を呼び出して、受け取った通話に関する詳細情報を取得できます。

受け取り側のアプリケーションは、まず LINECALLINFO 内のメディアモードを確認する必要があります。メディアモードのフラグが 1 つだけ設定されている場合、その通話は正式にそのメディアモードであり、アプリケーションはそれに応じて動作できます。UNKNOWN と他のメディアモードのフラグが設定されている場合、その通話のメディアモードは正式には UNKNOWN ですが、 LINECALLINFO でフラグが設定されているいずれかのメディアモードであると想定されます。アプリケーションは、最も優先度の高いメディアモードについて調査 (probe) すべきであると想定してください。

調査が (そのメディアモードまたは別のメディアモードで) 成功した場合、アプリケーションは LINECALLINFO のメディアモードメンバーを、認識された単一のメディアモードに設定する必要があります。そのメディアモードのフラグが LINECALLINFO のメディアモードと一致する場合、アプリケーションはそれに応じて動作できます。別のメディアモードであると判断した場合は、まずその通話をそのメディアモードへハンドオフする必要があります。

調査が失敗した場合、アプリケーションは LINECALLINFO 内の該当するメディアモードのフラグをクリアし、dwMediaMode に LINEMEDIAMODE_UNKNOWN を指定して通話をハンドオフする必要があります。また、自身の通話ハンドルを解放する (またはモニターに戻る) 必要もあります。

いずれのメディアモードでも判断できなかった場合、メディアアプリケーションが通話を UNKNOWN へハンドオフしようとする時点で、 LINECALLINFO のメディアモードフィールドには UNKNOWN フラグだけが設定された状態になります。アプリケーションがその通話の唯一の残った所有者である場合、最後の lineHandoff は失敗します。これは、アプリケーションが通話を切断してハンドルを解放すべきであることを示しており、その場合、通話は破棄されます。この操作によって、呼び出し元アプリケーションのその通話に対する特権は変化しませんが、アプリケーションは lineSetCallPrivilege を使用して通話に対する自身の特権を変更できます。

メモ

tapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして lineHandoff を定義します。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

// TAPI32.dll  (ANSI / -A)
#include <windows.h>

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

lineHandoffA = ctypes.windll.tapi32.lineHandoffA
lineHandoffA.restype = ctypes.c_int
lineHandoffA.argtypes = [
    wintypes.DWORD,  # hCall : DWORD
    wintypes.LPCSTR,  # lpszFileName : LPCSTR
    wintypes.DWORD,  # dwMediaMode : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	tapi32 = windows.NewLazySystemDLL("TAPI32.dll")
	proclineHandoffA = tapi32.NewProc("lineHandoffA")
)

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

extern "tapi32" fn lineHandoffA(
    hCall: u32, // DWORD
    lpszFileName: [*c]const u8, // LPCSTR
    dwMediaMode: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc lineHandoffA(
    hCall: uint32,  # DWORD
    lpszFileName: cstring,  # LPCSTR
    dwMediaMode: uint32  # DWORD
): int32 {.importc: "lineHandoffA", stdcall, dynlib: "TAPI32.dll".}
pragma(lib, "tapi32");
extern(Windows)
int lineHandoffA(
    uint hCall,   // DWORD
    const(char)* lpszFileName,   // LPCSTR
    uint dwMediaMode   // DWORD
);
ccall((:lineHandoffA, "TAPI32.dll"), stdcall, Int32,
      (UInt32, Cstring, UInt32),
      hCall, lpszFileName, dwMediaMode)
# hCall : DWORD -> UInt32
# lpszFileName : LPCSTR -> Cstring
# dwMediaMode : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t lineHandoffA(
    uint32_t hCall,
    const char* lpszFileName,
    uint32_t dwMediaMode);
]]
local tapi32 = ffi.load("tapi32")
-- tapi32.lineHandoffA(hCall, lpszFileName, dwMediaMode)
-- hCall : DWORD
-- lpszFileName : LPCSTR
-- dwMediaMode : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('TAPI32.dll');
const lineHandoffA = lib.func('__stdcall', 'lineHandoffA', 'int32_t', ['uint32_t', 'str', 'uint32_t']);
// lineHandoffA(hCall, lpszFileName, dwMediaMode)
// hCall : DWORD -> 'uint32_t'
// lpszFileName : LPCSTR -> 'str'
// dwMediaMode : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("TAPI32.dll", {
  lineHandoffA: { parameters: ["u32", "buffer", "u32"], result: "i32" },
});
// lib.symbols.lineHandoffA(hCall, lpszFileName, dwMediaMode)
// hCall : DWORD -> "u32"
// lpszFileName : LPCSTR -> "buffer"
// dwMediaMode : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t lineHandoffA(
    uint32_t hCall,
    const char* lpszFileName,
    uint32_t dwMediaMode);
C, "TAPI32.dll");
// $ffi->lineHandoffA(hCall, lpszFileName, dwMediaMode);
// hCall : DWORD
// lpszFileName : LPCSTR
// dwMediaMode : 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, W32APIOptions.ASCII_OPTIONS);
    int lineHandoffA(
        int hCall,   // DWORD
        String lpszFileName,   // LPCSTR
        int dwMediaMode   // DWORD
    );
}
@[Link("tapi32")]
lib LibTAPI32
  fun lineHandoffA = lineHandoffA(
    hCall : UInt32,   # DWORD
    lpszFileName : UInt8*,   # LPCSTR
    dwMediaMode : 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 lineHandoffANative = Int32 Function(Uint32, Pointer<Utf8>, Uint32);
typedef lineHandoffADart = int Function(int, Pointer<Utf8>, int);
final lineHandoffA = DynamicLibrary.open('TAPI32.dll')
    .lookupFunction<lineHandoffANative, lineHandoffADart>('lineHandoffA');
// hCall : DWORD -> Uint32
// lpszFileName : LPCSTR -> Pointer<Utf8>
// dwMediaMode : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function lineHandoffA(
  hCall: DWORD;   // DWORD
  lpszFileName: PAnsiChar;   // LPCSTR
  dwMediaMode: DWORD   // DWORD
): Integer; stdcall;
  external 'TAPI32.dll' name 'lineHandoffA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let linehandoffa =
  foreign "lineHandoffA"
    (uint32_t @-> string @-> uint32_t @-> returning int32_t)
(* hCall : DWORD -> uint32_t *)
(* lpszFileName : LPCSTR -> string *)
(* dwMediaMode : 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 ("lineHandoffA" line-handoff-a :convention :stdcall) :int32
  (h-call :uint32)   ; DWORD
  (lpsz-file-name :string)   ; LPCSTR
  (dw-media-mode :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $lineHandoffA = Win32::API::More->new('TAPI32',
    'int lineHandoffA(DWORD hCall, LPCSTR lpszFileName, DWORD dwMediaMode)');
# my $ret = $lineHandoffA->Call($hCall, $lpszFileName, $dwMediaMode);
# hCall : DWORD -> DWORD
# lpszFileName : LPCSTR -> LPCSTR
# dwMediaMode : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目