C-C++ Code Example: Retrieving PROPID_Q_JOURNAL

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

This example provides an application-defined function that retrieves the PROPID_Q_JOURNAL property of an existing queue and returns the journaling level of the queue to the caller.

This function can return the journaling level of a local private queue from information stored on the local computer, but must retrieve information stored in the directory service to return the journaling level of a local or remote public queue. This function cannot be used to obtain the journaling level of a remote private queue.

A direct format name can be passed to this function only for a local private queue.

For information on how Message Queuing uses the journaling level of the queue, see Target Journaling.

To retrieve PROPID_Q_JOURNAL

1. Define the maximum number of queue properties to be specified and the queue property counter.

2. Define the MQQUEUEPROPS structure.

3. Specify PROPID_Q_JOURNAL.

4. Initialize the MQQUEUEPROPS structure.

5. Validate the input parameters provided by the caller.

6. Call MQGetQueueProperties to retrieve the journaling level of the queue. If the call fails the returned error code is returned to the caller.

7. Pass the retrieved journaling level of the queue to the caller on return.

Code Example

The following code example can be run on all versions of Message Queuing.

HRESULT GetQueueJournalProp(  
                            LPCWSTR wszQueueFormatName,   
                            UCHAR *pbValue  
                            )  
{  
  
  // Define the maximum number of queue properties and a property counter.  
  const int NUMBEROFPROPERTIES = 1;  
  DWORD cPropId=0;  
  
  // Define a queue property structure.  
  MQQUEUEPROPS   QueueProps;  
  QUEUEPROPID    aQueuePropId[NUMBEROFPROPERTIES];  
  MQPROPVARIANT  aQueuePropVar[NUMBEROFPROPERTIES];  
  HRESULT        aQueuePropStatus[NUMBEROFPROPERTIES];  
  HRESULT hr = MQ_OK;  
  
  // Specify the PROPID_Q_JOURNAL property.  
  aQueuePropId[cPropId] = PROPID_Q_JOURNAL;       // Property ID  
  aQueuePropVar[cPropId].vt = VT_NULL;            // Type indicator  
  cPropId++;  
  
  // Initialize the MQQUEUEPROPS structure.  
  QueueProps.cProp = cPropId;  
  QueueProps.aPropID = aQueuePropId;  
  QueueProps.aPropVar = aQueuePropVar;  
  QueueProps.aStatus = aQueuePropStatus;  
  
  // Validate the input parameters.  
  if (wszQueueFormatName == NULL || pbValue == NULL)  
  {  
    return MQ_ERROR_INVALID_PARAMETER;  
  }  
  
  // Get the queue properties.  
  hr = MQGetQueueProperties(wszQueueFormatName, &QueueProps);  
  if (FAILED(hr))  
  {  
    return hr;  
  }  
  
  // Set the *pbValue parameter to pass the journaling level  
  // of the queue on return.  
  *pbValue = aQueuePropVar[0].bVal;  
  return hr;  
}