HypSubmitSelectedRangeWithoutRefresh

Cloud data provider types: Oracle Analytics Cloud - Essbase

On-premises data provider types: Oracle Essbase

Description

HypSubmitSelectedRangeWithoutRefresh() updates the database with data, as is, from the selected data range; it ignores cells outside the selected range and does not overwrite (or refresh) them. The selected range does not automatically get refreshed after submit; the user must manually refresh the grid to retrieve the updated data. For a successful submit, the user must select a range which constitutes a valid grid. Some of the behaviors can be controlled with the parameters noted below.

Note:

The ability to update the database depends on the access permissions of the submitter. To update data, you must have at least Write access to the database.
For the HypSubmitSelectedRangeWithoutRefresh function to work, the sheet must already be connected to a data source, and a valid range selection must be made before calling the function.
For a regular submit, Oracle recommends using the HypSubmitData function.

Syntax

HypSubmitSelectedRangeWithoutRefresh(vtSheetName)

ByVal vtSheetName As Variant

ByVal vtSubmitBlankCellsAsMissing As Variant

ByVal vtRefreshGridAfterSubmit As Variant

ByVal vtUseWholeSheet As Variant

Parameters

vtSheetName: The name of worksheet on which to run the function. If vtSheetName is Null or Empty, the active worksheet is used.

vtSubmitBlankCellsAsMissing: Unused. Should be set to False until the supported version of Oracle Hyperion Provider Services is available. If set to True results in an "Unsupported Provider Services " error.

vtRefreshGridAfterSubmit: If set to True, displays the selected grid result after a submit; if there is no submit operation, then sheet is not updated. If set to False, then submits only, and does not refresh the selected contents.

vtUseWholeSheet: Ignored in multiple-grid sheet. For single ad hoc grid sheet, if set to True, the whole sheet content is used. If set to False, uses the selected range as grid range.

Return Value

Returns 0 if the selected cells are submitted successfully; otherwise, returns the appropriate error code.

Example

Public Declare PtrSafe Function HypSubmitSelectedRangeWithoutRefresh Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtSubmitBlankCellsAsMissing As Variant, ByVal vtRefreshGridAfterSubmit As Variant, ByVal vtUseWholeSheet) As Long

Sub SubmitFreeform()
   sts = HypSubmitSelectedRangeWithoutRefresh("Sheet1", False, True, True) 
    'submits the whole grid in the sheet and refreshes the grid with result
   sts = HypSubmitSelectedRangeWithoutRefresh("Sheet1", False, False, False) 
    'submits only the selected grid range and no refresh is performed, 
    'so the sheet content is left as is
End Sub