WinQueryActiveDesktopPathname: Difference between revisions
No edit summary |
No edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Get the handle to the object id. | |||
== | ==Syntax== | ||
WinQueryActiveDesktopPathname(pathName, size) | |||
=== Returns | == 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. | True if successful, false if not successful. | ||
* [[TRUE]] | * [[TRUE]] | ||
* [[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++) == | |||
INCL_WINWORKPLACE | INCL_WINWORKPLACE | ||
== Calling Convention == | |||
[[Cdecl32]] | [[Cdecl32]] | ||
== Example Code == | |||
... | ... | ||
PSZ pathName; | PSZ pathName; | ||
| Line 27: | Line 30: | ||
... | ... | ||
== Related Functions == | |||
*[[WinQueryObjectPath]] | *[[WinQueryObjectPath]] | ||
== Notes == | |||
Since the desktop directory may not be <boot drive>:\DESKTOP, this API call is used to retrieve the directory of the desktop. | 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 | OS/2 Warp 3.0 and above | ||
[[Category:Win]] | [[Category:Win]] | ||
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