MQGetPrivateComputerInformation

Article
10/19/2016

Applies To: Windows 10, Windows 7, Windows 8, Windows 8.1, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, Windows Server 2012 R2, Windows Server Technical Preview, Windows Vista

(Introduced in MSMQ 2.0.) The MQGetPrivateComputerInformation function retrieves information about the local computer without accessing the directory service.

HRESULT APIENTRY MQGetPrivateComputerInformation(  
  LPCWSTR lpwcsComputerName,    
  MQPRIVATEPROPS * pPrivateProps           
);

Parameters

lpwcsComputerName

[in] Must be set to NULL to specify the local computer.

pPrivateProps

[in, out] Pointer to an MQPRIVATEPROPS structure that specifies which private computer properties to retrieve.

On input, this structure specifies which properties to retrieve.

On output, this structure contains the returned values for the properties and any optional status error codes for the properties (some properties do not return status error codes).

Return Values

MQ_OK

Indicates success.

MQ_ERROR_INVALID_PARAMETER (0xC00E0006)

One of the input parameters is not valid. For example, lpwcsComputerName is not set to NULL.

MQ_ERROR_ILLEGAL_MQPRIVATEPROPS (0xC00E007B)

Either no properties are specified in the MQPRIVATEPROPS structure, or the pPrivateProps parameter is set to NULL.

Remarks

This function may be called even when Message Queuing does not have access to a directory service. For example, this function is called to verify that the computer is operating in workgroup mode.

The values of the private computer properties returned by this call are calculated, they are not retrieved from the directory service.

Example Code

The following code example is included in Using Message Queuing.

For an example of	See
Verifying that the local computer is configured to operate in workgroup mode	C/C++ Code Example: Verifying Workgroup Installation

Requirements

Windows NT/2000/XP: Included in Windows 2000 and later.

Windows 95/98/Me: Unsupported.

Header: Declared in Mq.h.

Library: Use Mqrt.lib.

Partager via