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:

• 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