XLL+ Class Library (6.3)

CVectorConvertParams<T>::CVectorConvertParams

Constructs a CVectorConvertParams<T> object

CVectorConvertParams( );
CVectorConvertParams(
   const wchar_t* argName,
   unsigned long flags = 0,
   const wchar_t* groupName = 0,
   size_t rowOrColumn = (size_t)-1,
   long* expectedSize = 0,
   unsigned long lowerBound = 0,
   T& defaultCellValue = T()
);

Parameters

argName

The name of the argument to be converted, as it appears in Excel. This name is inserted into error messages if conversion fails.

flags

A set of flags, which are members of the XlConvertFlags enumeration.

groupName

The name of the grouped argument of which this argument is an item. Ignored unless flags contains XLA_OPER_IS_GROUP.

rowOrColumn

The position of the argument within its container. Used by error messages to indicate which item within a matrix group could not be converted.

expectedSize

A pointer to an integer containing the expected size of the vector, or -1 if the size is not yet known. Used to compare the sizes of vectors that are constrained with regard to size. Ignored if NULL.

During the conversion function, if *expectedSize contains a non-negative number then the size of the vector being read will be compared to that value and, if they do not match, an exception of type CXlConversionException is thrown. If *expectedSize contains a number, then it will be set to the size of the vector being read.

lowerBound

The number of empty items to insert at the start of the result vector. If you are going to pass the vector to a library function that expects vectors to be 1-based, then this value should be set to 1.

defaultCellValue

The default value to be used if a cell within the argument is empty. Ignored unless flags contains one or more of the XLA_DEFAULT_* values.

Requirements

Header: xlpconvert.h

See Also

CVectorConvertParams<T> Class | CVectorConvertParams<T> Methods