company logo

PropertyHandle :: GetArea - Get Instance area

The function returns the instance area for the property handle. In contrast to GetInstance() the function returns the instance area as (char *) pointer regardless on whether an instance is selected in the property handle or not.

The function will always return a data area when the propertyhandle has a valid description. Hence it cannot be used for checking whether a data area is available. For checking whether a data area has been allocated use HasData().

Return value:  Instance area ( void * )

Implementation details

const void * PropertyHandle  :: GetArea ( char chkopt=AUTO )

The function returns the area for the current property handle.

  • chkopt - Check option

    The option forces the function to check the property handle before running executing the function. You can pass NO to avoid unnecessary checking.

    Default: AUTO