(v13) getUTF8PathFromSWPath

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

getUTF8PathFromSWPath Function

.

TEXT

    void getUTF8PathFromSWPath(
      PlgFwTextByte* pUTF8Path,
      int blen,
      PlgFwTextString ptbzFwPath,
      int32 fIsDirectory
      );

Given a Harlequin‐encoded file system path name, this function will convert it to a UTF8‐encoded string in a form suitable for the underlying OS.

The parameter pUTF8Path should point to an open PFI string record which will receive the path. The length of the record, in bytes, is indicated by the parameter blen .

The two remaining parameters specify the input to the function: ptbzFwPath contains the Framework‐ encoded string to convert, and the flag fIsDirectory informs the function whether or not the string represents a directory.

Note: The string ptbzFwPath must be a syntactically valid absolute pathname. A filename on its own is not a valid argument. To translate filenames, call PFI function PlgFwStrToUTF8Buffer (or one of its siblings).

Note: The plugin must have bound the PFI function PlgFwStrToUTF8Buffer for the name to be returned successfully.