MSMQQueueInfo.Journal (Compact 2013)
3/26/2014
This property object specifies the journaling level of the destination queue. The journaling level determines whether messages retrieved from the destination queue are stored in the journal of the queue.
Syntax
HRESULT get_Journal(
long* plJournal
);
HRESULT put_Trace(
long lJournal
);
Parameters
plJournal or lJournal
Specifies the journaling level of the destination queue. The following table shows the possible values.Value
Description
MQ_JOURNAL
When a message is removed from the queue, it is stored in the queue journal.
MQ_JOURNAL_NONE
The default. Messages are not stored in a queue journal when they are removed from the queue.
Return Value
The following table describes the common return values.
Value |
Description |
|---|---|
S_OK |
Success |
E_INVALIDARG |
One or more arguments are invalid |
E_NOTIMPL |
The function contains no implementation |
E_OUTOFMEMORY |
Out of memory |
Remarks
The MSMQQueueInfo.Journal property is used to enforce target journaling for the destination queue.
When target journaling is enabled, Message Queuing stores a copy of each message removed from the queue in the destination queue's journal.
The size of the queue journal can be set using the MSMQQueueInfo.JournalQuota property.
Setting the MSMQQueueInfo.Journal property does not create a queue journal. Queue journals are system queues generated by MSMQ.
Setting and Retrieving the Journaling Level
To specify the journaling level when creating the queue, set the MSMQQueueInfo.Journal property and call the MSMQQueueInfo.Create method.
To reset the journaling level of an open queue, set MSMQQueueInfo.Journal to a new level and call the MSMQQueueInfo.Update method. This method updates the queue information stored by Message Queuing.
For public queues, this information is stored in the directory service.
For private queues, this information is stored on the computer where the messages of the queue are stored.
To retrieve the stored journaling level of a queue, call the MSMQQueueInfo.Refresh method and inspect the MSMQQueueInfo.Journal property.
Equivalent Function Property
When using function calls, the journaling level of the queue can be set and retrieve using the PROPID_Q_JOURNAL property.
Requirements
Header |
mqoai.h |
Library |
mqoa.lib |