DocumentLicense.getProductReference Method

Module: DocumentLicense

Definition

Retrieves the license product reference.

Python

@staticmethod
get_product_reference() -> str

Returns

str

The product reference.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

static String getProductReference()

Returns

String

The product reference.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C#

public static string GetProductReference()

Returns

string

The product reference.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

public static String getProductReference() throws DocumentException

Returns

String

The product reference.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

public static func getProductReference() throws -> String

Returns

String

The product reference.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C

int id3DocumentLicense_GetProductReference (
    char * productReference,
    int * productReferenceSize)

Parameters

productReference char *

out The product reference.

productReferenceSize int *

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

Returns

int

An error code.

See id3DocumentError file for the list of possible error codes.