SafePipeHandle Class

Definition

Represents a wrapper class for a pipe handle.

public ref class SafePipeHandle sealed : Microsoft::Win32::SafeHandles::SafeHandleZeroOrMinusOneIsInvalid
public ref class SafePipeHandle sealed : System::Runtime::InteropServices::SafeHandle
public sealed class SafePipeHandle : Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid
public sealed class SafePipeHandle : System.Runtime.InteropServices.SafeHandle
[System.Security.SecurityCritical(System.Security.SecurityCriticalScope.Everything)]
public sealed class SafePipeHandle : Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid
type SafePipeHandle = class
    inherit SafeHandleZeroOrMinusOneIsInvalid
type SafePipeHandle = class
    inherit SafeHandle
Public NotInheritable Class SafePipeHandle
Inherits SafeHandleZeroOrMinusOneIsInvalid
Public NotInheritable Class SafePipeHandle
Inherits SafeHandle
Inheritance
Inheritance
SafePipeHandle
Attributes

Remarks

This class is derived from SafeHandleZeroOrMinusOneIsInvalid. A value of 0 or -1 is an invalid pipe handle.

Important

This type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the IDisposable interface topic.

Constructors

SafePipeHandle(IntPtr, Boolean)

Initializes a new instance of the SafePipeHandle class.

Fields

handle

Specifies the handle to be wrapped.

(Inherited from SafeHandle)

Properties

IsClosed

Gets a value indicating whether the handle is closed.

(Inherited from SafeHandle)
IsInvalid

Gets a value that indicates whether the handle is invalid.

IsInvalid

Gets a value that indicates whether the handle is invalid.

(Inherited from SafeHandleZeroOrMinusOneIsInvalid)

Methods

Close()

Marks the handle for releasing and freeing resources.

(Inherited from SafeHandle)
DangerousAddRef(Boolean)

Manually increments the reference counter on SafeHandle instances.

(Inherited from SafeHandle)
DangerousGetHandle()

Returns the value of the handle field.

(Inherited from SafeHandle)
DangerousRelease()

Manually decrements the reference counter on a SafeHandle instance.

(Inherited from SafeHandle)
Dispose()

Releases all resources used by the SafeHandle class.

(Inherited from SafeHandle)
Dispose(Boolean)

Releases the unmanaged resources used by the SafeHandle class specifying whether to perform a normal dispose operation.

(Inherited from SafeHandle)
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ReleaseHandle()

When overridden in a derived class, executes the code required to free the handle.

(Inherited from SafeHandle)
SetHandle(IntPtr)

Sets the handle to the specified pre-existing handle.

(Inherited from SafeHandle)
SetHandleAsInvalid()

Marks a handle as no longer used.

(Inherited from SafeHandle)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to