DocumentLicense.getLicenseComment Method

Module: DocumentLicense

Definition

Retrieves the license comment.

Python

@staticmethod
get_license_comment() -> str

Returns

str

The license comment.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

static String getLicenseComment()

Returns

String

The license comment.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C#

public static string GetLicenseComment()

Returns

string

The license comment.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

public static String getLicenseComment() throws DocumentException

Returns

String

The license comment.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

public static func getLicenseComment() throws -> String

Returns

String

The license comment.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C

int id3DocumentLicense_GetLicenseComment (
    char * licenseComment,
    int * licenseCommentSize)

Parameters

licenseComment char *

out The license comment.

licenseCommentSize int *

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

Returns

int

An error code.

See id3DocumentError file for the list of possible error codes.