The Queue Property Structure

 

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

The MQQUEUEPROPS structure, shown below, includes a property count member to indicate the number of properties included in the structure, an array that identifies each property (aPropID), an array that specifies the value of each property (aPropVar), and an array for the returned status of each property (aStatus). Position i in each of the three arrays contains information about a single property.

typedef struct tagMQQUEUEPROPS  
{  
  DWORD          cProp;  
  QUEUEPROPID    *aPropID;  
  MQPROPVARIANT  *aPropVar;  
  HRESULT        *aStatus;  
} MQQUEUEPROPS;  

The MQQUEUEPROPS structure is used in the following calls:

• To set queue properties when creating a queue.

• To retrieve and set the properties of an existing queue.

• To specify search criteria when locating public queues.

aPropID, aPropVar, and aStatus

The following illustration shows how Message Queuing uses the data in these three arrays. Note that for each property the corresponding elements of the aPropID and aPropVar array must be set to the property identifier and value, respectively.

When setting properties for queues, if a property is set to the same value more than once, Message Queuing uses the first entry in the aPropVar array and discards all the subsequent entries. In the aStatus array, an information error value of MQ_INFORMATION_DUPLICATE_PROPERTY is returned for each discarded entry.