WebSphere WebSphere Business Integration Message Service Clients for C/C++ Version 1.2.7 and .NET Version 1.2.6 Operating Systems: AIX, Linux, Solaris, Windows

InitialContext

An application uses an InitialContext object to create objects from object definitions that are retrieved from a repository of administered objects.

Inheritance hierarchy:
xms::PropertyContext
   |
   +----xms::InitialContext

For a list of the XMS defined properties of an InitialContext object, see Properties of InitialContext.

Related concepts
InitialContext properties
URI format for XMS initial contexts
Retrieval of administered objects
Related tasks
InitialContext objects

Constructors

Summary of constructors:
Constructor Description
InitialContext Create an InitialContext object.

InitialContext – Create Initial Context

Interface:
InitialContext( const String & uri); 
InitialContext & create( const String & uri);

Create an InitialContext object.

Note: The creation of the InitialContext object is done separately from the connection to the repository containing administered objects. This allows properties to be set on the InitialContext object prior to connection. For further details, see InitialContext properties.
Parameters:
uri (input)
A String object encapsulating a URI that identifies the name and location of a repository containing administered objects. The exact syntax of the URI depends on the context type. For further information, see URI format for XMS initial contexts.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

Methods

Summary of methods:
Method Description
~InitialContext Delete the InitialContext object. This frees all resources associated with the InitialContext object.
getHandle Get the handle that a C application would use to access the InitialContext object.
isNull Determine whether the InitialContext object is a null object.
lookup Create an object from an object definition that is retrieved from the repository of administered objects.

~InitialContext – Delete Initial Context

Interface:
InitialContext:: ~InitialContext();

Delete the InitialContext object. This frees all resources associated with the InitialContext object.

If an application tries to delete an InitialContext object that is already deleted, the call is ignored.

Parameters:
None
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getHandle – Get Handle

Interface:
xmsHInitialContext getHandle() const;

Get the handle that a C application would use to access the InitialContext object.

Parameters:
None
Returns:
The handle for the InitialContext object.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

isNull – Check Whether Null

Interface:
xmsBOOL isNull() const;

Determine whether the InitialContext object is a null object.

Parameters:
None
Returns:
  • xmsTRUE, if the InitialContext object is a null object.
  • xmsFALSE, if the InitialContext object is not a null object.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

lookup – Look Up Object in Initial Context

Interface:
PropertyContext * lookup(const String & objectName) const;

Create an object from an object definition that is retrieved from the repository of administered objects.

Parameters:
objectName (input)
A String object encapsulating the name of the administered object. The name can be either a simple name or a complex name. For further details, see Retrieval of administered objects.
Returns:
A pointer to the object that is created.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

Inherited methods


Reference topic

Terms of Use | Rate this page

Last updated: 18 Jun 2008

© Copyright IBM Corporation 2005, 2008. All Rights Reserved.