lineForward

関数

回線やアドレスの着信を別アドレスへ転送設定する。

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

シグネチャ

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

INT lineForward(
    DWORD hLine,
    DWORD bAllAddresses,
    DWORD dwAddressID,
    const LINEFORWARDLIST* lpForwardList,
    DWORD dwNumRingsNoAnswer,
    DWORD* lphConsultCall,
    const LINECALLPARAMS* lpCallParams
);

パラメーター

名前	型	方向	説明
hLine	DWORD	in	回線デバイスへのハンドル。
bAllAddresses	DWORD	in	回線上のすべての発信アドレスを転送するか、指定した 1 つのアドレスだけを転送するかを指定します。TRUE の場合、回線上のすべてのアドレスが転送され、dwAddressID は無視されます。FALSE の場合、dwAddressID として指定されたアドレスだけが転送されます。
dwAddressID	DWORD	in	着信を転送する、指定した回線上のアドレス。bAllAddresses が TRUE の場合、このパラメーターは無視されます。アドレス識別子はアドレスに恒久的に関連付けられており、オペレーティングシステムをアップグレードしても変わりません。
lpForwardList	LINEFORWARDLIST*	in	具体的な転送指示を記述する可変長のデータ構造体へのポインター。型は LINEFORWARDLIST です。
dwNumRingsNoAnswer	DWORD	in	着信が「応答なし」と見なされるまでの呼び出し回数。dwNumRingsNoAnswer が範囲外の場合、実際の値は許容範囲内で最も近い値に設定されます。
lphConsultCall	DWORD*	inout	HCALL を格納する場所へのポインター。一部のテレフォニー環境では、この場所に、転送先の相手と通話するために使用される相談通話 (consultation call) のハンドルが設定され、アプリケーションがこの通話の最初の唯一の所有者になります。通話の転送に相談通話を必要としない環境であっても、このポインターは有効である必要があります。相談通話が作成されない場合、このハンドルは NULL に設定されます。
lpCallParams	LINECALLPARAMS*	in	LINECALLPARAMS 型の構造体へのポインター。このポインターは、 lineForward が転送先への通話の確立を必要とする場合 (かつ lphConsultCall が返される場合。この場合 lpCallParams は省略可能です) を除き、無視されます。NULL の場合は、既定の通話パラメーターが使用されます。それ以外の場合は、指定した通話パラメーターが hConsultCall の確立に使用されます。

戻り値の型: INT

公式ドキュメント

lineForward 関数 (tapi.h) は、指定した回線上の指定したアドレス宛ての着信を、指定した転送指示に従って転送します。

戻り値

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

LINEERR_INVALLINEHANDLE、LINEERR_NOMEM、LINEERR_INVALADDRESSID、LINEERR_OPERATIONUNAVAIL、LINEERR_INVALADDRESS、LINEERR_OPERATIONFAILED、LINEERR_INVALCOUNTRYCODE、LINEERR_RESOURCEUNAVAIL、LINEERR_INVALPOINTER、LINEERR_STRUCTURETOOSMALL、LINEERR_INVALPARAM、LINEERR_UNINITIALIZED。

解説(Remarks)

転送が成功したということは、要求がサービスプロバイダーに受け入れられたことを示すだけであり、交換機で転送が設定されたことを意味するものではありません。交換機で転送が設定されたことの確認は、 LINE_ADDRESSSTATE (転送) メッセージによって通知されます。

アドレスの転送は、この関数が再度呼び出されるまで有効なままです。最新の転送リストが以前のものを置き換えます。転送は、lpForwardList として NULL ポインターを指定することで取り消せます。転送リストのエントリに NULL の転送先アドレスを指定した場合、その操作は「応答不可 (do-not-disturb)」として動作します。

アドレスの転送状態は、外部からも影響を受けることがあります。たとえば、交換機での管理操作や、別の電話機からのユーザーの操作などです。サービスプロバイダーがこの状態変化を認識できるとは限らず、交換機が把握している転送状態と同期を保てない場合があります。

サービスプロバイダーはアドレスの転送状態を「確実に」把握できるとは限らない (未知の方法で転送されたり転送が解除されたりしている可能性がある) ため、 lineForward は新しい転送指示の設定に失敗しない限り成功します。言い換えると、転送が有効でない状態ですべての転送の取り消しを要求した場合でも、その要求は成功します。これは「転送の解除」という操作が存在せず、以前の転送指示のセットを変更できるだけだからです。

この操作の成否は、以前の転送指示のセットには依存しません。異なる転送指示を設定する場合も同様です。プロバイダーは、新しい転送指示を設定する前に「すべての転送を解除」する必要があります。アナログテレフォニー環境ではこれに時間がかかることがあるため、プロバイダーは現在の転送内容と新しい転送内容を比較し、最終状態にするために必要な指示だけを交換機に発行する (変更のない転送はそのままにする) ようにしてもかまいません。

LINEFORWARDLIST の dwNumEntries を 0 に設定して lineForward を呼び出した場合、lpForwardList パラメーターに NULL を指定した場合と同じ効果になります。現在有効なすべての転送が取り消されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 lineForward(
    DWORD hLine,
    DWORD bAllAddresses,
    DWORD dwAddressID,
    const LINEFORWARDLIST* lpForwardList,
    DWORD dwNumRingsNoAnswer,
    DWORD* lphConsultCall,
    const LINECALLPARAMS* lpCallParams
);

[DllImport("TAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int lineForward(
    uint hLine,   // DWORD
    uint bAllAddresses,   // DWORD
    uint dwAddressID,   // DWORD
    IntPtr lpForwardList,   // LINEFORWARDLIST*
    uint dwNumRingsNoAnswer,   // DWORD
    ref uint lphConsultCall,   // DWORD* in/out
    IntPtr lpCallParams   // LINECALLPARAMS*
);

<DllImport("TAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function lineForward(
    hLine As UInteger,   ' DWORD
    bAllAddresses As UInteger,   ' DWORD
    dwAddressID As UInteger,   ' DWORD
    lpForwardList As IntPtr,   ' LINEFORWARDLIST*
    dwNumRingsNoAnswer As UInteger,   ' DWORD
    ByRef lphConsultCall As UInteger,   ' DWORD* in/out
    lpCallParams As IntPtr   ' LINECALLPARAMS*
) As Integer
End Function

' hLine : DWORD
' bAllAddresses : DWORD
' dwAddressID : DWORD
' lpForwardList : LINEFORWARDLIST*
' dwNumRingsNoAnswer : DWORD
' lphConsultCall : DWORD* in/out
' lpCallParams : LINECALLPARAMS*
Declare PtrSafe Function lineForward Lib "tapi32" ( _
    ByVal hLine As Long, _
    ByVal bAllAddresses As Long, _
    ByVal dwAddressID As Long, _
    ByVal lpForwardList As LongPtr, _
    ByVal dwNumRingsNoAnswer As Long, _
    ByRef lphConsultCall As Long, _
    ByVal lpCallParams As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

lineForward = ctypes.windll.tapi32.lineForward
lineForward.restype = ctypes.c_int
lineForward.argtypes = [
    wintypes.DWORD,  # hLine : DWORD
    wintypes.DWORD,  # bAllAddresses : DWORD
    wintypes.DWORD,  # dwAddressID : DWORD
    ctypes.c_void_p,  # lpForwardList : LINEFORWARDLIST*
    wintypes.DWORD,  # dwNumRingsNoAnswer : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lphConsultCall : DWORD* in/out
    ctypes.c_void_p,  # lpCallParams : LINECALLPARAMS*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineForward = Fiddle::Function.new(
  lib['lineForward'],
  [
    -Fiddle::TYPE_INT,  # hLine : DWORD
    -Fiddle::TYPE_INT,  # bAllAddresses : DWORD
    -Fiddle::TYPE_INT,  # dwAddressID : DWORD
    Fiddle::TYPE_VOIDP,  # lpForwardList : LINEFORWARDLIST*
    -Fiddle::TYPE_INT,  # dwNumRingsNoAnswer : DWORD
    Fiddle::TYPE_VOIDP,  # lphConsultCall : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpCallParams : LINECALLPARAMS*
  ],
  Fiddle::TYPE_INT)

#[link(name = "tapi32")]
extern "system" {
    fn lineForward(
        hLine: u32,  // DWORD
        bAllAddresses: u32,  // DWORD
        dwAddressID: u32,  // DWORD
        lpForwardList: *const LINEFORWARDLIST,  // LINEFORWARDLIST*
        dwNumRingsNoAnswer: u32,  // DWORD
        lphConsultCall: *mut u32,  // DWORD* in/out
        lpCallParams: *const LINECALLPARAMS  // LINECALLPARAMS*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TAPI32.dll", CharSet = CharSet.Ansi)]
public static extern int lineForward(uint hLine, uint bAllAddresses, uint dwAddressID, IntPtr lpForwardList, uint dwNumRingsNoAnswer, ref uint lphConsultCall, IntPtr lpCallParams);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineForward' -Namespace Win32 -PassThru
# $api::lineForward(hLine, bAllAddresses, dwAddressID, lpForwardList, dwNumRingsNoAnswer, lphConsultCall, lpCallParams)

#uselib "TAPI32.dll"
#func global lineForward "lineForward" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; lineForward hLine, bAllAddresses, dwAddressID, varptr(lpForwardList), dwNumRingsNoAnswer, varptr(lphConsultCall), varptr(lpCallParams)   ; 戻り値は stat
; hLine : DWORD -> "sptr"
; bAllAddresses : DWORD -> "sptr"
; dwAddressID : DWORD -> "sptr"
; lpForwardList : LINEFORWARDLIST* -> "sptr"
; dwNumRingsNoAnswer : DWORD -> "sptr"
; lphConsultCall : DWORD* in/out -> "sptr"
; lpCallParams : LINECALLPARAMS* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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