WinQueryObjectPath: Difference between revisions
m Redirected page to OS2 API:PMI:WinQueryObjectPath |
mNo edit summary |
||
| Line 1: | Line 1: | ||
# | == 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. | |||
=== Returns === | |||
This function returns a [[BOOL]] with the values of: | |||
* [[TRUE]] | |||
* [[FALSE]] | |||
Returns from [[WinGetLastError]] should WinQueryObjectPath fail: | |||
* [[OS2_API:PMI:error#PMERR_INVALID_PARAMETER|PMERR_INVALID_PARAMETER]] | |||
* [[OS2_API:PMI:error#WPERR_BUFFER_TOO_SMALL|WPERR_BUFFER_TOO_SMALL]] | |||
* [[OS2_API:PMI:error#WPERR_OBJECT_NOT_FOUND|WPERR_OBJECT_NOT_FOUND]] | |||
=== Define (C/C++) === | |||
INCL_WINWORKPLACE | |||
=== Calling conversion === | |||
[[Cdecl32]] | |||
=== Example Code === | |||
... | |||
HOBJECT className; | |||
PSZ pathName; | |||
ULONG sizeOfPathName; // use [[OS2 API:Constant#CCHMAXPATH|CCHMAXPATH]] plus one. | |||
BOOL rc; | |||
... | |||
rc = WinQueryObjectPath (objectHandle, pathName, sizeOfPathName); | |||
... | |||
=== Related Functions === | |||
*[[WinCreateObject]] | |||
*[[WinQueryObject]] | |||
=== OS Version Introduced === | |||
OS/2 Warp 3.0 | |||
[[Category:Win]] | |||
Revision as of 01:43, 14 January 2017
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.
Returns
This function returns a BOOL with the values of:
Returns from WinGetLastError should WinQueryObjectPath fail:
Define (C/C++)
INCL_WINWORKPLACE
Calling conversion
Example Code
... HOBJECT className; PSZ pathName; ULONG sizeOfPathName; // use CCHMAXPATH plus one. BOOL rc; ... rc = WinQueryObjectPath (objectHandle, pathName, sizeOfPathName); ...
Related Functions
OS Version Introduced
OS/2 Warp 3.0