DocumentLicense.getLicenseName Method

Module: DocumentLicense

Definition

Retrieves the license name.

Python

@staticmethod
get_license_name() -> str

Returns

str

The license name.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

static String getLicenseName()

Returns

String

The license name.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C#

public static string GetLicenseName()

Returns

string

The license name.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

public static String getLicenseName() throws DocumentException

Returns

String

The license name.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

public static func getLicenseName() throws -> String

Returns

String

The license name.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C

int id3DocumentLicense_GetLicenseName (
    char * licenseName,
    int * licenseNameSize)

Parameters

licenseName char *

out The license name.

licenseNameSize int *

in Size of the ‘licenseName’ buffer. Receives the minimum required buffer size to hold the ‘licenseName’ string if the given one is too small (including the terminating NULL character), otherwise receives the number of characters in ‘licenseName’ (excluding terminating NULL character).

Returns

int

An error code.

See id3DocumentError file for the list of possible error codes.