MSMQApplication.IsDSEnabled

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 IsDSEnabled property of the MSMQApplication object indicates whether the Message Queuing service on the local computer is configured to use the directory service and is operating in domain or offline mode.

Data type:	Boolean
Run-time access:	Read-only

Property IsDSEnabled As Boolean

Property Value

True (-1)

The Message Queuing service on the local computer is configured to use the directory service and is operating in domain or offline mode.

False (0)

The Message Queuing service on the local computer is not configured to use the directory service and is operating in workgroup mode.

Error Codes

For information on return codes, see Message Queuing Error and Information Codes.

Remarks

Message Queuing determines the value of IsDSEnabled from the status of the computer without attempting to access the directory service.

When calling IsDSEnabled, you do not need to reference the MSMQApplication object explicitly because this object is defined as the application object, whose methods and properties are globally available.

This property applies only to the default (local) computer. If the application object references a specific computer (including the local computer), an MQ_ERROR_INVALID_PARAMETER error will be returned. You can use MSMQApplication.Machine to set the computer name to Null so that the application object will not reference a specific computer.

In C++ COM applications, you must use a smart pointer to the IMSMQApplication2 or IMSMQApplication3 interface to expose the IsConnected property.

Equivalent API Function Property

With API functions, the equivalent property is PROPID_PC_DS_ENABLED.

Example Code

The following example is included in Using Message Queuing.

For an example of	See
Verifying that the local computer running Message Queuing is part of a workgroup	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 Mqoai.h.

Library: Use Mqoa.lib.