KeyView 24.1

# UserCB()

This callback function is triggered by including the `$USERCB` token in a member of `KVHTMLTemplateEx`. For example, placing `"$USERCB=my_callback "` in `pszFirstH1Start` results in a callback at the point when `pszFirstH1Start` is processed. The user callback function is identified by the text assigned to `$USERCB`, which in this example is `my_callback`. This identifier is passed to the argument `pszUserCBid`.

## Syntax

    BOOL (pascal *UserCB) (
        void              *pCallingContext,
        char              *pszUserCBid,
        KVOutputStream    *pNewOutput
        void              *pReserved);

## Arguments

`pCallingContext` | A pointer that gets passed back to the caller-provided callback function. This pointer, which can be `NULL`, is specified as the second parameter of the call to `fpConvertStream()`.
`pszUserCBid` | A pointer to a string that identifies the source of the callback. The identifier must be delimited by a trailing white space. For example, `"my_callback "`.
`pNewOutput` | A pointer to a `KVOutputStream` structure that can be used to write data to the current block.
pReserved | Reserved for future use.

## Returns

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

Copyright 1997-2023 Open Text
Version 24.1 | Last updated December 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL KeyView 24.1

Topic Title: UserCB()