4.11.4.4 CORBA-CONTAINER-DESCRIBE-CONTENTS

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

目次索引

第4章 COBOLインタフェース

> 4.11 インタフェースリポジトリインタフェース

> 4.11.4 Container共通インタフェース

4.11.4.4 CORBA-CONTAINER-DESCRIBE-CONTENTS

名前

　CORBA-CONTAINER-DESCRIBE-CONTENTS

形式

DATA DIVISION.
  WORKING-STORAGE SECTION.
    COPY CONST IN CORBA.
    01 COPY OBJECT IN CORBA REPLACING CORBA-OBJECT BY OBJ.
    01 COPY DEFINITIONKIND IN CORBA REPLACING CORBA-DEFINITIONKIND BY LIMIT-TYPE.
    01 COPY BOOLEAN IN CORBA REPLACING CORBA-BOOLEAN BY EXCLUDE-INHERITED.
    01 COPY LONG IN CORBA REPLACING CORBA-LONG BY MAX-RETURNED-OBJS.
    01 COPY ENVIRONMENT IN CORBA REPLACING CORBA-ENVIRONMENT BY ENV.
    01 CONTAINER-DESCRIPTIONSEQ-ADDR USAGE IS POINTER.

PROCEDURE DIVISION.
    CALL "CORBA-CONTAINER-DESCRIBE-CONTENTS" USING
         OBJ
         LIMIT-TYPE 
         EXCLUDE-INHERITED 
         MAX-RETURNED-OBJS 
         ENV
         CONTAINER-DESCRIPTIONSEQ-ADDR.

機能説明

　OBJで指定したインタフェースリポジトリオブジェクトに直接包含される、または継承によって包含されるオブジェクトの定義情報を、DESCRIPTION構造体のリスト形式（“型の定義”を参照してください）で返します。
　本関数はDESCRIPTION構造体のリストを格納する領域を獲得するため、この領域が不要になった時点で、CORBA-FREE関数を使用して領域を解放する必要があります。

limit-typeで指定されたインタフェースタイプの包含オブジェクトが返却対象となります。
exclude-inheritedでTRUEが指定された場合は、継承オブジェクトは返却対象としません。
max-returned-objsで指定された数分の定義情報が返却されます。
limit-typeがCORBA-DK-ALLでかつExclude-inheritedがFALSEの場合は、包含/継承されるすべてのオブジェクト定義情報リストを返します。ただし、この場合もmax-returned-objsで指定された数分だけが返却対象となります。（登録されている数分得る場合は、max-returned-objsに-1を指定します）
返却対象のオブジェクトが見つからない場合は、返却リストのSEQ-LENGTHに0が設定され、オブジェクトリファレンスは不定となります。

復帰値

　正常終了した場合、オブジェクトの定義情報リストのアドレスが返されます。
　異常終了した場合、NIL（空の）定義情報リストが返されます。また、ENV構造体のMAJORにはCORBA-SYSTEM-EXCEPTIONが返され、IDとMINORに詳細情報が設定されます。IDとMINORの意味については、“メッセージ集”の“CORBAサービスから通知される例外情報/マイナーコード”を参照してください。

目次索引