OS2 API:WinQueryObject

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

WinQueryObject

WinQueryObject(objectID) 

Get the handle to the object id.

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.

Constants

Returns

This function returns a HOBJECT or NULLHANDLE with the occurrence of an error.

Returns from WinGetLastError should WinQueryObject fail:

• WPERR_OBJECT_NOT_FOUND
• WPERR_INVALID_OBJECTID

Module

Define (C/C++)

INCL_WINWORKPLACE

Export name/Ordinal

Calling conversion

Cdecl32

Example Code

...
PSZ objectID;
HOBJECT rc;
...
rc = WinQueryObject (objectID);
...

Related Functions

WinCopyObject WinCreateObject WinDestroyObject WinMoveObject WinOpenObject WinSaveObject WinSetObjectData

Notes

This API call allows the retrieval of the persistant 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.

OS Version Introduced

Back to OS/2 API