getPageHeaderJobNameEx

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

getPageHeaderJobNameEx Function

.

TEXT

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

Retrieves the job name from the page header and writes it into prJobName , optionally stripping out the part of the job name added by the RIP which specifies the page number.

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 page number prefix will be stripped out of the returned job name if the omitPageNumber flag is set. The job name in the page header is unaffected.

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 PlgFwStrRecordAlloc , PlgFwStrRecordOpen , PlgFwStrRecordAbandon , PlgFwStrRecordFree , PlgFwStrRecordGetBuffer , PlgFwStrGetTextCharacter , PlgFwStrNPutUTF8 , PlgFwStrCountBytes and PlgFwStrPutTextString for the job name to be returned successfully.

Note: To remove the separation name from the job, call this routine and then call getJobNameOnly on the result.