IN_GetFilename

All Editions image\bltlrgsq_shg.gif Related Functions  image\bltlrgsq_shg.gif Example

The IN_GetFilename function returns the file name of the specified document or layer.

Syntax

int IN_GetFilename( objectID, maxSize, pFileName )

Input Parameters

Meaning

IN_OBJECT objectID

identifier of the document or layer to query. See Remarks.

SHORT maxSize

the maximum size of the pFileName array in bytes

Output Parameters

Meaning

CHARPTR pFileName

pointer to the requested file name

Remarks

If the file format of the specified document object is valid, its file name is returned (assuming that the name itself is valid). If the document object is of a different format, the directory location of the document is determined, and its disk file name is returned. If that cannot be found either, IN_ERR_FILENAME_NA is returned.

If objectID is not a layer, then the file name for the whole document is used. You cannot retrieve the file name of a specific page in a multipage document.

Release information

Added to Imagenation for Windows in Release 4.10.

As of Release 5.1, also available in Imagenation for UNIX.

Also supported in Imagenation 3.3 for UNIX.

See also

Setting and requesting file information