.. index:: 
  !DocumentLicense.getProductReference Method
  
.. _id3_document_document_license_get_product_reference_class_method:

===============================================================================
DocumentLicense.getProductReference Method
===============================================================================

Module: :ref:`DocumentLicense<id3_document_document_license_class>`

Definition
----------

Retrieves the license product reference.


.. tab-set::

    .. tab-item:: Python
      :sync: Python

      .. code:: Python

        @staticmethod
        get_product_reference() -> str

      **Returns**

        .. line-block::

          ``str``
          The product reference.

      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: Dart
      :sync: Dart

      .. code:: Dart

        static String getProductReference()

      **Returns**

        .. line-block::

          ``String``
          The product reference.

      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: C#
      :sync: C#

      .. code:: C#

        public static string GetProductReference()

      **Returns**

        .. line-block::

          ``string``
          The product reference.

      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: Java
      :sync: Java

      .. code:: Java

        public static String getProductReference() throws DocumentException

      **Returns**

        .. line-block::

          ``String``
          The product reference.

      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: Swift
      :sync: Swift

      .. code:: Swift

        public static func getProductReference() throws -> String

      **Returns**

        .. line-block::

          ``String``
          The product reference.

      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: C
      :sync: C

      .. code:: C

        int id3DocumentLicense_GetProductReference (
            char * productReference, 
            int * productReferenceSize)

      **Parameters**

        .. line-block::

          ``productReference`` char *
          :guilabel:`out` The product reference.

          ``productReferenceSize`` int *
          :guilabel:`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**

        .. line-block::

          ``int``
          An error code.
          See :ref:`id3DocumentError<id3_document_document_error_enum>` file for the list of possible error codes.


