Jump to content

WinQueryObjectPath: Difference between revisions

From EDM2
No edit summary
 
Line 5: Line 5:


=== Parameters ===
=== Parameters ===
;objectHandle - [[HOBJECT]] - input : Object's handle.
;''objectHandle'' ([[HOBJECT]]) - input : Object's handle.
;pathName - [[PSZ]] - output : Memory for the path name of the object.
;''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.
;''sizeOfPathName'' ([[ULONG]]) - input : The size of the memory buffer for the path name - in bytes.


=== Returns ===
=== Returns ===

Latest revision as of 04:44, 15 June 2025

Get the path name of the object.

Syntax

WinQueryObjectPath(objectHandle, pathName, sizeOfPathName)

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.

Returns

This function returns a BOOL with the values of:

Returns from WinGetLastError should WinQueryObjectPath fail:

Define (C/C++)

INCL_WINWORKPLACE

Calling Convention

Cdecl32

Example Code

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

OS Version Introduced

OS/2 Warp 3.0

Related Functions