OracleBinary Structure

The OracleBinary structure represents a variable-length stream of binary data to be stored in or retrieved from a database.

Class Inheritance

System.Object

  System.ValueType

    Oracle.DataAccess.Types.OracleBinary

Declaration

// ADO.NET 2.0: C#
public struct OracleBinary : IComparable, INullable, IXmlSerializable

Thread Safety

All public static methods are thread-safe, although instance methods do not guarantee thread safety.

Example

// 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");
  }
}

Requirements

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


OracleBinary Members

OracleBinary members are listed in the following tables:

OracleBinary Constructors

OracleBinary constructors are listed in Table 14-1

Table 14-1 OracleBinary Constructors

Constructor Description

OracleBinary Constructor

Instantiates a new instance of OracleBinary structure


OracleBinary Static Fields

The OracleBinary static fields are listed in Table 14-2.

Table 14-2 OracleBinary Static Fields

Field Description

Null

Represents a null value that can be assigned to an instance of the OracleBinary structure


OracleBinary Static Methods

The OracleBinary static methods are listed in Table 14-3.

Table 14-3 OracleBinary Static Methods

Methods Description

Concat

Returns the concatenation of two OracleBinary structures

Equals

Determines if two OracleBinary values are equal (Overloaded)

GreaterThan

Determines if the first of two OracleBinary values is greater than the second

GreaterThanOrEqual

Determines if the first of two OracleBinary values is greater than or equal to the second

LessThan

Determines if the first of two OracleBinary values is less than the second

LessThanOrEqual

Determines if the first of two OracleBinary values is less than or equal to the second

NotEquals

Determines if two OracleBinary values are not equal


OracleBinary Static Operators

The OracleBinary static operators are listed in Table 14-4.

Table 14-4 OracleBinary Static Operators

Operator Description

operator +

Concatenates two OracleBinary values

operator ==

Determines if two OracleBinary values are equal

operator >

Determines if the first of two OracleBinary values is greater than the second

operator >=

Determines if the first of two OracleBinary values is greater than or equal to the second

operator !=

Determines if two OracleBinary values are not equal

operator <

Determines if the first of two OracleBinary value is less than the second

operator <=

Determines if the first of two OracleBinary value is less than or equal to the second


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

explicit operator byte[ ]

Converts an instance value to a byte array

implicit operator OracleBinary

Converts an instance value to an OracleBinary structure


OracleBinary Properties

The OracleBinary properties are listed in Table 14-6.

Table 14-6 OracleBinary Properties

Properties Description

IsNull

Indicates whether or not the current instance has a null value

Item

Obtains the particular byte in an OracleBinary structure using an index

Length

Returns the length of the binary data

Value

Returns the binary data that is stored in an OracleBinary structure


OracleBinary Instance Methods

The OracleBinary instance methods are listed in Table 14-7.

Table 14-7 OracleBinary Instance Methods

Methods Description

CompareTo

Compares the current instance to an object and returns an integer that represents their relative values

Equals

Determines if two objects contain the same binary data (Overloaded)

GetHashCode

Returns a hash code for the current instance

GetType

Inherited from System.Object

ToString

Converts the current OracleBinary structure to a string



OracleBinary Constructor

The OracleBinary constructor instantiates a new instance of the OracleBinary structure and sets its value to the provided array of bytes.

Declaration

// C#
public OracleBinary(byte[ ] bytes); 

Parameters

  • bytes

    A byte array.


OracleBinary Static Fields

The OracleBinary static fields are listed in Table 14-8.

Table 14-8 OracleBinary Static Fields

Field Description

Null

Represents a null value that can be assigned to an instance of the OracleBinary structure


Null

This static field represents a null value that can be assigned to an instance of the OracleBinary structure.

Declaration

// C#
public static readonly OracleBinary Null;

OracleBinary Static Methods

The OracleBinary static methods are listed in Table 14-9.

Table 14-9 OracleBinary Static Methods

Methods Description

Concat

Returns the concatenation of two OracleBinary structures

Equals

Determines if two OracleBinary values are equal (Overloaded)

GreaterThan

Determines if the first of two OracleBinary values is greater than the second

GreaterThanOrEqual

Determines if the first of two OracleBinary values is greater than or equal to the second

LessThan

Determines if the first of two OracleBinary values is less than the second

LessThanOrEqual

Determines if the first of two OracleBinary values is less than or equal to the second

NotEquals

Determines if two OracleBinary values are not equal


Concat

This method returns the concatenation of two OracleBinary structures.

Declaration

// C#
public static OracleBinary Concat(OracleBinary value1, OracleBinary value2);

Parameters

  • value1

    The first OracleBinary.

  • value2

    The second OracleBinary.

Return Value

An OracleBinary.

Remarks

If either argument has a null value, the returned OracleBinary structure has a null value.

Equals

This method determines if two OracleBinary values are equal.

Declaration

// C#
public static bool Equals(OracleBinary value1, OracleBinary value2);

Parameters

  • value1

    The first OracleBinary.

  • value2

    The second OracleBinary.

Return Value

Returns true if two OracleBinary values are equal; otherwise returns false.

Remarks

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.

GreaterThan

This method determines whether or not the first of two OracleBinary values is greater than the second.

Declaration

// C#
public static bool GreaterThan(OracleBinary value1, OracleBinary value2);

Parameters

  • value1

    The first OracleBinary.

  • value2

    The second OracleBinary.

Return Value

Returns true if the first of two OracleBinary values is greater than the second; otherwise returns false.

Remarks

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.

Example

// 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");
  }
}

GreaterThanOrEqual

This method determines whether or not the first of two OracleBinary values is greater than or equal to the second.

Declaration

// C#
public static bool GreaterThanOrEqual(OracleBinary value1, OracleBinary value2);

Parameters

  • value1

    The first OracleBinary.

  • value2

    The second OracleBinary.

Return Value

Returns true if the first of two OracleBinary values is greater than or equal to the second; otherwise returns false.

Remarks

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.

LessThan

This method determines whether or not the first of two OracleBinary values is less than the second.

Declaration

// C#
public static bool LessThan(OracleBinary value1, OracleBinary value2);

Parameters

  • value1

    The first OracleBinary.

  • value2

    The second OracleBinary.

Return Value

Returns true if the first of two OracleBinary values is less than the second; otherwise returns false.

Remarks

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.

LessThanOrEqual

This method determines whether or not the first of two OracleBinary values is less than or equal to the second.

Declaration

// C#
public static bool LessThanOrEqual(OracleBinary value1, OracleBinary value2);

Parameters

  • value1

    The first OracleBinary.

  • value2

    The second OracleBinary.

Return Value

Returns true if the first of two OracleBinary values is less than or equal to the second; otherwise returns false.

Remarks

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.

NotEquals

This method determines whether or not two OracleBinary values are not equal.

Declaration

// C#
public static bool NotEquals(OracleBinary value1, OracleBinary value2);

Parameters

  • value1

    The first OracleBinary.

  • value2

    The second OracleBinary.

Return Value

Returns true if two OracleBinary values are not equal; otherwise returns false.

Remarks

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.


OracleBinary Static Operators

The OracleBinary static operators are listed in Table 14-10.

Table 14-10 OracleBinary Static Operators

Operator Description

operator +

Concatenates two OracleBinary values

operator ==

Determines if two OracleBinary values are equal

operator >

Determines if the first of two OracleBinary values is greater than the second

operator >=

Determines if the first of two OracleBinary values is greater than or equal to the second

operator !=

Determines if two OracleBinary values are not equal

operator <

Determines if the first of two OracleBinary value is less than the second

operator <=

Determines if the first of two OracleBinary value is less than or equal to the second


operator +

This method concatenates two OracleBinary values.

Declaration

// C#
public static OracleBinary operator + (OracleBinary value1, OracleBinary value2);

Parameters

  • value1

    The first OracleBinary.

  • value2

    The second OracleBinary.

Return Value

OracleBinary

Remarks

If either argument has a null value, the returned OacleBinary structure has a null value.

operator ==

This method determines if two OracleBinary values are equal.

Declaration

// C#
public static bool operator == (OracleBinary value1, OracleBinary value2);

Parameters

  • value1

    The first OracleBinary.

  • value2

    The second OracleBinary.

Return Value

Returns true if they are the same; otherwise returns false.

Remarks

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.

operator >

This method determines if the first of two OracleBinary values is greater than the second.

Declaration

// C#
public static bool operator > (OracleBinary value1, OracleBinary value2);

Parameters

  • value1

    The first OracleBinary.

  • value2

    The second OracleBinary.

Return Value

Returns true if the first of two OracleBinary values is greater than the second; otherwise, returns false.

Remarks

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.

Example

// 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");
  }
}

operator >=

This method determines if the first of two OracleBinary values is greater than or equal to the second.

Declaration

// C#
public static bool operator >= (OracleBinary value1, OracleBinary value2);

Parameters

  • value1

    The first OracleBinary.

  • value2

    The second OracleBinary.

Return Value

Returns true if the first of two OracleBinary values is greater than or equal to the second; otherwise, returns false.

Remarks

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.

operator !=

This method determines if two OracleBinary values are not equal.

Declaration

// C#
public static bool operator != (OracleBinary value1, OracleBinary value2);

Parameters

  • value1

    The first OracleBinary.

  • value2

    The second OracleBinary.

Return Value

Returns true if the two OracleBinary values are not equal; otherwise, returns false.

operator <

This method determines if the first of two OracleBinary values is less than the second.

Declaration

// C#
public static bool operator < ( OracleBinary value1, OracleBinary value2);

Parameters

  • value1

    The first OracleBinary.

  • value2

    The second OracleBinary.

Return Value

Returns true if the first of two OracleBinary values is less than the second; otherwise, returns false.

Remarks

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.

operator <=

This method determines if the first of two OracleBinary values is less than or equal to the second.

Declaration

// C#
public static bool operator <= (OracleBinary value1, OracleBinary value1);

Parameters

  • value1

    The first OracleBinary.

  • value2

    The second OracleBinary.

Return Value

Returns true if the first of two OracleBinary values is less than or equal to the second; otherwise, returns false.

Remarks

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.


OracleBinary Static Type Conversion Operators

The OracleBinary static type conversion operators are listed in Table 14-11.

Table 14-11 OracleBinary Static Type Conversion Operators

Operator Description

explicit operator byte[ ]

Converts an instance value to a byte array

implicit operator OracleBinary

Converts an instance value to an OracleBinary structure


explicit operator byte[ ]

This method converts an OracleBinary value to a byte array.

Declaration

// C#
public static explicit operator byte[ ] (OracleBinary val);

Parameters

  • val

    An OracleBinary.

Return Value

A byte array.

Exceptions

OracleNullValueException - The OracleBinary structure has a null value.

implicit operator OracleBinary

This method converts a byte array to an OracleBinary structure.

Declaration

// C#
public static implicit operator OracleBinary(byte[ ] bytes);

Parameters

  • bytes

    A byte array.

Return Value

OracleBinary


OracleBinary Properties

The OracleBinary properties are listed in Table 14-12.

Table 14-12 OracleBinary Properties

Properties Description

IsNull

Indicates whether or not the current instance has a null value

Item

Obtains the particular byte in an OracleBinary structure using an index

Length

Returns the length of the binary data

Value

Returns the binary data that is stored in an OracleBinary structure


IsNull

This property indicates whether or not the current instance has a null value.

Declaration

// C#
public bool IsNull {get;}

Property Value

Returns true if the current instance has a null value; otherwise returns false.

Item

This property obtains the particular byte in an OracleBinary structure using an index.

Declaration

// C#
public byte this[int index] {get;}

Property Value

A byte in the specified index.

Exceptions

OracleNullValueException - The current instance has a null value.

Example

// 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]); 
  }
}

Length

This property returns the length of the binary data.

Declaration

// C#
public int length {get;}

Property Value

Length of the binary data.

Exceptions

OracleNullValueException - The current instance has a null value.

Example

// 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);
  }
}

Value

This property returns the binary data that is stored in the OracleBinary structure.

Declaration

// C#
public byte[] Value {get;}

Property Value

Binary data.

Exceptions

OracleNullValueException - The current instance has a null value.


OracleBinary Instance Methods

The OracleBinary instance methods are listed in Table 14-13.

Table 14-13 OracleBinary Instance Methods

Methods Description

CompareTo

Compares the current instance to an object and returns an integer that represents their relative values

Equals

Determines if two objects contain the same binary data (Overloaded)

GetHashCode

Returns a hash code for the current instance

GetType

Inherited from System.Object

ToString

Converts the current OracleBinary structure to a string


CompareTo

This method compares the current instance to an object and returns an integer that represents their relative values

Declaration

// C#
public int CompareTo(object obj);

Parameters

  • obj

    The object being compared.

Return Value

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.

Implements

IComparable

Exceptions

ArgumentException - The parameter is not of type OracleBinary.

Remarks

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.

Example

// 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");      
  }
}

Equals

This method determines whether or not an object is an instance of OracleBinary, and has the same binary data as the current instance.

Declaration

// C#
public override bool Equals(object obj);

Parameters

  • obj

    The object being compared.

Return Value

Returns true if obj is an instance of OracleBinary, and has the same binary data as the current instance; otherwise, returns false.

Remarks

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.

GetHashCode

Overrides Object

This method returns a hash code for the OracleBinary instance.

Declaration

// C#
public override int GetHashCode();

Return Value

An int that represents the hash.

ToString

Overrides Object

This method converts an OracleBinary instance to a string instance.

Declaration

// C#
public override string ToString();

Return Value

string

Remarks

If the current OracleBinary instance has a null value, the returned string "null".