Click here to return to the KiXtart HelpDesk main page...

KiXtart Command Reference

OLEGETPROPERTY

action

returns the value of a specific property of an OLE Automation object.

syntax

OLEGETPROPERTY (objecthandle , “propertyname”)

parameters

ObjectHandle

The handle of the object you want to access. This handle must have been obtained by a call to OLECreateObject, OLEGetObject, OLEGetSubObject, OLEGetProperty or OLECallFunc.

PropertyName

The name of the property you want to retrieve the value of.

returns

If the function succeeds, the return value is the value of the property. If the function fails, the return value will be empty, and @ERROR will be set to the relevant error code.