(v13) getPageHeaderJobName

This page applies to Harlequin v13.1r0 and later; and to Harlequin MultiRIP but not Harlequin Core

getPageHeaderJobName Function

.

    uint32 getPageHeaderJobName(
      PlgFwStrRecord * prJobName,
      pageHeader * pPageHeader,
      int32 fPreferUTF8Name
      );

Retrieves the job name from the page header and writes it into prJobName . The UTF8 form of the job name will be retrieved if the fPreferUTF8Name flag is set and the page header's jobNameUTF8 field is populated; otherwise, the standard job name will be retrieved.

The return value of the function is the number of bytes in the retrieved job name.

Note: The plugin must have bound the PFI functions PlgFwStrNPutUTF8 , PlgFwStrCountBytes and PlgFwStrPutTextString for the job name to be returned successfully.