FileName Property

Summary

Gets the file name this asynchronous operation is using.

Syntax

C++/CLI

Python

public string FileName { get; }

public: 
property String^ FileName { 
   String^ get(); 
}

FileName # get  (CodecsAsyncCompletedEventArgs)

Property Value

The file name this asynchronous operation is using. The default value is null.

Remarks

NOTE: This topic is part of RasterCodecs Async support using the .NET System.ComponentMode.AsyncOperation model. For .NET async/await support this type/member is not used. Instead, refer to RasterCodecs Async Operations.

Only one of the following can be a valid value (not a null reference) at any time: Uri, Stream or FileName. The property that contains a valid reference depends on what version of RasterCodecs.GetInformationAsync, RasterCodecs.LoadAsync or RasterCodecs.SaveAsync method has been called.

For example, if RasterCodecs.LoadAsync(Uri uri, object userState) is being called, the Uri will contain the same URI passed to the method while Stream and FileName will both be null.

If RasterCodecs.LoadAsync(String fileName, object userState) is being called, the FileName will contain the same file name string value passed to the method while Uri and Stream will both be null and so on.

Requirements

Target Platforms