WinQueryActiveDesktopPathname: Difference between revisions

Revision as of 05:19, 20 May 2018

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: @@
-;WinQueryActiveDesktopPathname(pathName, size) : Get the handle to the object id.
+Get the handle to the object id.
-=== Parameters ===
+==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 ===
+== Returns ==
 True if successful, false if not successful.
 * [[TRUE]]
@@ Line 12: / Line 15: @@
 * [[OS2_API:PMI:error#PMERR_INVALID_PARAMETER|PMERR_INVALID_PARAMETER]]
-=== Define (C/C++) ===
+== Define (C/C++) ==
 INCL_WINWORKPLACE
-=== Calling Convention ===
+== Calling Convention ==
 [[Cdecl32]]
-=== Example Code ===
+== Example Code ==
   ...
   PSZ pathName;
@@ Line 27: / Line 30: @@
   ...
-=== Related Functions ===
+== Related Functions ==
 *[[WinQueryObjectPath]]
-=== Notes ===
+== 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 Version Introduced ==
 OS/2 Warp 3.0 and above
 [[Category:Win]]