PROPID_M_LABEL

The PROPID_M_LABEL property specifies a label of the message.

Type Indicator

VT_LPWSTR

PROPVARIANT Field

pwszVal

Property Values

Arbitrary string (the default is none). Maximum length is 250 Unicode characters (including the end-of-string character).

Remarks

If the sending application specifies a message label longer than 250 Unicode characters, MSMQ returns an MQ_ERROR_LABEL_TOO_LONG error to the aStatus array.

To find the label of a message, pass PROPID_M_LABEL and PROPID_M_LABEL_LEN to MQReceiveMessage and examine the returned values.

Example

This example shows how PROPID_M_LABEL is specified in the MQMSGPROPS structure:

MsgProps.aPropID[i] = PROPID_M_LABEL;        //PropId
MsgProps.aPropVar[i].vt = VT_LPWSTR;         //Type
MsgProps.aPropVar[i].pwszVal = L"Hash hash"; //Value

For an example of using PROID_M_LABEL, see Sending Private Messages.

QuickInfo

  Windows NT: Requires version 4.0 SP3 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in mq.h.
  Import Library: Use mqrt.lib.
  Unicode: Defined only as Unicode.

See Also

MQReceiveMessage, PROPID_M_LABEL_LEN