The OracleBinary structure represents a variable-length stream of binary data to be stored in or retrieved from a database.
System.Object
System.ValueType
Oracle.DataAccess.Types.OracleBinary
// ADO.NET 2.0: C# public struct OracleBinary : IComparable, INullable, IXmlSerializable
All public static methods are thread-safe, although instance methods do not guarantee thread safety.
// C#
using System;
using Oracle.DataAccess.Types;
class OracleBinarySample
{
static void Main(string[] args)
{
// Initialize the OracleBinary structures
OracleBinary binary1= new OracleBinary(new byte[] {1,2,3,4,5});
OracleBinary binary2 = new OracleBinary(new byte[] {1,2,3});
OracleBinary binary3 = new OracleBinary(new byte[] {4,5});
OracleBinary binary4 = binary2 + binary3;
// Compare binary1 and binary4; they're equal
if (binary1 == binary4)
Console.WriteLine("The two OracleBinary structs are equal");
else
Console.WriteLine("The two OracleBinary structs are different");
}
}
Namespace: Oracle.DataAccess.Types
Assembly: Oracle.DataAccess.dll
ODP.NET Version: ODP.NET for .NET Framework 2.0 or ODP.NET for .NET Framework 4
See Also:
OracleBinary members are listed in the following tables:
OracleBinary constructors are listed in Table 14-1
Table 14-1 OracleBinary Constructors
| Constructor | Description |
|---|---|
|
Instantiates a new instance of |
The OracleBinary static fields are listed in Table 14-2.
Table 14-2 OracleBinary Static Fields
| Field | Description |
|---|---|
|
Represents a null value that can be assigned to an instance of the |
The OracleBinary static methods are listed in Table 14-3.
Table 14-3 OracleBinary Static Methods
| Methods | Description |
|---|---|
|
Returns the concatenation of two |
|
|
Determines if two |
|
|
Determines if the first of two |
|
|
Determines if the first of two |
|
|
Determines if the first of two |
|
|
Determines if the first of two |
|
|
Determines if two |
The OracleBinary static operators are listed in Table 14-4.
Table 14-4 OracleBinary Static Operators
| Operator | Description |
|---|---|
|
Concatenates two |
|
|
Determines if two |
|
|
Determines if the first of two |
|
|
Determines if the first of two |
|
|
Determines if two |
|
|
Determines if the first of two |
|
|
Determines if the first of two |
OracleBinary Static Type Conversion Operators
The OracleBinary static type conversion operators are listed in Table 14-5.
Table 14-5 OracleBinary Static Type Conversion Operators
| Operator | Description |
|---|---|
|
Converts an instance value to a byte array |
|
|
Converts an instance value to an |
The OracleBinary properties are listed in Table 14-6.
Table 14-6 OracleBinary Properties
| Properties | Description |
|---|---|
|
Indicates whether or not the current instance has a null value |
|
|
Obtains the particular |
|
|
Returns the length of the binary data |
|
|
Returns the binary data that is stored in an |
The OracleBinary instance methods are listed in Table 14-7.
Table 14-7 OracleBinary Instance Methods
| Methods | Description |
|---|---|
|
Compares the current instance to an object and returns an integer that represents their relative values |
|
|
Determines if two objects contain the same binary data (Overloaded) |
|
|
Returns a hash code for the current instance |
|
|
GetType |
Inherited from |
|
Converts the current |
The OracleBinary constructor instantiates a new instance of the OracleBinary structure and sets its value to the provided array of bytes.
// C#
public OracleBinary(byte[ ] bytes);
bytes
A byte array.
The OracleBinary static fields are listed in Table 14-8.
Table 14-8 OracleBinary Static Fields
| Field | Description |
|---|---|
|
Represents a null value that can be assigned to an instance of the |
The OracleBinary static methods are listed in Table 14-9.
Table 14-9 OracleBinary Static Methods
| Methods | Description |
|---|---|
|
Returns the concatenation of two |
|
|
Determines if two |
|
|
Determines if the first of two |
|
|
Determines if the first of two |
|
|
Determines if the first of two |
|
|
Determines if the first of two |
|
|
Determines if two |
This method returns the concatenation of two OracleBinary structures.
// C# public static OracleBinary Concat(OracleBinary value1, OracleBinary value2);
value1
The first OracleBinary.
value2
The second OracleBinary.
An OracleBinary.
If either argument has a null value, the returned OracleBinary structure has a null value.
This method determines if two OracleBinary values are equal.
// C# public static bool Equals(OracleBinary value1, OracleBinary value2);
value1
The first OracleBinary.
value2
The second OracleBinary.
Returns true if two OracleBinary values are equal; otherwise returns false.
The following rules apply to the behavior of this method.
Any OracleBinary that has a value is greater than an OracleBinary that has a null value.
Two OracleBinarys that contain a null value are equal.
This method determines whether or not the first of two OracleBinary values is greater than the second.
// C# public static bool GreaterThan(OracleBinary value1, OracleBinary value2);
value1
The first OracleBinary.
value2
The second OracleBinary.
Returns true if the first of two OracleBinary values is greater than the second; otherwise returns false.
The following rules apply to the behavior of this method.
Any OracleBinary that has a value is greater than an OracleBinary that has a null value.
Two OracleBinarys that contain a null value are equal.
// C#
using System;
using Oracle.DataAccess.Types;
class GreaterThanSample
{
static void Main(string[] args)
{
OracleBinary binary1 = OracleBinary.Null;
OracleBinary binary2 = new OracleBinary(new byte[] {1});
// Compare two OracleBinary structs; binary1 < binary2
if (OracleBinary.GreaterThan(binary1, binary2))
Console.WriteLine("binary1 > binary2");
else
Console.WriteLine("binary1 < binary2");
}
}
This method determines whether or not the first of two OracleBinary values is greater than or equal to the second.
// C# public static bool GreaterThanOrEqual(OracleBinary value1, OracleBinary value2);
value1
The first OracleBinary.
value2
The second OracleBinary.
Returns true if the first of two OracleBinary values is greater than or equal to the second; otherwise returns false.
The following rules apply to the behavior of this method.
Any OracleBinary that has a value is greater than an OracleBinary that has a null value.
Two OracleBinarys that contain a null value are equal.
This method determines whether or not the first of two OracleBinary values is less than the second.
// C# public static bool LessThan(OracleBinary value1, OracleBinary value2);
value1
The first OracleBinary.
value2
The second OracleBinary.
Returns true if the first of two OracleBinary values is less than the second; otherwise returns false.
The following rules apply to the behavior of this method.
Any OracleBinary that has a value is greater than an OracleBinary that has a null value.
Two OracleBinarys that contain a null value are equal.
This method determines whether or not the first of two OracleBinary values is less than or equal to the second.
// C# public static bool LessThanOrEqual(OracleBinary value1, OracleBinary value2);
value1
The first OracleBinary.
value2
The second OracleBinary.
Returns true if the first of two OracleBinary values is less than or equal to the second; otherwise returns false.
The following rules apply to the behavior of this method.
Any OracleBinary that has a value is greater than an OracleBinary that has a null value.
Two OracleBinarys that contain a null value are equal.
This method determines whether or not two OracleBinary values are not equal.
// C# public static bool NotEquals(OracleBinary value1, OracleBinary value2);
value1
The first OracleBinary.
value2
The second OracleBinary.
Returns true if two OracleBinary values are not equal; otherwise returns false.
The following rules apply to the behavior of this method.
Any OracleBinary that has a value is greater than an OracleBinary that has a null value.
Two OracleBinarys that contain a null value are equal.
The OracleBinary static operators are listed in Table 14-10.
Table 14-10 OracleBinary Static Operators
| Operator | Description |
|---|---|
|
Concatenates two |
|
|
Determines if two |
|
|
Determines if the first of two |
|
|
Determines if the first of two |
|
|
Determines if two |
|
|
Determines if the first of two |
|
|
Determines if the first of two |
This method concatenates two OracleBinary values.
// C# public static OracleBinary operator + (OracleBinary value1, OracleBinary value2);
value1
The first OracleBinary.
value2
The second OracleBinary.
OracleBinary
If either argument has a null value, the returned OacleBinary structure has a null value.
This method determines if two OracleBinary values are equal.
// C# public static bool operator == (OracleBinary value1, OracleBinary value2);
value1
The first OracleBinary.
value2
The second OracleBinary.
Returns true if they are the same; otherwise returns false.
The following rules apply to the behavior of this method.
Any OracleBinary that has a value is greater than an OracleBinary that has a null value.
Two OracleBinarys that contain a null value are equal.
This method determines if the first of two OracleBinary values is greater than the second.
// C# public static bool operator > (OracleBinary value1, OracleBinary value2);
value1
The first OracleBinary.
value2
The second OracleBinary.
Returns true if the first of two OracleBinary values is greater than the second; otherwise, returns false.
The following rules apply to the behavior of this method.
Any OracleBinary that has a value is greater than an OracleBinary that has a null value.
Two OracleBinarys that contain a null value are equal.
// C#
using System;
using Oracle.DataAccess.Types;
class OperatorSample
{
static void Main(string[] args)
{
OracleBinary binary1 = OracleBinary.Null;
OracleBinary binary2 = new OracleBinary(new byte[] {1});
// Compare two OracleBinary structs; binary1 < binary2
if (binary1 > binary2)
Console.WriteLine("binary1 > binary2");
else
Console.WriteLine("binary1 < binary2");
}
}
This method determines if the first of two OracleBinary values is greater than or equal to the second.
// C# public static bool operator >= (OracleBinary value1, OracleBinary value2);
value1
The first OracleBinary.
value2
The second OracleBinary.
Returns true if the first of two OracleBinary values is greater than or equal to the second; otherwise, returns false.
The following rules apply to the behavior of this method.
Any OracleBinary that has a value is greater than an OracleBinary that has a null value.
Two OracleBinarys that contain a null value are equal.
This method determines if two OracleBinary values are not equal.
// C# public static bool operator != (OracleBinary value1, OracleBinary value2);
value1
The first OracleBinary.
value2
The second OracleBinary.
Returns true if the two OracleBinary values are not equal; otherwise, returns false.
This method determines if the first of two OracleBinary values is less than the second.
// C# public static bool operator < ( OracleBinary value1, OracleBinary value2);
value1
The first OracleBinary.
value2
The second OracleBinary.
Returns true if the first of two OracleBinary values is less than the second; otherwise, returns false.
The following rules apply to the behavior of this method.
Any OracleBinary that has a value is greater than an OracleBinary that has a null value.
Two OracleBinarys that contain a null value are equal.
This method determines if the first of two OracleBinary values is less than or equal to the second.
// C# public static bool operator <= (OracleBinary value1, OracleBinary value1);
value1
The first OracleBinary.
value2
The second OracleBinary.
Returns true if the first of two OracleBinary values is less than or equal to the second; otherwise, returns false.
The following rules apply to the behavior of this method.
Any OracleBinary that has a value is greater than an OracleBinary that has a null value.
Two OracleBinarys that contain a null value are equal.
The OracleBinary static type conversion operators are listed in Table 14-11.
Table 14-11 OracleBinary Static Type Conversion Operators
| Operator | Description |
|---|---|
|
Converts an instance value to a byte array |
|
|
Converts an instance value to an |
This method converts an OracleBinary value to a byte array.
// C#
public static explicit operator byte[ ] (OracleBinary val);
val
An OracleBinary.
A byte array.
OracleNullValueException - The OracleBinary structure has a null value.
The OracleBinary properties are listed in Table 14-12.
Table 14-12 OracleBinary Properties
| Properties | Description |
|---|---|
|
Indicates whether or not the current instance has a null value |
|
|
Obtains the particular |
|
|
Returns the length of the binary data |
|
|
Returns the binary data that is stored in an |
This property indicates whether or not the current instance has a null value.
// C#
public bool IsNull {get;}
Returns true if the current instance has a null value; otherwise returns false.
This property obtains the particular byte in an OracleBinary structure using an index.
// C#
public byte this[int index] {get;}
A byte in the specified index.
OracleNullValueException - The current instance has a null value.
// C#
using System;
using Oracle.DataAccess.Types;
class ItemSample
{
static void Main(string[] args)
{
OracleBinary binary = new OracleBinary(new byte[] {1,2,3,4});
// Prints the value 4
Console.WriteLine(binary[binary.Length - 1]);
}
}
This property returns the length of the binary data.
// C#
public int length {get;}
Length of the binary data.
OracleNullValueException - The current instance has a null value.
// C#
using System;
using Oracle.DataAccess.Types;
class LengthSample
{
static void Main(string[] args)
{
OracleBinary binary = new OracleBinary(new byte[] {1,2,3,4});
// Prints the value 4
Console.WriteLine(binary.Length);
}
}
The OracleBinary instance methods are listed in Table 14-13.
Table 14-13 OracleBinary Instance Methods
| Methods | Description |
|---|---|
|
Compares the current instance to an object and returns an integer that represents their relative values |
|
|
Determines if two objects contain the same binary data (Overloaded) |
|
|
Returns a hash code for the current instance |
|
|
GetType |
Inherited from |
|
Converts the current |
This method compares the current instance to an object and returns an integer that represents their relative values
// C#
public int CompareTo(object obj);
obj
The object being compared.
The method returns a number that is:
Less than zero: if the current OracleBinary instance value is less than obj.
Zero: if the current OracleBinary instance and obj values have the same binary data.
Greater than zero: if the current OracleBinary instance value is greater than obj.
IComparable
ArgumentException - The parameter is not of type OracleBinary.
The following rules apply to the behavior of this method.
The comparison must be between OracleBinarys. For example, comparing an OracleBinary instance with an OracleTimeStamp instance is not allowed. When an OracleBinary is compared with a different type, an ArgumentException is thrown.
Any OracleBinary that has a value is greater than an OracleBinary that has a null value.
Two OracleBinarys that contain a null value are equal.
// C#
using System;
using Oracle.DataAccess.Types;
class CompareToSample
{
static void Main(string[] args)
{
OracleBinary binary1 = new OracleBinary(new byte[] {1,2,3});
OracleBinary binary2 = new OracleBinary(new byte[] {1,2,3,4});
// Compare
if (binary1.CompareTo(binary2) == 0)
Console.WriteLine("binary1 is the same as binary2");
else
Console.WriteLine("binary1 is different from binary2");
}
}
This method determines whether or not an object is an instance of OracleBinary, and has the same binary data as the current instance.
// C#
public override bool Equals(object obj);
obj
The object being compared.
Returns true if obj is an instance of OracleBinary, and has the same binary data as the current instance; otherwise, returns false.
The following rules apply to the behavior of this method.
Any OracleBinary that has a value is greater than an OracleBinary that has a null value.
Two OracleBinarys that contain a null value are equal.
Overrides Object
This method returns a hash code for the OracleBinary instance.
// C# public override int GetHashCode();
An int that represents the hash.