IAFS_FileSys::Rename Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
Line 9: Line 9:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Rename([in]                      IAFS_Name*  Name,
+
<pre class="brush:cpp;gutter:false">HRESULT Rename([in]                      IAFS_Name*  pName,
               [in]                      IAFS_Name*  NewName,
+
               [in]                      IAFS_Name*  pNewName,
               [in, defaultvalue(NULL)]  IString*    ErrDetails,
+
               [in, defaultvalue(NULL)]  IString*    pErrDetails,
               [in, defaultvalue(NULL)]  IFlag*      CancelFlag);</pre>
+
               [in, defaultvalue(NULL)]  IFlag*      pCancelFlag);</pre>
  
 
== Parameters ==
 
== Parameters ==
;Name
+
;pName
 
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
 
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
;NewName
+
;pNewName
 
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
 
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
;ErrDetails
+
;pErrDetails
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IString|IString]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IString|IString]].
;CancelFlag
+
;pCancelFlag
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IFlag|IFlag]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IFlag|IFlag]].
  

Latest revision as of 03:10, 15 June 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT Rename([in]                      IAFS_Name*  pName,
               [in]                      IAFS_Name*  pNewName,
               [in, defaultvalue(NULL)]  IString*    pErrDetails,
               [in, defaultvalue(NULL)]  IFlag*      pCancelFlag);

Parameters

pName
[in] Pointer to IAFS_Name.
pNewName
[in] Pointer to IAFS_Name.
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