_GetObjectProperty( ) API Library Routine

Returns a property value for an object.

int _GetObjectProperty(Value FAR *retval, Value FAR *objct, 
   char FAR *prop)

Remarks

The object to return a property for is specified with *objct, and the property to return is specified with *prop.

The value returned is placed in the *retval value structure.

Note

You must always fill the *retval structure with 0 prior to calling _GetObjectProperty().

_GetObjectProperty( ) returns 0 if it is successful; otherwise, the negative value of the corresponding Visual FoxPro error code is returned.

For more information on how to create an API library and integrate it with Visual FoxPro, see Accessing the Visual FoxPro API.