XLL+ Class Library (6.3)

CXlOper::FromMatrix

Assigns a 2-dimensional array of numbers, booleans or strings to the CXlOper

template< class T >
BOOL FromMatrix(
   const ple::imtx<T>& mat1,
   long lLBound1 = 0,
   long lLBound2 = 0,
   BOOL toBoolean = FALSE
);
template< class T >
BOOL FromMatrix(
   const xlp::matrix<T>& mat2,
   long lLBound1 = 0,
   long lLBound2 = 0,
   BOOL toBoolean = FALSE
);

Parameters

mat1

2-dimensional array of data, contained in an object which supports the imtx interface.

The following types for T are directly supported:

  • bool
  • long
  • unsigned long
  • int
  • unsigned int
  • short
  • unsigned short
  • double
  • float
  • CString
  • CStringA
  • CStringW
  • std::string
  • std::wstring
Any other type is treated as an enumerated type, and converted first to long and then to a number.

lLBound1

Lower bound of the rows of data in the matrix. The first lLBound1 rows of input will be ignored.

lLBound2

Lower bound of the columns of data in the matrix. The first lLBound2 columns of input will be ignored.

toBoolean

If TRUE, then the resulting Excel array will contain boolean values instead of numbers.

mat2

2-dimensional array of data.

The data types supported are as for mat1.

Return Value

Returns TRUE if the function succeeded, FALSE if it failed.

Remarks

This function sets the type of the CXlOper to be an array, allocates space for the matrix of numbers or strings provided and sets the values into the CXlOper.

The method will return FALSE if the size of the array is 0 or if it is too large.

NoteNote:

This method is deprecated. Use FromMatrix2 instead.

Requirements

Header: xllplus.h

See Also

CXlOper Class | CXlOper Methods | CXlOper::operator =