DispatcherObject.CheckAccess Method ()


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Determines whether the calling thread has access to this DispatcherObject.

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

member CheckAccess : unit -> bool

Return Value

Type: System.Boolean

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.

Calling this method is identical to calling CheckAccess on the associated Dispatcher object.

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.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 3.0
Return to top