GetAuxOutput()

This callback function enables the calling application to specify an auxiliary output stream for a block or graphic.

Syntax

BOOL (pascal *GetAuxOutput) (
    void                    *pCallingContext,
    KVXMLAnchorType          eAnchorType,
    char                    *pszAnchor,
    KVOutputStream          *pNewOutput);

Arguments

pCallingContext

A pointer passed back to the caller-provided callback functions. This pointer, which can be NULL, is specified as the second parameter of the call to fpConvertStream().

eAnchorType

A graphic or block anchor as defined by the enumerated types in KVXMLAnchorType.

pszAnchor

KeyView will have set this to the anchor associated with this stream. pszAnchor is based on the call to GetAnchor().

pNewOutput

A pointer to a KVOutputStream structure that can be used to write data to the current block.

Returns

  • To continue the conversion, return TRUE.
  • To terminate the conversion process without completing the conversion, return FALSE.

Discussion

  • If GetAuxOutput() is NULL, the pszDefaultOutputDirectory member of the instance of KVXMLOptions is used as the base storage location for auxiliary output files. If pszDefaultOutputDirectory is also NULL, auxiliary files are placed in the current working directory.

  • This function must fill out the provided stream function by setting an appropriate function for each member. Memory allocated to the I/O structure must be tracked and freed within the call to Close().