A destination is where an application sends messages, or it is a source from which an application receives messages, or both.
For a list of the XMS defined properties of a Destination object, see Properties of Destination.
Function | Description |
---|---|
xmsDestCreate | Create a destination using the specified uniform resource identifier (URI). |
xmsDestCreateByType | Create a destination using the specified destination type and name. |
xmsDestCreateTemporaryByType | Create a temporary destination. |
xmsDestDispose | Delete the destination. |
xmsDestGetName | Get the name of the destination. |
xmsDestGetTypeId | Get the type of the destination. |
xmsDestToString | Get the name of the destination in the format of a uniform resource identifier (URI). |
xmsRC xmsDestCreate(xmsCHAR *URI, xmsHDest *destination, xmsHErrorBlock errorBlock);
Create a destination using the specified uniform resource identifier (URI). Properties of the destination that are not specified by the URI take the default values.
For a destination that is a queue, this function does not create the queue in the messaging server. You must create the queue before an application can call this function.
xmsRC xmsDestCreateByType(xmsDESTINATION_TYPE destinationType, xmsCHAR *destinationName, xmsHDest *destination, xmsHErrorBlock errorBlock);
Create a destination using the specified destination type and name.
For a destination that is a queue, this function does not create the queue in the messaging server. You must create the queue before an application can call this function.
xmsRC xmsDestCreateTemporaryByType(xmsDESTINATION_TYPE destinationType, xmsHSess session, xmsHDest *destination, xmsHErrorBlock errorBlock);
Create a temporary destination.
The scope of the temporary destination is the connection. Only the sessions created by the connection can use the temporary destination.
The temporary destination remains until it is explicitly deleted, or the connection ends, whichever is the sooner.
For more information about temporary destinations, see Temporary destinations.
xmsRC xmsDestDispose(xmsHDest *destination, xmsHErrorBlock errorBlock);
For a destination that is a queue, this function does not delete the queue in the messaging server unless the queue was created for an XMS temporary queue.
If an application tries to delete a destination that is already deleted, the call is ignored.
xmsRC xmsDestGetName(xmsHDest destination, xmsCHAR *destinationName, xmsINT length, xmsINT *actualLength, xmsHErrorBlock errorBlock);
Get the name of the destination.
For more information about how to use this function, see C functions that return a string by value.
xmsRC xmsDestGetTypeId(xmsHDest destination, xmsDESTINATION_TYPE *destinationType, xmsHErrorBlock errorBlock);
Get the type of the destination.
xmsRC xmsDestToString(xmsHDest destination, xmsCHAR *destinationName, xmsINT length, xmsINT *actualLength, xmsHErrorBlock errorBlock);
Get the name of the destination in the format of a uniform resource identifier (URI).
For more information about how to use this function, see C functions that return a string by value.