Edit

Share via


IFileEngine.CreateFileHandlerAsync Method

Definition

Overloads

CreateFileHandlerAsync(Stream, String, Boolean, FileExecutionState)

Starts creating a file handler for given file stream.

CreateFileHandlerAsync(String, String, Boolean, FileExecutionState)

Starts creating a file handler for given file path.

CreateFileHandlerAsync(Stream, String, Boolean, FileExecutionState, Boolean)

Starts creating a file handler for given file stream.

CreateFileHandlerAsync(String, String, Boolean, FileExecutionState, Boolean)

Starts creating a file handler for given file path.

CreateFileHandlerAsync(Stream, String, Boolean, FileExecutionState)

Starts creating a file handler for given file stream.

public System.Threading.Tasks.Task<Microsoft.InformationProtection.File.IFileHandler> CreateFileHandlerAsync (System.IO.Stream inputStream, string inputFilePath, bool isAuditDiscoveryEnabled, Microsoft.InformationProtection.File.FileExecutionState fileExecutionState = default);
abstract member CreateFileHandlerAsync : System.IO.Stream * string * bool * Microsoft.InformationProtection.File.FileExecutionState -> System.Threading.Tasks.Task<Microsoft.InformationProtection.File.IFileHandler>
Public Function CreateFileHandlerAsync (inputStream As Stream, inputFilePath As String, isAuditDiscoveryEnabled As Boolean, Optional fileExecutionState As FileExecutionState = Nothing) As Task(Of IFileHandler)

Parameters

inputStream
Stream

A stream that represents the file.

inputFilePath
String

The file name. if one exists, it should include the file extension.

isAuditDiscoveryEnabled
Boolean

A bool representing whether audit discovery should be enabled or not.

fileExecutionState
FileExecutionState

A callback class for IFileHandler

Returns

A task that represents the asynchronous create operation. The value of the TResult parameter contains the IFileHandler.

Applies to

CreateFileHandlerAsync(String, String, Boolean, FileExecutionState)

Starts creating a file handler for given file path.

public System.Threading.Tasks.Task<Microsoft.InformationProtection.File.IFileHandler> CreateFileHandlerAsync (string inputFilePath, string actualFilePath, bool isAuditDiscoveryEnabled, Microsoft.InformationProtection.File.FileExecutionState fileExecutionState = default);
abstract member CreateFileHandlerAsync : string * string * bool * Microsoft.InformationProtection.File.FileExecutionState -> System.Threading.Tasks.Task<Microsoft.InformationProtection.File.IFileHandler>
Public Function CreateFileHandlerAsync (inputFilePath As String, actualFilePath As String, isAuditDiscoveryEnabled As Boolean, Optional fileExecutionState As FileExecutionState = Nothing) As Task(Of IFileHandler)

Parameters

inputFilePath
String

The file to open. The path must include the file name and, if one exists, the file name extension.

actualFilePath
String

The real (not temporary) file path, will be used for audit.

isAuditDiscoveryEnabled
Boolean

A bool representing whether audit discovery should be enabled or not.

fileExecutionState
FileExecutionState

A callback class for IFileHandler

Returns

A task that represents the asynchronous create operation. The value of the TResult parameter contains the IFileHandler.

Applies to

CreateFileHandlerAsync(Stream, String, Boolean, FileExecutionState, Boolean)

Starts creating a file handler for given file stream.

public System.Threading.Tasks.Task<Microsoft.InformationProtection.File.IFileHandler> CreateFileHandlerAsync (System.IO.Stream inputStream, string inputFilePath, bool isAuditDiscoveryEnabled, Microsoft.InformationProtection.File.FileExecutionState fileExecutionState = default, bool isGetSensitivityLabelAuditDiscoveryEnabled = true);
abstract member CreateFileHandlerAsync : System.IO.Stream * string * bool * Microsoft.InformationProtection.File.FileExecutionState * bool -> System.Threading.Tasks.Task<Microsoft.InformationProtection.File.IFileHandler>
Public Function CreateFileHandlerAsync (inputStream As Stream, inputFilePath As String, isAuditDiscoveryEnabled As Boolean, Optional fileExecutionState As FileExecutionState = Nothing, Optional isGetSensitivityLabelAuditDiscoveryEnabled As Boolean = true) As Task(Of IFileHandler)

Parameters

inputStream
Stream

A stream that represents the file.

inputFilePath
String

The file name. if one exists, it should include the file extension.

isAuditDiscoveryEnabled
Boolean

A bool representing whether audit discovery should be enabled or not.

fileExecutionState
FileExecutionState

A callback class for IFileHandler

isGetSensitivityLabelAuditDiscoveryEnabled
Boolean

A bool representing whether audit discovery is triggered for getSensitivityLabel or not.

Returns

A task that represents the asynchronous create operation. The value of the TResult parameter contains the IFileHandler.

Applies to

CreateFileHandlerAsync(String, String, Boolean, FileExecutionState, Boolean)

Starts creating a file handler for given file path.

public System.Threading.Tasks.Task<Microsoft.InformationProtection.File.IFileHandler> CreateFileHandlerAsync (string inputFilePath, string actualFilePath, bool isAuditDiscoveryEnabled, Microsoft.InformationProtection.File.FileExecutionState fileExecutionState = default, bool isGetSensitivityLabelAuditDiscoveryEnabled = true);
abstract member CreateFileHandlerAsync : string * string * bool * Microsoft.InformationProtection.File.FileExecutionState * bool -> System.Threading.Tasks.Task<Microsoft.InformationProtection.File.IFileHandler>
Public Function CreateFileHandlerAsync (inputFilePath As String, actualFilePath As String, isAuditDiscoveryEnabled As Boolean, Optional fileExecutionState As FileExecutionState = Nothing, Optional isGetSensitivityLabelAuditDiscoveryEnabled As Boolean = true) As Task(Of IFileHandler)

Parameters

inputFilePath
String

The file to open. The path must include the file name and, if one exists, the file name extension.

actualFilePath
String

The real (not temporary) file path, will be used for audit.

isAuditDiscoveryEnabled
Boolean

A bool representing whether audit discovery should be enabled or not.

fileExecutionState
FileExecutionState

A callback class for IFileHandler

isGetSensitivityLabelAuditDiscoveryEnabled
Boolean

A bool representing whether audit discovery is triggered for getSensitivityLabel or not.

Returns

A task that represents the asynchronous create operation. The value of the TResult parameter contains the IFileHandler.

Applies to