OS2 API:WinQueryActiveDesktopPathname

Contents 1 WinQueryActiveDesktopPathname 1.1 Parameters 1.2 Constants 1.3 Returns 1.4 Module 1.5 Define (C/C++) 1.6 Export name/Ordinal 1.7 Calling conversion 1.8 Example Code 1.9 Related Functions 1.10 Notes 1.11 OS Version Introduced

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.

Constants

Returns

True if successful, false if not successful.

• TRUE
• FALSE

Returns from WinGetLastError should WinQueryActiveDesktopPathname fail:

• PMERR_INVALID_PARAMETER

Module

Define (C/C++)

INCL_WINWORKPLACE

Export name/Ordinal

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, eCS 1.0 and above

Back to OS/2 API