QS.HELP¶
Spills a worksheet function’s description and parameter guidance
Category: QuantSupport - System.
- QS.HELP(function_name: text, transpose: logical or blank, headers: logical or blank) spilled range¶
- Parameters:
function_name (text) – Registered worksheet name, for example QS.CURVE.GET or QS.TRADE.SWAP
transpose (logical or blank) – Optional TRUE transposes the entire spill; omitted or blank defaults to FALSE; table headers move with their fields
headers (logical or blank) – Optional TRUE includes table headers (default); FALSE removes the first header row before transposing; omitted or blank defaults to TRUE
- Returns:
Two-column help spill of labels and values: Function, Category, Description, optional Aliases, then Parameter/Guidance and argument rows. Names and aliases are matched case-insensitively. headers=FALSE omits Parameter/Guidance while retaining the function metadata; transpose=TRUE exchanges rows and columns. headers=FALSE removes the header row before transposing; omitted headers defaults to TRUE. transpose=TRUE exchanges rows and columns; omitted transpose defaults to FALSE. Empty output returns a blank cell.
- Return Type:
spilled range
- Errors:
#VALUE! if the requested name or alias is not registered. Invalid transpose/headers flags return #VALUE!; use TRUE/FALSE or leave optional flags blank.
Formula¶
=QS.HELP(function_name, transpose, headers)
Calculation¶
Runs on Excel’s main calculation thread.
Native Declaration¶
fn qs_help (function_name : & str , transpose : * const xll_rs :: types :: XLOPER12 , headers : * const xll_rs :: types :: XLOPER12 ,) -> Result < * mut xll_rs :: types :: XLOPER12 , XllError >