MSMQMessage.AppSpecific (Compact 2013)

Article
08/18/2015

3/26/2014

This property specifies application-generated information, such as single integer values or application-defined message classes.

Syntax

HRESULT get_AppSpecific( 
  long* plAppSpecific 
);
HRESULT put_AppSpecific( 
  long plAppSpecific
);

Parameters

plAppSpecific or plAppSpecific
Application-generated information such as single integer values or defined message classes.

Return Value

The following table describes the common return values.

Value	Description
S_OK	Success
E_INVALIDARG	One or more arguments are invalid
E_NOTIMPL	The function contains no implementation
E_OUTOFMEMORY	Out of memory

Remarks

The AppSpecific property can be used to identify a single message or set of messages. For example, the receiving application can search a queue for all messages that have the same application specific information.

If the sending application sets AppSpecific to a negative value, receiving applications that are using the API calls to read messages will read these values as Unsigned Long values.

Another message property that can be used to pass application-defined information is MSMQMessage.CorrelationId.

Equivalent Function Property

When using function calls, the application specific information of the message can be set and retrieved using the PROPID_M_APPSPECIFIC message property.

Requirements

Header	mqoai.h
Library	mqoa.lib

Share via