CAEXDocumentLoadFromFileAsync Method

Create a CAEX document with content, loaded asynchronously from a file. The schema version of the CAEX document is set accordingly to the SchemaVersion-Attribute of the CAEXFile object.

Namespace: Aml.Engine.CAEX
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2

Syntax

C++

Copy

public static Task<CAEXDocument> LoadFromFileAsync(
	string filePath,
	CancellationToken cancellationToken = default,
	bool createIndices = false
)

Public Shared Function LoadFromFileAsync ( 
	filePath As String,
	Optional cancellationToken As CancellationToken = Nothing,
	Optional createIndices As Boolean = false
) As Task(Of CAEXDocument)

public:
static Task<CAEXDocument^>^ LoadFromFileAsync(
	String^ filePath, 
	CancellationToken cancellationToken = CancellationToken(), 
	bool createIndices = false
)

Parameters

filePath String: The file path.
cancellationToken CancellationToken (Optional): The cancellation token
createIndices Boolean (Optional): if set to true, indices for fast access are loaded for the default QueryService. Please note, that this option is only recommended to be set for read only documents, because the indices will not be updated when a document is changed. For editable documents the LookupService should be used.

Return Value

TaskCAEXDocument
The created CAEX document.

Exceptions

Exception	Condition
FileNotFoundException	filePath

Reference

CAEXDocument Class

Aml.Engine.CAEX Namespace