lineParkA

関数

通話を指定アドレスに保留(パーク)する(ANSI版)。

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

シグネチャ

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

INT lineParkA(
    DWORD hCall,
    DWORD dwParkMode,
    LPCSTR lpszDirAddress,
    VARSTRING* lpNonDirAddress
);

パラメーター

名前	型	方向	説明
hCall	DWORD	in	パークする呼び出しへのハンドル。アプリケーションはその呼び出しの所有者である必要があります。hCall の呼び出し状態は connected でなければなりません。
dwParkMode	DWORD	in	呼び出しをパークする際のパークモード。このパラメーターにはフラグを 1 つだけ設定でき、 LINEPARKMODE_ 定数のいずれかを使用します。
lpszDirAddress	LPCSTR	in	指定パーク (directed park) を使用する場合に、呼び出しをパークするアドレスを示す null 終端文字列へのポインター。アドレスはダイヤル可能な番号形式で指定します。このパラメーターは非指定パークの場合は無視されます。
lpNonDirAddress	VARSTRING*	inout	VARSTRING 型の構造体へのポインター。非指定パーク (nondirected park) の場合、呼び出しがパークされたアドレスがこの構造体に返されます。このパラメーターは指定パークの場合は無視されます。 VARSTRING 構造体内では、dwStringFormat に STRINGFORMAT_ASCII (null 終端文字列を含む ASCII 文字列バッファー) を設定する必要があり、終端の NULL も dwStringSize に含めて考慮する必要があります。 linePark を呼び出す前に、アプリケーションはこの構造体の dwTotalSize メンバーを設定し、情報を返すために TAPI が利用できるメモリー量を示す必要があります。

戻り値の型: INT

公式ドキュメント

linePark 関数は、指定されたパークモードに従って、指定された呼び出しをパークします。(lineParkA)

戻り値

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

LINEERR_INVALADDRESS, LINEERR_NOTOWNER, LINEERR_INVALCALLHANDLE, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALCALLSTATE, LINEERR_OPERATIONFAILED, LINEERR_INVALPARKMODE, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALPOINTER, LINEERR_STRUCTURETOOSMALL, LINEERR_NOMEM, LINEERR_UNINITIALIZED。

解説(Remarks)

指定パークでは、アプリケーションが呼び出しをパークしたいアドレスを決定します。非指定パークでは、スイッチがアドレスを決定し、それをアプリケーションに提供します。いずれの場合も、このアドレスを指定することでパークされた呼び出しをアンパークできます。

パークされた呼び出しは、正常にパークされた後、通常は idle 状態に遷移します。アプリケーションはその後、呼び出しのハンドルを解放する必要があります。アプリケーションがパークされた呼び出しに対して lineUnpark を実行した場合、古い呼び出しハンドルを解放していなくても、アンパークされた呼び出しに対して新しい呼び出しハンドルが作成されます。

スイッチによっては、呼び出しが長時間パークされたままになっているとユーザーにリマインダーを送るものがあります。アプリケーションには、呼び出し理由が reminder に設定された offering 呼び出しとして見えます。

非指定パークでは、 VARSTRING 構造体の dwTotalSize メンバーがパークアドレスを受け取るのに十分なメモリー量を示していない場合、対応する応答メッセージで LINEERR_STRUCTURETOOSMALL エラー値が返されます。その場合、完全なパークアドレスを取得する方法はありません。LINEERR_STRUCTURETOOSMALL エラー値が返された場合、NonDirAddress 構造体の dwNeededSize メンバーには有効な値が格納されません。非指定パークの linePark から LINEERR_STRUCTURETOOSMALL エラー値を受け取った場合は、バッファーのサイズを増やして、成功するか別の LINEERR_XXX 結果が返されるまで linePark を再度呼び出してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 lineParkA(
    DWORD hCall,
    DWORD dwParkMode,
    LPCSTR lpszDirAddress,
    VARSTRING* lpNonDirAddress
);

[DllImport("TAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int lineParkA(
    uint hCall,   // DWORD
    uint dwParkMode,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpszDirAddress,   // LPCSTR
    IntPtr lpNonDirAddress   // VARSTRING* in/out
);

<DllImport("TAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function lineParkA(
    hCall As UInteger,   ' DWORD
    dwParkMode As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpszDirAddress As String,   ' LPCSTR
    lpNonDirAddress As IntPtr   ' VARSTRING* in/out
) As Integer
End Function

' hCall : DWORD
' dwParkMode : DWORD
' lpszDirAddress : LPCSTR
' lpNonDirAddress : VARSTRING* in/out
Declare PtrSafe Function lineParkA Lib "tapi32" ( _
    ByVal hCall As Long, _
    ByVal dwParkMode As Long, _
    ByVal lpszDirAddress As String, _
    ByVal lpNonDirAddress As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

lineParkA = ctypes.windll.tapi32.lineParkA
lineParkA.restype = ctypes.c_int
lineParkA.argtypes = [
    wintypes.DWORD,  # hCall : DWORD
    wintypes.DWORD,  # dwParkMode : DWORD
    wintypes.LPCSTR,  # lpszDirAddress : LPCSTR
    ctypes.c_void_p,  # lpNonDirAddress : VARSTRING* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineParkA = Fiddle::Function.new(
  lib['lineParkA'],
  [
    -Fiddle::TYPE_INT,  # hCall : DWORD
    -Fiddle::TYPE_INT,  # dwParkMode : DWORD
    Fiddle::TYPE_VOIDP,  # lpszDirAddress : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpNonDirAddress : VARSTRING* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "tapi32")]
extern "system" {
    fn lineParkA(
        hCall: u32,  // DWORD
        dwParkMode: u32,  // DWORD
        lpszDirAddress: *const u8,  // LPCSTR
        lpNonDirAddress: *mut VARSTRING  // VARSTRING* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TAPI32.dll", CharSet = CharSet.Ansi)]
public static extern int lineParkA(uint hCall, uint dwParkMode, [MarshalAs(UnmanagedType.LPStr)] string lpszDirAddress, IntPtr lpNonDirAddress);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineParkA' -Namespace Win32 -PassThru
# $api::lineParkA(hCall, dwParkMode, lpszDirAddress, lpNonDirAddress)

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

出力引数:

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