lineHold 関数 (tapi.h)

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

lineHold 関数は、指定した呼び出しを保留にします。

構文

LONG lineHold(
  HCALL hCall
);

パラメーター

hCall

保留にする呼び出しを処理します。アプリケーションは、呼び出しの所有者である必要があります。 hCall の呼び出し状態は接続されている必要があります。

戻り値

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

LINEERR_INVALCALLHANDLE、LINEERR_OPERATIONUNAVAIL、LINEERR_INVALCALLSTATE、LINEERR_OPERATIONFAILED、LINEERR_NOMEM、LINEERR_RESOURCEUNAVAIL、LINEERR_NOTOWNER、LINEERR_UNINITIALIZED。

注釈

保留中の通話は一時的に切断され、アプリケーションは回線デバイスを使用して他の呼び出しを行ったり応答したりできます。 lineHold 関数は、指定された呼び出しのいわゆる "ハードホールド" を実行します ("相談呼び出し" とは対照的)。通常、ハードホールドの通話は電話会議に転送したり含めたりすることはできませんが、相談呼び出しは可能です。相談呼び出しは、 lineSetupTransfer、 lineSetupConference、または linePrepareAddToConference を使用して開始されます。

呼び出しが正常に保留にされた後、呼び出しの状態は通常 onHold に遷移します。保留呼び出しは lineUnhold によって取得されます。呼び出しが保留中の間、アプリケーションは、保留された呼び出しの状態変更に関するLINE_CALLSTATEメッセージを受信できます。たとえば、保持されているパーティがハングアップした場合、通話状態は 切断状態に遷移する可能性があります。

ブリッジされた状況では、 lineHold 操作が実際に通話を保留にしない可能性があります。これは、通話の他のステーションの状態が制御できるためです (たとえば、他のステーションが参加している場合に通話を "保留" しようとすることは不可能です)。代わりに、通話が他のステーションで接続されたままの場合は、LINECONNECTEDMODE_INACTIVE モードに変更できます。