IDSSXTabDataAccess Interface Reference

Inherited by IDSSRawTabularData, IDSSXTabDataAccess2, and IDSSXTabViewAccess.

List of all members.

---

Detailed Description

User should view this interface as a way to access a 2-D array of data.

Given a result set with m rows and n columns, the cell at row 0, column 0 represents the cell at the top-left corner, while the cell at row m - 1, column n - 1 is the cell at the bottom-right corner.

Each cell is retrieved as a VARIANT. In addition, entire result set and each row/column can be retrieved as a SAFEARRAY of VARIANT.

Public Member Functions
HRESULT	Cell ([in] Int32 RowIndex,[in] Int32 ColIndex,[out, retval]VARIANT *pCell)
	Return a cell specified by iRow and iColumn.
HRESULT	CellFlag ([in] Int32 RowIndex,[in] Int32 ColIndex,[out, retval]DSSData_Flags *pCellFlag)
	Return status information for each cell.
HRESULT	Column ([in] Int32 ColIndex,[out, retval] VARIANT *ppDataSet)
	Return an entire column.
HRESULT	Data ([out, retval] VARIANT *ppDataSet)
	Return the entire result set as a two dimensional array.
HRESULT	NumColumns ([out, retval] Int32 *pNumCols)
	Return the number of columns Return the number of columns.
HRESULT	NumRows ([out, retval] Int32 *pNumRows)
	Return the number of rows Return the number of rows.
HRESULT	Row ([in] Int32 RowIndex,[out, retval] VARIANT *ppDataSet)
	Return an entire row.

---

Member Function Documentation

HRESULT IDSSXTabDataAccess::Cell (  [in] Int32  RowIndex, [in] Int32  ColIndex, [out, retval] VARIANT *  pCell )

Return a cell specified by iRow and iColumn. NULL cell is indicated by VT_EMPTY. Parameters: RowIndex  The row index. Start from 0 ColIndex  The column index. Start from 0 pCell  The value in the specified cell. Returns: Usual COM result code: S_OK

HRESULT IDSSXTabDataAccess::CellFlag (  [in] Int32  RowIndex, [in] Int32  ColIndex, [out, retval] DSSData_Flags *  pCellFlag )

Return status information for each cell. Each bit, if set, indicate the invalid cell, floating point error during evaluation or other error conditions. However, for other methods on this interface, Cell, Row, Column, Data, when encounter cell with error flag, regardless of types of error, it will set the Variant into VT_EMPTY. For detailed information, this call is provided. DSSData_Flags bit values are following Constant Value Comment DssDataOk 0x00 DssDataNull 0x01 DssDataInvalidCell 0x02 DssDataTruncate 0x04 DssDataOverflow 0x08 DssDataUnderflow 0x10 DssDataZerodivide 0x20 DssDataInvalid 0x40 DssDataUnknown 0x80 Parameters: RowIndex  The row index. Start from 0 ColIndex  The column index. Start from 0 pCellFlag  Cell flag. Returns: Usual COM result code: S_OK

HRESULT IDSSXTabDataAccess::Column (  [in] Int32  ColIndex, [out, retval] VARIANT *  ppDataSet )

Return an entire column. Parameters: ColIndex  The row index. ppDataSet  SAFEARRAY of NumRows size. Each element is VARIANT representing a cell. Returns: Usual COM result code: S_OK

HRESULT IDSSXTabDataAccess::Data (  [out, retval] VARIANT *  ppDataSet  )

Return the entire result set as a two dimensional array. Default property of the interface. Parameters: ppDataSet  2-D SAFEARRAY with size of NumRows and NumColumns. Each element is a VARIANT representing a cell. Returns: Usual COM result code: S_OK

HRESULT IDSSXTabDataAccess::NumColumns (  [out, retval] Int32 *  pNumCols  )

Return the number of columns Return the number of columns. Returns: Usual COM result code: S_OK

HRESULT IDSSXTabDataAccess::NumRows (  [out, retval] Int32 *  pNumRows  )

Return the number of rows Return the number of rows. Returns: Usual COM result code: S_OK

HRESULT IDSSXTabDataAccess::Row (  [in] Int32  RowIndex, [out, retval] VARIANT *  ppDataSet )

Return an entire row. Parameters: RowIndex  The row index. ppDataSet  SAFEARRAY of NumColumns size. Each element is VARIANT representing a cell. Returns: Usual COM result code: S_OK

---