DocumentLibrary.loadDocumentTemplate Method

Module: DocumentLibrary

Definition

Loads the specified document template from a file.

Python

@staticmethod
load_document_template(path: str) -> None

Parameters

path str

in A string that contains the full path to the document template.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

static void loadDocumentTemplate(String? path)

Parameters

path String

in A string that contains the full path to the document template.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C#

public static void LoadDocumentTemplate(string path)

Parameters

path string

in A string that contains the full path to the document template.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

public static void loadDocumentTemplate(String path) throws DocumentException

Parameters

path String

in A string that contains the full path to the document template.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

public static func loadDocumentTemplate(path: String) throws

Parameters

path String

in A string that contains the full path to the document template.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C

int id3DocumentLibrary_LoadDocumentTemplate (
    const char * path)

Parameters

path const char *

in A string that contains the full path to the document template.

Returns

int

An error code.

See id3DocumentError file for the list of possible error codes.