OS2 API:WinQueryObjectPath

Contents 1 WinQueryObjectPath 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

WinQueryObjectPath

WinQueryObjectPath(objectHandle, pathName, sizeOfPathName) 

Get the path name of the object.

Parameters

objectHandle - HOBJECT - input 

Object's handle.

pathName - PSZ - output 

Memory for the path name of the object.

sizeOfPathName - ULONG - input 

The size of the memory buffer for the path name - in bytes.

Constants

Returns

This function returns a BOOL with the values of:

• TRUE
• FALSE

Returns from WinGetLastError should WinQueryObjectPath fail:

• PMERR_INVALID_PARAMETER
• WPERR_BUFFER_TOO_SMALL
• WPERR_OBJECT_NOT_FOUND

Module

Define (C/C++)

INCL_WINWORKPLACE

Export name/Ordinal

Calling conversion

Cdecl32

Example Code

...
HOBJECT className;
PSZ pathName;
ULONG sizeOfPathName; // use CCHMAXPATH plus one.
BOOL rc;
...
rc = WinQueryObjectPath (objectHandle, pathName, sizeOfPathName);
...

Related Functions

WinCreateObject WinQueryObject

Notes

OS Version Introduced

OS/2 Warp 3.0 and greater, eCS 1.0 and greater

Back to OS/2 API