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

lineOpen

関数
回線デバイスを開いてハンドルを取得する。
DLLTAPI32.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

INT lineOpen(
    DWORD hLineApp,
    DWORD dwDeviceID,
    DWORD* lphLine,
    DWORD dwAPIVersion,
    DWORD dwExtVersion,
    UINT_PTR dwCallbackInstance,
    DWORD dwPrivileges,
    DWORD dwMediaModes,
    const LINECALLPARAMS* lpCallParams
);

パラメーター

名前型方向説明
hLineAppDWORDinTAPI に対するアプリケーションの登録を表すハンドル。
dwDeviceIDDWORDin

開く回線デバイスを識別します。有効なデバイス識別子、または次の値を指定できます。

値 意味
LINEMAPPER
この値は、lpCallParams で指定されたプロパティをサポートする回線デバイスをシステム内で開くために使用します。アプリケーションは lineGetID を使用して、開かれた回線デバイスの識別子を特定できます。
lphLineDWORD*inout開かれた回線デバイスを表すハンドルが格納される HLINE ハンドルへのポインター。開かれた回線デバイスに対して他の関数を呼び出すときは、このハンドルでデバイスを識別します。
dwAPIVersionDWORDinアプリケーションと Telephony API が動作することに合意した API のバージョン番号。この番号は lineNegotiateAPIVersion で取得します。
dwExtVersionDWORDinアプリケーションとサービスプロバイダーが動作することに合意した拡張のバージョン番号。アプリケーションが拡張を使用しない場合、この番号は 0 になります。この番号は lineNegotiateExtVersion で取得します。
dwCallbackInstanceUINT_PTRinこの回線、またはこの回線上のアドレスや通話に関連する各メッセージとともにアプリケーションへ返されるユーザーインスタンスデータ。このパラメーターは Telephony API によって解釈されません。
dwPrivilegesDWORDin

通話が通知されるときにアプリケーションが必要とする特権。このパラメーターには LINECALLPRIVILEGE_ 定数 のうち 1 つ以上を指定します。TAPI バージョン 2.0 以降を使用するアプリケーションの場合、このパラメーターの値は LINEOPENOPTION_ 定数 の 1 つ以上と組み合わせることもできます。

LINEOPENOPTION_SINGLEADDRESS オプションを指定した場合、アプリケーションは、lpCallParams パラメーター (この場合は指定が必須です) が指す LINECALLPARAMS 構造体の dwAddressID メンバーで指定されたアドレスに現れる新しい通話のみを対象とします。

LINEOPENOPTION_SINGLEADDRESS を指定したにもかかわらず、lpCallParams が無効であるか、指定された dwAddressID がその回線上に存在しない場合、オープンは失敗し LINERR_INVALADDRESSID が返されます。

アプリケーションは、 LINECALLPARAMS 構造体の dwAddressID メンバーに目的のアドレスを設定するのに加えて、 LINECALLPARAMS の dwAddressMode に LINEADDRESSMODE_ADDRESSID を設定する必要があります。

LINEOPENOPTION_SINGLEADDRESS オプションが影響するのは、サービスプロバイダーが LINE_NEWCALL メッセージを使用して作成した通話について、TAPI が最初の通話の所有権を割り当てる処理のみです。LINECALLPRIVILEGE_MONITOR で回線を開いたアプリケーションは、その回線上で作成されるすべての通話の監視ハンドルを引き続き受け取ります。さらに、アプリケーションが通話を発信したり、開いた回線上の他のアドレスに影響する操作を実行したりすることは、いかなる形でも制限されません。

LINEOPENOPTION_PROXY オプションを指定する場合 (TAPI 2.0 以降のみ)、アプリケーションは処理する準備ができている具体的なプロキシ要求も示す必要があります。そのためには、lpCallParams パラメーターに、dwDevSpecificSize メンバーと dwDevSpecificOffset メンバーで DWORD の配列を区切るように設定した LINECALLPARAMS 構造体へのポインターを渡します。この配列の各要素には、 LINEPROXYREQUEST_ 定数 のいずれか 1 つを格納します。たとえば、Agent 関連の 5 つの関数すべてをサポートするプロキシハンドラーアプリケーションは、定義済みの 5 つの LINEPROXYREQUEST_ 値を格納した 5 つの DWORD の配列を渡します (dwDevSpecificSize は 10 進数で 20 になります)。

プロキシ要求ハンドラーアプリケーションは、その回線デバイスを制御する権限を持つ任意のコンピューター上で実行できます。ただし、要求は常に、その回線デバイスを実際に制御しているサービスプロバイダーが実行されているサーバーを経由してルーティングされます。したがって、プロキシ要求を処理するアプリケーション (ACD エージェント制御など) は、サービスプロバイダーと同じサーバー上で直接実行するのが最も効率的です。

既に登録されているアプリケーションと同じプロキシ要求を処理するために、同一のアプリケーションまたは他のアプリケーションがその後に回線デバイスを開いて登録しようとすると、LINEERR_NOTREGISTERED で失敗します。

回線上での要求の処理を停止するには、アプリケーションは lineClose を呼び出すだけです。

その他のフラグの組み合わせでは、LINEERR_INVALPRIVSELECT エラーが返されます。

dwMediaModesDWORDinアプリケーションが対象とするメディアの種類 (モード)。このパラメーターは、指定したメディアの種類について、着信通話や通話のハンドオフの対象候補としてアプリケーションを登録するために使用されます。このパラメーターは、dwPrivileges の LINECALLPRIVILEGE_OWNER ビットが設定されている場合にのみ意味を持ちます (設定されていない場合は無視されます)。このパラメーターには LINEMEDIAMODE_ 定数 のうち 1 つ以上を使用します。
lpCallParamsLINECALLPARAMS*inLINECALLPARAMS 型の構造体へのポインター。このポインターは LINEMAPPER または LINEOPENOPTION_PROXY を使用する場合にのみ使用され、それ以外の場合、lpCallParams は無視されます。ここには、回線デバイスが提供できる必要のある通話パラメーターを記述します。

戻り値の型: INT

公式ドキュメント

lineOpen 関数 (tapi.h) は、デバイス識別子で指定された回線デバイスを開き、対応する開かれた回線デバイスの回線ハンドルを返します。

戻り値

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

LINEERR_ALLOCATED、LINEERR_LINEMAPPERFAILED、LINEERR_BADDEVICEID、LINEERR_NODRIVER、LINEERR_INCOMPATIBLEAPIVERSION、LINEERR_NOMEM、LINEERR_INCOMPATIBLEEXTVERSION、LINEERR_OPERATIONFAILED、LINEERR_INVALAPPHANDLE、LINEERR_RESOURCEUNAVAIL、LINEERR_INVALMEDIAMODE、LINEERR_STRUCTURETOOSMALL、LINEERR_INVALPOINTER、LINEERR_UNINITIALIZED、LINEERR_INVALPRIVSELECT、LINEERR_REINIT、LINEERR_NODEVICE、LINEERR_OPERATIONUNAVAIL。

解説(Remarks)

LINEERR_ALLOCATED が返された場合、シリアルポートが別のプロセスによって排他的に開かれているなどの "持続的な" 状態が原因で、回線を開くことができません。LINEERR_RESOURCEUNAVAIL が返された場合、DSP のプロセッササイクルやメモリなど、動的なリソースの過剰割り当てが原因で回線を開くことができません。この過剰割り当ては、メディアの種類やトーンの監視によって引き起こされる一時的なものである場合があり、他のアプリケーションによるこれらの動作の変化によって、短時間のうちに回線を開き直せるようになることがあります。LINEERR_REINIT が返され、(テレフォニーサービスプロバイダーの追加や削除などの結果として) TAPI の再初期化が要求されている場合、最後のアプリケーションが ( lineShutdown を使用して) API の使用を終了するまで、 lineOpen の要求はこのエラーで拒否されます。終了した時点で新しい構成が有効になり、アプリケーションは再び lineInitializeEx を呼び出せるようになります。

回線を開くと、アプリケーションは常に、その回線で利用できる任意のアドレスで通話を発信できるようになります。回線上で着信通話を処理したり、通話のハンドオフ先になったりできるかどうかは、dwMediaModes パラメーターによって決まります。 lineOpen 関数は、指定されたメディアの種類の通話を監視すること、またはその所有権を受け取ることに関心があるアプリケーションとして、そのアプリケーションを登録します。アプリケーションが通話の監視のみを行う場合は、LINECALLPRIVILEGE_MONITOR を指定できます。発信のみを行う場合は、LINECALLPRIVILEGE_NONE を指定できます。分類されていない通話 (メディアの種類が不明な通話) を制御してもよい場合は、LINECALLPRIVILEGE_OWNER と LINEMEDIAMODE_UNKNOWN を指定できます。それ以外の場合、アプリケーションは処理したいメディアの種類を指定する必要があります。アプリケーションは lineSetCallPrivilege 関数を呼び出して、LINECALLPRIVILEGES_Constants で指定した通話の特権を変更できます。

lineOpen で指定したメディアの種類は、最初の着信通話の種類を判別するためにプロバイダーが行うメディアの種類の監視の既定値に追加されます。 lineMonitorMedia 関数は、 LINE_MONITORMEDIA メッセージを制御するマスクを変更します。オーナー特権で回線デバイスを開いたときに、拡張メディアの種類が登録されていない場合は、エラー LINEERR_INVALMEDIAMODE が返されます。

回線デバイスを正常に開いたアプリケーションは、常に lineMakeCall、 lineUnpark、 linePickup、 lineSetupConference (hCall が NULL の場合) を使用して通話を開始できるほか、 lineForward も使用できます (デバイスの機能や回線の状態などによってそれが許可されている場合)。

1 つのアプリケーションが複数のフラグを同時に指定して、複数のメディアの種類を処理することもできます。複数のアプリケーションが同じメディアの種類のために同じ回線デバイスを開くと、競合が発生する可能性があります。これらの競合は、ユーザーがアプリケーションに相対的な優先度を割り当てる優先度方式によって解決されます。ユーザーは lineSetAppPriority 関数を呼び出してアプリケーションの優先度を設定できます。あるメディアの種類について (要求していないのに) 通話の所有権を受け取ることができるのは、そのメディアの種類で最も優先度の高いアプリケーションだけです。所有権は、着信通話が最初に到着したとき、または通話がハンドオフされたときに受け取ることができます。通話の所有権を別のアプリケーションにハンドオフするには、lineHandoff 関数を呼び出します。ユーザーがアプリケーションに優先度を割り当てておらず、複数のアプリケーションが同じ回線デバイスを開いた場合は、既定で、最初に lineOpen を呼び出したアプリケーションが最も高い優先度を持ちます。

どのアプリケーション (優先度の低いアプリケーションを含む) でも、 lineGetNewCalls または lineGetConfRelatedCalls によって常に所有権を取得できます。回線上に通話が存在する時点でアプリケーションが監視のために回線を開いた場合、それらの既存の通話に関する LINE_CALLSTATE メッセージが、新しく監視を開始したアプリケーションへ自動的に生成されることはありません。アプリケーションは、回線上の現在の通話数を照会していくつの通話が存在するかを判断でき、必要であれば lineGetNewCalls を呼び出してそれらの通話のハンドルを取得できます。

自動音声を処理するアプリケーションは、対話型音声のオープンモードも選択したうえで、対話型音声については最も低い優先度を割り当てられるようにする必要があります。これは、サービスプロバイダーがすべての音声メディアの種類を対話型音声として報告するためです。UNKNOWN メディアの種類についてアプリケーションがメディアの種類の判別を行わず、かつ対話型音声のアプリケーションがその回線デバイスを開いていない場合、音声通話は自動音声アプリケーションに到達できず、切断されてしまいます。

同一のアプリケーション、または同一アプリケーションの異なるインスタンスが、同じパラメーターまたは異なるパラメーターで同じ回線を複数回開くことができます。

アプリケーションが回線デバイスを開くときは、ネゴシエート済みの API バージョンを指定する必要があります。また、その回線の拡張を使用する場合は、回線のデバイス固有の拡張バージョンも指定する必要があります。これらのバージョン番号は、 lineNegotiateAPIVersion および lineNegotiateExtVersion で取得しておく必要があります。バージョン番号によって、さまざまなアプリケーションのバージョンを、さまざまな API バージョンやサービスプロバイダーのバージョンと組み合わせて使用できます。

LINEMAPPER を使用すると、アプリケーションは回線を間接的に、つまり回線に求めるサービスによって選択できます。LINEMAPPER を使用して回線デバイスを開く場合、次のことが当てはまります。 LINECALLPARAMS データ構造体の先頭から dwAddressMode までのすべてのメンバーが有効です。dwAddressMode が LINEADDRESSMODE_ADDRESSID の場合は、回線上の任意のアドレスでよいことを意味します。一方、dwAddressMode が LINEADDRESSMODE_DIALABLEADDR で、特定の発信元アドレス (電話番号) を検索することを示している場合、またはプロバイダー固有の拡張である場合は、dwOrigAddressSize/Offset と、それらが参照する可変部分も有効です。dwAddressMode がプロバイダー固有の拡張である場合、可変サイズの dwDeviceSpecific メンバーに追加情報を含めることができます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 lineOpen(
    DWORD hLineApp,
    DWORD dwDeviceID,
    DWORD* lphLine,
    DWORD dwAPIVersion,
    DWORD dwExtVersion,
    UINT_PTR dwCallbackInstance,
    DWORD dwPrivileges,
    DWORD dwMediaModes,
    const LINECALLPARAMS* lpCallParams
);
[DllImport("TAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int lineOpen(
    uint hLineApp,   // DWORD
    uint dwDeviceID,   // DWORD
    ref uint lphLine,   // DWORD* in/out
    uint dwAPIVersion,   // DWORD
    uint dwExtVersion,   // DWORD
    UIntPtr dwCallbackInstance,   // UINT_PTR
    uint dwPrivileges,   // DWORD
    uint dwMediaModes,   // DWORD
    IntPtr lpCallParams   // LINECALLPARAMS*
);
<DllImport("TAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function lineOpen(
    hLineApp As UInteger,   ' DWORD
    dwDeviceID As UInteger,   ' DWORD
    ByRef lphLine As UInteger,   ' DWORD* in/out
    dwAPIVersion As UInteger,   ' DWORD
    dwExtVersion As UInteger,   ' DWORD
    dwCallbackInstance As UIntPtr,   ' UINT_PTR
    dwPrivileges As UInteger,   ' DWORD
    dwMediaModes As UInteger,   ' DWORD
    lpCallParams As IntPtr   ' LINECALLPARAMS*
) As Integer
End Function
' hLineApp : DWORD
' dwDeviceID : DWORD
' lphLine : DWORD* in/out
' dwAPIVersion : DWORD
' dwExtVersion : DWORD
' dwCallbackInstance : UINT_PTR
' dwPrivileges : DWORD
' dwMediaModes : DWORD
' lpCallParams : LINECALLPARAMS*
Declare PtrSafe Function lineOpen Lib "tapi32" ( _
    ByVal hLineApp As Long, _
    ByVal dwDeviceID As Long, _
    ByRef lphLine As Long, _
    ByVal dwAPIVersion As Long, _
    ByVal dwExtVersion As Long, _
    ByVal dwCallbackInstance As LongPtr, _
    ByVal dwPrivileges As Long, _
    ByVal dwMediaModes 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

lineOpen = ctypes.windll.tapi32.lineOpen
lineOpen.restype = ctypes.c_int
lineOpen.argtypes = [
    wintypes.DWORD,  # hLineApp : DWORD
    wintypes.DWORD,  # dwDeviceID : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lphLine : DWORD* in/out
    wintypes.DWORD,  # dwAPIVersion : DWORD
    wintypes.DWORD,  # dwExtVersion : DWORD
    ctypes.c_size_t,  # dwCallbackInstance : UINT_PTR
    wintypes.DWORD,  # dwPrivileges : DWORD
    wintypes.DWORD,  # dwMediaModes : DWORD
    ctypes.c_void_p,  # lpCallParams : LINECALLPARAMS*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineOpen = Fiddle::Function.new(
  lib['lineOpen'],
  [
    -Fiddle::TYPE_INT,  # hLineApp : DWORD
    -Fiddle::TYPE_INT,  # dwDeviceID : DWORD
    Fiddle::TYPE_VOIDP,  # lphLine : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwAPIVersion : DWORD
    -Fiddle::TYPE_INT,  # dwExtVersion : DWORD
    Fiddle::TYPE_UINTPTR_T,  # dwCallbackInstance : UINT_PTR
    -Fiddle::TYPE_INT,  # dwPrivileges : DWORD
    -Fiddle::TYPE_INT,  # dwMediaModes : DWORD
    Fiddle::TYPE_VOIDP,  # lpCallParams : LINECALLPARAMS*
  ],
  Fiddle::TYPE_INT)
#[link(name = "tapi32")]
extern "system" {
    fn lineOpen(
        hLineApp: u32,  // DWORD
        dwDeviceID: u32,  // DWORD
        lphLine: *mut u32,  // DWORD* in/out
        dwAPIVersion: u32,  // DWORD
        dwExtVersion: u32,  // DWORD
        dwCallbackInstance: usize,  // UINT_PTR
        dwPrivileges: u32,  // DWORD
        dwMediaModes: u32,  // DWORD
        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 lineOpen(uint hLineApp, uint dwDeviceID, ref uint lphLine, uint dwAPIVersion, uint dwExtVersion, UIntPtr dwCallbackInstance, uint dwPrivileges, uint dwMediaModes, IntPtr lpCallParams);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineOpen' -Namespace Win32 -PassThru
# $api::lineOpen(hLineApp, dwDeviceID, lphLine, dwAPIVersion, dwExtVersion, dwCallbackInstance, dwPrivileges, dwMediaModes, lpCallParams)
#uselib "TAPI32.dll"
#func global lineOpen "lineOpen" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; lineOpen hLineApp, dwDeviceID, varptr(lphLine), dwAPIVersion, dwExtVersion, dwCallbackInstance, dwPrivileges, dwMediaModes, varptr(lpCallParams)   ; 戻り値は stat
; hLineApp : DWORD -> "sptr"
; dwDeviceID : DWORD -> "sptr"
; lphLine : DWORD* in/out -> "sptr"
; dwAPIVersion : DWORD -> "sptr"
; dwExtVersion : DWORD -> "sptr"
; dwCallbackInstance : UINT_PTR -> "sptr"
; dwPrivileges : DWORD -> "sptr"
; dwMediaModes : DWORD -> "sptr"
; lpCallParams : LINECALLPARAMS* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "TAPI32.dll"
#cfunc global lineOpen "lineOpen" int, int, var, int, int, sptr, int, int, var
; res = lineOpen(hLineApp, dwDeviceID, lphLine, dwAPIVersion, dwExtVersion, dwCallbackInstance, dwPrivileges, dwMediaModes, lpCallParams)
; hLineApp : DWORD -> "int"
; dwDeviceID : DWORD -> "int"
; lphLine : DWORD* in/out -> "var"
; dwAPIVersion : DWORD -> "int"
; dwExtVersion : DWORD -> "int"
; dwCallbackInstance : UINT_PTR -> "sptr"
; dwPrivileges : DWORD -> "int"
; dwMediaModes : DWORD -> "int"
; lpCallParams : LINECALLPARAMS* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT lineOpen(DWORD hLineApp, DWORD dwDeviceID, DWORD* lphLine, DWORD dwAPIVersion, DWORD dwExtVersion, UINT_PTR dwCallbackInstance, DWORD dwPrivileges, DWORD dwMediaModes, LINECALLPARAMS* lpCallParams)
#uselib "TAPI32.dll"
#cfunc global lineOpen "lineOpen" int, int, var, int, int, intptr, int, int, var
; res = lineOpen(hLineApp, dwDeviceID, lphLine, dwAPIVersion, dwExtVersion, dwCallbackInstance, dwPrivileges, dwMediaModes, lpCallParams)
; hLineApp : DWORD -> "int"
; dwDeviceID : DWORD -> "int"
; lphLine : DWORD* in/out -> "var"
; dwAPIVersion : DWORD -> "int"
; dwExtVersion : DWORD -> "int"
; dwCallbackInstance : UINT_PTR -> "intptr"
; dwPrivileges : DWORD -> "int"
; dwMediaModes : DWORD -> "int"
; lpCallParams : LINECALLPARAMS* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	tapi32 = windows.NewLazySystemDLL("TAPI32.dll")
	proclineOpen = tapi32.NewProc("lineOpen")
)

// hLineApp (DWORD), dwDeviceID (DWORD), lphLine (DWORD* in/out), dwAPIVersion (DWORD), dwExtVersion (DWORD), dwCallbackInstance (UINT_PTR), dwPrivileges (DWORD), dwMediaModes (DWORD), lpCallParams (LINECALLPARAMS*)
r1, _, err := proclineOpen.Call(
	uintptr(hLineApp),
	uintptr(dwDeviceID),
	uintptr(lphLine),
	uintptr(dwAPIVersion),
	uintptr(dwExtVersion),
	uintptr(dwCallbackInstance),
	uintptr(dwPrivileges),
	uintptr(dwMediaModes),
	uintptr(lpCallParams),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function lineOpen(
  hLineApp: DWORD;   // DWORD
  dwDeviceID: DWORD;   // DWORD
  lphLine: Pointer;   // DWORD* in/out
  dwAPIVersion: DWORD;   // DWORD
  dwExtVersion: DWORD;   // DWORD
  dwCallbackInstance: NativeUInt;   // UINT_PTR
  dwPrivileges: DWORD;   // DWORD
  dwMediaModes: DWORD;   // DWORD
  lpCallParams: Pointer   // LINECALLPARAMS*
): Integer; stdcall;
  external 'TAPI32.dll' name 'lineOpen';
result := DllCall("TAPI32\lineOpen"
    , "UInt", hLineApp   ; DWORD
    , "UInt", dwDeviceID   ; DWORD
    , "Ptr", lphLine   ; DWORD* in/out
    , "UInt", dwAPIVersion   ; DWORD
    , "UInt", dwExtVersion   ; DWORD
    , "UPtr", dwCallbackInstance   ; UINT_PTR
    , "UInt", dwPrivileges   ; DWORD
    , "UInt", dwMediaModes   ; DWORD
    , "Ptr", lpCallParams   ; LINECALLPARAMS*
    , "Int")   ; return: INT
●lineOpen(hLineApp, dwDeviceID, lphLine, dwAPIVersion, dwExtVersion, dwCallbackInstance, dwPrivileges, dwMediaModes, lpCallParams) = DLL("TAPI32.dll", "int lineOpen(dword, dword, void*, dword, dword, int, dword, dword, void*)")
# 呼び出し: lineOpen(hLineApp, dwDeviceID, lphLine, dwAPIVersion, dwExtVersion, dwCallbackInstance, dwPrivileges, dwMediaModes, lpCallParams)
# hLineApp : DWORD -> "dword"
# dwDeviceID : DWORD -> "dword"
# lphLine : DWORD* in/out -> "void*"
# dwAPIVersion : DWORD -> "dword"
# dwExtVersion : DWORD -> "dword"
# dwCallbackInstance : UINT_PTR -> "int"
# dwPrivileges : DWORD -> "dword"
# dwMediaModes : DWORD -> "dword"
# lpCallParams : LINECALLPARAMS* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "tapi32" fn lineOpen(
    hLineApp: u32, // DWORD
    dwDeviceID: u32, // DWORD
    lphLine: [*c]u32, // DWORD* in/out
    dwAPIVersion: u32, // DWORD
    dwExtVersion: u32, // DWORD
    dwCallbackInstance: usize, // UINT_PTR
    dwPrivileges: u32, // DWORD
    dwMediaModes: u32, // DWORD
    lpCallParams: [*c]LINECALLPARAMS // LINECALLPARAMS*
) callconv(std.os.windows.WINAPI) i32;
proc lineOpen(
    hLineApp: uint32,  # DWORD
    dwDeviceID: uint32,  # DWORD
    lphLine: ptr uint32,  # DWORD* in/out
    dwAPIVersion: uint32,  # DWORD
    dwExtVersion: uint32,  # DWORD
    dwCallbackInstance: uint,  # UINT_PTR
    dwPrivileges: uint32,  # DWORD
    dwMediaModes: uint32,  # DWORD
    lpCallParams: ptr LINECALLPARAMS  # LINECALLPARAMS*
): int32 {.importc: "lineOpen", stdcall, dynlib: "TAPI32.dll".}
pragma(lib, "tapi32");
extern(Windows)
int lineOpen(
    uint hLineApp,   // DWORD
    uint dwDeviceID,   // DWORD
    uint* lphLine,   // DWORD* in/out
    uint dwAPIVersion,   // DWORD
    uint dwExtVersion,   // DWORD
    size_t dwCallbackInstance,   // UINT_PTR
    uint dwPrivileges,   // DWORD
    uint dwMediaModes,   // DWORD
    LINECALLPARAMS* lpCallParams   // LINECALLPARAMS*
);
ccall((:lineOpen, "TAPI32.dll"), stdcall, Int32,
      (UInt32, UInt32, Ptr{UInt32}, UInt32, UInt32, Csize_t, UInt32, UInt32, Ptr{LINECALLPARAMS}),
      hLineApp, dwDeviceID, lphLine, dwAPIVersion, dwExtVersion, dwCallbackInstance, dwPrivileges, dwMediaModes, lpCallParams)
# hLineApp : DWORD -> UInt32
# dwDeviceID : DWORD -> UInt32
# lphLine : DWORD* in/out -> Ptr{UInt32}
# dwAPIVersion : DWORD -> UInt32
# dwExtVersion : DWORD -> UInt32
# dwCallbackInstance : UINT_PTR -> Csize_t
# dwPrivileges : DWORD -> UInt32
# dwMediaModes : DWORD -> UInt32
# lpCallParams : LINECALLPARAMS* -> Ptr{LINECALLPARAMS}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t lineOpen(
    uint32_t hLineApp,
    uint32_t dwDeviceID,
    uint32_t* lphLine,
    uint32_t dwAPIVersion,
    uint32_t dwExtVersion,
    uintptr_t dwCallbackInstance,
    uint32_t dwPrivileges,
    uint32_t dwMediaModes,
    void* lpCallParams);
]]
local tapi32 = ffi.load("tapi32")
-- tapi32.lineOpen(hLineApp, dwDeviceID, lphLine, dwAPIVersion, dwExtVersion, dwCallbackInstance, dwPrivileges, dwMediaModes, lpCallParams)
-- hLineApp : DWORD
-- dwDeviceID : DWORD
-- lphLine : DWORD* in/out
-- dwAPIVersion : DWORD
-- dwExtVersion : DWORD
-- dwCallbackInstance : UINT_PTR
-- dwPrivileges : DWORD
-- dwMediaModes : DWORD
-- lpCallParams : LINECALLPARAMS*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('TAPI32.dll');
const lineOpen = lib.func('__stdcall', 'lineOpen', 'int32_t', ['uint32_t', 'uint32_t', 'uint32_t *', 'uint32_t', 'uint32_t', 'uintptr_t', 'uint32_t', 'uint32_t', 'void *']);
// lineOpen(hLineApp, dwDeviceID, lphLine, dwAPIVersion, dwExtVersion, dwCallbackInstance, dwPrivileges, dwMediaModes, lpCallParams)
// hLineApp : DWORD -> 'uint32_t'
// dwDeviceID : DWORD -> 'uint32_t'
// lphLine : DWORD* in/out -> 'uint32_t *'
// dwAPIVersion : DWORD -> 'uint32_t'
// dwExtVersion : DWORD -> 'uint32_t'
// dwCallbackInstance : UINT_PTR -> 'uintptr_t'
// dwPrivileges : DWORD -> 'uint32_t'
// dwMediaModes : DWORD -> 'uint32_t'
// lpCallParams : LINECALLPARAMS* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("TAPI32.dll", {
  lineOpen: { parameters: ["u32", "u32", "pointer", "u32", "u32", "usize", "u32", "u32", "pointer"], result: "i32" },
});
// lib.symbols.lineOpen(hLineApp, dwDeviceID, lphLine, dwAPIVersion, dwExtVersion, dwCallbackInstance, dwPrivileges, dwMediaModes, lpCallParams)
// hLineApp : DWORD -> "u32"
// dwDeviceID : DWORD -> "u32"
// lphLine : DWORD* in/out -> "pointer"
// dwAPIVersion : DWORD -> "u32"
// dwExtVersion : DWORD -> "u32"
// dwCallbackInstance : UINT_PTR -> "usize"
// dwPrivileges : DWORD -> "u32"
// dwMediaModes : DWORD -> "u32"
// lpCallParams : LINECALLPARAMS* -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t lineOpen(
    uint32_t hLineApp,
    uint32_t dwDeviceID,
    uint32_t* lphLine,
    uint32_t dwAPIVersion,
    uint32_t dwExtVersion,
    size_t dwCallbackInstance,
    uint32_t dwPrivileges,
    uint32_t dwMediaModes,
    void* lpCallParams);
C, "TAPI32.dll");
// $ffi->lineOpen(hLineApp, dwDeviceID, lphLine, dwAPIVersion, dwExtVersion, dwCallbackInstance, dwPrivileges, dwMediaModes, lpCallParams);
// hLineApp : DWORD
// dwDeviceID : DWORD
// lphLine : DWORD* in/out
// dwAPIVersion : DWORD
// dwExtVersion : DWORD
// dwCallbackInstance : UINT_PTR
// dwPrivileges : DWORD
// dwMediaModes : DWORD
// lpCallParams : LINECALLPARAMS*
// 構造体/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 lineOpen(
        int hLineApp,   // DWORD
        int dwDeviceID,   // DWORD
        IntByReference lphLine,   // DWORD* in/out
        int dwAPIVersion,   // DWORD
        int dwExtVersion,   // DWORD
        long dwCallbackInstance,   // UINT_PTR
        int dwPrivileges,   // DWORD
        int dwMediaModes,   // DWORD
        Pointer lpCallParams   // LINECALLPARAMS*
    );
}
@[Link("tapi32")]
lib LibTAPI32
  fun lineOpen = lineOpen(
    hLineApp : UInt32,   # DWORD
    dwDeviceID : UInt32,   # DWORD
    lphLine : UInt32*,   # DWORD* in/out
    dwAPIVersion : UInt32,   # DWORD
    dwExtVersion : UInt32,   # DWORD
    dwCallbackInstance : LibC::SizeT,   # UINT_PTR
    dwPrivileges : UInt32,   # DWORD
    dwMediaModes : UInt32,   # DWORD
    lpCallParams : LINECALLPARAMS*   # LINECALLPARAMS*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef lineOpenNative = Int32 Function(Uint32, Uint32, Pointer<Uint32>, Uint32, Uint32, UintPtr, Uint32, Uint32, Pointer<Void>);
typedef lineOpenDart = int Function(int, int, Pointer<Uint32>, int, int, int, int, int, Pointer<Void>);
final lineOpen = DynamicLibrary.open('TAPI32.dll')
    .lookupFunction<lineOpenNative, lineOpenDart>('lineOpen');
// hLineApp : DWORD -> Uint32
// dwDeviceID : DWORD -> Uint32
// lphLine : DWORD* in/out -> Pointer<Uint32>
// dwAPIVersion : DWORD -> Uint32
// dwExtVersion : DWORD -> Uint32
// dwCallbackInstance : UINT_PTR -> UintPtr
// dwPrivileges : DWORD -> Uint32
// dwMediaModes : DWORD -> Uint32
// lpCallParams : LINECALLPARAMS* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function lineOpen(
  hLineApp: DWORD;   // DWORD
  dwDeviceID: DWORD;   // DWORD
  lphLine: Pointer;   // DWORD* in/out
  dwAPIVersion: DWORD;   // DWORD
  dwExtVersion: DWORD;   // DWORD
  dwCallbackInstance: NativeUInt;   // UINT_PTR
  dwPrivileges: DWORD;   // DWORD
  dwMediaModes: DWORD;   // DWORD
  lpCallParams: Pointer   // LINECALLPARAMS*
): Integer; stdcall;
  external 'TAPI32.dll' name 'lineOpen';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "lineOpen"
  c_lineOpen :: Word32 -> Word32 -> Ptr Word32 -> Word32 -> Word32 -> CUIntPtr -> Word32 -> Word32 -> Ptr () -> IO Int32
-- hLineApp : DWORD -> Word32
-- dwDeviceID : DWORD -> Word32
-- lphLine : DWORD* in/out -> Ptr Word32
-- dwAPIVersion : DWORD -> Word32
-- dwExtVersion : DWORD -> Word32
-- dwCallbackInstance : UINT_PTR -> CUIntPtr
-- dwPrivileges : DWORD -> Word32
-- dwMediaModes : DWORD -> Word32
-- lpCallParams : LINECALLPARAMS* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let lineopen =
  foreign "lineOpen"
    (uint32_t @-> uint32_t @-> (ptr uint32_t) @-> uint32_t @-> uint32_t @-> size_t @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* hLineApp : DWORD -> uint32_t *)
(* dwDeviceID : DWORD -> uint32_t *)
(* lphLine : DWORD* in/out -> (ptr uint32_t) *)
(* dwAPIVersion : DWORD -> uint32_t *)
(* dwExtVersion : DWORD -> uint32_t *)
(* dwCallbackInstance : UINT_PTR -> size_t *)
(* dwPrivileges : DWORD -> uint32_t *)
(* dwMediaModes : DWORD -> uint32_t *)
(* lpCallParams : LINECALLPARAMS* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library tapi32 (t "TAPI32.dll"))
(cffi:use-foreign-library tapi32)

(cffi:defcfun ("lineOpen" line-open :convention :stdcall) :int32
  (h-line-app :uint32)   ; DWORD
  (dw-device-id :uint32)   ; DWORD
  (lph-line :pointer)   ; DWORD* in/out
  (dw-apiversion :uint32)   ; DWORD
  (dw-ext-version :uint32)   ; DWORD
  (dw-callback-instance :uint64)   ; UINT_PTR
  (dw-privileges :uint32)   ; DWORD
  (dw-media-modes :uint32)   ; DWORD
  (lp-call-params :pointer))   ; LINECALLPARAMS*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $lineOpen = Win32::API::More->new('TAPI32',
    'int lineOpen(DWORD hLineApp, DWORD dwDeviceID, LPVOID lphLine, DWORD dwAPIVersion, DWORD dwExtVersion, WPARAM dwCallbackInstance, DWORD dwPrivileges, DWORD dwMediaModes, LPVOID lpCallParams)');
# my $ret = $lineOpen->Call($hLineApp, $dwDeviceID, $lphLine, $dwAPIVersion, $dwExtVersion, $dwCallbackInstance, $dwPrivileges, $dwMediaModes, $lpCallParams);
# hLineApp : DWORD -> DWORD
# dwDeviceID : DWORD -> DWORD
# lphLine : DWORD* in/out -> LPVOID
# dwAPIVersion : DWORD -> DWORD
# dwExtVersion : DWORD -> DWORD
# dwCallbackInstance : UINT_PTR -> WPARAM
# dwPrivileges : DWORD -> DWORD
# dwMediaModes : DWORD -> DWORD
# lpCallParams : LINECALLPARAMS* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目
使用する型