IAFS_FileSys::GetVolumeSpace 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_FileSys::GetVolumeSpace Method}}
 
{{#customTitle:IAFS_FileSys::GetVolumeSpace Method}}
{{#parentPage:PXV:IAFS_FileSys|method}}
+
{{#parentPage:PXV:IAFS_FileSys|GetVolumeSpace Method|method}}
 
{{ToWrite}}
 
{{ToWrite}}
 
{{ToReview}}
 
{{ToReview}}
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetVolumeSpace([in] IAFS_Name* pName, [out] LONGLONG* pTotalBytes, [out] LONGLONG* pTotalFreeBytes, [out] LONGLONG* pFreeBytesAvailable, [in, defaultvalue(NULL)] IString* pErrDetails, [in, defaultvalue(NULL)] IFlag* pCancelFlag);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetVolumeSpace([in]                     IAFS_Name* pName,
 +
                      [out]                     LONGLONG*   pTotalBytes,
 +
                      [out]                     LONGLONG*   pTotalFreeBytes,
 +
                      [out]                     LONGLONG*   pFreeBytesAvailable,
 +
                      [in, defaultvalue(NULL)] IString*   pErrDetails,
 +
                      [in, defaultvalue(NULL)] IFlag*     pCancelFlag);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pName''
+
;pName
 
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
 
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
;''pTotalBytes''
+
;pTotalBytes
 
:[out]  Pointer to LONGLONG.
 
:[out]  Pointer to LONGLONG.
;''pTotalFreeBytes''
+
;pTotalFreeBytes
 
:[out]  Pointer to LONGLONG.
 
:[out]  Pointer to LONGLONG.
;''pFreeBytesAvailable''
+
;pFreeBytesAvailable
 
:[out]  Pointer to LONGLONG.
 
:[out]  Pointer to LONGLONG.
;''pErrDetails''
+
;pErrDetails
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IString|IString]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IString|IString]].
;''pCancelFlag''
+
;pCancelFlag
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IFlag|IFlag]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IFlag|IFlag]].
  

Revision as of 05:46, 23 April 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT GetVolumeSpace([in]                      IAFS_Name*  pName,
                       [out]                     LONGLONG*   pTotalBytes,
                       [out]                     LONGLONG*   pTotalFreeBytes,
                       [out]                     LONGLONG*   pFreeBytesAvailable,
                       [in, defaultvalue(NULL)]  IString*    pErrDetails,
                       [in, defaultvalue(NULL)]  IFlag*      pCancelFlag);

Parameters

pName
[in] Pointer to IAFS_Name.
pTotalBytes
[out] Pointer to LONGLONG.
pTotalFreeBytes
[out] Pointer to LONGLONG.
pFreeBytesAvailable
[out] Pointer to LONGLONG.
pErrDetails
[in, defaultvalue(NULL)] Pointer to IString.
pCancelFlag
[in, defaultvalue(NULL)] Pointer to IFlag.

Return Value

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

See Also

See also IAFS_FileSys.