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*  pName,
+
<pre class="brush:cpp;gutter:false">HRESULT Rename([in]                      IAFS_Name*  Name,
               [in]                      IAFS_Name*  pNewName,
+
               [in]                      IAFS_Name*  NewName,
               [in, defaultvalue(NULL)]  IString*    pErrDetails,
+
               [in, defaultvalue(NULL)]  IString*    ErrDetails,
               [in, defaultvalue(NULL)]  IFlag*      pCancelFlag);</pre>
+
               [in, defaultvalue(NULL)]  IFlag*      CancelFlag);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pName
+
;Name
 
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
 
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
;pNewName
+
;NewName
 
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
 
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
;pErrDetails
+
;ErrDetails
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IString|IString]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IString|IString]].
;pCancelFlag
+
;CancelFlag
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IFlag|IFlag]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IFlag|IFlag]].
  

Revision as of 08:43, 10 June 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT Rename([in]                      IAFS_Name*  Name,
               [in]                      IAFS_Name*  NewName,
               [in, defaultvalue(NULL)]  IString*    ErrDetails,
               [in, defaultvalue(NULL)]  IFlag*      CancelFlag);

Parameters

Name
[in] Pointer to IAFS_Name.
NewName
[in] Pointer to IAFS_Name.
ErrDetails
[in, defaultvalue(NULL)] Pointer to IString.
CancelFlag
[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