WinQueryActiveDesktopPathname: Difference between revisions
mNo edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 5: | Line 5: | ||
== Parameters == | == Parameters == | ||
; pathName | ; ''pathName'' ([[PSZ]]) - output : Memory buffer which this function will place the desktop folder's path name. | ||
; size | ; ''size'' ([[ULONG]]) - input : Size of the pathName memory buffer. | ||
== Returns == | == Returns == | ||
| Line 13: | Line 13: | ||
* [[FALSE]] | * [[FALSE]] | ||
Returns from [[WinGetLastError]] should WinQueryActiveDesktopPathname fail: | Returns from [[WinGetLastError]] should WinQueryActiveDesktopPathname fail: | ||
* [[ | * [[PM Error Codes#PMERR_INVALID_PARAMETER|PMERR_INVALID_PARAMETER]] | ||
== Define (C/C++) == | == Define (C/C++) == | ||
Latest revision as of 04:41, 15 June 2025
Get the handle to the object id.
Syntax
WinQueryActiveDesktopPathname(pathName, size)
Parameters
- pathName (PSZ) - output
- Memory buffer which this function will place the desktop folder's path name.
- size (ULONG) - input
- Size of the pathName memory buffer.
Returns
True if successful, false if not successful.
Returns from WinGetLastError should WinQueryActiveDesktopPathname fail:
Define (C/C++)
INCL_WINWORKPLACE
Calling Convention
Example Code
... PSZ pathName; ULONG size; BOOL rc; ... rc = WinQueryActiveDesktopPathname (pathName, size); ...
Related Functions
Notes
Since the desktop directory may not be <boot drive>:\DESKTOP, this API call is used to retrieve the directory of the desktop.
OS Version Introduced
OS/2 Warp 3.0 and above