C-C++ Code Example: Setting PROPID_Q_AUTHENTICATE

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 sets the PROPID_Q_AUTHENTICATE property of an existing queue based on the authentication level provided by the caller.

Setting this property changes how the queue will handle new messages sent to the queue. Setting this property has no effect on messages already in the queue.

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

For information on how Message Queuing authenticates messages, see Message Authentication.

To set PROPID_Q_AUTHENTICATE

1. Validate the input parameters provided by the caller.

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

3. Define the MQQUEUEPROPS structure.

4. Specify PROPID_Q_AUTHENTICATE.

5. Initialize the MQQUEUEPROPS structure.

6. Call MQSetQueueProperties to set the authentication level of the queue. If the call fails the returned error code is returned to the caller.

Code Example

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

HRESULT SetQueueAuthenticateProp(  
                                 LPCWSTR wszQueueFormatName,   
                                 UCHAR bValue  
                                 )  
{  
  
  // Validate the input string.  
  if (wszQueueFormatName == NULL)  
  {  
    return MQ_ERROR_INVALID_PARAMETER;  
  }  
  
  // 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_AUTHENTICATE property.  
  aQueuePropId[cPropId] = PROPID_Q_AUTHENTICATE;    // Property ID  
  aQueuePropVar[cPropId].vt = VT_UI1;               // Type indicator  
  aQueuePropVar[cPropId].bVal = bValue;             // Authentication level  
  cPropId++;  
  
  // Initialize the MQQUEUEPROPS structure.  
  QueueProps.cProp = cPropId;  
  QueueProps.aPropID = aQueuePropId;  
  QueueProps.aPropVar = aQueuePropVar;  
  QueueProps.aStatus = aQueuePropStatus;  
  
  // Set the queue properties.  
  hr = MQSetQueueProperties(wszQueueFormatName, &QueueProps);  
  return hr;  
}