XLL+ Class Library (6.3)

CXlOper::FromVector

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

template< class T >
BOOL FromVector(
   const std::vector<T>& dvec,
   BOOL bRow = FALSE,
   size_t lLBound = 0,
   BOOL toBoolean = FALSE
);

Parameters

dvec

1-dimensional array of data.

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.

bRow

If TRUE, then the vector created will be a row; otherwise the vector will be a column.

lLBound

The lower bound of "interesting" inputs. The first lLBound items in the input vector will be ignored.

toBoolean

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

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 with a single column or row, allocates space for the vector of doubles, booleans or strings provided and sets the values into the CXlOper.

Note that integer numeric types are returned to Excel as boolean values. To return integer types as numbers, use CXlOper::FromNumericVector2().

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

NoteNote:

This method is deprecated. Use FromVector2 instead.

Requirements

Header: xllplus.h

See Also

CXlOper Class | CXlOper Methods | CXlOper::operator = | CXlOper::CXlOper | CXlOper::FromNumericVector