.. highlightlang:: us

.. index:: DocSetLoadCallback

.. _docsetloadcallback:

DocSetLoadCallback
==================

.. us.tag DocSetLoadCallback NOTREADYENGLISH DocSet New5200

:ref:`DocSetLoadCallback` sets a callback function. The callback function will
be invoked before a document page is loaded.

.. function:: bool = DocSetLoadCallback(hDoc, ssLoadCallback)

.. us.return

**Return Value**

Is TRUE (1), if the function was successful and otherwise FALSE (0).

.. us.params

**Parameters**

.. uparam:: hDoc

   Identifies the document.

.. uparam:: ssLoadCallback

   *ssLoadCallback* is a string with the callback function name. The function
   must have three parameters::

     def callback_func(hPage, nPage, userDataObj)
     {
         return bRet;
     }

.. us.example

**Example**

.. include:: ../include/test_DocSetLoadCallback.ic

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - 5.20
     - New.

.. seealso::
   :ref:`Overview-Documents`,
   :ref:`DocGetLoadCallback`

:sub:`id-1552682`