Overview
C API (Core)
struct EventAccessForm { Symbol form; TYPE type; struct Dimensions dims; };
Notes
  • In this event, the Component is expected to provide the data structure that is pointed to by Event::data.

The Data should return information on the form of the generic representation of its content that is known in advance.

Fields

Symbol form OUT
A form constant, see below.
TYPE type OUT
The generic form's TYPE constant.
struct Dimensions dims OUT
The generic form's dimensions.

Constants

C_FORM_FIXED
The generic form has a fixed structure (data type and dimensions). The structure should be returned through dims and type, where "type" is a full type constant.
C_FORM_BOUNDED
The generic form has a structure that is content-dependent but that has a fixed data type and number of dimensions, with each of those dimensions having a maximum size. Return the maximum size of the generic form.
C_FORM_UNBOUNDED
The generic form cannot be determined in advance at all.
C_FORM_FIXED_BUT_LAST
The generic form has a fixed structure except that the last dimension may vary dependent on the content. Return the structure as above, but set the last dimension to the maximum size that dimension may take, or to DIM_ANY to indicate that the last dimension is unbounded. This is equivalent to C_FORM_UNBOUNDED except that the framework can determine the dimension from the results of EVENT_ACCESS_CONTENT_GET, avoiding a call to EVENT_ACCESS_FORM_CURRENT.

Action

  • Set form (and dims and type).

Example

C++ Source Code (against 1199)
// TODO // ok return C_OK;