ICIFileActionRenameParams

The ICIFileActionRenameParams interface specifies properties of the Event Rules File Operation Action.

IMPORTANT: Using this action within a Folder Monitor rule that triggers on renaming a file may result in the continual firing of the rule.

  • Property DestinationPath As String

    • Used to specify the destination path for the renamed file.

    HRESULT DestinationPath([out, retval] BSTR* pVal);
HRESULT DestinationPath([in] BSTR newVal);

    EFT v8.0.5 and later

  • Function GetFilter() As Object 

    • HRESULT GetFilter([out, retval] IDispatch* *pVal);

    EFT v8.0.5 and later

  • Property IncludeSubdirectories As Boolean

    • Specify whether to include subfolders in the renaming. 

    HRESULT IncludeSubdirectories([out, retval] VARIANT_BOOL *pVal);
HRESULT IncludeSubdirectories([in] VARIANT_BOOL newVal);

    EFT v8.0.5 and later

  • Property MatchingFileOption As MatchingFileOption

    • HRESULT MatchingFileOption([out, retval] MatchingFileOption* pVal);
HRESULT MatchingFileOption([in] MatchingFileOption newVal);

    EFT v8.0.5 and later

  • Sub SetFilter(newVal As Object) 

    • HRESULT SetFilter([in] IDispatch* newVal);

    EFT v8.0.5 and later

  • Property SourcePath As String

    • Used to select the source path to rename.

    HRESULT SourcePath([out, retval] BSTR* pVal);
HRESULT SourcePath([in] BSTR newVal);

    EFT v8.0.5 and later

  • Property TreatMissingSourceAsSuccess As Boolean 

    • HRESULT TreatMissingSourceAsSuccess([out, retval] VARIANT_BOOL *pVal);
HRESULT TreatMissingSourceAsSuccess([in] VARIANT_BOOL newVal);

    EFT v8.0.5 and later