MQSetQueueProperties (Compact 2013)

3/26/2014

This function sets the properties of a local queue.

Syntax

HRESULT APIENTRY MQSetQueueProperties(
  LPCWSTR lpwcsFormatName,
  MQQUEUEPROPS* pQueueProps
);

Parameters

• lpwcsFormatName
  [in] Pointer to the direct format name string of the queue whose properties will be set.

• pQueueProps
  [in] Pointer to the MQQUEUEPROPS structure that specifies the properties to be set.

  On input, the cProp member of MQQUEUEPROPS specifies the number of properties to be set, the aPropID array specifies their property identifiers, and the aPropVar array indicates the new values of the specified properties.

  On output, the optional aStatus array, if it was included in MQQUEUEPROPS, indicates the status of the properties.

Return Value

• MQ_OK
  Indicates success.

• MQ_ERROR_ILLEGAL_FORMATNAME
  The lpwcsFormatName parameter specified an illegal format name.

• MQ_ERROR_ILLEGAL_PROPERTY_VALUE
  An illegal property value is specified.

• MQ_ERROR_PROPERTY
  One or more properties resulted in an error.

• MQ_ERROR_SERVICE_NOT_AVAILABLE
  Cannot connect to the Queue Manager.

• MQ_ERROR_UNSUPPORTED_FORMATNAME_OPERATION
  The format name specified by the lpwcsFormatName parameter cannot be used.

  You cannot set the queue properties of a journal, dead-letter, or connector queue.

• MQ_INFORMATION_PROPERTY
  One or more properties resulted in a warning even though the function completed.

Remarks

The following queue properties cannot be set by MQSetQueueProperties.

Property	Reason
PROPID_Q_CREATE_TIME	Set by MSMQ.
PROPID_Q_MODIFY_TIME	Set by MSMQ.
PROPID_Q_PATHNAME	Can only be set when the queue is created.
PROPID_Q_TRANSACTION	Can only be set when the queue is created.

Note

OS versions prior to 2.12 require the MSMQ add-on pack.

Requirements

Header	mq.h
Library	msmqrt.lib

See Also

Reference

MSMQ Functions
aPropID
aPropVar
aStatus
PROPID_Q_CREATE_TIME
PROPID_Q_MODIFY_TIME
PROPID_Q_PATHNAME
PROPID_Q_TRANSACTION
MQQUEUEPROPS