IAFS_FileCachesMap::CreateCacheOnLocalFile Method

File Systems Layer > Interfaces > IAFS_FileCachesMap > IAFS_FileCachesMap::CreateCacheOnLocalFile Method

The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT CreateCacheOnLocalFile([in]                   IAFS_Name*                pRemoteFileName,
                               [in]                   LONG                      nRemoteFileIoFlags,
                               [in]                   IAFS_FileCacheCallbacks*  pCb,
                               [in]                   LONG                      nCacheFlags,
                               [in]                   LPWSTR                    sLocalFileName,
                               [in, defaultvalue(0)]  LONG                      nReadBufferSize,
                               [in, defaultvalue(0)]  LONG                      nWriteBufferSize,
                               [in, defaultvalue(0)]  VARIANT_BOOL              bDeleteOnClose,
                               [out, retval]          IAFS_FileCache**          pRes);

Parameters

pRemoteFileName

[in] Pointer to IAFS_Name.

nRemoteFileIoFlags

[in] Value of LONG.

pCb

[in] Pointer to IAFS_FileCacheCallbacks.

nCacheFlags

[in] Value of LONG.

sLocalFileName

[in] Value of LPWSTR.

nReadBufferSize

[in, defaultvalue(0)] Value of LONG.

nWriteBufferSize

[in, defaultvalue(0)] Value of LONG.

bDeleteOnClose

[in, defaultvalue(0)] Value of VARIANT_BOOL.

pRes

[out, retval] Pointer to IAFS_FileCache.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IAFS_FileCachesMap