lineGetMessage 関数 (tapi.h)

  • [アーティクル]

lineGetMessage 関数は、イベント ハンドル通知メカニズムを使用しているアプリケーションに配信するためにキューに入っている次の TAPI メッセージを返します (詳細については、「lineInitializeEx」を参照してください)。

構文

LONG lineGetMessage(
  HLINEAPP      hLineApp,
  LPLINEMESSAGE lpMessage,
  DWORD         dwTimeout
);

パラメーター

hLineApp

lineInitializeEx によって返されるハンドル。 アプリケーションは、LINEINITIALIZEEXPARAMS 構造体の dwOptions メンバーに LINEINITIALIZEEXOPTION_USEEVENT オプションを設定している必要があります。

lpMessage

LINEMESSAGE 構造体へのポインター。 この関数から正常に戻ると、構造体には、アプリケーションへの配信のためにキューに入れていた次のメッセージが含まれます。

dwTimeout

タイムアウト間隔 (ミリ秒単位)。 この関数は、メッセージが返されない場合でも、間隔が経過すると を返します。 dwTimeout が 0 の場合、関数はキューに登録されたメッセージを確認し、すぐにを返します。 dwTimeout が INFINITE の場合、関数のタイムアウト間隔は経過しません。

戻り値

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

LINEERR_INVALAPPHANDLE、LINEERR_OPERATIONFAILED、LINEERR_INVALPOINTER、LINEERR_NOMEM。

注釈

lineGetMessage 関数が 0 以外のタイムアウトで呼び出され、アプリケーションが別のスレッドで lineShutdown を呼び出した場合、この関数は LINEERR_INVALAPPHANDLE を使用して直ちにを返します。

タイムアウトが期限切れ (またはゼロ) で、キューからメッセージをフェッチできなかった場合、関数はエラー LINEERR_OPERATIONFAILEDを返します。

要件

要件 値
対象プラットフォーム Windows
ヘッダー tapi.h
Library Tapi32.lib
[DLL] Tapi32.dll

こちらもご覧ください

LINEINITIALIZEEXPARAMS

LINEMESSAGE

lineInitializeEx

lineShutdown