lineGetDevConfig 関数 (tapi.h)

[アーティクル]
08/26/2023

lineGetDevConfig 関数は、"不透明" なデータ構造オブジェクトを返します。その内容は、行 (サービスプロバイダー) とデバイスクラスに固有です。データ構造オブジェクトには、回線デバイスに関連付けられているメディアストリームデバイスの現在の構成が格納されます。

構文

LONG lineGetDevConfig(
  DWORD       dwDeviceID,
  LPVARSTRING lpDeviceConfig,
  LPCSTR      lpszDeviceClass
);

パラメーター

dwDeviceID

構成する回線デバイスの識別子。

lpDeviceConfig

デバイス構成構造体が返される VARSTRING 型のメモリ位置へのポインター。要求が正常に完了すると、この場所にデバイス構成が入力されます。 VARSTRING 構造体の dwStringFormat メンバーは、STRINGFORMAT_BINARYに設定されます。 lineGetDevConfig を呼び出す前に、アプリケーションは、この構造体の dwTotalSize メンバーを設定して、情報を返すために TAPI が使用できるメモリの量を示す必要があります。

メモ構造体のサイズパラメーターが正しくない場合は、データが上書きされる可能性があります。構造体のサイズの設定の詳細については、メモリ割り当てに関するトピックを参照してください。

lpszDeviceClass

構成が要求されるデバイスのデバイスクラスを指定する null で終わる文字列へのポインター。有効なデバイスクラスの lineGetID 文字列は、関数に指定されているものと同じです。

戻り値

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

LINEERR_BADDEVICEID、LINEERR_NODRIVER、LINEERR_INVALDEVICECLASS、LINEERR_OPERATIONUNAVAIL、LINEERR_INVALPOINTER、LINEERR_RESOURCEUNAVAIL、LINEERR_STRUCTURETOOSMALL、LINEERR_OPERATIONFAILED、LINEERR_NOMEM、LINEERR_UNINITIALIZED、LINEERR_NODEVICE。

注釈

通話の状態はデバイス固有です。

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

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

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