C-C++ Code Example: Retrieving 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 retrieves the PROPID_Q_AUTHENTICATE property of an existing queue and returns the authentication level of the queue to the caller.

This function can return the authentication 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 authentication level of a local or remote public queue. This function cannot be used to obtain the authentication 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 authenticates messages, see Message Authentication.

To retrieve PROPID_Q_AUTHENTICATE

1. Define an MQQUEUEPROPS structure.

2. Validate the input parameters provided by the caller.

3. Specify PROPID_Q_AUTHENTICATE.

4. Initialize the MQQUEUEPROPS structure.

5. Call MQGetQueueProperties to retrieve the authentication level of the queue. If the call fails, the returned error code is returned to the caller.

6. Pass the retrieved authentication 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 GetQueueAuthenticateProp(  
                                 LPCWSTR wszQueueFormatName,   
                                 UCHAR *pbValue  
                                 )  
{  
  
  // Define the maximum number of queue properties.  
  const int NUMBEROFPROPERTIES = 1;  
  
  // Define a queue property structure.  
  DWORD cPropId = 0;  
  MQQUEUEPROPS   QueueProps;  
  QUEUEPROPID    aQueuePropId[NUMBEROFPROPERTIES];  
  MQPROPVARIANT  aQueuePropVar[NUMBEROFPROPERTIES];  
  HRESULT        aQueuePropStatus[NUMBEROFPROPERTIES];  
  HRESULT hr = MQ_OK;  
  
  // Validate the input parameters.  
  if (wszQueueFormatName == NULL || pbValue == NULL)  
  {  
    return MQ_ERROR_INVALID_PARAMETER;  
  }  
  
  // Specify the PROPID_Q_AUTHENTICATE property.  
  aQueuePropId[cPropId] = PROPID_Q_AUTHENTICATE;  // 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;  
  
  // Get the queue properties.  
  hr = MQGetQueueProperties(wszQueueFormatName, &QueueProps);  
  if (FAILED(hr))  
  {  
    return hr;  
  }  
  
  // Set the *pbValue parameter to pass the authentication level of the queue on return.  
  *pbValue = aQueuePropVar[0].bVal;  
  return hr;  
}