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.

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

Functions

Summary of functions:
Function Description
xmsInitialContextCreate Create an InitialContext object.
xmsInitialContextDispose Delete the InitialContext object.
xmsInitialContextLookup Create an object from an object definition that is retrieved from the repository of administered objects.

xmsInitialContextCreate – Create Initial Context

Interface:
xmsRC xmsInitialContextCreate(xmsCHAR *URL,
                              xmsHInitialContect *initalContext,
                              xmsHErrorBlock errorBlock);

Create an InitialContext object.

Parameters:
URL (input)
A uniform resource locator (URL) that identifies the name and location of a repository containing administered objects. The URL is in the format of a null terminated string.
initialContext (output)
The handle for the InitialContext object.
errorBlock (input)
The handle for an error block or a null handle.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsInitialContextDispose – Delete Initial Context

Interface:
xmsRC xmsInitialContextDispose(xmsHInitialContext *initialContext,
                               xmsHErrorBlock errorBlock);

Delete the InitialContext object.

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

Parameters:
initialContext (input/output)
On input, the handle for the InitialContext object. On output, the function returns a null handle.
errorBlock (input)
The handle for an error block or a null handle.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsInitialContextLookup – Look Up Object in Initial Context

Interface:
xmsRC xmsInitialContextLookup(xmsHInitialContext initialContext,
                              xmsCHAR *objectName,
                              xmsHObj *returnedObject,
                              xmsHANDLE_TYPE *handleType,
                              xmsHErrorBlock errorBlock);

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

Parameters:
initialContext (input)
The handle for the InitialContext object.
objectName (input)
The name of the administered object in the format of a null terminated string.
returnedObject (output)
The handle for the object that is created.
handleType (output)
The type of the handle for the object that is created, which is one of following values:
  • XMS_HANDLE_TYPE_CONNFACT
  • XMS_HANDLE_TYPE_DEST
errorBlock (input)
The handle for an error block or a null handle.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

Reference topic

Terms of Use | Rate this page

Last updated: 18 Jun 2008

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