IAFS_FileSys::GetVolumeSpace Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IAFS_FileSys::GetVolumeSpace Method}}
 
{{#customTitle:IAFS_FileSys::GetVolumeSpace Method}}
 +
{{#parentPage:PXV:IAFS_FileSys#Methods|GetVolumeSpace|method}}
 +
{{ToWrite}}
 +
{{ToReview}}
  
 
The method of interface of PDF-XChange Editor SDK.
 
The method of interface of PDF-XChange Editor SDK.
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT GetVolumeSpace([in] IAFS_Name* pName, [out] LONGLONG* pTotalBytes, [out] LONGLONG* pTotalFreeBytes, [out] LONGLONG* pFreeBytesAvailable, [in, optional] IString* pErrDetails, [in, optional] IFlag* pCancelFlag);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetVolumeSpace([in]                     IAFS_Name* pName,
 +
                      [out]                     LONGLONG*   nTotalBytes,
 +
                      [out]                     LONGLONG*   nTotalFreeBytes,
 +
                      [out]                     LONGLONG*   nFreeBytesAvailable,
 +
                      [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''
+
;nTotalBytes
 
:[out]  Pointer to LONGLONG.
 
:[out]  Pointer to LONGLONG.
−
;''pTotalFreeBytes''
+
;nTotalFreeBytes
 
:[out]  Pointer to LONGLONG.
 
:[out]  Pointer to LONGLONG.
−
;''pFreeBytesAvailable''
+
;nFreeBytesAvailable
 
:[out]  Pointer to LONGLONG.
 
:[out]  Pointer to LONGLONG.
−
;''pErrDetails''
+
;pErrDetails
−
:[in, optional]  Pointer to [[PXV:IString|IString]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IString|IString]].
−
;''pCancelFlag''
+
;pCancelFlag
−
:[in, optional]  Pointer to [[PXV:IFlag|IFlag]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IFlag|IFlag]].
  
 
== Return Value ==
 
== Return Value ==
Line 25: Line 34:
  
 
== See Also ==
 
== See Also ==
−
See also [[PXV:IAFS_FileSys|IAFS_FileSys]].
+
[[PXV:IAFS_FileSys|IAFS_FileSys]]

Latest revision as of 02:10, 15 June 2015

File Systems Layer > Interfaces > IAFS_FileSys > IAFS_FileSys::GetVolumeSpace Method


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT GetVolumeSpace([in]                      IAFS_Name*  pName,
                       [out]                     LONGLONG*   nTotalBytes,
                       [out]                     LONGLONG*   nTotalFreeBytes,
                       [out]                     LONGLONG*   nFreeBytesAvailable,
                       [in, defaultvalue(NULL)]  IString*    pErrDetails,
                       [in, defaultvalue(NULL)]  IFlag*      pCancelFlag);

Parameters

pName
[in] Pointer to IAFS_Name.
nTotalBytes
[out] Pointer to LONGLONG.
nTotalFreeBytes
[out] Pointer to LONGLONG.
nFreeBytesAvailable
[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

IAFS_FileSys

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IAFS_FileSys_GetVolumeSpace&oldid=44335"