FCACHE_RICHCREATE_CALLBACK callback function (filehc.h)

A callback function that is used to create items in the cache. It is called by CacheRichCreateFile.

Syntax

FCACHE_RICHCREATE_CALLBACK FcacheRichcreateCallback;

HANDLE FcacheRichcreateCallback(
  [in]  LPSTR lpstrName,
  [in]  LPVOID lpvData,
  [out] DWORD *cbFileSize,
  [out] DWORD *cbFileSizeHigh,
  [out] BOOL *pfDidWeScanIt,
  [out] BOOL *pfIsStuffed,
  [out] BOOL *pfStoredWithDots,
  [out] BOOL *pfStoredWithTerminatingDot
)
{...}

Parameters

[in] lpstrName

The name of the file.

[in] lpvData

User-provided data to CacheRichCreateFile.

[out] cbFileSize

The size of the low DWORD.

[out] cbFileSizeHigh

The size of the high DWORD.

[out] pfDidWeScanIt

Set to TRUE if the file has been scanned; otherwise, it is set to FALSE.

[out] pfIsStuffed

Set to TRUE if the file is dot stuffed; otherwise, it is set to FALSE.

[out] pfStoredWithDots

If set to TRUE, this parameter indicates that any dots that appear at the beginning of a line are stored with an extra dot as required in NNTP, SMTP, and POP3 protocols. If this is FALSE, the message is stored without dot stuffing.

[out] pfStoredWithTerminatingDot

If set to TRUE, the file has been stored with a terminating dot; otherwise, it is FALSE.

Return value

Returns a handle to the file that was created in the cache.

Requirements

Requirement	Value
Target Platform	Windows
Header	filehc.h

See also

CacheRichCreateFile