microsoft.win32.safehandles

Class SafeFileHandle

java.lang.Object

org.mases.jcobridge.netreflection.NetObject

system.runtime.constrainedexecution.CriticalFinalizerObject

system.runtime.interopservices.SafeHandle

microsoft.win32.safehandles.SafeHandleZeroOrMinusOneIsInvalid

microsoft.win32.safehandles.SafeFileHandle

All Implemented Interfaces:

java.lang.AutoCloseable, IJCOBridgeReflected

public class SafeFileHandle
extends SafeHandleZeroOrMinusOneIsInvalid

The base .NET class managing Microsoft.Win32.SafeHandles.SafeFileHandle, System.Private.CoreLib, Version=11.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e.

.NET documentation at https://learn.microsoft.com/dotnet/api/Microsoft.Win32.SafeHandles.SafeFileHandle

Powered by JCOBridge: more info at https://www.jcobridge.com

Author:

MASES s.r.l https://masesgroup.com

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	assemblyFullName Fully assembly qualified name: System.Private.CoreLib, Version=11.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
static java.lang.String	assemblyShortName Assembly name: System.Private.CoreLib
static java.lang.String	className Qualified class name: Microsoft.Win32.SafeHandles.SafeFileHandle
static JCType	classType The type managed from JCOBridge.

Fields inherited from class org.mases.jcobridge.netreflection.NetObject

Null

Constructor Summary

Constructors

Constructor and Description
SafeFileHandle() Initializes a new instance by invoking the .NET constructor.
SafeFileHandle(java.lang.Object instance) Internal constructor.

Method Summary

Modifier and Type	Method and Description
static SafeFileHandle	cast(IJCOBridgeReflected from) Try to cast the IJCOBridgeReflected instance into SafeFileHandle, a cast assert is made to check if types are compatible.
static void	CreateAnonymousPipe(JCORefOut<SafeFileHandle> readHandle, JCORefOut<SafeFileHandle> writeHandle, boolean asyncRead, boolean asyncWrite) Invokes the .NET member CreateAnonymousPipe.
boolean	getIsAsync() Gets the value of the .NET property IsAsync.
java.lang.String	getJCOAssemblyName() Returns the full name of the assembly of the .NET type.
java.lang.String	getJCOClassName() Returns the full name of the .NET type.
java.lang.Object	getJCOInstance() Returns the underlying object managed by the bridge.
java.lang.String	getJCOObjectName() Returns the name of the .NET type qualified with its assembly.
JCType	getJCOType() Returns the JCType of the .NET type.
FileHandleType	getType() Gets the value of the .NET property Type.
void	setJCOInstance(JCObject instance) Sets the underlying object managed by the bridge.

Methods inherited from class system.runtime.interopservices.SafeHandle

close, Close, DangerousAddRef, DangerousRelease, Dispose, getIsClosed, getIsInvalid, SetHandleAsInvalid

Methods inherited from class org.mases.jcobridge.netreflection.NetObject

Equals, Equals, GetHashCode, GetType, hashCode, toString, ToString

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Field Detail

assemblyFullName

public static final java.lang.String assemblyFullName

Fully assembly qualified name: System.Private.CoreLib, Version=11.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e

See Also:

Constant Field Values

assemblyShortName

public static final java.lang.String assemblyShortName

Assembly name: System.Private.CoreLib

See Also:

Constant Field Values

className

public static final java.lang.String className

Qualified class name: Microsoft.Win32.SafeHandles.SafeFileHandle

See Also:

Constant Field Values

classType

public static JCType classType

The type managed from JCOBridge. See JCType

Constructor Detail

SafeFileHandle

public SafeFileHandle()
               throws java.lang.Throwable,
                      ArgumentNullException,
                      PlatformNotSupportedException

Initializes a new instance by invoking the .NET constructor.

Throws:

java.lang.Throwable - if the .NET constructor fails

ArgumentNullException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

See Also:

.NET documentation

SafeFileHandle

public SafeFileHandle(java.lang.Object instance)
               throws java.lang.Throwable

Internal constructor. Use with caution

Parameters:

instance - the underlying bridge object: it must be a JCObject

Throws:

java.lang.Throwable - if instance is not a JCObject

Method Detail

cast

public static SafeFileHandle cast(IJCOBridgeReflected from)
                           throws java.lang.Throwable

Try to cast the IJCOBridgeReflected instance into SafeFileHandle, a cast assert is made to check if types are compatible.

Parameters:

from - IJCOBridgeReflected instance to be casted

Returns:

SafeFileHandle instance

Throws:

java.lang.Throwable - in case of error during cast operation

CreateAnonymousPipe

public static void CreateAnonymousPipe(JCORefOut<SafeFileHandle> readHandle,
                                       JCORefOut<SafeFileHandle> writeHandle,
                                       boolean asyncRead,
                                       boolean asyncWrite)
                                throws java.lang.Throwable,
                                       PlatformNotSupportedException,
                                       NotSupportedException,
                                       IndexOutOfRangeException,
                                       ArgumentException,
                                       ArgumentOutOfRangeException,
                                       ArgumentNullException,
                                       FormatException,
                                       MissingMethodException,
                                       TargetInvocationException,
                                       ObjectDisposedException,
                                       ArrayTypeMismatchException,
                                       InvalidOperationException,
                                       Win32Exception,
                                       CultureNotFoundException,
                                       OutOfMemoryException,
                                       IOException,
                                       ApplicationException,
                                       ThreadStateException

Invokes the .NET member CreateAnonymousPipe.

Parameters:

readHandle - the argument of type JCORefOut<SafeFileHandle>

writeHandle - the argument of type JCORefOut<SafeFileHandle>

asyncRead - the argument of type boolean

asyncWrite - the argument of type boolean

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

PlatformNotSupportedException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

FormatException - if the .NET member raises it

MissingMethodException - if the .NET member raises it

TargetInvocationException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

Win32Exception - if the .NET member raises it

CultureNotFoundException - if the .NET member raises it

OutOfMemoryException - if the .NET member raises it

IOException - if the .NET member raises it

ApplicationException - if the .NET member raises it

ThreadStateException - if the .NET member raises it

See Also:

.NET documentation

getIsAsync

public boolean getIsAsync()
                   throws java.lang.Throwable,
                          ObjectDisposedException,
                          PlatformNotSupportedException,
                          IndexOutOfRangeException,
                          ArgumentException,
                          ArgumentOutOfRangeException,
                          ArgumentNullException,
                          InvalidOperationException,
                          NotSupportedException,
                          FormatException,
                          OutOfMemoryException

Gets the value of the .NET property IsAsync.

Returns:

the value of the property

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ObjectDisposedException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

FormatException - if the .NET member raises it

OutOfMemoryException - if the .NET member raises it

See Also:

.NET documentation

getJCOAssemblyName

public java.lang.String getJCOAssemblyName()

Description copied from class: NetObject

Returns the full name of the assembly of the .NET type.

Specified by:

getJCOAssemblyName in interface IJCOBridgeReflected

Overrides:

getJCOAssemblyName in class SafeHandleZeroOrMinusOneIsInvalid

Returns:

the full assembly name

getJCOClassName

public java.lang.String getJCOClassName()

Description copied from class: NetObject

Returns the full name of the .NET type.

Specified by:

getJCOClassName in interface IJCOBridgeReflected

Overrides:

getJCOClassName in class SafeHandleZeroOrMinusOneIsInvalid

Returns:

the full class name

getJCOInstance

public java.lang.Object getJCOInstance()

Description copied from class: NetObject

Returns the underlying object managed by the bridge.

Specified by:

getJCOInstance in interface IJCOBridgeReflected

Overrides:

getJCOInstance in class SafeHandleZeroOrMinusOneIsInvalid

Returns:

the underlying object, or null if there is none

getJCOObjectName

public java.lang.String getJCOObjectName()

Description copied from class: NetObject

Returns the name of the .NET type qualified with its assembly.

Specified by:

getJCOObjectName in interface IJCOBridgeReflected

Overrides:

getJCOObjectName in class SafeHandleZeroOrMinusOneIsInvalid

Returns:

the assembly qualified name

getJCOType

public JCType getJCOType()

Description copied from class: NetObject

Returns the JCType of the .NET type.

Specified by:

getJCOType in interface IJCOBridgeReflected

Overrides:

getJCOType in class SafeHandleZeroOrMinusOneIsInvalid

Returns:

the type of the .NET class

getType

public FileHandleType getType()
                       throws java.lang.Throwable,
                              PlatformNotSupportedException,
                              ObjectDisposedException,
                              IndexOutOfRangeException,
                              ArgumentException,
                              ArgumentOutOfRangeException,
                              ArgumentNullException,
                              InvalidOperationException,
                              NotSupportedException,
                              FormatException,
                              OutOfMemoryException

Gets the value of the .NET property Type.

Returns:

the value of the property

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

PlatformNotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

FormatException - if the .NET member raises it

OutOfMemoryException - if the .NET member raises it

See Also:

.NET documentation

setJCOInstance

public void setJCOInstance(JCObject instance)

Description copied from class: NetObject

Sets the underlying object managed by the bridge.

Overrides:

setJCOInstance in class SafeHandleZeroOrMinusOneIsInvalid

Parameters:

instance - the new underlying object