SAPGetProperty
You can use this API method to read properties of a data source or a workbook. The command returns a Boolean value: True or False.
To call the method, use Application.Run and specify the following input parameters:
- Property Name
Enter one of the following properties:
- IsDataSourceActive to check whether a data source is active.
- IsDataSourceEditable to check whether the data source is input-ready.
- HasChangedPlanData to check whether the workbook contains changed planning data.
- IsAutoRefresh to check whether the automatic refresh is active or paused on workbook level or for the specified data source.
- IsConnected to check whether a data source is already connected.
- LastError to get information on an error that occurred while executing Analysis API methods and functions.
- ChangedCrosstabs to get the crosstabs that have been changed in the last round trip with callback AfterRedisplay.
- ChangedDatasources to get the data sources that have been changed in the last round trip with callback AfterRedisplay.
- Data Source Alias
Enter the formula alias for the data source. You can set the alias when configuring the data source on the Components tab in the design panel. This parameter is optional.
If you use the HasChangedPlanData or LastError property, you should not enter a data source alias, as this property is not related to a specific data source but to the complete workbook.
Example
Dim lResult As Variant
lResult= Application.Run("SAPGetProperty", "IsDataSourceEditable", "DS_1")
If you execute the command, it returns the Boolean value. If the data source DS_1 is editable, the value is True.
Example
Iret = Application.Run("SAPGetProperty", "IsConnected", "DS_1")
If you execute the command, it returns the Boolean value. If the data source DS_1 is connected, the value is True.