MQGetMachineProperties

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function retrieves information about a Queue Manager on the local machine.

Syntax

HRESULT APIENTRY MQGetMachineProperties(
  LPCWSTR lpwcsMachineName,
  const GUID* pguidMachineID,
  MQQMPROPS* pQMProps
);

Parameters

• lpwcsMachineName
  [in] Not supported; set to NULL.

• pguidMachineID
  [in] Not supported; set to NULL.

• pQMProps
  [in, out] Pointer to a Queue Manager properties structure, MQQMPROPS, specifying which properties to retrieve.

Return Value

• MQ_OK
  Indicates success.

• MQ_ERROR_ACCESS_DENIED
  Access to the specified computer is denied.

  Verify the access rights for the operation.

• MQ_ERROR_INVALID_PARAMETER
  Both the name (lpwcsMachineName) and computer (pguidMachineID) identifiers were specified.

• MQ_ERROR_ILLEGAL_MQQMPROPS
  Either pQMprops was NULL or no properties were specified.

• MQ_ERROR_ILLEGAL_PROPERTY_VT
  An invalid type indicator was supplied for a property value in pQMProps.

• MQ_INFORMATION_UNSUPPORTED_PROPERTY
  An unsupported property identifier was specified in pQMProps.

• MQ_INFORMATION_DUPLICATE_PROPERTY
  A duplicate property identifier was specified in pQMProps. The second entry is ignored.

Remarks

For Windows Embedded CE, the only valid Queue Manager property is PROPID_QM_MACHINE_ID.

If a property specified by pQMProps is set to VT_NULL, MSMQ allocates the memory needed to store the property value when MQGetMachineProperties is called.

If the returned property type replaces the VT_NULL value, the application must free the memory allocated for the property value by calling MQFreeMemory.

Requirements

See Also

Reference

MQFreeMemory
PROPID_QM_MACHINE_ID
MQQMPROPS