HypSubmitSelectedDataCells

Data provider types: Oracle Essbase

Description

HypSubmitSelectedDataCells() allows the selected data cells to be submitted.

Note:

  • For free-form grids, this VBA function allows selected blank cells to be submitted as #Missing.

  • 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 HypSubmitSelectedDataCells 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

HypSubmitSelectedDataCells(vtSheetName)

ByVal vtSheetName As Variant

ByVal vtDataRange as Variant

ByVal vtSubmitBlankCellsAsMissingInFreeFormGrid 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.

vtDataRange: Unused. If vtDataRange is provided, it will be ignored. If this parameter is set to Empty, then the selected cells on the worksheet are submitted.

Currently, you must select data cells manually on the sheet or by using a Visual Basic Range Select macro, and then run the HypSubmitSelectedDataCells() function.

vtSubmitBlankCellsAsMissingInFreeFormGrid: Applies only to free-form grids. When set to "True", any blank cells in the selected range are submitted as #Missing. When set to false, blank cells will revert back to the value that was last stored with the provider.

Return Value

Returns 0 if the selected cells are submitted successfully and HsSetVal functions, if any, were run. Returns 1 if the sheet was not connected but HsSetVal functions, if any, were run. Returns 2 if sheet had no ad hoc grid but HsSetVal functions, if any, were run. Otherwise, returns the appropriate error code.

Example

Sub SubmitRange()
   'Example assumes sheet is already connected and the data 
   'cells to be submitted are already selected
   sts = HypSubmitSelectedDataCells("Sheet1", Empty, True)
End Sub