MSMQQueueInfo.JournalQuota
Applies To: Windows 10, Windows 7, Windows 8, Windows 8.1, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, Windows Server 2012 R2, Windows Server Technical Preview, Windows Vista
Optional. The JournalQuota property of the MSMQQueueInfo object specifies the maximum size (in kilobytes) of the queue journal.
| Data type: | Long |
| Run-time access: | Read/write |
Property JournalQuota As Long
Property Value
Maximum size (in kilobytes) of the queue journal (the default is INFINITE).
Remarks
JournalQuota is used along with MSMQQueueInfo.Journal to request target journaling. For information on target journaling, see Target Journaling.
Periodically clear messages from the queue journal to remove messages that are no longer needed. Message stored in the queue journal count against the quota of the journal and the quota of the computer where the journal resides (the computer quota is set by the administrator).
If the journal or computer quota is exceeded, Message Queuing will not send copies of messages to the journal when the messages are received
To specify the maximum size of the queue journal when creating a destination queue, set the MSMQQueueInfo.PathName property and the JournalQuota property, and then call the MSMQQueueInfo.Create method.
To reset or retrieve the journal quota of an existing queue, your application must first obtain an MSMQQueueInfo object that represents the queue. This object can be returned by a query using the MSMQQuery.LookupQueue method or created by the sending or receiving application.
Before using an application-created MSMQQueueInfo object, the application must initialize it to reference the queue by setting its MSMQQueueInfo.PathName or MSMQQueueInfo.FormatName property property. For public queues, setting the FormatName property with a cached public format name instead of the PathName property frees Message Queuing from the need to retrieve information stored in the directory service to generate this format name. Direct format names can be used only for local private queues.
To reset the maximum size of the queue journal, set JournalQuota 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 maximum size of a queue journal, call the MSMQQueueInfo.Refresh method and inspect the JournalQuota property. The property values of the MSMQQueueInfo object are not updated with the values stored by Message Queuing until the MSMQQueueInfo.Refresh method is called.
Equivalent API Function Property
With function calls, the equivalent property is PROPID_Q_JOURNAL_QUOTA.
Example Code
The following examples are included in Using Message Queuing.
| For an example of | See |
|---|---|
| Setting the maximum size of the queue journal when creating a destination queue | Visual Basic Code Example: Enforcing Target Journaling |
| Setting and retrieving maximum size of a queue journal | Visual Basic Code Example: Setting MSMQQueueInfo.JournalQuota Visual Basic Code Example: Retrieving MSMQQueueInfo.JournalQuota |
Requirements
Windows NT/2000/XP: Included in Windows NT 4.0 SP3 and later.
Windows 95/98/Me: Included in Windows 95 and later.
Header: Declared in Mqoai.h.
Library: Use Mqoa.lib.
See Also
MSMQQueueInfo
MSMQQueueInfo.Create
MSMQQueueInfo.Journal
MSMQQueueInfo.Refresh
MSMQQueueInfo.Update
PROPID_Q_JOURNAL_QUOTA