fpGetAnchor()

This function gets the file name automatically generated by Export and used for external graphics referenced with <a xmlns:xlink= xlink href=> tags and for heading-level table of contents entries.

Syntax

BOOL pascal fpGetAnchor( 
    void                 *pCallingContext,
    KVHTMLAnchorTypeEx    eAnchorTypeEx,
    KVXMLAnchorType       eAnchorType,
    char                 *pszAnchor,
    int                   cbAnchorMax,
    BYTE                 *pcHTML, 
    UINT                  cbHTML);

Arguments

pCallingContext

A pointer passed back to the callback functions.

eAnchorTypeEx

The graphic or block anchor type for the output stream. It must be one of the enumerated types defined in KVXMLAnchorType.

pszAnchor

A pointer to the location in which the new anchor is stored.

cbAnchorMax

The maximum number of bytes to place in pszAnchor.

pcHTML

A pointer to either the markup defining the contents of the table of contents entry, a pointer to the external graphic name, or NULL.

cbHTML

The number of valid bytes in pcHTML.

Returns

  • If the call is successful, the return value is TRUE.

  • If this call is unsuccessful, the return value is FALSE. Processing is halted.

Discussion

  • pszAnchor must be assigned. It might be derived from the cbAnchorMax, pcHTML, and cbHTML values that are also provided.

  • pcHTML can be NULL if the graphic is an internal part of the document.

  • This function is exposed so that it can be called from the GetAnchor() callback function to obtain default behavior for anchor types the callback is not set to handle.