linePickupA

関数

他で保留・着信中の通話を取得して応答する(ANSI版)。

DLLTAPI32.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

INT linePickupA(
    DWORD hLine,
    DWORD dwAddressID,
    DWORD* lphCall,
    LPCSTR lpszDestAddress,
    LPCSTR lpszGroupID
);

パラメーター

名前	型	方向	説明
hLine	DWORD	in	通話をピックアップする対象の、オープンされている回線デバイスへのハンドル。
dwAddressID	DWORD	in	ピックアップを発信する hLine 上のアドレス。アドレス識別子はアドレスに恒久的に関連付けられており、オペレーティングシステムのアップグレードをまたいでも変化しません。
lphCall	DWORD*	inout	ピックアップした通話のハンドルが返されるメモリ位置へのポインター。アプリケーションがその通話の最初の唯一の所有者になります。
lpszDestAddress	LPCSTR	in	ピックアップする通話のアドレスを格納した、null で終わる文字バッファーへのポインター。アドレスは標準のダイヤル可能アドレス形式で指定します。
lpszGroupID	LPCSTR	in	呼び出し中のステーションが属するグループ識別子を格納した、null で終わる文字バッファーへのポインター。現在のピックアップグループ外の通話をピックアップする場合、交換機によってはこのパラメーターが必要になります。 lpszGroupID パラメーターは、lpszDestAddress に NULL ポインターを指定したうえで単独で指定できます。また、デバイスで必要とされる場合は、lpszDestAddress に加えて lpszGroupID を指定することもできます。

戻り値の型: INT

公式ドキュメント

linePickup 関数は、指定した宛先アドレスで呼び出し中の通話をピックアップし、ピックアップした通話の通話ハンドルを返します。(linePickupA)

戻り値

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

LINEERR_INVALADDRESS、LINEERR_NOMEM、LINEERR_INVALADDRESSID、LINEERR_OPERATIONUNAVAIL、LINEERR_INVALGROUPID、LINEERR_OPERATIONFAILED、LINEERR_INVALLINEHANDLE、LINEERR_RESOURCEUNAVAIL、LINEERR_INVALPOINTER、LINEERR_UNINITIALIZED。

解説(Remarks)

通話のピックアップに成功すると、アプリケーションには LINE_CALLSTATE メッセージによって通話状態の変化が通知されます。 LINECALLINFO 構造体は、ピックアップされた通話に関する情報を提供します。この構造体では、通話の理由が pickup として示されます。この構造体は lineGetCallInfo を使用して取得できます。

LINEADDRCAPFLAGS_PICKUPCALLWAIT が TRUE の場合、 linePickup を使用すると、ユーザーはキャッチホン (call-waiting) の信号音を聞き取ったもののプロバイダーがその検出を行えない通話をピックアップできます。これにより、サービスプロバイダーがキャッチホンの信号を検出できない場合でも、待機中の通話にユーザーが「応答」する手段が提供されます。キャッチホンの通話をピックアップするには、lpszDestAddress と lpszGroupID の両方のポインターパラメーターを NULL にする必要があります。 linePickup 関数は、待機中の通話に対して新しい通話ハンドルを作成し、そのハンドルをユーザーに渡します。dwAddressID パラメーターは 0 であることがほとんどです (特に、単一回線の家庭用の場合)。

linePickup で 2 番目の通話をピックアップした後は、 lineSwapHold を使用して 2 つの通話を切り替えることができます。 lineDrop 関数を使用すると、一方の通話を切断して他方に切り替えることができます (以降も同様です)。現在の通話を切断して 2 番目の通話をピックアップしたい場合は、キャッチホンの通知音が聞こえた時点で lineDrop を呼び出し、2 番目の通話が鳴るのを待ってから、新しい通話ハンドルに対して lineAnswer を呼び出します。 LINEADDRESSSTATUS の dwAddressFeatures メンバーにある LINEADDRFEATURE_PICKUP フラグは、実際にピックアップが可能かどうかを示します。

メモ

tapi.h ヘッダーは linePickup を、UNICODE プリプロセッサー定数の定義に応じてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコードに依存しないエイリアスと、エンコードに依存しないコードではない記述を混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、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 linePickupA(
    DWORD hLine,
    DWORD dwAddressID,
    DWORD* lphCall,
    LPCSTR lpszDestAddress,
    LPCSTR lpszGroupID
);

[DllImport("TAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int linePickupA(
    uint hLine,   // DWORD
    uint dwAddressID,   // DWORD
    ref uint lphCall,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPStr)] string lpszDestAddress,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpszGroupID   // LPCSTR
);

<DllImport("TAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function linePickupA(
    hLine As UInteger,   ' DWORD
    dwAddressID As UInteger,   ' DWORD
    ByRef lphCall As UInteger,   ' DWORD* in/out
    <MarshalAs(UnmanagedType.LPStr)> lpszDestAddress As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszGroupID As String   ' LPCSTR
) As Integer
End Function

' hLine : DWORD
' dwAddressID : DWORD
' lphCall : DWORD* in/out
' lpszDestAddress : LPCSTR
' lpszGroupID : LPCSTR
Declare PtrSafe Function linePickupA Lib "tapi32" ( _
    ByVal hLine As Long, _
    ByVal dwAddressID As Long, _
    ByRef lphCall As Long, _
    ByVal lpszDestAddress As String, _
    ByVal lpszGroupID As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

linePickupA = ctypes.windll.tapi32.linePickupA
linePickupA.restype = ctypes.c_int
linePickupA.argtypes = [
    wintypes.DWORD,  # hLine : DWORD
    wintypes.DWORD,  # dwAddressID : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lphCall : DWORD* in/out
    wintypes.LPCSTR,  # lpszDestAddress : LPCSTR
    wintypes.LPCSTR,  # lpszGroupID : LPCSTR
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
linePickupA = Fiddle::Function.new(
  lib['linePickupA'],
  [
    -Fiddle::TYPE_INT,  # hLine : DWORD
    -Fiddle::TYPE_INT,  # dwAddressID : DWORD
    Fiddle::TYPE_VOIDP,  # lphCall : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpszDestAddress : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszGroupID : LPCSTR
  ],
  Fiddle::TYPE_INT)

#[link(name = "tapi32")]
extern "system" {
    fn linePickupA(
        hLine: u32,  // DWORD
        dwAddressID: u32,  // DWORD
        lphCall: *mut u32,  // DWORD* in/out
        lpszDestAddress: *const u8,  // LPCSTR
        lpszGroupID: *const u8  // LPCSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TAPI32.dll", CharSet = CharSet.Ansi)]
public static extern int linePickupA(uint hLine, uint dwAddressID, ref uint lphCall, [MarshalAs(UnmanagedType.LPStr)] string lpszDestAddress, [MarshalAs(UnmanagedType.LPStr)] string lpszGroupID);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_linePickupA' -Namespace Win32 -PassThru
# $api::linePickupA(hLine, dwAddressID, lphCall, lpszDestAddress, lpszGroupID)

#uselib "TAPI32.dll"
#func global linePickupA "linePickupA" sptr, sptr, sptr, sptr, sptr
; linePickupA hLine, dwAddressID, varptr(lphCall), lpszDestAddress, lpszGroupID   ; 戻り値は stat
; hLine : DWORD -> "sptr"
; dwAddressID : DWORD -> "sptr"
; lphCall : DWORD* in/out -> "sptr"
; lpszDestAddress : LPCSTR -> "sptr"
; lpszGroupID : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "TAPI32.dll"
#cfunc global linePickupA "linePickupA" int, int, var, str, str
; res = linePickupA(hLine, dwAddressID, lphCall, lpszDestAddress, lpszGroupID)
; hLine : DWORD -> "int"
; dwAddressID : DWORD -> "int"
; lphCall : DWORD* in/out -> "var"
; lpszDestAddress : LPCSTR -> "str"
; lpszGroupID : LPCSTR -> "str"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "TAPI32.dll"
#cfunc global linePickupA "linePickupA" int, int, sptr, str, str
; res = linePickupA(hLine, dwAddressID, varptr(lphCall), lpszDestAddress, lpszGroupID)
; hLine : DWORD -> "int"
; dwAddressID : DWORD -> "int"
; lphCall : DWORD* in/out -> "sptr"
; lpszDestAddress : LPCSTR -> "str"
; lpszGroupID : LPCSTR -> "str"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。