Interstage Application Server リファレンスマニュアル（API編）

1.19.2.5 ES_ChannelUtil_get_queue_length()

名前

  ES_ChannelUtil_get_queue_length

形式

  #include  <EventService.h>
  CORBA_unsigned_long 
  ES_ChannelUtil_get_queue_length(
                ES_ChannelUtil       obj, 
                CORBA_Environment    *env );

機能説明

　イベントチャネルにキューイングされているイベントデータ数を取得します。

パラメタ

　obj

　ES_ChannelUtilのオブジェクトリファレンス。

　env

　例外情報が格納される構造体。

復帰値

　正常終了した場合は、env構造体の_majorにCORBA_NO_EXCEPTIONが設定され、イベントチャネルにキューイングされているイベントデータ数を返します。
　異常終了した場合は、env構造体の_majorにCORBA_SYSTEM_EXCEPTIONまたはCORBA_USER_EXCEPTIONが設定され、env構造体の_idに詳細情報が設定されます。

　システム例外の場合、以下の詳細情報が設定されます。

　ex_CORBA_StExcep_COMM_FAILURE

　通信異常が発生しました。

　ex_CORBA_StExcep_NO_IMPLEMENT

　イベントチャネルが起動されていません。