This documentation is archived and is not being maintained.

DispatcherObject.CheckAccess Method

Determines whether the calling thread has access to this DispatcherObject.

Namespace: System.Windows.Threading
Assembly: WindowsBase (in windowsbase.dll)

public bool CheckAccess ()
public boolean CheckAccess ()
public function CheckAccess () : boolean
You cannot use methods in XAML.

Return Value

true if the calling thread has access to this object; otherwise, false.

Only the thread the Dispatcher was created on may access the DispatcherObject.

Any thread can check to see whether it has access to this DispatcherObject.

The difference between CheckAccess and VerifyAccess is that CheckAccess returns a Boolean that specifies whether the calling thread has access to this DispatcherObject and VerifyAccess throws an exception if the calling thread does not have access to the this DispatcherObject.

The following example uses CheckAccess to determine whether a thread has access to the thread that a Button was created on. The CheckAccess method on the Button is called to verify access to the thread. If the calling thread has access, the Button is updated by just accessing the members of the Button; otherwise, a delegate, which accepts a Button as an argument, is posted onto the Dispatcher of the Button.

// Uses the DispatcherObject.CheckAccess method to determine if 
// the calling thread has access to the thread the UI object is on
private void TryToUpdateButtonCheckAccess(object uiObject)
    Button theButton = uiObject as Button;

    if (theButton != null)
        // Checking if this thread has access to the object
            // This thread has access so it can update the UI thread
            // This thread does not have access to the UI thread
            // Pushing update method on the Dispatcher of the UI thread
                new UpdateUIDelegate(UpdateButtonUI), theButton);

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0