CharBuffer.Get Method
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.
Overloads
Get() |
Relative get method. |
Get(Char[]) |
Relative bulk get method. |
Get(Int32) |
Absolute get method. |
Get(Char[], Int32, Int32) |
Relative bulk get method. |
Get()
Relative get method.
[Android.Runtime.Register("get", "()C", "GetGetHandler")]
public abstract char Get ();
[<Android.Runtime.Register("get", "()C", "GetGetHandler")>]
abstract member Get : unit -> char
Returns
The char at the buffer's current position
- Attributes
Exceptions
if the position is equal or greater than limit.
Remarks
Relative get method. Reads the char at this buffer's current position, and then increments the position.
Java documentation for java.nio.CharBuffer.get()
.
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.
Applies to
Get(Char[])
Relative bulk get method.
[Android.Runtime.Register("get", "([C)Ljava/nio/CharBuffer;", "GetGet_arrayCHandler")]
public virtual Java.Nio.CharBuffer? Get (char[]? dst);
[<Android.Runtime.Register("get", "([C)Ljava/nio/CharBuffer;", "GetGet_arrayCHandler")>]
abstract member Get : char[] -> Java.Nio.CharBuffer
override this.Get : char[] -> Java.Nio.CharBuffer
Parameters
- dst
- Char[]
The destination array
Returns
This buffer
- Attributes
Exceptions
if dst.length
is greater than remaining()
.
Remarks
Relative bulk get method.
This method transfers chars from this buffer into the given destination array. An invocation of this method of the form src.get(a)
behaves in exactly the same way as the invocation
src.get(a, 0, a.length)
Java documentation for java.nio.CharBuffer.get(char[])
.
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.
Applies to
Get(Int32)
Absolute get method.
[Android.Runtime.Register("get", "(I)C", "GetGet_IHandler")]
public abstract char Get (int index);
[<Android.Runtime.Register("get", "(I)C", "GetGet_IHandler")>]
abstract member Get : int -> char
Parameters
- index
- Int32
The index from which the char will be read
Returns
The char at the given index
- Attributes
Exceptions
if index is invalid.
Remarks
Absolute get method. Reads the char at the given index.
Java documentation for java.nio.CharBuffer.get(int)
.
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.
Applies to
Get(Char[], Int32, Int32)
Relative bulk get method.
[Android.Runtime.Register("get", "([CII)Ljava/nio/CharBuffer;", "GetGet_arrayCIIHandler")]
public virtual Java.Nio.CharBuffer? Get (char[]? dst, int offset, int length);
[<Android.Runtime.Register("get", "([CII)Ljava/nio/CharBuffer;", "GetGet_arrayCIIHandler")>]
abstract member Get : char[] * int * int -> Java.Nio.CharBuffer
override this.Get : char[] * int * int -> Java.Nio.CharBuffer
Parameters
- dst
- Char[]
The array into which chars are to be written
- offset
- Int32
The offset within the array of the first char to be
written; must be non-negative and no larger than
dst.length
- length
- Int32
The maximum number of chars to be written to the given
array; must be non-negative and no larger than
dst.length - offset
Returns
This buffer
- Attributes
Exceptions
if either dstOffset
or charCount
is invalid.
if charCount
is greater than remaining()
.
Remarks
Relative bulk get method.
This method transfers chars from this buffer into the given destination array. If there are fewer chars remaining in the buffer than are required to satisfy the request, that is, if length
>
remaining()
, then no chars are transferred and a BufferUnderflowException
is thrown.
Otherwise, this method copies length
chars from this buffer into the given array, starting at the current position of this buffer and at the given offset in the array. The position of this buffer is then incremented by length
.
In other words, an invocation of this method of the form src.get(dst, off, len)
has exactly the same effect as the loop
{@code
for (int i = off; i < off + len; i++)
dst[i] = src.get();
}
except that it first checks that there are sufficient chars in this buffer and it is potentially much more efficient.
Java documentation for java.nio.CharBuffer.get(char[], int, int)
.
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.