Method IncludeWithOptions
IncludeWithOptions(int, List<KeyValue>, string, DocumentId, out List<string>, out List<DocumentId>)
Imports a file with conversion into an existing document using specified options.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 8, 0, 0)]
List<DocumentId> IncludeWithOptions(int inImporterIx, List<KeyValue> inOptions, string inFullName, DocumentId inDocumentId, out List<string> outLog, out List<DocumentId> outBadDocumentIds)Parameters
| Type | Name | Description |
|---|---|---|
| int | inImporterIx | Index of importer to use, within [0, ImporterCount-1]. |
| List<KeyValue> | inOptions | Importer options to use. |
| string | inFullName | Full name of the file to import. |
| DocumentId | inDocumentId | Document where data are to be stored. |
| List<string> | outLog | List of string describing the result. |
| List<DocumentId> | outBadDocumentIds | Identifiers of documents containing bad geometry. |
Returns
| Type | Description |
|---|---|
| List<DocumentId> | Imported documents, including the specified document. |
Remarks
StartModification(string, bool) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.8.