lineGetDevConfigW

関数

回線デバイスのメディア構成情報を取得する(Unicode版)。

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

シグネチャ

// TAPI32.dll  (Unicode / -W)
#include <windows.h>

INT lineGetDevConfigW(
    DWORD dwDeviceID,
    VARSTRING* lpDeviceConfig,
    LPCWSTR lpszDeviceClass
);

パラメーター

名前	型	方向	説明
dwDeviceID	DWORD	in	構成する回線デバイスの識別子。
lpDeviceConfig	VARSTRING*	inout	デバイス構成構造体が返される VARSTRING 型のメモリ位置へのポインター。要求が正常に完了すると、この位置にデバイス構成が格納されます。 VARSTRING 構造体の dwStringFormat メンバーには STRINGFORMAT_BINARY が設定されます。 lineGetDevConfig を呼び出す前に、アプリケーションはこの構造体の dwTotalSize メンバーを設定し、情報を返すために TAPI が利用できるメモリ量を示す必要があります。注意構造体内のサイズパラメーターが正しくない場合、データが上書きされる可能性があります。構造体のサイズ設定の詳細については、メモリの割り当てに関するトピックを参照してください。
lpszDeviceClass	LPCWSTR	in	構成を要求するデバイスのデバイスクラスを指定する、null で終わる文字列へのポインター。有効なデバイスクラス文字列は、 lineGetID 関数に指定するものと同じです。

戻り値の型: INT

公式ドキュメント

lineGetDevConfigW (Unicode) 関数は、回線およびデバイスクラスに固有の内容を持つ「不透明な (opaque)」データ構造オブジェクトを返します。

戻り値

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

LINEERR_BADDEVICEID, LINEERR_NODRIVER, LINEERR_INVALDEVICECLASS, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALPOINTER, LINEERR_RESOURCEUNAVAIL, LINEERR_STRUCTURETOOSMALL, LINEERR_OPERATIONFAILED, LINEERR_NOMEM, LINEERR_UNINITIALIZED, LINEERR_NODEVICE.

解説(Remarks)

呼び出しの状態 (call state) はデバイスに固有です。

lineGetDevConfig 関数を使用すると、特定の回線デバイスに関連付けられたメディアストリームデバイスの構成を示すデータ構造体を TAPI から取得できます。たとえば、この構造体の内容には、回線に関連付けられた「datamodem」メディアデバイスのデータレート、文字形式、変調方式、エラー制御プロトコルの設定を指定できます。

通常、アプリケーションは lineGetID を呼び出して回線に関連付けられたメディアストリームデバイスを特定し、次に lineConfigDialog を呼び出してユーザーがデバイス構成を設定できるようにします。その後、 lineGetDevConfig を呼び出し、特定の発信先に関連付けた電話帳 (またはその他のデータベース) に構成情報を保存できます。後でユーザーが同じ発信先に再度発信したい場合は、 lineSetDevConfig を使用して、ユーザーが選択した構成設定を復元できます。 lineSetDevConfig、 lineConfigDialog、 lineGetDevConfig の各関数をこの順序で使用することで、ユーザーが設定を確認して更新できるようになります。

構造体に含まれるデータの正確な形式は、回線およびメディアストリーム API (デバイスクラス) に固有であり、文書化されておらず、未定義です。この関数が返す構造体は、アプリケーションが直接アクセスしたり操作したりすることはできず、そのままの形で保存し、後で lineSetDevConfig で設定を復元するために使用することしかできません。また、この構造体は、同じデバイスクラスであっても、必ずしも他のデバイスに渡せるとは限りません (場合によっては動作することもありますが、保証されません)。

メモ

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

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

各言語での呼び出し定義

// TAPI32.dll  (Unicode / -W)
#include <windows.h>

INT lineGetDevConfigW(
    DWORD dwDeviceID,
    VARSTRING* lpDeviceConfig,
    LPCWSTR lpszDeviceClass
);

[DllImport("TAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int lineGetDevConfigW(
    uint dwDeviceID,   // DWORD
    IntPtr lpDeviceConfig,   // VARSTRING* in/out
    [MarshalAs(UnmanagedType.LPWStr)] string lpszDeviceClass   // LPCWSTR
);

<DllImport("TAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function lineGetDevConfigW(
    dwDeviceID As UInteger,   ' DWORD
    lpDeviceConfig As IntPtr,   ' VARSTRING* in/out
    <MarshalAs(UnmanagedType.LPWStr)> lpszDeviceClass As String   ' LPCWSTR
) As Integer
End Function

' dwDeviceID : DWORD
' lpDeviceConfig : VARSTRING* in/out
' lpszDeviceClass : LPCWSTR
Declare PtrSafe Function lineGetDevConfigW Lib "tapi32" ( _
    ByVal dwDeviceID As Long, _
    ByVal lpDeviceConfig As LongPtr, _
    ByVal lpszDeviceClass As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

lineGetDevConfigW = ctypes.windll.tapi32.lineGetDevConfigW
lineGetDevConfigW.restype = ctypes.c_int
lineGetDevConfigW.argtypes = [
    wintypes.DWORD,  # dwDeviceID : DWORD
    ctypes.c_void_p,  # lpDeviceConfig : VARSTRING* in/out
    wintypes.LPCWSTR,  # lpszDeviceClass : LPCWSTR
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineGetDevConfigW = Fiddle::Function.new(
  lib['lineGetDevConfigW'],
  [
    -Fiddle::TYPE_INT,  # dwDeviceID : DWORD
    Fiddle::TYPE_VOIDP,  # lpDeviceConfig : VARSTRING* in/out
    Fiddle::TYPE_VOIDP,  # lpszDeviceClass : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "tapi32")]
extern "system" {
    fn lineGetDevConfigW(
        dwDeviceID: u32,  // DWORD
        lpDeviceConfig: *mut VARSTRING,  // VARSTRING* in/out
        lpszDeviceClass: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TAPI32.dll", CharSet = CharSet.Unicode)]
public static extern int lineGetDevConfigW(uint dwDeviceID, IntPtr lpDeviceConfig, [MarshalAs(UnmanagedType.LPWStr)] string lpszDeviceClass);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineGetDevConfigW' -Namespace Win32 -PassThru
# $api::lineGetDevConfigW(dwDeviceID, lpDeviceConfig, lpszDeviceClass)

#uselib "TAPI32.dll"
#func global lineGetDevConfigW "lineGetDevConfigW" wptr, wptr, wptr
; lineGetDevConfigW dwDeviceID, varptr(lpDeviceConfig), lpszDeviceClass   ; 戻り値は stat
; dwDeviceID : DWORD -> "wptr"
; lpDeviceConfig : VARSTRING* in/out -> "wptr"
; lpszDeviceClass : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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