Open topic with navigation

# UserCB()

This callback function is triggered by including the `$USERCB` token in a member of `KV` `HTML` `Template` `Ex`. 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

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

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

© 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