WinQueryActiveDesktopPathname: Difference between revisions

Latest revision as of 04:41, 15 June 2025

Get the handle to the object id.

WinQueryActiveDesktopPathname(pathName, size)

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.

True if successful, false if not successful.

Returns from WinGetLastError should WinQueryActiveDesktopPathname fail:

INCL_WINWORKPLACE

...
PSZ pathName;
ULONG size;
BOOL rc;
...
rc = WinQueryActiveDesktopPathname (pathName, size);
...

Since the desktop directory may not be <boot drive>:\DESKTOP, this API call is used to retrieve the directory of the desktop.

OS/2 Warp 3.0 and above

@@ Line 1: / Line 1: @@
-#REDIRECT [[OS2 API:PMI:WinQueryActiveDesktopPathname]]
+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.
+* [[TRUE]]
+* [[FALSE]]
+Returns from [[WinGetLastError]] should WinQueryActiveDesktopPathname fail:
+* [[PM Error Codes#PMERR_INVALID_PARAMETER|PMERR_INVALID_PARAMETER]]
+== Define (C/C++) ==
+INCL_WINWORKPLACE
+== Calling Convention ==
+[[Cdecl32]]
+== Example Code ==
+ ...
+ PSZ pathName;
+ ULONG size;
+ BOOL rc;
+ ...
+ rc = WinQueryActiveDesktopPathname (pathName, size);
+ ...
+== Related Functions ==
+*[[WinQueryObjectPath]]
+== 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
+[[Category:Win]]