WinQueryActiveDesktopPathname: Difference between revisions

Revision as of 19:22, 22 December 2016

WinQueryActiveDesktopPathname(pathName, size): Get the handle to the object id.

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]]
+;WinQueryActiveDesktopPathname(pathName, size) : Get the handle to the object id.
+=== 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:
+* [[OS2_API:PMI:error#PMERR_INVALID_PARAMETER|PMERR_INVALID_PARAMETER]]
+=== Define (C/C++) ===
+INCL_WINWORKPLACE
+=== Calling conversion ===
+[[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]]