GetAnchor()
This function should provide the anchor name used for external graphics referenced with
tags, heading-level table of contents entries, and external files (such as CSS files and revision summary files).
The anchor name you provide is passed into GetAuxOutput() to identify the output stream if defined, otherwise it is used as the auxiliary file name.
Syntax
BOOL (pascal *GetAnchor) ( void *pCallingContext, KVHTMLXMLAnchorTypeEx eAnchorTypeEx, char *pszAnchor, int cbAnchorMax, BYTE *pcHTML, UINT cbHTML);
Arguments
|
A pointer that gets passed back to the caller-provided callback functions. This pointer, which can be |
|
The anchor type for the output stream. It must be one of the enumerated types defined in |
|
A pointer to the memory that you should write the new anchor to. |
|
The maximum number of bytes to place in |
|
KeyView will have set this to either
|
|
The number of valid bytes in |
Returns
- To continue the conversion, return
TRUE
. - To terminate the conversion process without completing the conversion, return
FALSE
.
Discussion
-
If this callback is
NULL
, default anchor names are generated. The generated names are unique across the document. -
This function is called once per block, block chunk, graphic anchor, or extra file. Any required code can be executed here as long as a unique value for
pszAnchor
is assigned. If this string is not unique, an existing file might be overwritten, producing undesirable results. The callback function should contain the functionality to verify whether files already exist. -
This function can call the fpGetAnchor() interface function, which returns the default anchor generated by Export. For example, to specify only graphic anchor names, provide an anchor when
eAnchorType
isVectorPictureAnchor
orRasterPictureAnchor
. For all other anchor types, callfpGetAnchor()
with the same parameters you were passed. -
pszAnchor
must be assigned. It can be derived from thecbAnchorMax
,pcHTML
, andcbHTML
values, which are also provided. -
pcHTML
can be null if the graphic is an internal part of the document.