WinQueryObject: Difference between revisions
m Redirected page to OS2 API:PMI:WinQueryObject |
m →Returns |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
# | Get the handle to the object id. | ||
==Syntax== | |||
WinQueryObject(objectID) | |||
=== Parameters === | |||
;objectID - [[PSZ]] - input:Object id of an existing object as assigned by [[WinCreateObject]] or [[WinSetObjectData]], or the fully qualified path name of the object. | |||
=== Returns === | |||
This function returns a [[HOBJECT]] or [[NULLHANDLE]] with the occurrence of an error. | |||
Returns from [[WinGetLastError]] should '''WinQueryObject''' fail: | |||
* [[PM Error Codes#WPERR_OBJECT_NOT_FOUND|WPERR_OBJECT_NOT_FOUND]] | |||
* [[PM Error Codes#WPERR_INVALID_OBJECTID|WPERR_INVALID_OBJECTID]] | |||
=== Define (C/C++) === | |||
INCL_WINWORKPLACE | |||
=== Calling Convention === | |||
[[Cdecl32]] | |||
=== Example Code === | |||
... | |||
PSZ objectID; | |||
HOBJECT rc; | |||
... | |||
rc = WinQueryObject (objectID); | |||
... | |||
=== Notes === | |||
This API call allows the retrieval of the persistent object handle for any file object with the fully qualified file name. Also, any object's handle can be retrieved by its object ID string. Using the object's handle, its state can be manipulated with [[WinSetObjectData]], or delete the object with [[WinDestroyObject]]. Valid object ID strings start with the "<" character and end with the ">" character. | |||
==Related Functions== | |||
*[[WinCopyObject]] | |||
*[[WinCreateObject]] | |||
*[[WinDestroyObject]] | |||
*[[WinMoveObject]] | |||
*[[WinOpenObject]] | |||
*[[WinSaveObject]] | |||
*[[WinSetObjectData]] | |||
[[Category:Win]] | |||
Latest revision as of 02:15, 1 December 2019
Get the handle to the object id.
Syntax
WinQueryObject(objectID)
Parameters
- objectID - PSZ - input
- Object id of an existing object as assigned by WinCreateObject or WinSetObjectData, or the fully qualified path name of the object.
Returns
This function returns a HOBJECT or NULLHANDLE with the occurrence of an error.
Returns from WinGetLastError should WinQueryObject fail:
Define (C/C++)
INCL_WINWORKPLACE
Calling Convention
Example Code
... PSZ objectID; HOBJECT rc; ... rc = WinQueryObject (objectID); ...
Notes
This API call allows the retrieval of the persistent object handle for any file object with the fully qualified file name. Also, any object's handle can be retrieved by its object ID string. Using the object's handle, its state can be manipulated with WinSetObjectData, or delete the object with WinDestroyObject. Valid object ID strings start with the "<" character and end with the ">" character.