Jump to content

WinQueryActiveDesktopPathname: Difference between revisions

From EDM2
No edit summary
 
Line 5: Line 5:


== Parameters ==
== Parameters ==
; pathName - [[PSZ]] - output : Memory buffer which this function will place the desktop folder's path name.
; ''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.
; ''size'' ([[ULONG]]) - input : Size of the pathName memory buffer.


== Returns ==
== Returns ==

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

Cdecl32

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