MQGetMachineProperties

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

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 Values

  • 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 one of the property values 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 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. However, when the returned property type replaces the VT_NULL value, the application must still free the memory allocated for the property value by calling MQFreeMemory.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 2.0 and later. Versions prior to 2.12 require the MSMQ add-on pack. Mq.h Mq.h Msmqrt.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

MQFreeMemory, PROPID_QM_MACHINE_ID, MQQMPROPS

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.