CAEXDocumentLoadFromStringAsync Method

Asynchronous method to create a CAEX document with content, loaded from a UTF-8 encoded string. 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> LoadFromStringAsync(
	string utf8EncodedString,
	bool createIndices = false
)

Public Shared Function LoadFromStringAsync ( 
	utf8EncodedString As String,
	Optional createIndices As Boolean = false
) As Task(Of CAEXDocument)

public:
static Task<CAEXDocument^>^ LoadFromStringAsync(
	String^ utf8EncodedString, 
	bool createIndices = false
)

Parameters

utf8EncodedString String: The content string.
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 CAEX document.

Exceptions

Exception	Condition
ArgumentNullException	utf8EncodedString

Reference

CAEXDocument Class

Aml.Engine.CAEX Namespace