# Function Reference

# _WinAPI_OpenDesktop

Opens the specified desktop object

#include <WinAPISys.au3>
_WinAPI_OpenDesktop ( $sName [, $iAccess = 0 [, $iFlags = 0 [, $bInherit = False]]] )

## Parameters

$sName | The name of the desktop to be opened. Desktop names are case-insensitive. This desktop must belong to the current window station.
$iAccess | [optional] The access to the desktop. This parameter can be one or more of the following values: $DESKTOP_ALL_ACCESS $DESKTOP_CREATEMENU $DESKTOP_CREATEWINDOW $DESKTOP_ENUMERATE $DESKTOP_HOOKCONTROL $DESKTOP_JOURNALPLAYBACK $DESKTOP_JOURNALRECORD $DESKTOP_READOBJECTS $DESKTOP_SWITCHDESKTOP $DESKTOP_WRITEOBJECTS
$iFlags | [optional] The optional flags. It can be zero or the following value: $DF_ALLOWOTHERACCOUNTHOOK
$bInherit | [optional] Specifies whether inherites the handle by a processes, valid values: True - The processes created by this process will inherit the handle. False - The processes do not inherit this handle (Default).

## Return Value

Success: | Handle to the opened desktop.
Failure: | 0, call _WinAPI_GetLastError() to get extended error information.

## Remarks

When you are finished using the desktop, call the _WinAPI_CloseDesktop() function to close it.

## Related

_WinAPI_CloseDesktop

## See Also

Search OpenDesktop in MSDN Library.