OpenDesktop function
Opens the specified desktop object.
Syntax
HDESK WINAPI OpenDesktop( _In_ LPTSTR lpszDesktop, _In_ DWORD dwFlags, _In_ BOOL fInherit, _In_ ACCESS_MASK dwDesiredAccess );
Parameters
- lpszDesktop [in]
-
The name of the desktop to be opened. Desktop names are case-insensitive.
This desktop must belong to the current window station.
- dwFlags [in]
-
This parameter can be zero or the following value.
Value Meaning - DF_ALLOWOTHERACCOUNTHOOK
- 0x0001
Allows processes running in other accounts on the desktop to set hooks in this process.
- fInherit [in]
-
If this value is TRUE, processes created by this process will inherit the handle. Otherwise, the processes do not inherit this handle.
- dwDesiredAccess [in]
-
The access to the desktop. For a list of access rights, see Desktop Security and Access Rights.
Return value
If the function succeeds, the return value is a handle to the opened desktop. When you are finished using the handle, call the CloseDesktop function to close it.
If the function fails, the return value is NULL. To get extended error information, call GetLastError.
Remarks
The calling process must have an associated window station, either assigned by the system at process creation time or set by the SetProcessWindowStation function.
If the dwDesiredAccess parameter specifies the READ_CONTROL, WRITE_DAC, or WRITE_OWNER standard access rights, you must also request the DESKTOP_READOBJECTS and DESKTOP_WRITEOBJECTS access rights.
Requirements
|
Minimum supported client |
Windows 2000 Professional [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows 2000 Server [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names |
OpenDesktopW (Unicode) and OpenDesktopA (ANSI) |
See also
- CloseDesktop
- CreateDesktop
- Desktops
- OpenInputDesktop
- SetProcessWindowStation
- SetThreadDesktop
- SwitchDesktop
- Window Station and Desktop Functions