MQMSGPROPS

 

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 MQMSGPROPS structure describes a set of message properties. It specifies the number of properties (cProp) in the set, an array containing the identifier of each property (aPropID), and an array containing the value (or placeholder for the value) of each property (aPropVar). It also provides an optional status array (aStatus) for errors associated with the property (some properties do not return a status). For detailed information about the properties that can be included in the set, see Message Properties.

typedef struct tagMQMSGPROPS  
{  
  DWORD cProp;  
  MSGPROPID * aPropID;  
  MQPROPVARIANT * aPropVar;  
  HRESULT * aStatus;  
} MQMSGPROPS;  

Members

cProp

Number of properties in the set.

aPropID

Array of message property identifiers (for example, PROPID_M_LABEL, PROPID_M_MSGID, PROPID_M_BODY, and so on). For information about the array used to store the identifiers, see aPropID.

aPropVar

Array of values of the properties in the set. For information about the structure, see aPropVar.

aStatus

Optional. Array of return codes indicating the status of the properties in the set. For information about the array used to store the return codes, see aStatus.

If this member is not used, it should be set to NULL.

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 Mq.h.

See Also

Message Queuing Structures
Message Properties
aPropID
aPropVar
aStatus