Function Name: Put Data Table

Definition

Used to create all the cells of the given Data Table. (To create only a section of the Data Table, use SE_PutDataTableExtent() instead.)

Returns

SE_NULL_REQUIRED_PARAMETER - and data_table is unaffected, if

1. data_in_ptr was NULL,
2. selected_elements was NULL,
3. element_count is zero, or
4. selected_components was NULL but required.

SE_INVALID_OR_NULL_OBJECT - and data_table is unaffected, if data_table is not a handle to a valid, active (i.e., unfreed), saved Data Table.

SE_UNRESOLVED_OBJECT - and data_table is unaffected, if data_table is an unresolved object.

SE_INVALID_ACCESS_MODE - and data_table is unaffected, if data_table belongs to a transmittal that was opened in read-only mode.

SE_FAILURE - and data_table is unaffected, if any of the following conditions are encountered:

1. the given selected_elements, selected_components don't form a valid Data Table signature,
2. Data Table doesn't belong to an open transmittal,
3. Data Table is a Property Grid with data_present set to SE_FALSE (note that the default value of this field is SE_TRUE, if the user has not yet set the fields of the Property Grid),
4. the byte_count is not correct for the given extents and set of selected elements and components, or
5. the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

   Prototype

   
   

   extern SE_STATUS_CODE_ENUM
   SE_PutDataTable
   (
   	SE_OBJECT		data_table,	(notes)
   	SE_PINT32		element_count,	(notes)
   const	EDCS_AC_ID		selected_elements[],	(notes)
   const	EDCS_CC_ID		selected_components[],	(notes)
   	SE_UINT32		byte_count,	(notes)
   const	SE_PROPERTY_DATA_VALUE	*	data_in_ptr	(notes)
   );

   ---

   Parameters Notes

   data_table

    the <Data Table> whose cells are being created.

   element_count

    the number of elements per cell to create, and the size
       of the selected_elements array.

   selected_elements

     selected_elements -- an array of EDCS Attribute
       Codes (EACs), indicating which elements will be created for each cell,
       *and* defining how those elements will be ordered when they are created.

   selected_components

    if selected_elements[i] ==
       EDCS_AC_INDEX_TO_COMPONENT or EDCS_AC_INDEX_TO_LIBRARY, then
       selected_components[i] is used to distinguish which component or library
       <Data Table> should be used. Otherwise, selected_components[i] is
       ignored.

   byte_count

    the amount of memory that is occupied by the data values of
       the cells to be created. The number of bytes needed for each cell is the
       number of elements (element_count) times the size of a cell value
       (the sizeof(SE_PROPERTY_DATA_VALUE)).

   data_in_ptr

    a pointer to byte_count bytes of memory, already allocated
       either in a store or in the user's memory space, to be written to the
       <Data Table>.

   ---

   Prev: Publish Object. Next: Put Data Table Extent. Up:Index.