Reads data from a 2-dimensional array into a matrix of numbers or strings
template< class T > BOOL ReadMatrix( ple::imtx<T>& mat1, const char* pszArgName, CString& strError, long* plUBound1 = 0, long* plUBound2 = 0, long lFlags = XLA_ARRAY_FLAGS_STD, long lLBound1 = 0, long lLBound2 = 0, long lIgnoreRows = 0, long lIgnoreCols = 0 ) const; template< class T > BOOL ReadMatrix( ple::imtx<T>& mat1, const char* pszArgName, CXlOper& xloError, long* plUBound1 = 0, long* plUBound2 = 0, long lFlags = XLA_ARRAY_FLAGS_STD, long lLBound1 = 0, long lLBound2 = 0, long lIgnoreRows = 0, long lIgnoreCols = 0 ) const; template< class T > BOOL ReadMatrix( xlp::matrix<T>& mat2, const char* pszArgName, CString& strError, long* plUBound1 = 0, long* plUBound2 = 0, long lFlags = XLA_ARRAY_FLAGS_STD, long lLBound1 = 0, long lLBound2 = 0, long lIgnoreRows = 0, long lIgnoreCols = 0 ) const; template< class T > BOOL ReadMatrix( xlp::matrix<T>& mat2, const char* pszArgName, CXlOper& xloError, long* plUBound1 = 0, long* plUBound2 = 0, long lFlags = XLA_ARRAY_FLAGS_STD, long lLBound1 = 0, long lLBound2 = 0, long lIgnoreRows = 0, long lIgnoreCols = 0 ) const; |
A matrix class (descended from class imtx<T>) containing items of type T, whose contents will be replaced by the contents of the CXlOper.
The following types are directly supported for T:
A matrix of double, whose contents will be replaced by the contents of the CXlOper.
The name of the argument that is being read. This will be used in any error strings that are generated.
Reference to an error string buffer. If the function fails for any reason, a useful error string will be placed here, e.g. "MyArgName: expected number in cell 3".
Pointer to upper bound of first dimension (height). If it is null, then it is ignored. If it is not null then it is used to check that the upper bounds of various arrays are consistent.
See Bounded input arrays for more information on the use of upper bounds.
Pointer to upper bound of second dimension (width). If it is null, then it is ignored. If it is not null then it is used to check that the upper bounds of various arrays are consistent.
See Bounded input arrays for more information on the use of upper bounds.
Flags controlling the conversion. See matrix & vector flags for a full list of flag values.
This will be used as a lower bound in the output matrix. lLBound rows containing default values (zero or blank) will be inserted at the start of the output matrix.
This will be used as a lower bound in the output matrix. lLBound columns containing default values (zero or blank) will be inserted at the start of the output matrix.
The first lIgnoreRows rows of input will be ignored. This option can be useful for excluding labels.
The first lIgnoreCols columns of input will be ignored. This option can be useful for excluding labels.
If any error occurs, a description will be put into xloError. It can then conveniently be returned as the result of the add-in function.
A matrix of the deprecated class matrix<T>, containing items of type T, whose contents will be replaced by the contents of the CXlOper.
Types supported are the same as for mat1.
A matrix of double, whose contents will be replaced by the contents of the CXlOper.
The function returns TRUE if the conversion was successful, FALSE if it failed for any reason.
If it fails, an explanatory error string will be written to strError or xloError. This should be returned to the user.
This function extracts a rectangular range of numbers or strings from an array argument. Using the default flag values, it is reasonably 'smart': by default it truncates any empty cells at the end (right or bottom) of the input range.
However, a wide variety of other options are available, if you use other flag values and optional arguments. See matrix & vector flags for a full list of flag values.
See Bounded input arrays for more information on the use of upper bounds.
Note: |
---|
This method is deprecated. Use XlReadMatrix instead. |
If the CXlOper contains a reference to a range of cells, rather than the values of the cells, then this function will fail, and will return a message stating that the argument must be coerced before use.
You should write code to Coerce the input to a value, e.g.:
extern "C" __declspec( dllexport ) LPXLOPER ReadXlOper(const CXlOper* Arg1) { CXlOper xloResult; //}}XLP_SRC CXlOper valArg1; if (valArg1.Coerce(*Arg1) != 0) return CXlOper::RetError(xlerrValue); ple::mtx_ptrs<bool> matB; if (!valArg1.ReadMatrix(matB, "Arg1", strError)) return CXlOper::RetString(strError); ... }
Header: xllplus.h
CXlOper Class | CXlOper Methods | Bounded input arrays | CXlOper::ReadVector()