SafeHandle.IsInvalid Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
When overridden in a derived class, gets a value indicating whether the handle value is invalid.
public:
abstract property bool IsInvalid { bool get(); };public abstract bool IsInvalid { get; }member this.IsInvalid : boolPublic MustOverride ReadOnly Property IsInvalid As BooleanProperty Value
true if the handle value is invalid; otherwise, false.
Examples
The following example checks if a file was opened successfully. This code example is part of a larger example provided for the SafeHandle class.
// Determine if file is opened successfully.
if (_handle.IsInvalid)
throw new Win32Exception(Marshal.GetLastWin32Error(), fileName);
Remarks
Derived classes must implement the IsInvalid property so that the common language runtime can determine whether critical finalization is required. Derived classes must provide an implementation that suits the general type of handle they support (0 or -1 is invalid). These classes can then be further derived for specific safe handle types.
Unlike the IsClosed property, which reports whether the SafeHandle object has finished using the underlying handle, the IsInvalid property calculates whether the given handle value is always considered invalid. Therefore, the IsInvalid property always returns the same value for any one handle value.
