IAFS_FileCachesMap::CreateNewCache Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 1: Line 1:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IAFS_FileCachesMap::CreateNewCache Method}}
 
{{#customTitle:IAFS_FileCachesMap::CreateNewCache Method}}
{{#parentPage:PXV:IAFS_FileCachesMap|method}}
+
{{#parentPage:PXV:IAFS_FileCachesMap|CreateNewCache Method|method}}
 
{{ToWrite}}
 
{{ToWrite}}
 
{{ToReview}}
 
{{ToReview}}
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT CreateNewCache([in] IAFS_File* pFile, [in] IAFS_FileCacheCallbacks* pCb, [in] LONG nCacheFlags, [in] LONGLONG nFileSize, [in] VARIANT_BOOL bNewFile, [in, defaultvalue(0)] LONG nReadBufferSize, [in, defaultvalue(0)] LONG nWriteBufferSize, [out, retval] IAFS_FileCache** ppCache);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT CreateNewCache([in]                   IAFS_File*               pFile,
 +
                      [in]                   IAFS_FileCacheCallbacks* pCb,
 +
                      [in]                   LONG                     nCacheFlags,
 +
                      [in]                   LONGLONG                 nFileSize,
 +
                      [in]                   VARIANT_BOOL             bNewFile,
 +
                      [in, defaultvalue(0)] LONG                     nReadBufferSize,
 +
                      [in, defaultvalue(0)] LONG                     nWriteBufferSize,
 +
                      [out, retval]         IAFS_FileCache**         ppCache);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pFile''
+
;pFile
 
:[in]  Pointer to [[PXV:IAFS_File|IAFS_File]].
 
:[in]  Pointer to [[PXV:IAFS_File|IAFS_File]].
;''pCb''
+
;pCb
 
:[in]  Pointer to [[PXV:IAFS_FileCacheCallbacks|IAFS_FileCacheCallbacks]].
 
:[in]  Pointer to [[PXV:IAFS_FileCacheCallbacks|IAFS_FileCacheCallbacks]].
;''nCacheFlags''
+
;nCacheFlags
 
:[in]  Value of LONG.
 
:[in]  Value of LONG.
;''nFileSize''
+
;nFileSize
 
:[in]  Value of LONGLONG.
 
:[in]  Value of LONGLONG.
;''bNewFile''
+
;bNewFile
 
:[in]  Value of VARIANT_BOOL.
 
:[in]  Value of VARIANT_BOOL.
;''nReadBufferSize''
+
;nReadBufferSize
 
:[in, defaultvalue(0)]  Value of LONG.
 
:[in, defaultvalue(0)]  Value of LONG.
;''nWriteBufferSize''
+
;nWriteBufferSize
 
:[in, defaultvalue(0)]  Value of LONG.
 
:[in, defaultvalue(0)]  Value of LONG.
;''ppCache''
+
;ppCache
 
:[out, retval]  Pointer to [[PXV:IAFS_FileCache|IAFS_FileCache]].
 
:[out, retval]  Pointer to [[PXV:IAFS_FileCache|IAFS_FileCache]].
  

Revision as of 05:45, 23 April 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT CreateNewCache([in]                   IAFS_File*                pFile,
                       [in]                   IAFS_FileCacheCallbacks*  pCb,
                       [in]                   LONG                      nCacheFlags,
                       [in]                   LONGLONG                  nFileSize,
                       [in]                   VARIANT_BOOL              bNewFile,
                       [in, defaultvalue(0)]  LONG                      nReadBufferSize,
                       [in, defaultvalue(0)]  LONG                      nWriteBufferSize,
                       [out, retval]          IAFS_FileCache**          ppCache);

Parameters

pFile
[in] Pointer to IAFS_File.
pCb
[in] Pointer to IAFS_FileCacheCallbacks.
nCacheFlags
[in] Value of LONG.
nFileSize
[in] Value of LONGLONG.
bNewFile
[in] Value of VARIANT_BOOL.
nReadBufferSize
[in, defaultvalue(0)] Value of LONG.
nWriteBufferSize
[in, defaultvalue(0)] Value of LONG.
ppCache
[out, retval] Pointer to IAFS_FileCache.

Return Value

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

See Also

See also IAFS_FileCachesMap.