DashboardLoaderLoadFromFileDataLocation Method |
|
DataPA OpenAnalytics API Reference
Function to return a saved ManagedDashboard object from an OS file based on a data location.
Namespace: DataPAEnterpriseDashboardAssembly: DataPAEnterpriseDashboard (in DataPAEnterpriseDashboard.dll) Version: 1.0.90.0 (1.0.90.0)
Syntax public ManagedDashboard LoadFromFileDataLocation(
string FileName,
string DataLocation,
ref string ErrMessage = "",
SessionManagerDataFileFormatEnum DataFileformat = SessionManagerDataFileFormatEnum.dat,
bool Silent = false
)
Public Function LoadFromFileDataLocation (
FileName As String,
DataLocation As String,
Optional ByRef ErrMessage As String = "",
Optional DataFileformat As SessionManagerDataFileFormatEnum = SessionManagerDataFileFormatEnum.dat,
Optional Silent As Boolean = false
) As ManagedDashboard
public:
virtual ManagedDashboard^ LoadFromFileDataLocation(
String^ FileName,
String^ DataLocation,
String^% ErrMessage = L"",
SessionManagerDataFileFormatEnum DataFileformat = SessionManagerDataFileFormatEnum::dat,
bool Silent = false
) sealed
function LoadFromFileDataLocation(FileName, DataLocation, ErrMessage, DataFileformat, Silent);
Parameters
- FileName
- Type: SystemString
The fully qualified filename of the saved ManagedDashboard. - DataLocation
- Type: SystemString
The data location to be used to open this dashboard. - ErrMessage (Optional)
- Type: SystemString
Any returned error message. - DataFileformat (Optional)
- Type: DataPAClientConfigSessionManagerDataFileFormatEnum
- Silent (Optional)
- Type: SystemBoolean
A flag to specify whether this function should be executed silently.
Return Value
Type:
ManagedDashboardThe a saved ManagedDashboard object.
Remarks See Also