Jump to content

WinQueryObjectPath: Difference between revisions

From EDM2
WinQueryObjectPath moved to OS2 API:WinQueryObjectPath
 
No edit summary
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
#REDIRECT [[OS2 API:WinQueryObjectPath]]
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:
* [[TRUE]]
* [[FALSE]]
Returns from [[WinGetLastError]] should WinQueryObjectPath fail:
* [[PM Error Codes#PMERR_INVALID_PARAMETER|PMERR_INVALID_PARAMETER]]
* [[PM Error Codes#WPERR_BUFFER_TOO_SMALL|WPERR_BUFFER_TOO_SMALL]]
* [[PM Error Codes#WPERR_OBJECT_NOT_FOUND|WPERR_OBJECT_NOT_FOUND]]
=== 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==
*[[WinCreateObject]]
*[[WinQueryObject]]
[[Category:Win]]

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