ModuleDef::describe

Overview The describe operation returns a structure containing information about a CORBA::ModuleDef Interface Repository object.
Original interface ModuleDef Interface
Exceptions CORBA::SystemException


Intended Usage

The inherited describe operation returns a structure (CORBA::Contained::Description) that contains information about a CORBA::ModuleDef Interface Repository object. The CORBA::Contained::Description structure has two fields: kind (CORBA::DefinitionKind data type), and value (CORBA::Any data type).

The kind of definition described by the returned structure is provided using the kind field, and the value field is a CORBA::Any that contains the description that is specific to the kind of object described. When the describe operation is invoked on a module (CORBA::ModuleDef) object, the kind field is equal to CORBA::dk_Module and the value field contains the CORBA::ModuleDescription structure.

Syntax

  struct ModuleDescription {
     Identifier name;
     RepositoryId id;
     RepositoryId defined_in;
     VersionSpec version;
     };
     struct Description {
     DefinitionKind kind;
     any value;
     };
     Description describe ();

Input parameters

None.

Return values

Description *
The returned value is a pointer to a CORBA::Contained::Description structure. The memory is owned by the caller and can be removed using delete.

Example

  // C++
     // assume that 'this_module' has already been initialized
     CORBA::ModuleDef * this_module;
 
     // retrieve a description of the module
     CORBA::Contained::Description * returned_description;  
     returned_description = this_module-> describe ();
     // retrieve the module description from the returned description structure
     CORBA::ModuleDescription * module_description;
     module_description = (CORBA::ModuleDescription * ) returned_description 
                           value.value ();

Related reference
CORBA module



Searchable topic ID:   rcor_modmd1
Last updated: Jun 21, 2007 8:07:48 PM CDT    WebSphere Business Integration Server Foundation, Version 5.0.2
http://publib.boulder.ibm.com/infocenter/wasinfo/index.jsp?topic=/com.ibm.wasee.doc/info/ee/corba/ref/rcor_modmd1.html

Library | Support | Terms of Use | Feedback