OpenWbk

Syntax

OpenWbkResult OpenWbk(OdId tOb, OpenWbkArg tArg)

Parameters

tOb. Moniker of a repository object that is a workbook.

tArg. Operation execution parameters.

Description

The OpenWbk operation opens a workbook and gets context for working with this workbook.

Comments

To execute the operation, in the tOb field specify moniker of the object that is a workbook, and in the tArg field specify opening parameters. The tArg field can contain the following information: workbook opening mode (view or edit), values of the parameters to be sent to parametric data sources, and parameters for extracting and changing data or metadata. Parameters of data or metadata extraction are specified in the tArg.metaGet or tArg.metaGetActiveSheet field. Parameters for changing data or metadata are specified in the tArg.metaSet field. The result of the operation is the moniker of opened workbook instance, and the metadata if a corresponding pattern was defined on executing the operation. To further work with an opened workbook, use the GetWbkMd and SetWbkMd operations. Use the CloseWbk operation to close an opened workbook instance.

To work with a workbook table, use the GetTabSheetData and SetTabSheetData operations, to work with a workbook chart, use the GetChart and SetChart operations.

Example

Various methods of using this operation are given in the following examples:

Example name
Opening Workbook for Read
Opening Workbook and Changing Data Display Period

See also:

Working with Time Series Database