Overview

objecthandler utilities.

Function List

ohBoostVersion ()
ohFilter ()
ohFunctionCount ()
ohPack ()
ohRangeRetrieveError ()
ohRemoveInvalidColumns ()
ohRemoveInvalidRows ()
ohStack ()
ohStringConcatenate ()
ohStringSplit ()
ohTrigger ()
ohVbaError ()
ohVersion ()

Function Documentation

ohBoostVersion

string returnValue
 
ohBoostVersion(
        any Trigger)

Description:

returns the version number of Boost.

Supported Platforms:

Excel

Parameters

Trigger dependency tracking trigger

ohFilter

vector<any> returnValue
 
ohFilter(
        vector<any> Input
        vector<bool> Flags)

Description:

Filters the first vector using the second one as boolean inclusion flags.

Supported Platforms:

Excel

Parameters

Input	vector to be filtered.
Flags	vector to inclusion flags.

ohFunctionCount

long returnValue
 
ohFunctionCount(
        any Trigger)

Description:

returns the number of functions in this addin.

Supported Platforms:

Excel

Parameters

Trigger dependency tracking trigger

ohPack

vector<vector<any> > returnValue
 
ohPack(
        vector<vector<any> > InputRange
        any Trigger)

Description:

trim error/null/empty values from bottom/right of matrix/vector.

Supported Platforms:

Excel

Parameters

InputRange	scalar/vector/matrix of values to be packed.
Trigger	dependency tracking trigger

ohRangeRetrieveError

reference returnValue
 
ohRangeRetrieveError(
        reference Range)

Description:

Retrieve the error message if any that is associated with the given range.

Supported Platforms:

Excel

Parameters

Range range to query.

ohRemoveInvalidColumns

vector<vector<any> > returnValue
 
ohRemoveInvalidColumns(
        vector<vector<any> > InputRange
        any Trigger)

Description:

trim error/null/empty columns from matrix/vector.

Supported Platforms:

Excel

Parameters

InputRange	scalar/vector/matrix of values to be packed.
Trigger	dependency tracking trigger

ohRemoveInvalidRows

vector<vector<any> > returnValue
 
ohRemoveInvalidRows(
        vector<vector<any> > InputRange
        any Trigger)

Description:

trim error/null/empty rows from matrix/vector.

Supported Platforms:

Excel

Parameters

InputRange	scalar/vector/matrix of values to be packed.
Trigger	dependency tracking trigger

ohStack

long returnValue
 
ohStack(
        any Trigger)

Description:

Returns the amount of stack space left available to the XLL. This function returns the number 65535 when the stack size exceeds 64K.

Supported Platforms:

Excel

Parameters

Trigger dependency tracking trigger

ohStringConcatenate

string returnValue
 
ohStringConcatenate(
        vector<string> Substrings
        string Delimiter)

Description:

Concatenate substrings into a single string using the given delimiter.

Supported Platforms:

Excel

Parameters

Substrings	string to be parsed.
Delimiter	delimiter string.

ohStringSplit

vector<string> returnValue
 
ohStringSplit(
        string String
        string Delimiters
        bool ConcatenateDelim)

Description:

Split a string into substrings using the given delimiter.

Supported Platforms:

Excel

Parameters

String	string to be parsed.
Delimiters	delimiter characters.
ConcatenateDelim	specifies if multiple adjacent delimiters are to be considered as one (TRUE) or not (FALSE). Default value = false.

ohTrigger

long returnValue
 
ohTrigger(
        any Dummy0
        any Dummy1
        any Dummy2
        any Dummy3
        any Dummy4
        any Dummy5
        any Dummy6
        any Dummy7
        any Dummy8
        any Dummy9
        any Dummy10
        any Dummy11
        any Dummy12
        any Dummy13)

Description:

forces a dependency between multiple ranges and returns the update counter.

Supported Platforms:

Excel

Parameters

Dummy0	dummy range reference (ignored).
Dummy1	dummy range reference (ignored).
Dummy2	dummy range reference (ignored).
Dummy3	dummy range reference (ignored).
Dummy4	dummy range reference (ignored).
Dummy5	dummy range reference (ignored).
Dummy6	dummy range reference (ignored).
Dummy7	dummy range reference (ignored).
Dummy8	dummy range reference (ignored).
Dummy9	dummy range reference (ignored).
Dummy10	dummy range reference (ignored).
Dummy11	dummy range reference (ignored).
Dummy12	dummy range reference (ignored).
Dummy13	dummy range reference (ignored).

ohVbaError

string returnValue
 
ohVbaError(
        any Trigger)

Description:

Retrieve error message associated with VBA code.

Supported Platforms:

Excel

Parameters

Trigger dependency tracking trigger

ohVersion

string returnValue
 
ohVersion(
        any Trigger)

Description:

returns the version number of ObjectHandler.

Supported Platforms:

Excel, C++

Parameters

Trigger dependency tracking trigger