Open topic with navigation

# 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,
        KVHTMLXMLAnchorTypeEx          eAnchorTypeEx,
        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 `KV` `XML` `AnchorType`.
`pszAnchor` | A pointer to location where a new anchor is stored. `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

- If the call is successful, the return value is `TRUE`.

- If the call is unsuccessful, the return value is `FALSE`. Processing is halted.

## 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.

- For each `pszAnchor` provided, create (`malloc`) an appropriate I/O structure. Assign `pNewOutput->pOutputStreamPrivateData` to point to that structure. Each remaining member of the `KVOutputStream` should then be initialized by assigning a function pointer to the additional application-defined functions, cast to the appropriate function prototype for `Create()`, `Write()`, `Seek()`, `Tell()`, and `Close()`. Memory allocated to the I/O structure must be tracked and can be freed up within the call to `Close()`. See the `callback.c` sample program.

© Copyright 2006-2019 Micro Focus or one of its affiliates | Send documentation feedback Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm