lineGetAgentStatusA 関数 (tapi.h)

[アーティクル]
03/02/2024

lineGetAgentStatus 関数は、指定されたアドレスのエージェント関連の状態を取得します。

構文

LONG lineGetAgentStatusA(
  HLINE             hLine,
  DWORD             dwAddressID,
  LPLINEAGENTSTATUS lpAgentStatus
);

パラメーター

hLine

開線デバイスへのハンドル。

dwAddressID

エージェントの状態を照会するオープンラインデバイスのアドレス。アドレス識別子は、アドレスに完全に関連付けられます。識別子は、オペレーティングシステムのアップグレード間で一定のままです。

lpAgentStatus

LINEAGENTSTATUS 型の可変サイズの構造体へのポインター。要求が正常に完了すると、この構造体にはエージェントの状態情報が入力されます。 lineGetAgentStatus を呼び出す前に、アプリケーションは、情報を返すために TAPI が使用できるメモリの量を示すために、この構造体の dwTotalSize メンバーを設定する必要があります。

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

戻り値

非同期操作が開始された場合は、正の要求識別子を返します。それ以外の場合は、次のいずれかの負のエラー値:

LINEERR_INVALADDRESSID、LINEERR_INVALLINEHANDLE、LINEERR_INVALPOINTER、LINEERR_NOMEM、LINEERR_OPERATIONFAILED、LINEERR_OPERATIONUNAVAIL、LINEERR_RESOURCEUNAVAIL、LINEERR_STRUCTURETOOSMALL、LINEERR_UNINITIALIZED。

注釈

注意

tapi.h ヘッダーは、LINEGetAgentStatus をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。