ParcelFileDescriptor Class
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.
The FileDescriptor returned by Parcel#readFileDescriptor, allowing
you to close it when done with it.
[Android.Runtime.Register("android/os/ParcelFileDescriptor", DoNotGenerateAcw=true)]
public class ParcelFileDescriptor : Java.Lang.Object, Android.OS.IParcelable, IDisposable, Java.IO.ICloseable[<Android.Runtime.Register("android/os/ParcelFileDescriptor", DoNotGenerateAcw=true)>]
type ParcelFileDescriptor = class
inherit Object
interface IParcelable
interface IJavaObject
interface IDisposable
interface IJavaPeerable
interface ICloseable- Inheritance
- Attributes
- Implements
Remarks
The FileDescriptor returned by Parcel#readFileDescriptor, allowing you to close it when done with it.
Java documentation for android.os.ParcelFileDescriptor.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Constructors
| Name | Description |
|---|---|
| ParcelFileDescriptor(IntPtr, JniHandleOwnership) |
A constructor used when creating managed representations of JNI objects; called by the runtime. |
| ParcelFileDescriptor(ParcelFileDescriptor) |
Create a new ParcelFileDescriptor wrapped around another descriptor. |
Properties
| Name | Description |
|---|---|
| Class |
Returns the runtime class of this |
| Creator |
Gets the Creator value. |
| Fd |
Return the native fd int for this ParcelFileDescriptor. |
| FileDescriptor |
Retrieve the actual FileDescriptor associated with this object. |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| JniIdentityHashCode |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniManagedPeerState |
Gets the state flags last assigned by the runtime. (Inherited from JavaObject) |
| JniPeerMembers |
Provides JNI peer-member metadata for this type. |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| StatSize |
Return the total size of the file representing this fd, as determined by
|
| ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. |
| ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. |
Methods
| Name | Description |
|---|---|
| AdoptFd(Int32) |
Take ownership of a raw native fd in to a new ParcelFileDescriptor. |
| CanDetectErrors() |
Indicates if this ParcelFileDescriptor can communicate and detect remote errors/crashes. |
| CheckError() |
Detect and throw if the other end of a pipe or socket pair encountered an error or crashed. |
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Close() |
Close the ParcelFileDescriptor. |
| CloseWithError(String) |
Close the ParcelFileDescriptor, informing any peer that an error occurred while processing. |
| Construct(JniObjectReference, JniObjectReferenceOptions) |
Delegates construction of this peer to the runtime's value manager. (Inherited from JavaObject) |
| CreatePipe() |
Create two ParcelFileDescriptors structured as a data pipe. |
| CreateReliablePipe() |
Create two ParcelFileDescriptors structured as a data pipe. |
| CreateReliableSocketPair() |
Create two ParcelFileDescriptors structured as a pair of sockets connected to each other. |
| CreateSocketPair() |
Create two ParcelFileDescriptors structured as a pair of sockets connected to each other. |
| DescribeContents() |
Describe the kinds of special objects contained in this Parcelable's marshalled representation. |
| DetachFd() |
Return the native fd int for this ParcelFileDescriptor and detach it from the object here. |
| Dispose() |
Releases the resources held by this Java peer. (Inherited from Object) |
| Dispose(Boolean) |
Releases the resources held by this Java peer. (Inherited from Object) |
| DisposeUnlessReferenced() |
Asks the value manager to dispose this peer unless its mapping retains this same managed instance. (Inherited from JavaObject) |
| Dup() |
Create a new ParcelFileDescriptor that is a dup of the existing FileDescriptor. |
| Dup(FileDescriptor) |
Create a new ParcelFileDescriptor that is a dup of an existing FileDescriptor. |
| Equals(Object) |
Tests whether another managed peer refers to the same Java object. (Inherited from JavaObject) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| FromDatagramSocket(DatagramSocket) |
Create a new ParcelFileDescriptor from the specified DatagramSocket. |
| FromFd(Int32) |
Create a new ParcelFileDescriptor from a raw native fd. |
| FromSocket(Socket) |
Create a new ParcelFileDescriptor from the specified Socket. |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| JavaFinalize() |
Obsolete.
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
| NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
| Open(File, ParcelFileMode, Handler, ParcelFileDescriptor+IOnCloseListener) |
Create a new ParcelFileDescriptor accessing a given file. |
| Open(File, ParcelFileMode) |
Create a new ParcelFileDescriptor accessing a given file. |
| ParseMode(String) |
Converts a string representing a file mode, such as "rw", into a bitmask suitable for use
with |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) |
Stores a reference value in the control block without creating a JNI reference copy. (Inherited from JavaObject) |
| ToArray<T>() |
Creates a managed array from this Java array wrapper. (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() |
Unregisters this Java peer from the interop runtime. (Inherited from Object) |
| Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
| Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| Wrap(ParcelFileDescriptor, Handler, ParcelFileDescriptor+IOnCloseListener) |
Create a new ParcelFileDescriptor wrapping an already-opened file. |
| WriteToParcel(Parcel, ParcelableWriteFlags) |
To be added
If |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() |
Marks this peer as disposed and calls |
| IJavaPeerable.Finalized() |
Marks this peer as disposed and calls |
| IJavaPeerable.JniObjectReferenceControlBlock |
Gets the native control-block pointer used by this peer. (Inherited from JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) |
Stores the identity hash code supplied by the runtime. (Inherited from JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) |
Replaces the stored managed peer state flags. (Inherited from JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) |
Updates the peer reference and releases a disposed peer's control block when the reference is invalid. (Inherited from JavaObject) |
| IJavaPeerable.UnregisterFromRuntime() |
Removes this instance from the runtime's Java object lookup. |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) |
Reuses a compatible managed peer or obtains a wrapper of the requested type. |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |