ODP.NET Type Structures

This section covers the ODP.NET Type structures.

• OracleBinary Structure

• OracleDate Structure

• OracleDecimal Structure

• OracleIntervalDS Structure

• OracleIntervalYM Structure

• OracleString Structure

• OracleTimeStamp Structure

• OracleTimeStampLTZ Structure

• OracleTimeStampTZ Structure

---

OracleBinary Structure

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

Class Inheritance

Object

  ValueType

    OracleBinary

Declaration

// C#
public struct OracleBinary : IComparable

Thread Safety

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

Example

// C#
// Concatenation of the OracleBinary values using + operator
OracleBinary ob1a = new OracleBinary(new byte[] {1,2,3});
OracleBinary ob1b = new OracleBinary(new byte[] {4});
OracleBinary ob1 = ob1a + ob1b;
OracleBinary ob2 = new OracleBinary(new byte[] {1,2,3,4});
// Output the length if ob1 is equal to ob2
if (ob1 == ob2)
    Console.WriteLine("The OracleBinary structures are equal with length " 
         + ob1.Length);

Requirements

Namespace: Oracle.DataAccess.Types

Assembly: Oracle.DataAccess.dll

OracleBinary Members

OracleBinary members are listed in the following tables:

OracleBinary Constructors

OracleBinary constructors are listed in Table 5-1

OracleBinary Static Fields

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

OracleBinary Static Methods

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

OracleBinary Static Operators

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

OracleBinary Static Type Conversion Operators

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

OracleBinary Properties

The OracleBinary properties are listed in Table 5-6.

OracleBinary Instance Methods

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

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.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleBinary Structure OracleBinary Members

  
  

OracleBinary Static Fields

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

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 5-9.

Concat

This method returns the concatenation of two OracleBinary structures.

Declaration

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

Parameters

• value1

  First OracleBinary.

• value2

  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

  First OracleBinary.

• value2

  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.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleBinary Structure OracleBinary Members

  
  

GreaterThan

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

Declaration

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

Parameters

• value1

  First OracleBinary.

• value2

  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#
OracleBinary ob1 = OracleBinary.Null;
OracleBinary ob2 = new OracleBinary(new byte[] {1});
if (OracleBinary.GreaterThan(ob2,ob1))
  Console.WriteLine("ob2 > ob1");

GreaterThanOrEqual

This method determines whether 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

  First OracleBinary.

• value2

  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.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleBinary Structure OracleBinary Members

  
  

LessThan

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

Declaration

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

Parameters

• value1

  First OracleBinary.

• value2

  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.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleBinary Structure OracleBinary Members

  
  

LessThanOrEqual

This method determines whether 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

  First OracleBinary.

• value2

  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.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleBinary Structure OracleBinary Members

  
  

NotEquals

This method determines whether two OracleBinary values are not equal.

Declaration

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

Parameters

• value1

  First OracleBinary.

• value2

  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.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleBinary Structure OracleBinary Members

  
  

OracleBinary Static Operators

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

operator +

This method concatenates two OracleBinary values.

Declaration

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

Parameters

• value1

  First OracleBinary.

• value2

  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

  First OracleBinary.

• value2

  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.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleBinary Structure OracleBinary Members

  
  

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

  First OracleBinary.

• value2

  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#
OracleBinary ob1 = OracleBinary.Null;
OracleBinary ob2 = new OracleBinary(new byte[] {1});
if (ob2 > ob1)
  Console.WriteLine("ob2 > ob1");

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

  First OracleBinary.

• value2

  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.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleBinary Structure OracleBinary Members

  
  

operator !=

This method determines if two OracleBinary values are not equal.

Declaration

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

Parameters

• value1

  First OracleBinary.

• value2

  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

  First OracleBinary.

• value2

  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.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleBinary Structure OracleBinary Members

  
  

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

  First OracleBinary.

• value2

  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.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleBinary Structure OracleBinary Members

  
  

OracleBinary Static Type Conversion Operators

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

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 5-12.

IsNull

This property indicates whether 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#
OracleBinary ob1 = new OracleBinary(new byte[] {4,3,2,1});
Console.WriteLine(ob1[ob1.Length-1]); // Prints the value 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#
OracleBinary ob1 = new OracleBinary(new byte[] {4,3,2,1});
Console.WriteLine(ob1.Length); // Prints the value 4

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 5-13.

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#
OracleBinary ob1 = new OracleBinary(new byte[] {1,1,1,1});
OracleBinary ob2 = new OracleBinary(new byte[] {1});

// append to ob2 while they are not equal
while (ob1.CompareTo(ob2) != 0)
   ob2 = ob2 + ob2;
Console.WriteLine("ob1 == ob2");

Equals

This method determines whether 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.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleBinary Structure OracleBinary Members

  
  

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".

---

OracleDate Structure

The OracleDate structure represents the Oracle DATE datatype to be stored in or retrieved from a database. Each OracleDate stores the following information: year, month, day, hour, minute, and second.

Class Inheritance

Object

  ValueType

    OracleDate

Declaration

// C#
public struct OracleDate : IComparable

Thread Safety

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

Example

// C#
// Compute the number of days between minimum values of
// the OracleDate and DateTime structures
OracleDate od1 = new OracleDate(DateTime.MinValue);
OracleDate od2 = OracleDate.MinValue;

// Set the nls_date_format for the ToString()
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.DateFormat = "DD-MON-YYYY BC";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine("DateTime.MinValue   = " + od1.ToString());
Console.WriteLine("OracleDate.MinValue = " + od2.ToString());

// Compare the two values
int result = od1.CompareTo(od2);

// Output the difference in number of days (as a positive value)
if (result == 0)
  Console.WriteLine("DateTime and OracleDate Minimum values"+
    " are equal.");
else if (result < 0)
  Console.WriteLine("DateTime Minimum value is before OracleDate" +
    " Minumum value by " + od2.GetDaysBetween(od1) + " days.");
else if (result > 0)
  Console.WriteLine("OracleDate Minimum value is before DateTime" +
    " Minumum value by " + od1.GetDaysBetween(od2) + " days.");

Requirements

Namespace: Oracle.DataAccess.Types

Assembly: Oracle.DataAccess.dll

OracleDate Members

OracleDate members are listed in the following tables:

OracleDate Constructors

OracleDate constructors are listed in Table 5-14

OracleDate Static Fields

The OracleDate static fields are listed in Table 5-15.

OracleDate Static Methods

The OracleDate static methods are listed in Table 5-16.

OracleDate Static Operators

The OracleDate static operators are listed in Table 5-17.

OracleDate Static Type Conversions

The OracleDate static type conversions are listed in Table 5-18.

OracleDate Properties

The OracleDate properties are listed in Table 5-19.

OracleDate Methods

The OracleDate methods are listed in Table 5-20.

OracleDate Constructors

The OracleDate constructors instantiates a new instance of the OracleDate structure.

Overload List:

• OracleDate(DateTime)

  This constructor creates a new instance of the OracleDate structure and sets its value for date and time using the supplied DateTime value.

• OracleDate(string)

  This constructor creates a new instance of the OracleDate structure and sets its value using the supplied string.

• OracleDate(int, int, int)

  This constructor creates a new instance of the OracleDate structure and set its value for date using the supplied year, month, and day.

• OracleDate(int, int, int, int, int, int)

  This constructor creates a new instance of the OracleDate structure and set its value for time using the supplied year, month, day, hour, minute, and second.

• OracleDate(byte [ ])

  This constructor creates a new instance of the OracleDate structure and sets its value to the provided byte array, which is in the internal Oracle DATE format.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDate Structure OracleDate Members

  
  

OracleDate(DateTime)

This constructor creates a new instance of the OracleDate structure and sets its value for date and time using the supplied DateTime value.

Declaration

// C#
public OracleDate (DateTime dt);

Parameters

• dt

  The provided DateTime value.

Remarks

The OracleDate structure only supports up to a second precision. The time value in the provided DateTime structure that has a precision smaller than second is ignored.

OracleDate(string)

This constructor creates a new instance of the OracleDate structure and sets its value using the supplied string.

Declaration

// C#
public OracleDate (string dateStr);

Parameters

• dateStr

  A string that represents an Oracle DATE.

Exceptions

ArgumentException - The dateStr is an invalid string representation of an Oracle DATE or the dateStr is not in the date format specified by the thread's OracleGlobalization.DateFormat property, which represents Oracle's NLS_DATE_FORMAT parameter.

ArgumentNullException - The dateStr is null.

Remarks

The names and abbreviations used for months and days are in the language specified by the DateLanguage and Calendar properties of the thread's OracleGlobalization object. If any of the thread's globalization properties are set to null or an empty string, the client computer's settings are used.

Example

// C#
// Set the nls_date_format for the Parse() method
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.DateFormat = "YYYY-MON-DD";
OracleGlobalization.SetThreadInfo(og);

// construct OracleDate from a string using the DateFormat specified.
OracleDate od = new OracleDate("1999-NOV-11");

// Set the nls_date_format for the OracleDate(string) constructor
og.DateFormat = "DD-MON-YYYY";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine(od.ToString()); // Prints 11-NOV-1999

OracleDate(int, int, int)

This constructor creates a new instance of the OracleDate structure and set its value for date using the supplied year, month, and day.

Declaration

// C#
public OracleDate (int year, int month, int day);

Parameters

• year

  The supplied year. Range of year is (-4712 to 9999).

• month

  The supplied month. Range of month is (1 to 12).

• day

  The supplied day. Range of day is (1 to 31).

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleDate (that is, the day is out of range for the month).

OracleDate(int, int, int, int, int, int)

This constructor creates a new instance of the OracleDate structure and set its value for time using the supplied year, month, day, hour, minute, and second.

Declaration

// C#
public OracleDate (int year, int month, int day, int hour, int minute, int second);

Parameters

• year

  The supplied year. Range of year is (-4712 to 9999).

• month

  The supplied month. Range of month is (1 to 12).

• day

  The supplied day. Range of day is (1 to 31).

• hour

  The supplied hour. Range of hour is (0 to 23).

• minute

  The supplied minute. Range of minute is (0 to 59).

• second

  The supplied second. Range of second is (0 to 59).

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleDate (that is, the day is out of range for the month).

OracleDate(byte [ ])

This constructor creates a new instance of the OracleDate structure and sets its value to the provided byte array, which is in the internal Oracle DATE format.

Declaration

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

Parameters

• bytes

  A byte array that represents Oracle DATE in the internal Oracle DATE format.

Exceptions

ArgumentException - bytes is null or bytes is not in internal Oracle DATE format or bytes is not a valid Oracle DATE.

OracleDate Static Fields

The OracleDate static fields are listed in Table 5-21.

MaxValue

This static field represents the maximum valid date for an OracleDate structure, which is December 31, 9999 23:59:59.

Declaration

// C#
public static readonly OracleDate MaxValue;

MinValue

This static field represents the minimum valid date for an OracleDate structure, which is January 1, -4712.

Declaration

// C#
public static readonly OracleDate MinValue;

Null

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

Declaration

// C#
public static readonly OracleDate Null;

OracleDate Static Methods

The OracleDate static methods are listed in Table 5-22.

Equals

Overloads Object

This method determines if two OracleDate values are equal.

Declaration

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

Parameters

• value1

  First OracleDate.

• value2

  Second OracleDate.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDate that has a value compares greater than an OracleDate that has a null value.

• Two OracleDates that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDate Structure OracleDate Members

  
  

GreaterThan

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

Declaration

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

Parameters

• value1

  First OracleDate.

• value2

  Second OracleDate.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDate that has a value compares greater than an OracleDate that has a null value.

• Two OracleDates that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDate Structure OracleDate Members

  
  

GreaterThanOrEqual

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

Declaration

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

Parameters

• value1

  First OracleDate.

• value2

  Second OracleDate.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDate that has a value compares greater than an OracleDate that has a null value.

• Two OracleDates that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDate Structure OracleDate Members

  
  

LessThan

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

Declaration

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

Parameters

• value1

  First OracleDate.

• value2

  Second OracleDate.

Return Value

Returns true if the first of two OracleDate values is less than the second. Otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleDate that has a value compares greater than an OracleDate that has a null value.

• Two OracleDates that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDate Structure OracleDate Members

  
  

LessThanOrEqual

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

Declaration

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

Parameters

• value1

  First OracleDate.

• value2

  Second OracleDate.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDate that has a value compares greater than an OracleDate that has a null value.

• Two OracleDates that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDate Structure OracleDate Members

  
  

NotEquals

This method determines if two OracleDate values are not equal.

Declaration

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

Parameters

• value1

  First OracleDate.

• value2

  Second OracleDate.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDate that has a value compares greater than an OracleDate that has a null value.

• Two OracleDates that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDate Structure OracleDate Members

  
  

GetSysDate

This method gets an OracleDate structure that represents the current date and time.

Declaration

// C#
public static OracleDate GetSysDate ();

Return Value

An OracleDate structure that represents the current date and time.

Parse

This method gets an OracleDate structure and sets its value for date and time using the supplied string.

Declaration

// C#
public static OracleDate Parse (string dateStr);

Parameters

• dateStr

  A string that represents an Oracle DATE.

Return Value

An OracleDate structure.

Exceptions

ArgumentException - The dateStr is an invalid string representation of an Oracle DATE or the dateStr is not in the date format specified by the thread's OracleGlobalization.DateFormat property, which represents Oracle's NLS_DATE_FORMAT parameter.

ArgumentNullException - The dateStr is null.

Remarks

The names and abbreviations used for months and days are in the language specified by the DateLanguage and Calendar properties of the thread's OracleGlobalization object. If any of the thread's globalization properties are set to null or an empty string, the client computer's settings are used.

Example

// C#
// Set the nls_date_format for the Parse() method
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.DateFormat = "YYYY-MON-DD";
OracleGlobalization.SetThreadInfo(og);

// construct OracleDate from a string using the DateFormat specified.
OracleDate od = OracleDate.Parse("1999-NOV-11");

// Set the nls_date_format for the ToString() method
og.DateFormat = "DD-MON-YYYY";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine(od.ToString()); // Prints 11-NOV-1999

OracleDate Static Operators

The OracleDate static operators are listed in Table 5-23.

operator ==

This method determines if two OracleDate values are the same.

Declaration

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

Parameters

• value1

  First OracleDate.

• value2

  Second OracleDate.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDate that has a value compares greater than an OracleDate that has a null value.

• Two OracleDates that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDate Structure OracleDate Members

  
  

operator >

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

Declaration

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

Parameters

• value1

  First OracleDate.

• value2

  Second OracleDate.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDate that has a value compares greater than an OracleDate that has a null value.

• Two OracleDates that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDate Structure OracleDate Members

  
  

operator >=

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

Declaration

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

Parameters

• value1

  First OracleDate.

• value2

  Second OracleDate.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDate that has a value compares greater than an OracleDate that has a null value.

• Two OracleDates that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDate Structure OracleDate Members

  
  

operator !=

This method determines if the two OracleDate values are not equal.

Declaration

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

Parameters

• value1

  First OracleDate.

• value2

  Second OracleDate.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDate that has a value compares greater than an OracleDate that has a null value.

• Two OracleDates that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDate Structure OracleDate Members

  
  

operator <

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

Declaration

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

Parameters

• value1

  First OracleDate.

• value2

  Second OracleDate.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDate that has a value compares greater than an OracleDate that has a null value.

• Two OracleDates that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDate Structure OracleDate Members

  
  

operator <=

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

Declaration

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

Parameters

• value1

  First OracleDate.

• value2

  Second OracleDate.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDate that has a value compares greater than an OracleDate that has a null value.

• Two OracleDates that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDate Structure OracleDate Members

  
  

OracleDate Static Type Conversions

The OracleDate static type conversions are listed in Table 5-24.

explicit operator DateTime

This method converts an OracleDate structure to a DateTime structure.

Declaration

// C#
public static explicit operator DateTime(OracleDate val);

Parameters

• val

  An OracleDate structure.

Return Value

A DateTime structure.

explicit operator OracleDate

explicit operator OracleDate converts the provided structure to a OracleDate structure.

Overload List:

• explicit operator OracleDate(DateTime)

  This method converts a DateTime structure to an OracleDate structure.

• explicit operator OracleDate(OracleTimeStamp)

  This method converts an OracleTimeStamp structure to an OracleDate structure.

• explicit operator OracleDate(string)

  This method converts the supplied string to an OracleDate structure.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDate Structure OracleDate Members

  
  

explicit operator OracleDate(DateTime)

This method converts a DateTime structure to an OracleDate structure.

Declaration

// C#
public static explicit operator OracleDate(DateTime dt);

Parameters

• dt

  A DateTime structure.

Return Value

An OracleDate structure.

explicit operator OracleDate(OracleTimeStamp)

This method converts an OracleTimeStamp structure to an OracleDate structure.

Declaration

// C#
public explicit operator OracleDate(OracleTimeStamp ts);

Parameters

• ts

  OracleTimeStamp

Return Value

The returned OracleDate structure contains the date and time in the OracleTimeStamp structure.

Remarks

The precision of the OracleTimeStamp value can be lost during the conversion.

If the OracleTimeStamp structure has a null value, the returned OracleDate structure also has a null value.

explicit operator OracleDate(string)

This method converts the supplied string to an OracleDate structure.

Declaration

// C#
public explicit operator OracleDate (string dateStr);

Parameters

• dateStr

  A string representation of an Oracle DATE.

Return Value

The returned OracleDate structure contains the date and time in the string dateStr.

Exceptions

ArgumentNullException - The dateStr is null.

ArgumentException - This exception is thrown if any of the following conditions exist:

• The dateStr is an invalid string representation of an Oracle DATE.

• The dateStr is not in the date format specified by the thread's OracleGlobalization.DateFormat property, which represents Oracle's NLS_DATE_FORMAT parameter.

Remarks

The names and abbreviations used for months and days are in the language specified by the DateLanguage and Calendar properties of the thread's OracleGlobalization object. If any of the thread's globalization properties are set to null or an empty string, the client computer's settings are used.

Example

// C#
// Set the nls_date_format for the Parse() method
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.DateFormat = "YYYY-MON-DD";
OracleGlobalization.SetThreadInfo(og);

// construct OracleDate from a string using the DateFormat specified.
OracleDate od = (OracleDate) "1999-NOV-11";

// Set the nls_date_format for the ToString() method
og.DateFormat = "DD-MON-YYYY";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine(od.ToString()); // Prints 11-NOV-1999

OracleDate Properties

The OracleDate properties are listed in Table 5-25.

BinData

This property gets a array of bytes that represents an Oracle DATE in Oracle internal format.

Declaration

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

Property Value

An array of bytes.

Exceptions

OracleNullValueException - OracleDate has a null value.

Day

This property gets the day component of an OracleDate.

Declaration

// C#
public int Day{get;}

Property Value

A number that represents the day. Range of Day is (1 to 31).

Exceptions

OracleNullValueException - OracleDate has a null value.

IsNull

This property indicates whether 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.

Hour

This property gets the hour component of an OracleDate.

Declaration

// C#
public int Hour {get;}

Property Value

A number that represents Hour. Range of Hour is (0 to 23).

Exceptions

OracleNullValueException - OracleDate has a null value.

Minute

This property gets the minute component of an OracleDate.

Declaration

// C#
public int Minute {get;}

Property Value

A number that represents Minute. Range of Minute is (0 to 59).

Exceptions

OracleNullValueException - OracleDate has a null value.

Month

This property gets the month component of an OracleDate.

Declaration

// C#
public int Month {get;}

Property Value

A number that represents Month. Range of Month is (1 to 12).

Exceptions

OracleNullValueException - OracleDate has a null value.

Second

This property gets the second component of an OracleDate.

Declaration

// C#
public int Second {get;}

Property Value

A number that represents Second. Range of Second is (0 to 59).

Exceptions

OracleNullValueException - OracleDate has a null value.

Value

This property specifies the date and time that is stored in the OracleDate structure.

Declaration

// C#
public DateTime Value {get;}

Property Value

A DateTime.

Exceptions

OracleNullValueException - OracleDate has a null value.

Year

This property gets the year component of an OracleDate.

Declaration

// C#
public int Year {get;}

Property Value

A number that represents Year. Range of Year is (-4712 to 9999).

Exceptions

OracleNullValueException - OracleDate has a null value.

OracleDate Methods

The OracleDate methods are listed in Table 5-26.

CompareTo

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

Declaration

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

Parameters

• obj

  An object.

Return Value

The method returns:

• Less than zero: if the current OracleDate instance value is less than that of obj.

• Zero: if the current OracleDate instance and obj values are equal.

• Greater than zero: if the current OracleDate instance value is greater than obj.

Implements

IComparable

Exceptions

ArgumentException - The obj parameter is not an instance of OracleDate.

Remarks

The following rules apply to the behavior of this method.

• The comparison must be between OracleDates. For example, comparing an OracleDate instance with an OracleBinary instance is not allowed. When an OracleDate is compared with a different type, an ArgumentException is thrown.

• Any OracleDate that has a value compares greater than an OracleDate that has a null value.

• Two OracleDates that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDate Structure OracleDate Members

  
  

Equals

This method determines whether an object has the same date and time as the current OracleDate instance.

Declaration

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

Parameters

• obj

  An object.

Return Value

Returns true if obj has the same type as the current instance and represents the same date and time; otherwise returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleDate that has a value compares greater than an OracleDate that has a null value.

• Two OracleDates that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDate Structure OracleDate Members

  
  

GetHashCode

Overrides Object

This method returns a hash code for the OracleDate instance.

Declaration

// C#
public override int GetHashCode();

Return Value

A number that represents the hash code.

GetDaysBetween

This method calculates the number of days between the current OracleDate instance and the supplied OracleDate structure.

Declaration

// C#
public int GetDaysBetween (OracleDate val);

Parameters

• val

  An OracleDate structure.

Return Value

The number of days between the current OracleDate instance and the OracleDate structure.

Exceptions

OracleNullValueException - The current instance or the supplied OracleDate structure has a null value.

ToOracleTimeStamp

This method converts the current OracleDate structure to an OracleTimeStamp structure.

Declaration

// C#
public OracleTimeStamp ToOracleTimeStamp();

Return Value

An OracleTimeStamp structure.

Remarks

The returned OracleTimeStamp structure has date and time in the current instance.

If the OracleDate instance has a null value, the returned OracleTimeStamp structure has a null value.

ToString

Overrides ValueType

This method converts the current OracleDate structure to a string.

Declaration

// C#
public override string ToString();

Return Value

A string.

Remarks

The returned value is a string representation of the OracleDate in the format specified by the thread's OracleGlobalization.DateFormat property. The names and abbreviations used for months and days are in the language specified by the thread's OracleGlobalization.DateLanguage and OracleGlobalization.Calendar properties. If any of the thread's globalization properties are set to null or an empty string, the client computer's settings are used.

Example

// C#
// Set the nls_date_format for the Parse() method
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.DateFormat = "YYYY-MON-DD";
OracleGlobalization.SetThreadInfo(og);

// construct OracleDate from a string using the DateFormat specified.
OracleDate od = new OracleDate("1999-NOV-11");

// Set the nls_date_format for the ToString() method
og.DateFormat = "DD-MON-YYYY";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine(od.ToString()); // Prints 11-NOV-1999

---

OracleDecimal Structure

The OracleDecimal structure represents an Oracle NUMBER in the database or any Oracle numeric value.

Class Inheritance

Object

  ValueType

    OracleDecimal

Declaration

// C#
public struct OracleDecimal : IComparable

Thread Safety

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

Remarks

OracleDecimal can store up to 38 precision, while the .NET Decimal datatype can only hold up to 28 precision. When accessing the OracleDecimal.Value property from an OracleDecimal that has a value greater than 28 precision, loss of precision can occur. To retrieve the actual value of OracleDecimal, use the OracleDecimal.ToString() method. Another approach is to obtain the OracleDecimal value as a byte array in an internal Oracle NUMBER format through the BinData property.

Example

// C#
// Illustrates the usage of OracleDecimal
OracleDecimal pi = OracleDecimal.Pi;
// Use of implicit operator OracleDecimal(int)
OracleDecimal approxPi = OracleDecimal.Divide(22,7);

// Round the difference to 5 decimal places
OracleDecimal diff=OracleDecimal.Round(OracleDecimal.Abs(pi -approxPi),5);

// Set the format for ToString() - display with trailing zeroes
diff.Format = "9.9999900";
Console.WriteLine(diff.ToString());

Requirements

Namespace: Oracle.DataAccess.Types

Assembly: Oracle.DataAccess.dll

OracleDecimal Members

OracleDecimal members are listed in the following tables:

OracleDecimal Constructors

OracleDecimal constructors are listed in Table 5-27

OracleDecimal Static Fields

The OracleDecimal static fields are listed in Table 5-28.

OracleDecimal Static (Comparison) Methods

The OracleDecimal static (comparison) methods are listed in Table 5-29.

OracleDecimal Static (Manipulation) Methods

The OracleDecimal static (manipulation) methods are listed in Table 5-30.

OracleDecimal Static (Logarithmic) Methods

The OracleDecimal static (logarithmic) methods are listed in Table 5-31.

OracleDecimal Static (Trigonometric) Methods

The OracleDecimal static (trigonometric) methods are listed in Table 5-32.

OracleDecimal Static (Comparison) Operators

The OracleDecimal static (comparison) operators are listed in Table 5-33.

OracleDecimal Static Operators (Conversion from .NET Type to OracleDecimal)

The OracleDecimal static operators (Conversion from .NET Type to OracleDecimal) are listed in Table 5-34.

OracleDecimal Static Operators (Conversion from OracleDecimal to .NET)

The OracleDecimal static operators (Conversion from OracleDecimal to .NET) are listed in Table 5-35.

OracleDecimal Properties

The OracleDecimal properties are listed in Table 5-36.

OracleDecimal Instance Methods

The OracleDecimal instance methods are listed in Table 5-37.

OracleDecimal Constructors

The OracleDecimal constructors instantiate a new instance of the OracleDecimal structure.

Overload List:

• OracleDecimal(byte [ ])

  This constructor creates a new instance of the OracleDecimal structure and sets its value to the supplied byte array, which is in an Oracle NUMBER format.

• OracleDecimal(decimal)

  This constructor creates a new instance of the OracleDecimal structure and sets its value to the supplied Decimal value.

• OracleDecimal(double)

  This constructor creates a new instance of the OracleDecimal structure and sets its value to the supplied double value.

• OracleDecimal(int)

  This constructor creates a new instance of the OracleDecimal structure and sets its value to the supplied Int32 value.

• OracleDecimal(float)

  This constructor creates a new instance of the OracleDecimal structure and sets its value to the supplied Single value.

• OracleDecimal(long)

  This constructor creates a new instance of the OracleDecimal structure and sets its value to the supplied Int64 value.

• OracleDecimal(string)

  This constructor creates a new instance of the OracleDecimal structure and sets its value to the supplied string value.

• OracleDecimal(string, string)

  This constructor creates a new instance of the OracleDecimal structure with the supplied string value and number format.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

OracleDecimal(byte [ ])

This constructor creates a new instance of the OracleDecimal structure and sets its value to the supplied byte array, which is in an Oracle NUMBER format.

Declaration

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

Parameters

• bytes

  A byte array that represents an Oracle NUMBER in an internal Oracle format.

Exceptions

ArgumentException - The bytes parameter is not in a internal Oracle NUMBER format or bytes has an invalid value.

ArgumentNullException - The bytes parameter is null.

OracleDecimal(decimal)

This constructor creates a new instance of the OracleDecimal structure and sets its value to the supplied Decimal value.

Declaration

// C#
public OracleDecimal(decimal decX); 

Parameters

• decX

  The provided Decimal value.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

OracleDecimal(double)

This constructor creates a new instance of the OracleDecimal structure and sets its value to the supplied double value.

Declaration

// C#
public OracleDecimal(double doubleX)

Parameters

• doubleX

  The provided double value.

Exceptions

OverFlowException - The value of the supplied double is greater than the maximum value or less than the minimum value of OracleDecimal.

Remarks

OracleDecimal contains the following values depending on the provided double value:

• double.PositiveInfinity: positive infinity value

• double.NegativeInfinity: negative infinity value.

• double.NaN: null value

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

OracleDecimal(int)

This constructor creates a new instance of the OracleDecimal structure and sets its value to the supplied Int32 value.

Declaration

// C#
public OracleDecimal(int intX);

Parameters

• intX

  The provided Int32 value.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

OracleDecimal(float)

This constructor creates a new instance of the OracleDecimal structure and sets its value to the supplied Single value.

Declaration

// C#
public OracleDecimal(float floatX);

Parameters

• floatX

  The provided float value.

Remarks

OracleDecimal contains the following values depending on the provided float value:

float.PositiveInfinity: positive infinity value

float.NegativeInfinity: negative infinity value

float.NaN: null value

OracleDecimal(long)

This constructor creates a new instance of the OracleDecimal structure and sets its value to the supplied Int64 value.

Declaration

// C#
public OracleDecimal(long longX);

Parameters

• longX

  The provided Int64 value.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

OracleDecimal(string)

This constructor creates a new instance of the OracleDecimal structure and sets its value to the supplied string value.

Declaration

// C#
public OracleDecimal(string numStr);

Parameters

• numStr

  The provided string value.

Exceptions

ArgumentException - The numStr parameter is an invalid string representation of an OracleDecimal.

ArgumentNullException - The numStr parameter is null.

OverFlowException - The value of numStr is greater than the maximum value or less than the minimum value of OracleDecimal.

OracleDecimal(string, string)

This constructor creates a new instance of the OracleDecimal structure with the supplied string value and number format.

Declaration

// C#
public OracleDecimal(string numStr, string format);

Parameters

• numStr

  The provided string value.

• format

  The provided number format.

Exceptions

ArgumentException - The numStr parameter is an invalid string representation of an OracleDecimal or the numStr is not in the numeric format specified by format.

ArgumentNullException - The numStr parameter is null.

OverFlowException - The value of numStr parameter is greater than the maximum value or less than the minimum value of OracleDecimal.

Remarks

If the numeric format includes decimal and group separators, then the provided string must use those characters defined by the OracleGlobalization.NumericCharacters of the thread.

If the numeric format includes the currency symbol, ISO currency symbol, or the dual currency symbol, then the provided string must use those symbols defined by the OracleGlobalization.Currency, OracleGlobalization.ISOCurrency, and OracleGlobalization.DualCurrency properties respectively.

Example

// C#
// Set the nls parameters to be used in the numeric format
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.Currency = "$";
og.NumericCharacters = ".,";
OracleGlobalization.SetThreadInfo(og);

// Construct an OracleDecimal using a valid numeric format
OracleDecimal od = new OracleDecimal("$2,222.22","L9G999D99");
Console.WriteLine(od.ToString()); // Prints $2,222.22

OracleDecimal Static Fields

The OracleDecimal static fields are listed in Table 5-38.

MaxPrecision

This static field represents the maximum precision, which is 38.

Declaration

// C#
public static readonly byte MaxPrecision;

MaxScale

This static field a constant representing the maximum scale, which is 127.

Declaration

// C#
public static readonly byte MaxScale;

MaxValue

This static field indicates a constant representing the maximum value for this structure, which is 9.9…9 x 10¹²⁵ (38 nines followed by 88 zeroes).

Declaration

// C#
public static readonly OracleDecimal MaxValue;

MinScale

This static field indicates a constant representing the maximum scale, which is -84.

Declaration

// C#
public static readonly int MinScale;

MinValue

This static field indicates a constant representing the minimum value for this structure, which is -1.0 x 10¹³⁰.

Declaration

// C#
public static readonly OracleDecimal MinValue;

NegativeOne

This static field indicates a constant representing the negative one value.

Declaration

// C#
public static readonly OracleDecimal NegativeOne;

Null

This static field represents a null value that can be assigned to an OracleDecimal instance.

Declaration

// C#
public static readonly OracleDecimal Null;

One

This static field indicates a constant representing the positive one value.

Declaration

// C#
public static readonly OracleDecimal One;

Pi

This static field indicates a constant representing the numeric Pi value.

Declaration

// C#
public static readonly OracleDecimal Pi;

Zero

This static field indicates a constant representing the zero value.

Declaration

// C#
public static readonly OracleDecimal Zero;

OracleDecimal Static (Comparison) Methods

The OracleDecimal static (comparison) methods are listed in Table 5-39.

Equals

This method determines if two OracleDecimal values are equal.

Declaration

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

Parameters

• value1

  First OracleDecimal.

• value2

  Second OracleDecimal.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDecimal that has a value compares greater than an OracleDecimal that has a null value.

• Two OracleDecimals that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

GreaterThan

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

Declaration

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

Parameters

• value1

  First OracleDecimal.

• value2

  Second OracleDecimal.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDecimal that has a value compares greater than an OracleDecimal that has a null value.

• Two OracleDecimals that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

GreaterThanOrEqual

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

Declaration

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

Parameters

• value1

  First OracleDecimal.

• value2

  Second OracleDecimal.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDecimal that has a value compares greater than an OracleDecimal that has a null value.

• Two OracleDecimals that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

LessThan

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

Declaration

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

Parameters

• value1

  First OracleDecimal.

• value2

  Second OracleDecimal.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDecimal that has a value compares greater than an OracleDecimal that has a null value.

• Two OracleDecimals that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

LessThanOrEqual

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

Declaration

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

Parameters

• value1

  First OracleDecimal.

• value2

  Second OracleDecimal.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDecimal that has a value compares greater than an OracleDecimal that has a null value.

• Two OracleDecimals that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

NotEquals

This method determines if two OracleDecimal values are not equal.

Declaration

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

Parameters

• value1

  First OracleDecimal.

• value2

  Second OracleDecimal.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDecimal that has a value compares greater than an OracleDecimal that has a null value.

• Two OracleDecimals that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

OracleDecimal Static (Manipulation) Methods

The OracleDecimal static (manipulation) methods are listed in Table 5-40.

Abs

This method returns the absolute value of an OracleDecimal.

Declaration

// C#
public static OracleDecimal Abs(OracleDecimal val);

Parameters

• val

  An OracleDecimal.

Return Value

The absolute value of an OracleDecimal.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Add

This method adds two OracleDecimal structures.

Declaration

// C#
public static OracleDecimal Add(OracleDecimal val1, OracleDecimal val2);

Parameters

• val1

  First OracleDecimal.

• val2

  Second OracleDecimal.

Return Value

Returns an OracleDecimal structure.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

AdjustScale

This method returns a new OracleDecimal with the specified number of digits and indicates whether or not to round or truncate the number if the scale is less than the original.

Declaration

// C#
public static OracleDecimal AdjustScale(OracleDecimal val, int digits,
     bool fRound);

Parameters

• val

  An OracleDecimal.

• digits

  The number of digits.

• fRound

  Indicates whether to round or truncate the number. Setting it to true rounds the number and setting it to false truncates the number.

Return Value

An OracleDecimal.

Remarks

If the supplied OracleDecimal has a null value, the returned OracleDecimal has a null value.

Example

// C#
OracleDecimal od = new OracleDecimal(5.555); 
// Adjust Scale to 2 with rounding off
OracleDecimal odr = OracleDecimal.AdjustScale(od, 2, true);
Console.WriteLine(odr.ToString()); // Prints 5.56
// Adjust Scale to 2 with truncation
OracleDecimal odt = OracleDecimal.AdjustScale(od, 2, false);
Console.WriteLine(odt.ToString()); // Prints 5.55

Ceiling

This method returns a new OracleDecimal structure with its value set to the ceiling of the supplied OracleDecimal.

Declaration

// C#
public static OracleDecimal Ceiling(OracleDecimal val);

Parameters

• val

  An OracleDecimal.

Return Value

A new OracleDecimal structure.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

ConvertToPrecScale

This method returns a new OracleDecimal structure with a new precision and scale.

Declaration

// C#
public static OracleDecimal ConvertToPrecScale(OracleDecimal val, int precision, 
  int scale);

Parameters

• val

  An OracleDecimal structure.

• precision

  The precision. Range of precision is 1 to 38.

• scale

  The number of digits to the right of the decimal point. Range of scale is -84 to 127.

Return Value

A new OracleDecimal structure.

Remarks

If the supplied OracleDecimal has a null value, the returned OracleDecimal has a null value.

Example

// C#
OracleDecimal od = new OracleDecimal(555.6666);

// Set the precision of od to 5 and scale to 2
OracleDecimal odp5s2 = OracleDecimal.ConvertToPrecScale(od,5,2);
Console.WriteLine(odp5s2.ToString()); // Prints 555.67

// Set the precision of od to 3 and scale to 0
OracleDecimal odp3s0 = OracleDecimal.ConvertToPrecScale(od,3,0);
Console.WriteLine(odp3s0.ToString()); // Prints 556

Divide

This method divides one OracleDecimal value by another.

Declaration

// C#
public static OracleDecimal Divide(OracleDecimal val1, OracleDecimal val2);

Parameters

• val1

  An OracleDecimal.

• val2

  An OracleDecimal.

Return Value

A new OracleDecimal structure.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Floor

This method returns a new OracleDecimal structure with its value set to the floor of the supplied OracleDecimal structure.

Declaration

// C#
public static OracleDecimal Floor(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure.

Return Value

A new OracleDecimal structure.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Max

This method returns the maximum value of the two supplied OracleDecimal structures.

Declaration

// C#
public static OracleDecimal Max(OracleDecimal val1, OracleDecimal val2);

Parameters

• val1

  An OracleDecimal structure.

• val2

  An OracleDecimal structure.

Return Value

An OracleDecimal structure that has the greater value.

Min

This method returns the minimum value of the two supplied OracleDecimal structures.

Declaration

// C#
public static OracleDecimal Min(OracleDecimal val1, OracleDecimal val2);

Parameters

• val1

  An OracleDecimal structure.

• val2

  An OracleDecimal structure.

Return Value

An OracleDecimal structure that has the smaller value.

Mod

This method returns a new OracleDecimal structure with its value set to the modulus of two OracleDecimal structures.

Declaration

// C#
public static OracleDecimal Mod(OracleDecimal val1, OracleDecimal divider);

Parameters

• val1

  An OracleDecimal structure.

• divider

  An OracleDecimal structure.

Return Value

An OracleDecimal.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Multiply

This method returns a new OracleDecimal structure with its value set to the result of multiplying two OracleDecimal structures.

Declaration

// C#
public static OracleDecimal Multiply(OracleDecimal val1, OracleDecimal val2);

Parameters

• val1

  An OracleDecimal structure.

• val2

  An OracleDecimal structure.

Return Value

A new OracleDecimal structure.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Negate

This method returns a new OracleDecimal structure with its value set to the negation of the supplied OracleDecimal structures.

Declaration

// C#
public static OracleDecimal Negate(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure.

Return Value

A new OracleDecimal structure.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Parse

This method converts a string to an OracleDecimal.

Declaration

// C#
public static OracleDecimal Parse (string str);

Parameters

• str

  The string being converted.

Return Value

A new OracleDecimal structure.

Exceptions

ArgumentException - The numStr parameter is an invalid string representation of an OracleDecimal.

ArgumentNullException - The numStr parameter is null.

OverFlowException - The value of numStr is greater than the maximum value or less than the minimum value of OracleDecimal.

Round

This method returns a new OracleDecimal structure with its value set to that of the supplied OracleDecimal structure and rounded off to the specified place.

Declaration

// C#
public static OracleDecimal Round(OracleDecimal val, int decplace);

Parameters

• val

  An OracleDecimal structure.

• decplace

  The specified decimal place. If the value is positive, the function rounds the OracleDecimal structure to the right of the decimal point. If the value is negative, the function rounds to the left of the decimal point.

Return Value

An OracleDecimal structure.

Remarks

If the supplied OracleDecimal structure has a null value, the returned OracleDecimal has a null value.

SetPrecision

This method returns a new OracleDecimal structure with a new specified precision.

Declaration

// C#
public static OracleDecimal SetPrecision(OracleDecimal val, int precision);

Parameters

• val

  An OracleDecimal structure.

• precision

  The specified precision. Range of precision is 1 to 38.

Return Value

An OracleDecimal structure.

Remarks

The returned OracleDecimal is rounded off if the specified precision is smaller than the precision of val.

If val has a null value, the returned OracleDecimal has a null value.

Example

// C#
OracleDecimal od = new OracleDecimal(555.6666);

// Set the precision of od to 3
OracleDecimal odp3 = OracleDecimal.SetPrecision(od,3);
Console.WriteLine(odp3.ToString()); // Prints 556

// Set the precision of od to 4
OracleDecimal odp4 = OracleDecimal.SetPrecision(od,4);
Console.WriteLine(odp4.ToString()); // Prints 555.7

Shift

This method returns a new OracleDecimal structure with its value set to that of the supplied OracleDecimal structure, and its decimal place shifted to the specified number of places to the right.

Declaration

// C#
public static OracleDecimal Shift(OracleDecimal val, int decplaces);

Parameters

• val

  An OracleDecimal structure.

• decplaces

  The specified number of places to be shifted.

Return Value

An OracleDecimal structure.

Remarks

If the supplied OracleDecimal structure has a null value, the returned OracleDecimal has a null value.

If decplaces is negative, the shift is to the left.

Sign

This method determines the sign of an OracleDecimal structure.

Declaration

// C#
public static int Sign(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure.

Return Value

• -1: if the supplied OracleDecimal < 0

• 0: if the supplied OracleDecimal == 0

• 1: if the supplied OracleDecimal > 0

Exceptions

OracleNullValueException - The argument has a null value.

Sqrt

This method returns a new OracleDecimal structure with its value set to the square root of the supplied OracleDecimal structure.

Declaration

// C#
public static OracleDecimal Sqrt(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure.

Return Value

An OracleDecimal structure.

Exceptions

ArgumentOutOfRangeException - The provided OracleDecimal structure is less than zero.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Subtract

This method returns a new OracleDecimal structure with its value set to result of subtracting one OracleDecimal structure from another.

Declaration

// C#
public static OracleDecimal Subtract(OracleDecimal val1, OracleDecimal val2);

Parameters

• val1

  An OracleDecimal structure.

• val2

  An OracleDecimal structure.

Return Value

An OracleDecimal structure.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Truncate

This method truncates the OracleDecimal at a specified position.

Declaration

// C#
public static OracleDecimal Truncate(OracleDecimal val, int pos);

Parameters

• val

  An OracleDecimal structure.

• pos

  The specified position. If the value is positive, the function truncates the OracleDecimal structure to the right of the decimal point. If the value is negative, it truncates the OracleDecimal structure to the left of the decimal point.

Return Value

An OracleDecimal structure.

Remarks

If the supplied OracleDecimal structure has a null value, the returned OracleDecimal has a null value.

OracleDecimal Static (Logarithmic) Methods

The OracleDecimal static (logarithmic) methods are listed in Table 5-41.

Exp

This method returns a new OracleDecimal structure with its value set to e raised to the supplied OracleDecimal.

Declaration

// C#
public static OracleDecimal Exp(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure.

Return Value

An OracleDecimal structure.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Log

Log returns the supplied OracleDecimal structure with its value set to the logarithm of the supplied OracleDecimal structure.

Overload List:

• Log(OracleDecimal)

  This method returns a new OracleDecimal structure with its value set to the natural logarithm (base e) of the supplied OracleDecimal structure.

• Log(OracleDecimal, int)

  This method returns the supplied OracleDecimal structure with its value set to the logarithm of the supplied OracleDecimal structure in the supplied base.

• Log(OracleDecimal, OracleDecimal)

  This method returns the supplied OracleDecimal structure with its value set to the logarithm of the supplied OracleDecimal structure in the supplied base.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

Log(OracleDecimal)

This method returns a new OracleDecimal structure with its value set to the natural logarithm (base e) of the supplied OracleDecimal structure.

Declaration

// C#
public static OracleDecimal Log(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure whose logarithm is to be calculated.

Return Value

Returns a new OracleDecimal structure with its value set to the natural logarithm (base e) of val.

Exceptions

ArgumentOutOfRangeException - The supplied OracleDecimal value is less than zero.

Remarks

If the supplied OracleDecimal structure has a null value, the returned OracleDecimal has a null value.

If the supplied OracleDecimal structure has zero value, the result is undefined, and the returned OracleDecimal structure has a null value.

Log(OracleDecimal, int)

This method returns the supplied OracleDecimal structure with its value set to the logarithm of the supplied OracleDecimal structure in the supplied base.

Declaration

// C#
public static OracleDecimal Log(OracleDecimal val, int logBase);

Parameters

• val

  An OracleDecimal structure whose logarithm is to be calculated.

• logBase

  An int that specifies the base of the logarithm.

Return Value

A new OracleDecimal structure with its value set to the logarithm of val in the supplied base.

Exceptions

ArgumentOutOfRangeException - Either argument is less than zero.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

If both arguments have zero value, the result is undefined, and the returned OracleDecimal structure has a null value.

Log(OracleDecimal, OracleDecimal)

This method returns the supplied OracleDecimal structure with its value set to the logarithm of the supplied OracleDecimal structure in the supplied base.

Declaration

// C#
public static OracleDecimal Log(OracleDecimal val, OracleDecimal logBase);

Parameters

• val

  An OracleDecimal structure whose logarithm is to be calculated.

• logBase

  An OracleDecimal structure that specifies the base of the logarithm.

Return Value

Returns the logarithm of val in the supplied base.

Exceptions

ArgumentOutOfRangeException - Either the val or logBase parameter is less than zero.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

If both arguments have zero value, the result is undefined, and the returned OracleDecimal structure has a null value.

Pow

Pow returns a new OracleDecimal structure with its value set to the supplied OracleDecimal structure raised to the supplied power.

Overload List:

• Pow(OracleDecimal, int)

  This method returns a new OracleDecimal structure with its value set to the supplied OracleDecimal value raised to the supplied Int32 power.

• Pow(OracleDecimal, OracleDecimal)

  This method returns a new OracleDecimal structure with its value set to the supplied OracleDecimal structure raised to the supplied OracleDecimal power.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

Pow(OracleDecimal, int)

This method returns a new OracleDecimal structure with its value set to the supplied OracleDecimal value raised to the supplied Int32 power.

Declaration

// C#
public static OracleDecimal Pow(OracleDecimal val, int power);

Parameters

• val

  An OracleDecimal structure.

• power

  An int value that specifies the power.

Return Value

An OracleDecimal structure.

Remarks

If the supplied OracleDecimal structure has a null value, the returned OracleDecimal has a null value.

Pow(OracleDecimal, OracleDecimal)

This method returns a new OracleDecimal structure with its value set to the supplied OracleDecimal structure raised to the supplied OracleDecimal power.

Declaration

// C#
public static OracleDecimal Pow(OracleDecimal val, OracleDecimal power);

Parameters

• val

  An OracleDecimal structure.

• power

  An OracleDecimal structure that specifies the power.

Return Value

An OracleDecimal structure.

Remarks

If the supplied OracleDecimal structure has a null value, the returned OracleDecimal has a null value.

OracleDecimal Static (Trigonometric) Methods

The OracleDecimal static (trigonometric) methods are listed in Table 5-42.

Acos

This method returns an angle in radian whose cosine is the supplied OracleDecimal structure.

Declaration

// C#
public static OracleDecimal Acos(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure. Range is (-1 to 1).

Return Value

An OracleDecimal structure that represents an angle in radian.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Asin

This method returns an angle in radian whose sine is the supplied OracleDecimal structure.

Declaration

// C#
public static OracleDecimal Asin(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure. Range is (-1 to 1).

Return Value

An OracleDecimal structure that represents an angle in radian.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Atan

This method returns an angle in radian whose tangent is the supplied OracleDecimal structure

Declaration

// C#
public static OracleDecimal Atan(OracleDecimal val);

Parameters

• val

  An OracleDecimal.

Return Value

An OracleDecimal structure that represents an angle in radian.

Remarks

If the argument has a null value, the returned OracleDecimal has a null value.

Atan2

This method returns an angle in radian whose tangent is the quotient of the two supplied OracleDecimal structures.

Declaration

// C#
public static OracleDecimal Atan2(OracleDecimal val1, OracleDecimal val2);

Parameters

• val1

  An OracleDecimal structure that represents the y-coordinate.

• val2

  An OracleDecimal structure that represents the x-coordinate.

Return Value

An OracleDecimal structure that represents an angle in radian.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Cos

This method returns the cosine of the supplied angle in radian.

Declaration

// C#
public static OracleDecimal Cos(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure that represents an angle in radian.

Return Value

An OracleDecimal instance.

Exceptions

ArgumentOutOfRangeException - The val parameter is positive or negative infinity.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Sin

This method returns the sine of the supplied angle in radian.

Declaration

// C#
public static OracleDecimal Sin(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure.

Return Value

An OracleDecimal structure that represents an angle in radian.

Exceptions

ArgumentOutOfRangeException - The val parameter is positive or negative infinity.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Tan

This method returns the tangent of the supplied angle in radian.

Declaration

// C#
public static OracleDecimal Tan(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure that represents an angle in radian.

Return Value

An OracleDecimal instance.

Exceptions

ArgumentOutOfRangeException - The val parameter is positive or negative infinity.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Cosh

This method returns the hyperbolic cosine of the supplied angle in radian.

Declaration

// C#
public static OracleDecimal Cosh(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure that represents an angle in radian.

Return Value

An OracleDecimal instance.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Sinh

This method returns the hyperbolic sine of the supplied angle in radian.

Declaration

// C#
public static OracleDecimal Sinh(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure that represents an angle in radian.

Return Value

An OracleDecimal instance.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

Tanh

This method returns the hyperbolic tangent of the supplied angle in radian.

Declaration

// C#
public static OracleDecimal Tanh(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure that represents an angle in radian.

Return Value

An OracleDecimal instance.

Remarks

If either argument has a null value, the returned OracleDecimal has a null value.

OracleDecimal Static (Comparison) Operators

The OracleDecimal static (comparison) operators are listed in Table 5-43.

operator +

This method adds two OracleDecimal values.

Declaration

// C#
public static OracleDecimal operator + (OracleDecimal val1, OracleDecimal val2);

Parameters

• val1

  First OracleDecimal.

• val2

  Second OracleDecimal.

Return Value

An OracleDecimal structure.

Remarks

If either operand has a null value, the returned OracleDecimal has a null value.

operator /

This method divides one OracleDecimalvalue by another.

Declaration

// C#
public static OracleDecimal operator / (OracleDecimal val1, OracleDecimal val2);

Parameters

• val1

  First OracleDecimal.

• val2

Second OracleDecimal.

Return Value

An OracleDecimal structure.

Remarks

If either operand has a null value, the returned OracleDecimal has a null value.

operator ==

This method determines if two OracleDecimal values are equal.

Declaration

// C#
public static bool operator == (OracleDecimal val1, OracleDecimal val2);

Parameters

• val1

  First OracleDecimal.

• val2

  Second OracleDecimal.

Return Value

Returns true if their values are equal; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleDecimal that has a value compares greater than an OracleDecimal that has a null value.

• Two OracleDecimals that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

operator >

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

Declaration

// C#
public static bool operator > (OracleDecimal val1, OracleDecimal val2);

Parameters

• val1

  First OracleDecimal.

• val2

  Second OracleDecimal.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDecimal that has a value compares greater than an OracleDecimal that has a null value.

• Two OracleDecimals that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

operator >=

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

Declaration

// C#
public static bool operator >= (OracleDecimal val1, OracleDecimal val2);

Parameters

• val1

  First OracleDecimal.

• val2

  Second OracleDecimal.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDecimal that has a value compares greater than an OracleDecimal that has a null value.

• Two OracleDecimals that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

operator !=

This method determines if the first of two OracleDecimal values are not equal.

Declaration

// C#
public static bool operator != (OracleDecimal val1, OracleDecimal val2);

Parameters

• val1

  First OracleDecimal.

• val2

  Second OracleDecimal.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDecimal that has a value compares greater than an OracleDecimal that has a null value.

• Two OracleDecimals that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

operator <

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

Declaration

// C#
public static bool operator < (OracleDecimal val1,  OracleDecimal val2);

Parameters

• val1

  First OracleDecimal.

• val2

  Second OracleDecimal.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDecimal that has a value compares greater than an OracleDecimal that has a null value.

• Two OracleDecimals that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

operator <=

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

Declaration

// C#
public static bool operator <= (OracleDecimal val1, OracleDecimal val2);

Parameters

• val1

  First OracleDecimal.

• val2

  Second OracleDecimal.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleDecimal that has a value compares greater than an OracleDecimal that has a null value.

• Two OracleDecimals that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

operator *

This method multiplies two OracleDecimal structures.

Declaration

// C#
public static OracleDecimal operator * (OracleDecimal val1, OracleDecimal val2);

Parameters

• val1

  First OracleDecimal.

• val2

  Second OracleDecimal.

Return Value

A new OracleDecimal structure.

Remarks

If either operand has a null value, the returned OracleDecimal has a null value.

operator -

This method subtracts one OracleDecimal structure from another.

Declaration

// C#
public static OracleDecimal operator - (OracleDecimal val1, OracleDecimal val2);

Parameters

• val1

  First OracleDecimal.

• val2

  Second OracleDecimal.

Return Value

A new OracleDecimal structure.

Remarks

If either operand has a null value, the returned OracleDecimal has a null value.

operator -

This method negates the supplied OracleDecimal structure.

Declaration

// C#
public static OracleDecimal operator - (OracleDecimal val);

Parameters

• val

  An OracleDecimal.

Return Value

A new OracleDecimal structure.

Remarks

If the supplied OracleDecimal structure has a null value, the returned OracleDecimal has a null value.

operator%

This method returns a new OracleDecimal structure with its value set to the modulus of two OracleDecimal structures.

Declaration

// C#
public static OracleDecimal operator % (OracleDecimal val, 
     OracleDecimal divider);

Parameters

• val

  An OracleDecimal.

• divider

  An OracleDecimal.

Return Value

A new OracleDecimal structure.

Remarks

If either operand has a null value, the returned OracleDecimal has a null value.

OracleDecimal Static Operators (Conversion from .NET Type to OracleDecimal)

The OracleDecimal static operators (Conversion from .NET Type to OracleDecimal) are listed in Table 5-44.

implicit operator OracleDecimal

implicit operator OracleDecimal returns the OracleDecimal representation of a value.

Overload List:

• implicit operator OracleDecimal(decimal)

  This method returns the OracleDecimal representation of a decimal value.

• implicit operator OracleDecimal(int)

  This method returns the OracleDecimal representation of an int value.

• implicit operator OracleDecimal(long)

  This method returns the OracleDecimal representation of a long value.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

implicit operator OracleDecimal(decimal)

This method returns the OracleDecimal representation of a decimal value.

Declaration

// C#
public static implicit operator OracleDecimal(decimal val);

Parameters

• val

  A decimal value.

Return Value

An OracleDecimal.

implicit operator OracleDecimal(int)

This method returns the OracleDecimal representation of an int value.

Declaration

// C#
public static implicit operator OracleDecimal(int val);

Parameters

• val

  An int value.

Return Value

An OracleDecimal.

implicit operator OracleDecimal(long)

This method returns the OracleDecimal representation of a long value.

Declaration

// C#
public static implicit operator OracleDecimal(long val);

Parameters

• val

  A long value.

Return Value

An OracleDecimal.

explicit operator OracleDecimal

OracleDecimal returns the OracleDecimal representation of a value.

Overload List:

• explicit operator OracleDecimal(double)

  This method returns the OracleDecimal representation of a double.

• explicit operator OracleDecimal(string)

  This method returns the OracleDecimal representation of a string.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

explicit operator OracleDecimal(double)

This method returns the OracleDecimal representation of a double.

Declaration

// C#
public static explicit operator OracleDecimal(double val);

Parameters

• val

  A double.

Return Value

An OracleDecimal.

Exceptions

OverFlowException - The value of the supplied double is greater than the maximum value of OracleDecimal or less than the minimum value of OracleDecimal.

Remarks

OracleDecimal contains the following values depending on the provided double value:

• double.PositiveInfinity: positive infinity value

• double.NegativeInfinity: negative infinity value.

• double.NaN: null value

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

explicit operator OracleDecimal(string)

This method returns the OracleDecimal representation of a string.

Declaration

// C#
public static explicit operator OracleDecimal(string numStr);

Parameters

• numStr

  A string that represents a numeric value.

Return Value

An OracleDecimal.

Exceptions

ArgumentException - The numStr parameter is an invalid string representation of an OracleDecimal.

OracleDecimal Static Operators (Conversion from OracleDecimal to .NET)

The OracleDecimal static operators (Conversion from OracleDecimal to .NET) are listed in Table 5-45.

explicit operator byte

This method returns the byte representation of the OracleDecimal value.

Declaration

// C#
public static explicit operator byte(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure.

Return Value

A byte.

Exceptions

OracleNullValueException - OracleDecimal has a null value.

OverFlowException- The byte cannot represent the supplied OracleDecimal structure.

explicit operator decimal

This method returns the decimal representation of the OracleDecimal value.

Declaration

// C#
public static explicit operator decimal(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure.

Return Value

A decimal.

Exceptions

OracleNullValueException - The OracleDecimal has a null value.

OverFlowException - The decimal cannot represent the supplied OracleDecimal structure.

explicit operator double

This method returns the double representation of the OracleDecimal value.

Declaration

// C#
public static explicit operator double(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure.

Return Value

A double.

Exceptions

OracleNullValueException - The OracleDecimal has a null value.

OverFlowException - The double cannot represent the supplied OracleDecimal structure.

explicit operator short

This method returns the short representation of the OracleDecimal value.

Declaration

// C#
public static explicit operator short(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure.

Return Value

A short.

Exceptions

OracleNullValueException - The OracleDecimal has a null value.

OverFlowException - The short cannot represent the supplied OracleDecimal structure.

explicit operator int

This method returns the int representation of the OracleDecimal value.

Declaration

// C#
public static explicit operator int(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure.

Return Value

An int.

Exceptions

OracleNullValueException - The OracleDecimal has a null value.

OverFlowException - The int cannot represent the supplied OracleDecimal structure.

explicit operator long

This method returns the long representation of the OracleDecimal value.

Declaration

// C#
public static explicit operator long(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure.

Return Value

A long.

Exceptions

OracleNullValueException - The OracleDecimal has a null value.

OverFlowException - The long cannot represent the supplied OracleDecimal structure.

explicit operator float

This method returns the float representation of the OracleDecimal value.

Declaration

// C#
public static explicit operator float(OracleDecimal val);

Parameters

• val

  An OracleDecimal structure.

Return Value

A float.

Exceptions

OracleNullValueException - The OracleDecimal has a null value.

OverFlowException - The float cannot represent the supplied OracleDecimal structure.

OracleDecimal Properties

The OracleDecimal properties are listed in Table 5-46.

BinData

This property returns a byte array that represents the Oracle NUMBER in an internal Oracle format.

Declaration

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

Property Value

A byte array that represents the Oracle NUMBER in an internal Oracle format.

Exceptions

OracleNullValueException - The current instance has a null value.

Format

This property specifies the format for ToString().

Declaration

// C#
public string Format {get; set;}

Property Value

The string which specifies the format.

Remarks

Format is used when ToString() is called on an instance of an OracleDecimal. It is useful if the ToString() method needs a specific currency symbol, group, or decimal separator as part of a string.

By default, this property is null which indicates that no special formatting is used.

The decimal and group separator characters are specified by the thread's OracleGlobalization.NumericCharacters.

The currency symbols are specified by the following thread properties:

• OracleGlobalization.Currency

• OracleGlobalization.ISOCurrency

• OracleGlobalization.DualCurrency

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure "OracleGlobalization Class" "Globalization Support"

  
  

IsInt

This property indicates whether the current instance is an integer value.

Declaration

// C#
public bool IsInt {get;}

Property Value

A bool value that returns true if the current instance is an integer value; otherwise, returns false.

Exceptions

OracleNullValueException - The current instance has a null value.

IsNull

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

Declaration

// C#
public bool IsNull {get;}

Property Value

A bool value that returns true if the current instance has a null value; otherwise, returns false.

IsPositive

This property indicates whether the value of the current instance is greater than 0.

Declaration

// C#
public bool IsPositive {get;}

Property Value

A bool value that returns true if the current instance is greater than 0; otherwise, returns false.

Exceptions

OracleNullValueException - The current instance has a null value.

IsZero

This property indicates whether the current instance has a zero value.

Declaration

// C#
public  bool IsZero{get;}

Property Value

A bool value that returns true if the current instance has a zero value; otherwise, returns false.

Exceptions

OracleNullValueException - The current instance has a null value.

Value

This method returns a decimal value.

Declaration

// C#
public decimal Value {get;}

Property Value

A decimal value.

Exceptions

OracleNullValueException - The current instance has a null value.

OverFlowException - The decimal cannot represent the supplied OracleDecimal structure.

Remarks

Precision can be lost when the decimal value is obtained from an OracleDecimal. See Remarks under "OracleDecimal Structure" for further information.

OracleDecimal Instance Methods

The OracleDecimal instance methods are listed in Table 5-47.

CompareTo

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

Declaration

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

Parameters

• obj

  The supplied instance.

Return Value

The method returns a number:

• Less than zero: if the value of the current instance is less than obj.

• Zero: if the value of the current instance is equal to obj.

• Greater than zero: if the value of the current instance is greater than obj.

Implements

IComparable

Exceptions

ArgumentException - The parameter is not of type OracleDecimal.

Remarks

The following rules apply to the behavior of this method.

• The comparison must be between OracleDecimals. For example, comparing an OracleDecimal instance with an OracleBinary instance is not allowed. When an OracleDecimal is compared with a different type, an ArgumentException is thrown.

• Any OracleDecimal that has a value compares greater than an OracleDecimal that has a null value.

• Two OracleDecimals that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

Equals

Overrides Object

This method determines whether an object is an instance of OracleDecimal, and whether the value of the object is equal to the current instance.

Declaration

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

Parameters

• obj

  An OracleDecimal instance.

Return Value

Returns true if obj is an instance of OracleDecimal, and the value of obj is equal to the current instance; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleDecimal that has a value compares greater than an OracleDecimal that has a null value.

• Two OracleDecimals that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleDecimal Members OracleDecimal Structure

  
  

GetHashCode

Overrides Object

This method returns a hash code for the current instance.

Declaration

// C#
public override int GetHashCode();

Return Value

Returns a hash code.

ToByte

This method returns the byte representation of the current instance.

Declaration

// C#
public byte ToByte();

Return Value

A byte.

Exceptions

OverFlowException - The byte cannot represent the current instance.

OracleNullValueException - The current instance has a null value.

ToDouble

This method returns the double representation of the current instance.

Declaration

// C#
public double ToDouble();

Return Value

A double.

Exceptions

OverFlowException - The double cannot represent the current instance.

OracleNullValueException - The current instance has a null value.

ToInt16

This method returns the Int16 representation of the current instance.

Declaration

// C#
public short ToInt16();

Return Value

A short.

Exceptions

OverFlowException - The short cannot represent the current instance.

OracleNullValueException - The current instance has a null value.

ToInt32

This method returns the Int32 representation of the current instance.

Declaration

// C#
public int ToInt32();

Return Value

An int.

Exceptions

OverFlowException - The int cannot represent the current instance.

OracleNullValueException - The current instance has a null value.

ToInt64

This method returns the Int64 representation of the current instance.

Declaration

// C#
public long ToInt64();

Return Value

A long.

Exceptions

OverFlowException - The long cannot represent the current instance.

OracleNullValueException - The current instance has a null value.

ToSingle

This method returns the Single representation of the current instance.

Declaration

// C#
public float ToSingle();

Return Value

A float.

Exceptions

OverFlowException - The float cannot represent the current instance.

OracleNullValueException - The current instance has a null value.

ToString

Overrides Object

This method returns the string representation of the current instance.

Declaration

// C#
public override string ToString();

Return Value

Returns the number in a string.

Remarks

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

The returned value is a string representation of an OracleDecimal in the numeric format specified by the Format property.

The decimal and group separator characters are specified by the thread's OracleGlobalization.NumericCharacters.

The currency symbols are specified by the following thread properties:

• OracleGlobalization.Currency

• OracleGlobalization.ISOCurrency

• OracleGlobalization.DualCurrency

If the numeric format is not specified, an Oracle default value is used.

---

OracleIntervalDS Structure

The OracleIntervalDS structure represents the Oracle INTERVAL DAY TO SECOND datatype to be stored in or retrieved from a database. Each OracleIntervalDS stores a period of time in term of days, hours, minutes, seconds, and fractional seconds.

Class Inheritance

Object

  ValueType

    OracleIntervalDS

Declaration

// C#
public struct OracleIntervalDS : IComparable

Thread Safety

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

Example

// C#
//  Illustrates usage of OracleIntervalDS

OracleIntervalDS idsMax = OracleIntervalDS.MaxValue;
double maxDays = idsMax.TotalDays;
maxDays -= 1;
OracleIntervalDS idsMax_1 = new OracleIntervalDS(maxDays);

// Calculate the difference. It should be 1 +/- epsilon days
// where epsilon for OracleIntervalDS = 0.000000001 seconds.

OracleIntervalDS idsDiff = idsMax - idsMax_1;

// If the difference isnt exactly 1 day, display the difference
if (idsDiff.TotalDays != 1)
   Console.WriteLine(idsDiff.ToString());

Requirements

Namespace: Oracle.DataAccess.Types

Assembly: Oracle.DataAccess.dll

OracleIntervalDS Members

OracleIntervalDS members are listed in the following tables:

OracleIntervalDS Constructors

OracleIntervalDS constructors are listed in Table 5-48

OracleIntervalDS Static Fields

The OracleIntervalDS static fields are listed in Table 5-49.

OracleIntervalDS Static Methods

The OracleIntervalDS static methods are listed in Table 5-50.

OracleIntervalDS Static Operators

The OracleIntervalDS static operators are listed in Table 5-51.

OracleIntervalDS Type Conversions

The OracleIntervalDS type conversions are listed in Table 5-52.

OracleIntervalDS Properties

The OracleIntervalDS properties are listed in Table 5-53.

OracleIntervalDS Methods

The OracleIntervalDS methods are listed in Table 5-54.

OracleIntervalDS Constructors

OracleIntervalDS constructors create a new instance of the OracleIntervalDS structure.

Overload List:

• OracleIntervalDS(TimeSpan)

  This constructor creates a new instance of the OracleIntervalDS structure and sets its value using a TimeSpan structure.

• OracleIntervalDS(string)

  This constructor creates a new instance of the OracleIntervalDS structure and sets its value using a string that indicates a period of time.

• OracleIntervalDS(double)

  This constructor creates a new instance of the OracleIntervalDS structure and sets its value using the total number of days.

• OracleIntervalDS(int, int, int, int, double)

  This constructor creates a new instance of the OracleIntervalDS structure and sets its value using the supplied days, hours, minutes, seconds and milliseconds.

• OracleIntervalDS(int, int, int, int, int)

  This constructor creates a new instance of the OracleIntervalDS structure and sets its value using the supplied days, hours, minutes, seconds, and nanoseconds.

• OracleIntervalDS(byte[ ])

  This constructor creates a new instance of the OracleIntervalDS structure and sets its value to the provided byte array, which is in an internal Oracle INTERVAL DAY TO SECOND format.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

OracleIntervalDS(TimeSpan)

This constructor creates a new instance of the OracleIntervalDS structure and sets its value using a TimeSpan structure.

Declaration

// C#
public OracleIntervalDS(TimeSpan ts);  

Parameters

• ts

  A TimeSpan structure.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

OracleIntervalDS(string)

This constructor creates a new instance of the OracleIntervalDS structure and sets its value using a string that indicates a period of time.

Declaration

// C#
public OracleIntervalDS(string intervalStr);  

Parameters

• intervalStr

  A string representing the Oracle INTERVAL DAY TO SECOND.

Exceptions

ArgumentException - The intervalStr parameter is not in the valid format or has an invalid value.

ArgumentNullException - The intervalStr parameter is null.

Remarks

The value specified in the supplied intervalStr must be in Day HH:MI:SSxFF format.

Example

"1 2:3:4.99" means 1 day, 2 hours, 3 minutes, 4 seconds, and 990 milliseconds or 1 day, 2 hours, 3 minutes, 4 seconds, and 990000000 nanoseconds.

OracleIntervalDS(double)

This constructor creates a new instance of the OracleIntervalDS structure and sets its value using the total number of days.

Declaration

// C#
public OracleIntervalDS(double totalDays);

Parameters

• totalDays

  The supplied total number of days for a time interval. Range of days is -1000,000,000 < totalDays < 1000,000,000.

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleIntervalDS.

OracleIntervalDS(int, int, int, int, double)

This constructor creates a new instance of the OracleIntervalDS structure and sets its value using the supplied days, hours, minutes, seconds, and milliseconds.

Declaration

// C#
public OracleIntervalDS (int days, int hours, int minutes, int seconds,
 double milliSeconds); 

Parameters

• days

  The days provided. Range of day is (-999,999,999 to 999,999,999).

• hours

  The hours provided. Range of hour is (-23 to 23).

• minutes

  The minutes provided. Range of minute is (-59 to 59).

• seconds

  The seconds provided. Range of second is (-59 to 59).

• milliSeconds

  The milliseconds provided. Range of millisecond is (- 999.999999 to 999.999999).

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleIntervalDS.

Remarks

The sign of all the arguments must be the same.

OracleIntervalDS(int, int, int, int, int)

This constructor creates a new instance of the OracleIntervalDS structure and sets its value using the supplied days, hours, minutes, seconds, and nanoseconds.

Declaration

// C#
public OracleIntervalDS (int days, int hours, int minutes, int seconds,
 int nanoseconds);  

Parameters

• days

  The days provided. Range of day is (-999,999,999 to 999,999,999).

• hours

  The hours provided. Range of hour is (-23 to 23).

• minutes

  The minutes provided. Range of minute is (-59 to 59).

• seconds

  The seconds provided. Range of second is (-59 to 59).

• nanoseconds

  The nanoseconds provided. Range of nanosecond is (-999,999,999 to 999,999,999)

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleIntervalDS.

Remarks

The sign of all the arguments must be the same.

OracleIntervalDS(byte[ ])

This constructor creates a new instance of the OracleIntervalDS structure and sets its value to the provided byte array, which is in an internal Oracle INTERVAL DAY TO SECOND format.

Declaration

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

Parameters

• bytes

  A byte array that is in an internal Oracle INTERVAL DAY TO SECOND format.

Exceptions

ArgumentException - bytes is not in internal Oracle INTERVAL DAY TO SECOND format, or bytes is not a valid Oracle INTERVAL DAY TO SECOND.

ArgumentNullException - bytes is null.

OracleIntervalDS Static Fields

The OracleIntervalDS static fields are listed in Table 5-55.

MaxValue

This static field represents the maximum value for an OracleIntervalDS structure.

Declaration

// C#
public static readonly OracleIntervalDS MaxValue;

Remarks

Maximum values:

• Day: 999999999

• hour: 23

• minute is 59

• second: 59

• nanosecond: 999999999

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

MinValue

This static field represents the minimum value for an OracleIntervalDS structure.

Declaration

// C#
public static readonly OracleIntervalDS MinValue;

Remarks

Minimum values:

• Day: -999999999

• hour: -23

• minute: -59

• second: -59

• nanosecond: -999999999

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

Null

This static field represents a null value that can be assigned to an OracleIntervalDS instance.

Declaration

// C#
public static readonly OracleIntervalDS Null;

Zero

This static field represents a zero value for an OracleIntervalDS structure.

Declaration

// C#
public static readonly OracleIntervalDS Zero;

OracleIntervalDS Static Methods

The OracleIntervalDS static methods are listed in Table 5-56.

Equals

This static method determines whether two OracleIntervalDS values are equal.

Declaration

// C#
public static bool Equals(OracleIntervalDS val1, OracleIntervalDS val2);

Parameters

• val1

  First OracleIntervalDS.

• val2

  Second OracleIntervalDS.

Return Value

If the two OracleIntervalDS structures represent the same time interval, returns true; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.

• Two OracleIntervalDSs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

GreaterThan

This static method determines whether the first of two OracleIntervalDS values is greater than the second.

Declaration

// C#
public static bool GreaterThan(OracleIntervalDS val1, OracleIntervalDS val2);

Parameters

• val1

  First OracleIntervalDS.

• val2

  Second OracleIntervalDS.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.

• Two OracleIntervalDSs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

GreaterThanOrEqual

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

Declaration

// C#
public static bool GreaterThanOrEqual(OracleIntervalDS val1, 
   OracleIntervalDS val2);

Parameters

• val1

  First OracleIntervalDS.

• val2

  Second OracleIntervalDS.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.

• Two OracleIntervalDSs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

LessThan

This static method determines whether the first of two OracleIntervalDS values is less than the second.

Declaration

// C#
public static bool LessThan(OracleIntervalDS val1, OracleIntervalDS val2);

Parameters

• val1

  First OracleIntervalDS.

• val2

  Second OracleIntervalDS.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.

• Two OracleIntervalDSs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

LessThanOrEqual

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

Declaration

// C#
public static bool LessThanOrEqual(OracleIntervalDS val1, OracleIntervalDS val2);

Parameters

• val1

  First OracleIntervalDS.

• val2

  Second OracleIntervalDS.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.

• Two OracleIntervalDSs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

NotEquals

This static method determines whether two OracleIntervalDS values are not equal.

Declaration

// C#
public static bool NotEquals(OracleIntervalDS val1, OracleIntervalDS val2);

Parameters

• val1

  First OracleIntervalDS.

• val2

  Second OracleIntervalDS.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.

• Two OracleIntervalDSs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

Parse

This static method returns an OracleIntervalDS instance and sets its value for time interval using a string.

Declaration

// C#
public static OracleIntervalDS Parse(string intervalStr);

Parameters

• intervalStr

  A string representing the Oracle INTERVAL DAY TO SECOND.

Return Value

Returns an OracleIntervalDS instance representing the time interval from the supplied string.

Exceptions

ArgumentException - The intervalStr parameter is not in the valid format or intervalStr has an invalid value.

ArgumentNullException - The intervalStr parameter is null.

Remarks

The value specified in intervalStr must be in Day HH:MI:SSxFF format.

Example

"1 2:3:4.99" means 1 day, 2 hours, 3 minutes, 4 seconds, and 990 milliseconds or 1 day, 2 hours, 3 minutes, 4 seconds, and 990000000 nanoseconds.

SetPrecision

This static method returns a new instance of an OracleIntervalDS with the specified day precision and fractional second precision.

Declaration

// C#
public static OracleIntervalDS SetPrecision(OracleIntervalDS value1,int dayPrecision, int fracSecPrecision);

Parameters

• value1

  An OracleIntervalDS structure.

• dayPrecision

  The day precision provided. Range of day precision is (0 to 9).

• fracSecPrecision

  The fractional second precision provided. Range of fractional second precision is (0 to 9).

Return Value

An OracleIntervalDS instance.

Exceptions

ArgumentOutOfRangeException - An argument value is out of the specified range.

Remarks

Depending on the value specified in the supplied dayPrecision, 0 or more leading zeros are displayed in the string returned by ToString().

The value specified in the supplied fracSecPrecision is used to perform a rounding off operation on the supplied OracleIntervalDS value. Depending on this value, 0 or more trailing zeros are displayed in the string returned by ToString().

Example

The OracleIntervalDS with a value of "1 2:3:4.99" results in the string "001 2:3:4.99000" when SetPrecision() is called, with the day precision set to 3 and fractional second precision set to 5.

OracleIntervalDS Static Operators

The OracleIntervalDS static operators are listed in Table 5-57.

operator +

This static operator adds two OracleIntervalDS values.

Declaration

// C#
public static OracleIntervalDS operator + (OracleIntervalDS val1,  OracleIntervalDS val2);

Parameters

• val1

  First OracleIntervalDS.

• val2

  Second OracleIntervalDS.

Return Value

An OracleIntervalDS.

Remarks

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

operator ==

This static operator determines if two OracleIntervalDS values are equal.

Declaration

// C#
public static bool operator == (OracleIntervalDS val1, OracleIntervalDS val2);

Parameters

• val1

  First OracleIntervalDS.

• val2

  Second OracleIntervalDS.

Return Value

Returns true if the two OracleIntervalDS values are the same; otherwise returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.

• Two OracleIntervalDSs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

operator >

This static operator determines if the first of two OracleIntervalDS values is greater than the second.

Declaration

// C#
public static bool operator > (OracleIntervalDS val1, OracleIntervalDS val2);

Parameters

• val1

  First OracleIntervalDS.

• val2

  Second OracleIntervalDS.

Return Value

Returns true if one OracleIntervalDS value is greater than another; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.

• Two OracleIntervalDSs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

operator >=

This static operator determines if the first of two OracleIntervalDS values is greater than or equal to the second.

Declaration

// C#
public static bool operator >= (OracleIntervalDS val1, OracleIntervalDS val2);

Parameters

• val1

  First OracleIntervalDS.

• val2

  Second OracleIntervalDS.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.

• Two OracleIntervalDSs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

operator !=

This static operator determines if the two OracleIntervalDS values are not equal.

Declaration

// C#
public static bool operator != (OracleIntervalDS val1, OracleIntervalDS val2);

Parameters

• val1

  First OracleIntervalDS.

• val2

  Second OracleIntervalDS.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.

• Two OracleIntervalDSs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

operator <

This static operator determines if the first of two OracleIntervalDS values is less than the second.

Declaration

// C#
public static bool operator < (OracleIntervalDS val1, OracleIntervalDS val2);

Parameters

• val1

  First OracleIntervalDS.

• val2

  Second OracleIntervalDS.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.

• Two OracleIntervalDSs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

operator <=

This static operator determines if the first of two OracleIntervalDS values is less than or equal to the second.

Declaration

// C#
public static bool operator <= (OracleIntervalDS val1, OracleIntervalDS val2);

Parameters

• val1

  First OracleIntervalDS.

• val2

  Second OracleIntervalDS.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.

• Two OracleIntervalDSs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

operator -

This static operator subtracts one OracleIntervalDS structure from another.

Declaration

// C#
public static OracleIntervalDS operator - (OracleIntervalDS val1, OracleIntervalDS val2);

Parameters

• val1

  First OracleIntervalDS.

• val2

  Second OracleIntervalDS.

Return Value

An OracleIntervalDS structure.

Remarks

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

operator -

This static operator negates the supplied OracleIntervalDS structure.

Declaration

// C#
public static OracleIntervalDS operator - (OracleIntervalDS val);

Parameters

• val

  An OracleIntervalDS.

Return Value

An OracleIntervalDS structure.

Remarks

If the supplied OracleIntervalDS structure has a null value, the returned OracleIntervalDS structure has a null value.

operator *

This static operator multiplies an OracleIntervalDS value by a number.

Declaration

// C#
public static OracleIntervalDS operator * (OracleIntervalDS val1, int multiplier);

Parameters

• val1

  First OracleIntervalDS.

• multiplier

  A multiplier.

Return Value

A new OracleIntervalDS instance.

Remarks

If the OracleIntervalDS structure has a null value, the returned OracleIntervalDS structure has a null value.

operator /

This static operator divides an OracleIntervalDS value by a number.

Declaration

// C#
public static OracleIntervalDS operator / (OracleIntervalDS val1, int divisor);

Parameters

• val1

  First OracleIntervalDS.

• divisor

  A divisor.

Return Value

An OracleIntervalDS structure.

Remarks

If the OracleIntervalDS structure has a null value, the returned OracleIntervalDS structure has a null value.

OracleIntervalDS Type Conversions

The OracleIntervalDS type conversions are listed in Table 5-58.

explicit operator TimeSpan

This type conversion operator converts an OracleIntervalDS structure to a TimeSpan structure.

Declaration

// C#
public static explicit operator TimeSpan(OracleIntervalDS val);

Parameters

• val

  An OracleIntervalDS instance.

Return Value

A TimeSpan structure.

Exceptions

OracleNullValueException - The OracleIntervalDS structure has a null value.

Remarks

explicit operator OracleIntervalDS

This type conversion operator converts a string to an OracleIntervalDS structure.

Declaration

// C#
public static explicit operator OracleIntervalDS (string intervalStr);

Parameters

• intervalStr

  A string representation of an Oracle INTERVAL DAY TO SECOND.

Return Value

An OracleIntervalDS structure.

Exceptions

ArgumentException - The supplied intervalStr parameter is not in the correct format or has an invalid value.

ArgumentNullException - The intervalStr parameter is null.

Remarks

The returned OracleIntervalDS structure contains the same time interval represented by the supplied intervalStr. The value specified in the supplied intervalStr must be in Day HH:MI:SSxFF format.

Example

"1 2:3:4.99" means 1 day, 2 hours, 3 minutes 4 seconds and 990 milliseconds or 1 day, 2 hours, 3 minutes 4 seconds and 990000000 nanoseconds.

implicit operator OracleIntervalDS

This type conversion operator converts a TimeSpan structure to an OracleIntervalDS structure.

Declaration

// C#
public static implicit operator OracleIntervalDS(TimeSpan val);

Parameters

• val

  A TimeSpan instance.

Return Value

An OracleIntervalDS structure.

Remarks

The returned OracleIntervalDS structure contains the same days, hours, seconds, and milliseconds as the supplied TimeSpan val.

OracleIntervalDS Properties

The OracleIntervalDS properties are listed in Table 5-59.

BinData

This property returns an array of bytes that represents the Oracle INTERVAL DAY TO SECOND in Oracle internal format.

Declaration

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

Property Value

A byte array that represents an Oracle INTERVAL DAY TO SECOND in Oracle internal format.

Exceptions

OracleNullValueException - The current instance has a null value.

Remarks

Days

This property gets the days component of an OracleIntervalDS.

Declaration

// C#
public int Days {get;}

Property Value

An int representing the days component.

Exceptions

OracleNullValueException - The current instance has a null value.

Hours

This property gets the hours component of an OracleIntervalDS.

Declaration

// C#
public int Hours {get;}

Property Value

An int representing the hours component.

Exceptions

OracleNullValueException - The current instance has a null value.

IsNull

This property indicates whether 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.

Milliseconds

This property gets the milliseconds component of an OracleIntervalDS.

Declaration

// C#
public double Milliseconds {get;}

Property Value

A double that represents milliseconds component.

Exceptions

OracleNullValueException - The current instance has a null value.

Minutes

This property gets the minutes component of an OracleIntervalDS.

Declaration

// C#
public int Minutes {get;}

Property Value

A int that represents minutes component.

Exceptions

OracleNullValueException - The current instance has a null value.

Nanoseconds

This property gets the nanoseconds component of an OracleIntervalDS.

Declaration

// C#
public int Nanoseconds {get;}

Property Value

An int that represents nanoseconds component.

Exceptions

OracleNullValueException - The current instance has a null value.

Seconds

This property gets the seconds component of an OracleIntervalDS.

Declaration

// C#
public int Seconds {get;}

Property Value

An int that represents seconds component.

Exceptions

OracleNullValueException - The current instance has a null value.

TotalDays

This property returns the total number, in days, that represent the time period in the OracleIntervalDS structure.

Declaration

// C#
public double TotalDays {get;}

Property Value

A double that represents the total number of days.

Exceptions

OracleNullValueException - The current instance has a null value.

Value

This property specifies the time interval that is stored in the OracleIntervalDS structure.

Declaration

// C#
public TimeSpan Value {get;}

Property Value

A time interval.

Exceptions

OracleNullValueException - The current instance has a null value.

OracleIntervalDS Methods

The OracleIntervalDS methods are listed in Table 5-60.

CompareTo

This method compares the current OracleIntervalDS 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 to.

Return Value

The method returns:

• Less than zero: if the current OracleIntervalDS represents a shorter time interval than obj.

• Zero: if the current OracleIntervalDS and obj represent the same time interval.

• Greater than zero: if the current OracleIntervalDS represents a longer time interval than obj.

Implements

IComparable

Exceptions

ArgumentException - The obj parameter is not of type OracleIntervalDS.

Remarks

The following rules apply to the behavior of this method.

• The comparison must be between OracleIntervalDSs. For example, comparing an OracleIntervalDS instance with an OracleBinary instance is not allowed. When an OracleIntervalDS is compared with a different type, an ArgumentException is thrown.

• Any OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.

• Two OracleIntervalDSs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

Equals

This method determines whether the specified object has the same time interval as the current instance.

Declaration

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

Parameters

• obj

  The specified object.

Return Value

Returns true if obj is of type OracleIntervalDS and has the same time interval as the current instance; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.

• Two OracleIntervalDSs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalDS Structure OracleIntervalDS Members

  
  

GetHashCode

Overrides Object

This method returns a hash code for the OracleIntervalDS instance.

Declaration

// C#
public override int GetHashCode();

ToString

Overrides Object

This method converts the current OracleIntervalDS structure to a string.

Declaration

// C#
public override string ToString();

Return Value

Returns a string.

Remarks

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

---

OracleIntervalYM Structure

The OracleIntervalYM structure represents the Oracle INTERVAL YEAR TO MONTH datatype to be stored in or retrieved from a database. Each OracleIntervalYM stores a period of time in years and months.

Class Inheritance

Object

  ValueType

    OracleIntervalYM

Declaration

// C#
public struct OracleIntervalYM : IComparable

Thread Safety

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

Example

// C#
//  Illustrates usage of OracleIntervalYM

OracleIntervalYM iymMax = OracleIntervalYM.MaxValue;
double maxYears = iymMax.TotalYears;
maxYears -= 1;
OracleIntervalYM iymMax_1 = new OracleIntervalYM(maxYears);

// Calculate the difference. It should be 1 +/- epsilon years
// where epsilon for OracleIntervalYM = 1 month.

OracleIntervalYM iymDiff = iymMax - iymMax_1;

// If the difference isnt exactly 1 day, display the difference
if (iymDiff.TotalYears != 1)
    Console.WriteLine(iymDiff.ToString());

Requirements

Namespace: Oracle.DataAccess.Types

Assembly: Oracle.DataAccess.dll

OracleIntervalYM Members

OracleIntervalYM members are listed in the following tables:

OracleIntervalYM Constructors

OracleIntervalYM constructors are listed in Table 5-61

OracleIntervalYM Static Fields

The OracleIntervalYM static fields are listed in Table 5-62.

OracleIntervalYM Static Methods

The OracleIntervalYM static methods are listed in Table 5-63.

OracleIntervalYM Static Operators

The OracleIntervalYM static operators are listed in Table 5-64.

OracleIntervalYM Type Conversions

The OracleIntervalYM conversions are listed in Table 5-65.

OracleIntervalYM Properties

The OracleIntervalYM properties are listed in Table 5-66.

OracleIntervalYM Methods

The OracleIntervalYM methods are listed in Table 5-67.

OracleIntervalYM Constructors

The OracleIntervalYM constructors creates a new instance of the OracleIntervalYM structure.

Overload List:

• OracleIntervalYM(long)

  This method creates a new instance of the OracleIntervalYM structure using the supplied total number of months for a period of time.

• OracleIntervalYM(string)

  This method creates a new instance of the OracleIntervalYM structure and sets its value using the supplied string.

• OracleIntervalYM(double)

  This method creates a new instance of the OracleIntervalYM structure and sets its value using the total number of years.

• OracleIntervalYM(int, int)

  This method creates a new instance of the OracleIntervalYM structure and sets its value using years and months.

• OracleIntervalYM(byte[ ])

  This method creates a new instance of the OracleIntervalYM structure and sets its value to the provided byte array, which is in an internal Oracle INTERVAL DAY TO SECOND format.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalYM Structure OracleIntervalYM Members

  
  

OracleIntervalYM(long)

This method creates a new instance of the OracleIntervalYM structure using the supplied total number of months for a period of time.

Declaration

// C#
public OracleIntervalYM (long totalMonths); 

Parameters

• totalMonths

  The number of total months for a time interval. Range is -12,000,000,000 < totalMonths < 12,000,000,000.

Exceptions

ArgumentOutOfRangeException - The totalMonths parameter is out of the specified range.

OracleIntervalYM(string)

This method creates a new instance of the OracleIntervalYM structure and sets its value using the supplied string.

Declaration

// C#
public OracleIntervalYM (string intervalStr);  

Parameters

• intervalStr

  A string representing the Oracle INTERVAL YEAR TO MONTH.

Remarks

The value specified in the supplied intervalStr must be in Year-Month format.

Exceptions

ArgumentException - The intervalStr parameter is not in the valid format or intervalStr has an invalid value.

ArgumentNullException - The intervalStr parameter is null.

Example

"1-2" means 1 year and 2 months.

OracleIntervalYM(double)

This method creates a new instance of the OracleIntervalYM structure and sets its value using the total number of years.

Declaration

// C#
public OracleIntervalYM (double totalYears);

Parameters

• totalYears

  Number of total years. Range is -1,000,000,000 < totalYears > 1,000,000,000.

Exceptions

ArgumentOutOfRangeException - The totalYears parameter is out of the specified range.

ArgumentException - The totalYears parameter cannot be used to construct a valid OracleIntervalYM.

OracleIntervalYM(int, int)

This method creates a new instance of the OracleIntervalYM structure and sets its value using years and months.

Declaration

// C#
public OracleIntervalYM (int years, int months); 

Parameters

• years

  Number of years. Range of year is (-999,999,999 to 999,999,999).

• months

  Number of months. Range of month is (-11 to 11).

Remarks

The sign of all the arguments must be the same.

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleIntervalYM.

OracleIntervalYM(byte[ ])

This method creates a new instance of the OracleIntervalYM structure and sets its value to the provided byte array, which is in an internal Oracle INTERVAL DAY TO SECOND format.

Declaration

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

Parameters

• bytes

  A byte array that is in an internal Oracle INTERVAL YEAR TO MONTH format.

Exceptions

ArgumentException - The supplied byte array is not in an internal Oracle INTERVAL YEAR TO MONTH format or the supplied byte array has an invalid value.

ArgumentNullException - bytes is null.

Remarks

The supplied byte array must be in an internal Oracle INTERVAL YEAR TO MONTH format.

OracleIntervalYM Static Fields

The OracleIntervalYM static fields are listed in Table 5-68.

MaxValue

This static field represents the maximum value for an OracleIntervalYM structure.

Declaration

// C#
public static readonly OracleIntervalYM MaxValue;

Remarks

Year is 999999999 and Month is 11.

MinValue

This static field represents the minimum value for an OracleIntervalYM structure.

Declaration

// C#
public static readonly OracleIntervalYM MinValue;

Remarks

Year is -999999999 and Month is -11.

Null

This static field represents a null value that can be assigned to an OracleIntervalYM instance.

Declaration

// C#
public static readonly OracleIntervalYM Null;

Zero

This static field represents a zero value for an OracleIntervalYM structure.

Declaration

// C#
public static readonly OracleIntervalDS Zero;

OracleIntervalYM Static Methods

The OracleIntervalYM static methods are listed in Table 5-69.

Equals

This static method determines whether two OracleIntervalYM values are equal.

Declaration

// C#
public static bool Equals(OracleIntervalYM val1, OracleIntervalYM val2);

Parameters

• val1

  An OracleIntervalYM structure.

• val2

  An OracleIntervalYM structure.

Return Value

Returns true if two OracleIntervalYM values represent the same time interval, otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalYM that has a value compares greater than an OracleIntervalYM that has a null value.

• Two OracleIntervalYMs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalYM Structure OracleIntervalYM Members

  
  

GreaterThan

This static method determines whether the first of two OracleIntervalYM values is greater than the second.

Declaration

// C#
public static bool GreaterThan(OracleIntervalYM val1, OracleIntervalYM val2);

Parameters

• val1

  First OracleIntervalYM.

• val2

  Second OracleIntervalYM.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalYM that has a value compares greater than an OracleIntervalYM that has a null value.

• Two OracleIntervalYMs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalYM Structure OracleIntervalYM Members

  
  

GreaterThanOrEqual

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

Declaration

// C#
public static bool GreaterThanOrEqual(OracleIntervalYM val1, OracleIntervalYM val2);

Parameters

• val1

  First OracleIntervalYM.

• val2

  Second OracleIntervalYM.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalYM that has a value compares greater than an OracleIntervalYM that has a null value.

• Two OracleIntervalYMs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalYM Structure OracleIntervalYM Members

  
  

LessThan

This static method determines whether the first of two OracleIntervalYM values is less than the second.

Declaration

// C#
public static bool LessThan(OracleIntervalYM val1, OracleIntervalYM val2);

Parameters

• val1

  First OracleIntervalYM.

• val2

  Second OracleIntervalYM.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalYM that has a value compares greater than an OracleIntervalYM that has a null value.

• Two OracleIntervalYMs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalYM Structure OracleIntervalYM Members

  
  

LessThanOrEqual

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

Declaration

// C#
public static bool LessThanOrEqual(OracleIntervalYM val1, OracleIntervalYM val2);

Parameters

• val1

  First OracleIntervalYM.

• val2

  Second OracleIntervalYM.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalYM that has a value compares greater than an OracleIntervalYM that has a null value.

• Two OracleIntervalYMs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalYM Structure OracleIntervalYM Members

  
  

NotEquals

This static method determines whether two OracleIntervalYM values are not equal.

Declaration

// C#
public static bool NotEquals(OracleIntervalYM val1, OracleIntervalYM val2);

Parameters

• val1

  First OracleIntervalYM.

• val2

  Second OracleIntervalYM.

Return Value

Returns true if two OracleIntervalYM values are not equal. Returns false otherwise.

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalYM that has a value compares greater than an OracleIntervalYM that has a null value.

• Two OracleIntervalYMs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalYM Structure OracleIntervalYM Members

  
  

Parse

This static method returns an OracleIntervalYM structure and sets its value for time interval using a string.

Declaration

// C#
public static OracleIntervalYM Parse (string intervalStr);

Parameters

• intervalStr

  A string representing the Oracle INTERVAL YEAR TO MONTH.

Return Value

Returns an OracleIntervalYM structure.

Exceptions

ArgumentException - The intervalStr parameter is not in the valid format or intervalStr has an invalid value.

ArgumentNullException - The intervalStr parameter is null.

Remarks

The value specified in the supplied intervalStr must be in the Year-Month format.

Example

"1-2" means 1 year and 2 months.

SetPrecision

This static method returns a new instance of an OracleIntervalYM with the specified year precision.

Declaration

// C#
public static OracleIntervalYM SetPrecision(OracleIntervalYM value1,int yearPrecision);

Parameters

• value1

  An OracleIntervalYM structure.

• yearPrecision

  The year precision provided. Range of year precision is (0 to 9).

Return Value

An OracleIntervalDS instance.

Exceptions

ArgumentOutOfRangeException - yearPrecision is out of the specified range.

Remarks

Depending on the value specified in the supplied yearPrecision, 0 or more leading zeros are displayed in the string returned by ToString().

Example

An OracleIntervalYM with a value of "1-2" results in the string "001-2" when SetPrecision() is called with the year precision set to 3.

OracleIntervalYM Static Operators

The OracleIntervalYM static operators are listed in Table 5-70.

operator +

This static operator adds two OracleIntervalYM values.

Declaration

// C#
public static OracleIntervalYM operator + (OracleIntervalYM val1,  OracleIntervalYM val2);

Parameters

• val1

  First OracleIntervalYM.

• val2

  Second OracleIntervalYM.

Return Value

OracleIntervalYM

Remarks

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

operator ==

This static operator determines if two OracleIntervalYM values are equal.

Declaration

// C#
public static bool operator == (OracleIntervalYM val1, OracleIntervalYM val2);

Parameters

• val1

  First OracleIntervalYM.

• val2

  Second OracleIntervalYM.

Return Value

Returns true if they are equal; otherwise returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalYM that has a value compares greater than an OracleIntervalYM that has a null value.

• Two OracleIntervalYMs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalYM Structure OracleIntervalYM Members

  
  

operator >

This static operator determines if the first of two OracleIntervalYM values is greater than the second.

Declaration

// C#
public static bool operator > (OracleIntervalYM val1, OracleIntervalYM val2);

Parameters

• val1

  First OracleIntervalYM.

• val2

  Second OracleIntervalYM.

Return Value

Returns true if one OracleIntervalYM value is greater than another; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalYM that has a value compares greater than an OracleIntervalYM that has a null value.

• Two OracleIntervalYMs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalYM Structure OracleIntervalYM Members

  
  

operator >=

This static operator determines if the first of two OracleIntervalYM values is greater than or equal to the second.

Declaration

// C#
public static bool operator >= (OracleIntervalYM val1, OracleIntervalYM val2);

Parameters

• val1

  First OracleIntervalYM.

• val2

  Second OracleIntervalYM.

Return Value

Returns true if one OracleIntervalYM value is greater than or equal to another; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalYM that has a value compares greater than an OracleIntervalYM that has a null value.

• Two OracleIntervalYMs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalYM Structure OracleIntervalYM Members

  
  

operator !=

This static operator determines whether two OracleIntervalYM values are not equal.

Declaration

// C#
public static bool operator != (OracleIntervalYM val1, OracleIntervalYM val2)

Parameters

• val1

  First OracleIntervalYM.

• val2

  Second OracleIntervalYM.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalYM that has a value compares greater than an OracleIntervalYM that has a null value.

• Two OracleIntervalYMs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalYM Structure OracleIntervalYM Members

  
  

operator <

This static operator determines if the first of two OracleIntervalYM values is less than the second.

Declaration

// C#
public static bool operator < (OracleIntervalYM val1, OracleIntervalYM val2);

Parameters

• val1

  First OracleIntervalYM.

• val2

  Second OracleIntervalYM.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalYM that has a value compares greater than an OracleIntervalYM that has a null value.

• Two OracleIntervalYMs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalYM Structure OracleIntervalYM Members

  
  

operator <=

This static operator determines if the first of two OracleIntervalYM values is less than or equal to the second.

Declaration

// C#
public static bool operator <= (OracleIntervalYM val1, OracleIntervalYM val2);

Parameters

• val1

  First OracleIntervalYM.

• val2

  Second OracleIntervalYM.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalYM that has a value compares greater than an OracleIntervalYM that has a null value.

• Two OracleIntervalYMs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalYM Structure OracleIntervalYM Members

  
  

operator -

This static operator subtracts one OracleIntervalYM structure from another.

Declaration

// C#
public static OracleIntervalYM operator - (OracleIntervalYM val1, OracleIntervalYM val2);

Parameters

• val1

  First OracleIntervalYM.

• val2

  Second OracleIntervalYM.

Return Value

An OracleIntervalYM structure.

Remarks

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

operator -

This static operator negates an OracleIntervalYM structure.

Declaration

// C#
public static OracleIntervalYM operator - (OracleIntervalYM val);

Parameters

• val

  An OracleIntervalYM.

Return Value

An OracleIntervalYM structure.

Remarks

If the supplied OracleIntervalYM structure has a null value, the returned OracleIntervalYM structure has a null value.

operator *

This static operator multiplies an OracleIntervalYM value by a number.

Declaration

// C#
public static OracleIntervalYM operator * (OracleIntervalYM val1, int multiplier);

Parameters

• val1

  First OracleIntervalYM.

• multiplier

  A multiplier.

Return Value

An OracleIntervalYM structure.

Remarks

If the supplied OracleIntervalYM structure has a null value, the returned OracleIntervalYM structure has a null value.

operator /

This static operator divides an OracleIntervalYM value by a number.

Declaration

// C#
public static OracleIntervalYM operator / (OracleIntervalYM val1, int divisor);

Parameters

• val1

  First OracleIntervalYM.

• divisor

  A divisor.

Return Value

An OracleIntervalYM structure.

Remarks

If the supplied OracleIntervalYM structure has a null value, the returned OracleIntervalYM structure has a null value.

OracleIntervalYM Type Conversions

The OracleIntervalYM conversions are listed in Table 5-71.

explicit operator long

This type conversion operator converts an OracleIntervalYM to a number that represents the number of months in the time interval.

Declaration

// C#
public static explicit operator long (OracleIntervalYM val);

Parameters

• val

  An OracleIntervalYM structure.

Return Value

A long number in months.

Exceptions

OracleNullValueException - The OracleIntervalYM structure has a null value.

explicit operator OracleIntervalYM

This type conversion operator converts the string intervalStr to an OracleIntervalYM structure.

Declaration

// C#
public static explicit operator OracleIntervalYM (string intervalStr);

Parameters

• intervalStr

  A string representation of an Oracle INTERVAL YEAR TO MONTH.

Return Value

An OracleIntervalYM structure.

Exceptions

ArgumentException - The supplied intervalStr parameter is not in the correct format or has an invalid value.

ArgumentNullException - The intervalStr parameter is null.

Remarks

The returned OracleIntervalDS structure contains the same time interval represented by the supplied intervalStr. The value specified in the supplied intervalStr must be in Year-Month format.

implicit operator OracleIntervalYM

This type conversion operator converts the total number of months as time interval to an OracleIntervalYM structure.

Declaration

// C#
public static implicit operator OracleIntervalYM (long months);

Parameters

• months

  The number of months to be converted. Range is (-999,999,999 * 12)-11 <= months <= (999,999,999 * 12)+11.

Return Value

An OracleIntervalYM structure.

Exceptions

ArgumentOutOfRangeException - The months parameter is out of the specified range.

OracleIntervalYM Properties

The OracleIntervalYM properties are listed in Table 5-72.

BinData

This property returns an array of bytes that represents the Oracle INTERVAL YEAR TO MONTH in Oracle internal format.

Declaration

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

Property Value

A byte array that represents an Oracle INTERVAL YEAR TO MONTH in Oracle internal format.

Exceptions

OracleNullValueException - The current instance has a null value.

IsNull

This property indicates whether the value has a null value.

Declaration

// C#
public bool IsNull {get;}

Property Value

Returns true if value has a null value; otherwise, returns false.

Months

This property gets the months component of an OracleIntervalYM.

Declaration

// C#
public int Months {get;}

Property Value

An int representing the months component.

Exceptions

OracleNullValueException - The current instance has a null value.

TotalYears

This property returns the total number, in years, that represents the period of time in the current OracleIntervalYM structure.

Declaration

// C#
public double TotalYears {get;}

Property Value

A double representing the total number of years.

Exceptions

OracleNullValueException - The current instance has a null value.

Value

This property gets the total number of months that is stored in the OracleIntervalYM structure.

Declaration

// C#
public long Value {get;}

Property Value

The total number of months representing the time interval.

Exceptions

OracleNullValueException - The current instance has a null value.

Years

This property gets the years component of an OracleIntervalYM.

Declaration

// C#
public int Years {get;}

Property Value

An int representing the years component.

Exceptions

OracleNullValueException - The current instance has a null value.

OracleIntervalYM Methods

The OracleIntervalYM methods are listed in Table 5-73.

CompareTo

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

Declaration

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

Parameters

• obj

  The supplied object.

Return Value

The method returns a number:

Less than zero: if the current OracleIntervalYM represents a shorter time interval than obj.

Zero: if the current OracleIntervalYM and obj represent the same time interval.

Greater than zero: if the current OracleIntervalYM represents a longer time interval than obj.

Implements

IComparable

Exceptions

ArgumentException - The obj parameter is not of type OracleIntervalYM.

Remarks

The following rules apply to the behavior of this method.

• The comparison must be between OracleIntervalYMs. For example, comparing an OracleIntervalYM instance with an OracleBinary instance is not allowed. When an OracleIntervalYM is compared with a different type, an ArgumentException is thrown.

• Any OracleIntervalYM that has a value compares greater than an OracleIntervalYM that has a null value.

• Two OracleIntervalYMs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalYM Structure OracleIntervalYM Members

  
  

Equals

Overrides Object

This method determines whether the specified object has the same time interval as the current instance.

Declaration

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

Parameters

• obj

  The supplied object.

Return Value

Returns true if the specified object instance is of type OracleIntervalYM and has the same time interval; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleIntervalYM that has a value compares greater than an OracleIntervalYM that has a null value.

• Two OracleIntervalYMs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleIntervalYM Structure OracleIntervalYM Members

  
  

GetHashCode

Overrides Object

This method returns a hash code for the OracleIntervalYM instance.

Declaration

// C#
public override int GetHashCode();

Return Value

An int representing a hash code.

ToString

Overrides Object

This method converts the current OracleIntervalYM structure to a string.

Declaration

// C#
public override string ToString();

Return Value

A string that represents the current OracleIntervalYM structure.

Remarks

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

---

OracleString Structure

The OracleString structure represents a variable-length stream of characters to be stored in or retrieved from a database.

Class Inheritance

Object

  ValueType

    OracleString

Declaration

// C#
public struct OracleString : IComparable

Thread Safety

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

Example

// C#
// Illustrates the usage of OracleString

// bytes1 is non-Unicode encoded byte array = AAAAA
// bytes2 is Unicode encoded byte array = aa

byte[] bytes1 = new byte[] {65,65,65,65,65};
byte[] bytes2 = new byte[] {97,0,97,0};

// set str1 = AAA
// set str2 = a
OracleString str1 = new OracleString(bytes1, 0, 3, false, true);
OracleString str2 = new OracleString(bytes2, 2, 2, true, true);

// Display the constructed strings
Console.WriteLine("String str1 = " + str1.Value  +
 ". Length = " + str1.Length); // Prints String str1 = AAA. Length = 3

 Console.WriteLine("String str2 = " + str2.Value  + 
   ". Length = " + str2.Length); // Prints String str2 = a. Length = 1

while (str1 > str2)
   str2 = OracleString.Concat(str2,"a");

// Display the constructed strings
Console.WriteLine("String str1 = " + str1.Value + 
   ". Length = " + str1.Length); // Prints String str1 = AAA. Length= 3
Console.WriteLine("String str2 = " + str2.Value + 
   ". Length = " + str2.Length); // Prints String str2 = aaa. Length= 3

Requirements

Namespace: Oracle.DataAccess.Types

Assembly: Oracle.DataAccess.dll

OracleString Members

OracleString members are listed in the following tables:

OracleString Constructors

OracleString constructors are listed in Table 5-74

OracleString Static Fields

The OracleString static fields are listed in Table 5-75.

OracleString Static Methods

The OracleString static methods are listed in Table 5-76.

OracleString Static Operators

The OracleString static operators are listed in Table 5-77.

OracleString Type Conversions

The OracleString type conversions are listed in Table 5-78.

OracleString Properties

The OracleString properties are listed in Table 5-79.

OracleString Methods

The OracleString methods are listed in Table 5-80.

OracleString Constructors

The OracleString constructors create new instances of the OracleString structure.

Overload List:

• OracleString(string)

  This constructor creates a new instance of the OracleString structure and sets its value using a string.

• OracleString(string, bool)

  This constructor creates a new instance of the OracleString structure and sets its value using a string and specifies if case is ignored in comparison.

• OracleString(byte [ ], bool)

  This constructor creates a new instance of the OracleString structure and sets its value using a byte array and specifies if the supplied byte array is Unicode encoded.

• OracleString(byte [ ], bool, bool)

  This constructor creates a new instance of the OracleString structure and sets its value using a byte array and specifies the following: if the supplied byte array is Unicode encoded and if case is ignored in comparison.

• OracleString(byte [ ], int, int, bool)

  This constructor creates a new instance of the OracleString structure and sets its value using a byte array, and specifies the following: the starting index in the byte array, the number of bytes to copy from the byte array, and if the supplied byte array is Unicode encoded.

• OracleString(byte [ ], int, int, bool, bool)

  This constructor creates a new instance of the OracleString structure and sets its value using a byte array, and specifies the following: the starting index in the byte array, the number of bytes to copy from the byte array, if the supplied byte array is Unicode encoded, and if case is ignored in comparison.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

OracleString(string)

This constructor creates a new instance of the OracleString structure and sets its value using a string.

Declaration

// C#
public OracleString(string data);

Parameters

• data

  A string value.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

OracleString(string, bool)

This constructor creates a new instance of the OracleString structure and sets its value using a string and specifies if case is ignored in comparison.

Declaration

// C#
public OracleString(string data, bool isCaseIgnored);

Parameters

• data

  A string value.

• isCaseIgnored

  Specifies if case is ignored in comparison. Specifies true if case is to be ignored; otherwise, specifies false.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

OracleString(byte [ ], bool)

This constructor creates a new instance of the OracleString structure and sets its value using a byte array and specifies if the supplied byte array is Unicode encoded.

Declaration

// C#
public OracleString(byte[] data, bool fUnicode);

Parameters

• data

  Byte array data for the new OracleString.

• fUnicode

  Specifies if the supplied data is Unicode encoded. Specifies true if Unicode encoded; otherwise, false.

Exceptions

ArgumentNullException - The data parameter is null.

OracleString(byte [ ], bool, bool)

This constructor creates a new instance of the OracleString structure and sets its value using a byte array and specifies the following: if the supplied byte array is Unicode encoded and if case is ignored in comparison.

Declaration

// C#
public OracleString(byte[] data, bool fUnicode, bool isCaseIgnored);

Parameters

• data

  Byte array data for the new OracleString.

• fUnicode

  Specifies if the supplied data is Unicode encoded. Specifies true if Unicode encoded; otherwise, false.

• isCaseIgnored

  Specifies if case is ignored in comparison. Specifies true if case is to be ignored; otherwise, specifies false.

Exceptions

ArgumentNullException - The data parameter is null.

OracleString(byte [ ], int, int, bool)

This constructor creates a new instance of the OracleString structure and sets its value using a byte array, and specifies the following: the starting index in the byte array, the number of bytes to copy from the byte array, and if the supplied byte array is Unicode encoded.

Declaration

// C#
public OracleString(byte[] data, int index, int count, bool fUnicode);

Parameters

• data

  Byte array data for the new OracleString.

• index

  The starting index to copy from data.

• count

  The number of bytes to copy.

• fUnicode

  Specifies if the supplied data is Unicode encoded. Specifies true if Unicode encoded; otherwise, false.

Exceptions

ArgumentNullException - The data parameter is null.

ArgumentOutOfRangeException - The count parameter is less than zero.

IndexOutOfRangeException - The index parameter is greater than or equal to the length of data or less than zero.

OracleString(byte [ ], int, int, bool, bool)

This constructor creates a new instance of the OracleString structure and sets its value using a byte array, and specifies the following: the starting index in the byte array, the number of bytes to copy from the byte array, if the supplied byte array is Unicode encoded, and if case is ignored in comparison.

Declaration

// C#
public OracleString(byte[] data, int index, int count, bool fUnicode,
  bool isCaseIgnored);

Parameters

• data

  Byte array data for the new OracleString.

• index

  The starting index to copy from data.

• count

  The number of bytes to copy.

• fUnicode

  Specifies if the supplied data is Unicode encoded. Specifies true if Unicode encoded; otherwise, false.

• isCaseIgnored

  Specifies if case is ignored in comparison. Specifies true if case is to be ignored; otherwise, specifies false.

Exceptions

ArgumentNullException - The data parameter is null.

ArgumentOutOfRangeException - The count parameter is less than zero.

IndexOutOfRangeException - The index parameter is greater than or equal to the length of data or less than zero.

OracleString Static Fields

The OracleString static fields are listed in Table 5-81.

Null

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

Declaration

// C#
public static readonly OracleString Null;

OracleString Static Methods

The OracleString static methods are listed in Table 5-82.

Concat

This static method concatenates two OracleString instances and returns a new OracleString instance that represents the result.

Declaration

// C#
public static OracleString Concat(OracleString str1, OracleString str2);

Parameters

• str1

  First OracleString.

• str2

  Second OracleString.

Return Value

An OracleString.

Remarks

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

Equals

Overloads Object

This static method determines whether the two OracleStrings being compared are equal.

Declaration

// C#
public static bool Equals(OracleString str1, OracleString str2);

Parameters

• str1

  First OracleString.

• str2

  Second OracleString.

Return Value

Returns true if the two OracleStrings being compared are equal; returns false otherwise.

Remarks

The following rules apply to the behavior of this method.

• Any OracleString that has a value is greater than an OracleString that has a null value.

• Two OracleStrings that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

GreaterThan

This static method determines whether the first of two OracleString values is greater than the second.

Declaration

// C#
public static bool GreaterThan(OracleString str1, OracleString str2);

Parameters

• str1

  First OracleString.

• str2

  Second OracleString.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleString that has a value is greater than an OracleString that has a null value.

• Two OracleStrings that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

GreaterThanOrEqual

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

Declaration

// C#
public static bool GreaterThanOrEqual(OracleString str1, OracleString str2);

Parameters

• str1

  First OracleString.

• str2

  Second OracleString.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleString that has a value is greater than an OracleString that has a null value.

• Two OracleStrings that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

LessThan

This static method determines whether the first of two OracleString values is less than the second.

Declaration

// C#
public static bool LessThan(OracleString str1, OracleString str2);

Parameters

• str1

  First OracleString.

• str2

  Second OracleString.

Return Value

Returns true if the first is less than the second; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleString that has a value is greater than an OracleString that has a null value.

• Two OracleStrings that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

LessThanOrEqual

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

Declaration

// C#
public static bool LessThanOrEqual(OracleString str1, OracleString str2);

Parameters

• str1

  First OracleString.

• str2

  Second OracleString.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleString that has a value is greater than an OracleString that has a null value.

• Two OracleStrings that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

NotEquals

This static method determines whether two OracleString values are not equal.

Declaration

// C#
public static bool NotEquals(OracleString str1, OracleString str2);

Parameters

• str1

  First OracleString.

• str2

  Second OracleString.

Return Value

Returns true if the two OracleString instances are not equal; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleString that has a value is greater than an OracleString that has a null value.

• Two OracleStrings that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

OracleString Static Operators

The OracleString static operators are listed in Table 5-83.

operator +

This static operator concatenates two OracleString values.

Declaration

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

Parameters

• value1

  First OracleString.

• value2

  Second OracleString.

Return Value

An OracleString.

Remarks

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

operator ==

This static operator determines if two OracleString values are equal.

Declaration

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

Parameters

• value1

  First OracleString.

• value2

  Second OracleString.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleString that has a value is greater than an OracleString that has a null value.

• Two OracleStrings that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

operator >

This static operator determines if the first of two OracleString values is greater than the second.

Declaration

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

Parameters

• value1

  First OracleString.

• value2

  Second OracleString.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleString that has a value is greater than an OracleString that has a null value.

• Two OracleStrings that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

operator >=

This static operator determines if the first of two OracleString values is greater than or equal to the second.

Declaration

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

Parameters

• value1

  First OracleString.

• value2

  Second OracleString.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleString that has a value is greater than an OracleString that has a null value.

• Two OracleStrings that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

operator !=

This static operator determines if two OracleString values are not equal.

Declaration

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

Parameters

• value1

  First OracleString.

• value2

  Second OracleString.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleString that has a value is greater than an OracleString that has a null value.

• Two OracleStrings that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

operator <

This static operator determines if the first of two OracleStrings is less than the second.

Declaration

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

Parameters

• value1

  First OracleString.

• value2

  Second OracleString.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleString that has a value is greater than an OracleString has a null value.

• Two OracleStrings that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

operator <=

This static operator determines if the first of two OracleString values is less than or equal to the second.

Declaration

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

Parameters

• value1

  First OracleString.

• value2

  Second OracleString.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleString that has a value is greater than an OracleString that has a null value.

• Two OracleStrings that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

OracleString Type Conversions

The OracleString type conversions are listed in Table 5-84.

explicit operator string

This type conversion operator converts the supplied OracleString to a string.

Declaration

//C#
public static explicit operator string (OracleString value1);

Parameters

• value1

  The supplied OracleString.

Return Value

string

Exceptions

OracleNullValueException - The OracleString structure has a null value.

implicit operator OracleString

This type conversion operator converts the supplied string to an OracleString.

Declaration

// C#
public static implicit operator OracleString (string value1);

Parameters

• value1

  The supplied string.

Return Value

An OracleString.

OracleString Properties

The OracleString properties are listed in Table 5-85.

IsCaseIgnored

This property indicates whether case should be ignored when performing string comparison.

Declaration

//C#
public bool IsCaseIgnored {get;set;}

Property Value

Returns true if string comparison must ignore case; otherwise false.

Remarks

Default value is true.

Example

// C#
OracleString str1 = new OracleString("aAaAa");
OracleString str2 = new OracleString("AaAaA");

str1.IsCaseIgnored = true;
str2.IsCaseIgnored = true;

Console.WriteLine(str1.CompareTo(str2)); // Prints 0

// Note that IsCaseIgnored must be set to false for both OracleStrings
// otherwise an exception is thrown

str1.IsCaseIgnored = false;
str2.IsCaseIgnored = false;

Console.WriteLine(str1.CompareTo(str2)); // Prints non zero value

IsNull

This property indicates whether the current instance contains a null value.

Declaration

// C#
public bool IsNull {get;}

Property Value

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

Item

This property obtains the particular character in an OracleString using an index.

Declaration

// C#
public char Item {get;}

Property Value

A char value.

Exceptions

OracleNullValueException - The current instance has a null value.

Length

This property returns the length of the OracleString.

Declaration

// C#
public int Length {get;}

Property Value

A int value.

Exceptions

OracleNullValueException - The current instance has a null value.

OracleString Methods

The OracleString methods are listed in Table 5-86.

Clone

This method creates a copy of an OracleString instance.

Declaration

// C#
public OracleString Clone();

Return Value

An OracleString structure.

Remarks

The cloned object has the same property values as that of the object being cloned.

Example

// C#
...
OracleString str_cloned = str.Clone();
...

CompareTo

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

Declaration

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

Parameters

• obj

  The object being compared to the current instance.

Return Value

The method returns a number that is:

• Less than zero: if the current OracleString value is less than obj.

• Zero: if the current OracleString value is equal to obj.

• Greater than zero: if the current OracleString value is greater than obj.

Implements

IComparable

Exceptions

ArgumentException - The obj parameter is not of type OracleString.

Remarks

The following rules apply to the behavior of this method.

• The comparison must be between OracleStrings. For example, comparing an OracleString instance with an OracleBinary instance is not allowed. When an OracleString is compared with a different type, an ArgumentException is thrown.

• Any OracleString that has a value is greater than an OracleString that has a null value.

• Two OracleStrings that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

Equals

This method determines whether supplied object is an instance of OracleString and has the same values as the current OracleString instance.

Declaration

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

Parameters

• obj

  An object being compared.

Return Value

Returns true if the supplied object is an instance of OracleString and has the same values as the current OracleString instance; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleString that has a value is greater than an OracleString that has a null value.

• Two OracleStrings that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleString Structure OracleString Members

  
  

GetHashCode

Overrides Object

This method returns a hash code for the OracleString instance.

Declaration

// C#
public override int GetHashCode();

Return Value

A number that represents the hash code.

GetNonUnicodeBytes

This method returns an array of bytes, containing the contents of the OracleString, in the client character set format.

Declaration

// C#
public byte[] GetNonUnicodeBytes();

Return Value

A byte array that contains the contents of the OracleString in the client character set format.

Remarks

If the current instance has a null value, an OracleNullValueException is thrown.

GetUnicodeBytes

This method returns an array of bytes, containing the contents of the OracleString in Unicode format.

Declaration

// C#
public byte[] GetUnicodeBytes();

Return Value

A byte array that contains the contents of the OracleString in Unicode format.

Remarks

If the current instance has a null value, an OracleNullValueException is thrown.

ToString

Overrides Object

This method converts the current OracleString instance to a string.

Declaration

// C#
public override string ToString();

Return Value

A string.

Remarks

If the current OracleString instance has a null value, the string contains "null".

---

OracleTimeStamp Structure

The OracleTimeStamp structure represents the Oracle TIMESTAMP datatype to be stored in or retrieved from a database. Each OracleTimeStamp stores the following information: year, month, day, hour, minute, second, and nanosecond.

Class Inheritance

Object

  ValueType

    OracleTimeStamp

Declaration

// C#
public struct OracleTimeStamp : IComparable

Thread Safety

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

Example

// C#
// Illustrates usage of OracleTimeStamp

OracleTimeStamp  tsCurrent1 = OracleTimeStamp.GetSysDate();
OracleTimeStamp  tsCurrent2 = DateTime.Now;

// Calculate the difference between tsCurrent1 and tsCurrent2
OracleIntervalDS idsDiff = tsCurrent2.GetDaysBetween(tsCurrent1);

// Calculate the difference using AddNanoseconds()
int nanoDiff = 0;
while (tsCurrent2 > tsCurrent1)
{
  nanoDiff += 10;
  tsCurrent1 = tsCurrent1.AddNanoseconds(10);
}
Console.WriteLine("idsDiff.Nanoseconds = " + idsDiff.Nanoseconds);
      Console.WriteLine("nanoDiff = " + nanoDiff);

Requirements

Namespace: Oracle.DataAccess.Types

Assembly: Oracle.DataAccess.dll

OracleTimeStamp Members

OracleTimeStamp members are listed in the following tables:

OracleTimeStamp Constructors

OracleTimeStamp constructors are listed in Table 5-87

OracleTimeStamp Static Fields

The OracleTimeStamp static fields are listed in Table 5-88.

OracleTimeStamp Static Methods

The OracleTimeStamp static methods are listed in Table 5-89.

OracleTimeStamp Static Operators

The OracleTimeStamp static operators are listed in Table 5-90.

OracleTimeStamp Static Type Conversions

The OracleTimeStamp static type conversions are listed in Table 5-91.

OracleTimeStamp Properties

The OracleTimeStamp properties are listed in Table 5-92.

OracleTimeStamp Methods

The OracleTimeStamp methods are listed in Table 5-93.

OracleTimeStamp Constructors

The OracleTimeStamp constructors create new instances of the OracleTimeStamp structure.

Overload List:

• OracleTimeStamp(DateTime)

  This constructor creates a new instance of the OracleTimeStamp structure and sets its value for date and time using the supplied DateTime value.

• OracleTimeStamp(string)

  This constructor creates a new instance of the OracleTimeStamp structure and sets its value using the supplied string.

• OracleTimeStamp(int, int, int)

  This constructor creates a new instance of the OracleTimeStamp structure and sets its value for date using year, month, and day.

• OracleTimeStamp(int, int, int, int, int, int)

  This constructor creates a new instance of the OracleTimeStamp structure and sets its value for date and time using year, month, day, hour, minute, and second.

• OracleTimeStamp(int, int, int, int, int, int, double)

  This constructor creates a new instance of the OracleTimeStamp structure and sets its value for date and time using year, month, day, hour, minute, second, and millisecond.

• OracleTimeStamp(int, int, int, int, int, int, int)

  This constructor creates a new instance of the OracleTimeStamp structure and sets its value for date and time using year, month, day, hour, minute, second, and nanosecond.

• OracleTimeStamp(byte [ ])

  This constructor creates a new instance of the OracleTimeStamp structure and sets its value to the provided byte array, which is in the internal Oracle TIMESTAMP format.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

OracleTimeStamp(DateTime)

This constructor creates a new instance of the OracleTimeStamp structure and sets its value for date and time using the supplied DateTime value.

Declaration

// C#
public OracleTimeStamp (DateTime dt);

Parameters

• dt

  The supplied DateTime value.

Exceptions

ArgumentException - The dt parameter cannot be used to construct a valid OracleTimeStamp.

OracleTimeStamp(string)

This constructor creates a new instance of the OracleTimeStamp structure and sets its value using the supplied string.

Declaration

// C#
public OracleTimeStamp (string tsStr);

Parameters

• tsStr

  A string that represents an Oracle TIMESTAMP.

Exceptions

ArgumentException - The tsStr value is an invalid string representation of an Oracle TIMESTAMP or the supplied tsStr is not in the timestamp format specified by the OracleGlobalization.TimeStampFormat property of the thread, which represents Oracle's NLS_TIMESTAMP_FORMAT parameter.

ArgumentNullException - The tsStr value is null.

Remarks

The names and abbreviations used for months and days are in the language specified by the DateLanguage and Calendar properties of the thread's OracleGlobalization object. If any of the thread's globalization properties are set to null or an empty string, the client computer's settings are used.

Example

// C#
// Set the nls_timestamp_format for the OracleTimeStamp(string) constructor
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.TimeStampFormat   = "DD-MON-YYYY HH:MI:SS.FF AM";
OracleGlobalization.SetThreadInfo(og);

// construct OracleTimeStamp from a string using the format specified.

OracleTimeStamp ts = new OracleTimeStamp("11-NOV-1999 11:02:33.444 AM");

// Set the nls_timestamp_format for the ToString() method
og.TimeStampFormat = "YYYY-MON-DD HH:MI:SS.FF AM";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine(ts.ToString());
// Prints "1999-NOV-11 11:02:33.444000000 AM"

OracleTimeStamp(int, int, int)

This constructor creates a new instance of the OracleTimeStamp structure and sets its value for date using year, month, and day.

Declaration

// C#
public OracleTimeStamp(int year, int month, int day);

Parameters

• year

  The year provided. Range of year is (-4712 to 9999).

• month

  The month provided. Range of month is (1 to 12).

• day

  The day provided. Range of day is (1 to 31).

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStamp (that is, the day is out of range for the month).

OracleTimeStamp(int, int, int, int, int, int)

This constructor creates a new instance of the OracleTimeStamp structure and sets its value for date and time using year, month, day, hour, minute, and second.

Declaration

// C#
public OracleTimeStamp (int year, int month, int day, int hour, int minute, int second);

Parameters

• year

  The year provided. Range of year is (-4712 to 9999).

• month

  The month provided. Range of month is (1 to 12).

• day

  The day provided. Range of day is (1 to 31).

• hour

  The hour provided. Range of hour is (0 to 23).

• minute

  The minute provided. Range of minute is (0 to 59).

• second

  The second provided. Range of second is (0 to 59).

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStamp (that is, the day is out of range for the month).

OracleTimeStamp(int, int, int, int, int, int, double)

This constructor creates a new instance of the OracleTimeStamp structure and sets its value for date and time using year, month, day, hour, minute, second, and millisecond.

Declaration

// C#
public OracleTimeStamp(int year, int month, int day, int hour, int minute,
 int second, double millisecond);

Parameters

• year

  The year provided. Range of year is (-4712 to 9999).

• month

  The month provided. Range of month is (1 to 12).

• day

  The day provided. Range of day is (1 to 31).

• hour

  The hour provided. Range of hour is (0 to 23).

• minute

  The minute provided. Range of minute is (0 to 59).

• second

  The second provided. Range of second is (0 to 59).

• milliSeconds

  The milliseconds provided. Range of millisecond is (0 to 999.999999).

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStamp (that is, the day is out of range for the month).

OracleTimeStamp(int, int, int, int, int, int, int)

This constructor creates a new instance of the OracleTimeStamp structure and sets its value for date and time using year, month, day, hour, minute, second, and nanosecond.

Declaration

// C#
public OracleTimeStamp (int year, int month, int day, int hour, int minute, int second, int nanosecond);

Parameters

• year

  The year provided. Range of year is (-4712 to 9999).

• month

  The month provided. Range of month is (1 to 12).

• day

  The day provided. Range of day is (1 to 31).

• hour

  The hour provided. Range of hour is (0 to 23).

• minute

  The minute provided. Range of minute is (0 to 59).

• second

  The second provided. Range of second is (0 to 59).

• nanosecond

  The nanosecond provided. Range of nanosecond is (0 to 999999999).

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStamp (that is, the day is out of range for the month).

OracleTimeStamp(byte [ ])

This constructor creates a new instance of the OracleTimeStamp structure and sets its value to the provided byte array, which is in the internal Oracle TIMESTAMP format.

Declaration

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

Parameters

• bytes

  A byte array that represents an Oracle TIMESTAMP in Oracle internal format.

Exceptions

ArgumentException - bytes is not in an internal Oracle TIMESTAMP format or bytes is not a valid Oracle TIMESTAMP.

ArgumentNullException - bytes is null.

OracleTimeStamp Static Fields

The OracleTimeStamp static fields are listed in Table 5-94.

MaxValue

This static field represents the maximum valid date and time for an OracleTimeStamp structure, which is December 31, 9999 23:59:59.999999999.

Declaration

// C#
public static readonly OraTimestamp MaxValue;

MinValue

This static field represents the minimum valid date and time for an OracleTimeStamp structure, which is January 1, -4712 0:0:0.

Declaration

// C#
public static readonly OracleTimeStamp MinValue;

Null

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

Declaration

// C#
public static readonly OracleTimeStamp Null;

OracleTimeStamp Static Methods

The OracleTimeStamp static methods are listed in Table 5-95.

Equals

This static method determines if two OracleTimeStamp values are equal.

Declaration

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

Parameters

• value1

  First OracleTimeStamp.

• value2

  Second OracleTimeStamp.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStamp that has a value is greater than an OracleTimeStamp that has a null value.

• Two OracleTimeStamps that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

GreaterThan

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

Declaration

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

Parameters

• value1

  First OracleTimeStamp.

• value2

  Second OracleTimeStamp.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStamp that has a value is greater than an OracleTimeStamp that has a null value.

• Two OracleTimeStamps that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

GreaterThanOrEqual

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

Declaration

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

Parameters

• value1

  First OracleTimeStamp.

• value2

  Second OracleTimeStamp.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStamp that has a value is greater than an OracleTimeStamp that has a null value.

• Two OracleTimeStamps that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

LessThan

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

Declaration

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

Parameters

• value1

  First OracleTimeStamp.

• value2

  Second OracleTimeStamp.

Return Value

Returns true if the first of two OracleTimeStamp values is less than the second. Returns false otherwise.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStamp that has a value is greater than an OracleTimeStamp that has a null value.

• Two OracleTimeStamps that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

LessThanOrEqual

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

Declaration

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

Parameters

• value1

  First OracleTimeStamp.

• value2

  Second OracleTimeStamp.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStamp that has a value is greater than an OracleTimeStamp that has a null value.

• Two OracleTimeStamps that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

NotEquals

This static method determines if two OracleTimeStamp values are not equal.

Declaration

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

Parameters

• value1

  First OracleTimeStamp.

• value2

  Second OracleTimeStamp.

Return Value

Returns true if two OracleTimeStamp values are not equal. Returns false otherwise.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStamp that has a value is greater than an OracleTimeStamp that has a null value.

• Two OracleTimeStamps that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

GetSysDate

This static method gets an OracleTimeStamp structure that represents the current date and time.

Declaration

// C#
public static OracleTimeStamp GetSysDate();

Return Value

An OracleTimeStamp structure that represents the current date and time.

Parse

This static method gets an OracleTimeStamp structure and sets its value using the supplied string.

Declaration

// C#
public static OracleTimeStamp Parse(string datetime);

Parameters

• datetime

  A string that represents an Oracle TIMESTAMP.

Return Value

An OracleTimeStamp structure.

Exceptions

ArgumentException - The tsStr is an invalid string representation of an Oracle TIMESTAMP or the supplied tsStr is not in the timestamp format specified by the OracleGlobalization.TimeStampFormat property of the thread, which represents Oracle's NLS_TIMESTAMP_FORMAT parameter.

ArgumentNullException - The tsStr value is null.

Remarks

The names and abbreviations used for months and days are in the language specified by the DateLanguage and Calendar properties of the thread's OracleGlobalization object. If any of the thread's globalization properties are set to null or an empty string, the client computer's settings are used.

Example

// C#
// Set the nls_timestamp_format for the Parse() method
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.TimeStampFormat   = "DD-MON-YYYY HH:MI:SS.FF AM";
OracleGlobalization.SetThreadInfo(og);

// construct OracleTimeStamp from a string using the format specified.

OracleTimeStamp ts = OracleTimeStamp.Parse("11-NOV-1999 11:02:33.444 AM");

// Set the nls_timestamp_format for the ToString() method
og.TimeStampFormat = "YYYY-MON-DD HH:MI:SS.FF AM";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine(ts.ToString());
// Prints "1999-NOV-11 11:02:33.444000000 AM"

SetPrecision

This static method returns a new instance of an OracleTimeStamp with the specified fractional second precision.

Declaration

// C#
public static OracleTimeStamp SetPrecision(OracleTimeStamp value1, int fracSecPrecision);

Parameters

• value1

  The provided OracleTimeStamp object.

• fracSecPrecision

  The fractional second precision provided. Range of fractional second precision is (0 to 9).

Return Value

An OracleTimeStamp structure with the specified fractional second precision.

Exceptions

ArgumentOutOfRangeException - fracSecPrecision is out of the specified range.

Remarks

The value specified in the supplied fracSecPrecision is used to perform a rounding off operation on the supplied OracleTimeStamp value. Depending on this value, 0 or more trailing zeros are displayed in the string returned by ToString().

Example

The OracleTimeStamp with a value of "December 31, 9999 23:59:59.99" results in the string "December 31, 9999 23:59:59.99000" when SetPrecision() is called with the fractional second precision set to 5.

OracleTimeStamp Static Operators

The OracleTimeStamp static operators are listed in Table 5-96.

operator +

operator+ adds the supplied object to the OracleTimeStamp and returns a new OracleTimeStamp structure.

Overload List:

• operator + (OracleTimeStamp, OracleIntervalDS)

  This static operator adds the supplied OracleIntervalDS to the OracleTimeStamp and returns a new OracleTimeStamp structure.

• operator + (OracleTimeStamp, OracleIntervalYM)

  This static operator adds the supplied OracleIntervalYM to the supplied OracleTimeStamp and returns a new OracleTimeStamp structure.

• operator + (OracleTimeStamp, TimeSpan)

  This static operator adds the supplied TimeSpan to the supplied OracleTimeStamp and returns a new OracleTimeStamp structure.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

operator + (OracleTimeStamp, OracleIntervalDS)

This static operator adds the supplied OracleIntervalDS to the OracleTimeStamp and returns a new OracleTimeStamp structure.

Declaration

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

Parameters

• value1

  An OracleTimeStamp.

• value2

  An OracleIntervalDS.

Return Value

An OracleTimeStamp.

Remarks

If either parameter has a null value, the returned OracleTimeStamp has a null value.

operator + (OracleTimeStamp, OracleIntervalYM)

This static operator adds the supplied OracleIntervalYM to the supplied OracleTimeStamp and returns a new OracleTimeStamp structure.

Declaration

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

Parameters

• value1

  An OracleTimeStamp.

• value2

  An OracleIntervalYM.

Return Value

An OracleTimeStamp.

Remarks

If either parameter has a null value, the returned OracleTimeStamp has a null value.

operator + (OracleTimeStamp, TimeSpan)

This static operator adds the supplied TimeSpan to the supplied OracleTimeStamp and returns a new OracleTimeStamp structure.

Declaration

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

Parameters

• value1

  An OracleTimeStamp.

• value2

  A TimeSpan.

Return Value

An OracleTimeStamp.

Remarks

If the OracleTimeStamp instance has a null value, the returned OracleTimeStamp has a null value.

operator ==

This static operator determines if two OracleTimeStamp values are equal.

Declaration

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

Parameters

• value1

  First OracleTimeStamp.

• value2

  Second OracleTimeStamp.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStamp that has a value is greater than an OracleTimeStamp that has a null value.

• Two OracleTimeStamps that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

operator >

This static operator determines if the first of two OracleTimeStamp values is greater than the second.

Declaration

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

Parameters

• value1

  First OracleTimeStamp.

• value2

  Second OracleTimeStamp.

Return Value

Returns true if the first OracleTimeStamp value is greater than the second; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStamp that has a value is greater than an OracleTimeStamp that has a null value.

• Two OracleTimeStamps that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

operator >=

This static operator determines if the first of two OracleTimeStamp values is greater than or equal to the second.

Declaration

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

Parameters

• value1

  First OracleTimeStamp.

• value2

  Second OracleTimeStamp.

Return Value

Returns true if the first OracleTimeStamp is greater than or equal to the second; otherwise returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStamp that has a value is greater than an OracleTimeStamp that has a null value.

• Two OracleTimeStamps that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

operator !=

This static operator determines if two OracleTimeStamp values are not equal.

Declaration

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

Parameters

• value1

  First OracleTimeStamp.

• value2

  Second OracleTimeStamp.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStamp that has a value is greater than an OracleTimeStamp that has a null value.

• Two OracleTimeStamps that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

operator <

This static operator determines if the first of two OracleTimeStamp values is less than the second.

Declaration

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

Parameters

• value1

  First OracleTimeStamp.

• value2

  Second OracleTimeStamp.

Return Value

Returns true if the first OracleTimeStamp is less than the second; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStamp that has a value is greater than an OracleTimeStamp that has a null value.

• Two OracleTimeStamps that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

operator <=

This static operator determines if the first of two OracleTimeStamp values is less than or equal to the second.

Declaration

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

Parameters

• value1

  First OracleTimeStamp.

• value2

  Second OracleTimeStamp.

Return Value

Returns true if the first OracleTimeStamp is less than or equal to the second; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStamp that has a value is greater than an OracleTimeStamp that has a null value.

• Two OracleTimeStamps that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

operator -

operator- subtracts the supplied value, from the supplied OracleTimeStamp value, and returns a new OracleTimeStamp structure.

Overload List:

• operator - (OracleTimeStamp, OracleIntervalDS)

  This static operator subtracts the supplied OracleIntervalDS value, from the supplied OracleTimeStamp value, and return a new OracleTimeStamp structure.

• operator - (OracleTimeStamp, OracleIntervalYM)

  This static operator subtracts the supplied OracleIntervalYM value, from the supplied OracleTimeStamp value, and returns a new OracleTimeStamp structure.

• operator - (OracleTimeStamp, TimeSpan)

  This static operator subtracts the supplied TimeSpan value, from the supplied OracleTimeStamp value, and returns a new OracleTimeStamp structure.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

operator - (OracleTimeStamp, OracleIntervalDS)

This static operator subtracts the supplied OracleIntervalDS value, from the supplied OracleTimeStamp value, and return a new OracleTimeStamp structure.

Declaration

// C#
public static operator - (OracleTimeStamp value1, OracleIntervalDS value2);

Parameters

• value1

  An OracleTimeStamp.

• value2

  An OracleIntervalDS instance.

Return Value

An OracleTimeStamp structure.

Remarks

If either parameter has a null value, the returned OracleTimeStamp has a null value.

operator - (OracleTimeStamp, OracleIntervalYM)

This static operator subtracts the supplied OracleIntervalYM value, from the supplied OracleTimeStamp value, and returns a new OracleTimeStamp structure.

Declaration

// C#
public static operator - (OracleTimeStamp value1, OracleIntervalYM value2);

Parameters

• value1

  An OracleTimeStamp.

• value2

  An OracleIntervalYM instance.

Return Value

An OracleTimeStamp structure.

Remarks

If either parameter has a null value, the returned OracleTimeStamp has a null value.

operator - (OracleTimeStamp, TimeSpan)

This static operator subtracts the supplied TimeSpan value, from the supplied OracleTimeStamp value, and returns a new OracleTimeStamp structure.

Declaration

// C#
public static operator - (OracleTimeStamp value1, TimeSpan value2);

Parameters

• value1

  An OracleTimeStamp.

• value2

  A TimeSpan instance.

Return Value

An OracleTimeStamp structure.

Remarks

If the OracleTimeStamp instance has a null value, the returned OracleTimeStamp structure has a null value.

OracleTimeStamp Static Type Conversions

The OracleTimeStamp static type conversions are listed in Table 5-97.

explicit operator OracleTimeStamp

explicit operator OracleTimeStamp converts the supplied value to an OracleTimeStamp structure

Overload List:

• explicit operator OracleTimeStamp(OracleTimeStampLTZ)

  This static type conversion operator converts an OracleTimeStampLTZ value to an OracleTimeStamp structure.

• explicit operator OracleTimeStamp(OracleTimeStampTZ)

  This static type conversion operator converts an OracleTimeStampTZ value to an OracleTimeStamp structure.

• explicit operator OracleTimeStamp(string)

  This static type conversion operator converts the supplied string to an OracleTimeStamp structure.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

explicit operator OracleTimeStamp(OracleTimeStampLTZ)

This static type conversion operator converts an OracleTimeStampLTZ value to an OracleTimeStamp structure.

Declaration

// C#
public static explicit operator OracleTimeStamp(OracleTimeStampLTZ value1);

Parameters

• value1

  An OracleTimeStampLTZ instance.

Return Value

The returned OracleTimeStamp contains the date and time of the OracleTimeStampLTZ structure.

Remarks

If the OracleTimeStampLTZ structure has a null value, the returned OracleTimeStamp structure also has a null value.

explicit operator OracleTimeStamp(OracleTimeStampTZ)

This static type conversion operator converts an OracleTimeStampTZ value to an OracleTimeStamp structure.

Declaration

// C#
public static explicit operator OracleTimeStamp(OracleTimeStampTZ value1);

Parameters

• value1

  An OracleTimeStampTZ instance.

Return Value

The returned OracleTimeStamp contains the date and time information from value1, but the time zone information from value1 is truncated.

Remarks

If the OracleTimeStampTZ structure has a null value, the returned OracleTimeStamp structure also has a null value.

explicit operator OracleTimeStamp(string)

This static type conversion operator converts the supplied string to an OracleTimeStamp structure.

Declaration

// C#
public static explicit operator OracleTimeStamp(string tsStr);

Parameters

• tsStr

  A string representation of an Oracle TIMESTAMP.

Return Value

A OracleTimeStamp.

Exceptions

ArgumentException - The tsStr is an invalid string representation of an Oracle TIMESTAMP or the tsStr is not in the timestamp format specified by the thread's OracleGlobalization.TimeStampFormat property, which represents Oracle's NLS_TIMESTAMP_FORMAT parameter.

Remarks

The names and abbreviations used for months and days are in the language specified by the DateLanguage and Calendar properties of the thread's OracleGlobalization object. If any of the thread's globalization properties are set to null or an empty string, the client computer's settings are used.

Example

// C#
// Set the nls_timestamp_format for the explicit operator // OracleTimeStamp(string)
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.TimeStampFormat   = "DD-MON-YYYY HH:MI:SS.FF AM";
OracleGlobalization.SetThreadInfo(og);

// construct OracleTimeStamp from a string using the format specified.

OracleTimeStamp ts = new OracleTimeStamp("11-NOV-1999 11:02:33.444 AM");

// Set the nls_timestamp_format for the ToString method
og.TimeStampFormat = "YYYY-MON-DD HH:MI:SS.FF AM";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine(ts.ToString());
// Prints "1999-NOV-11 11:02:33.444000000 AM"

implicit operator OracleTimeStamp

This static type conversion operator converts a value to an OracleTimeStamp structure.

Overload List:

• implicit operator OracleTimeStamp(OracleDate)

  This static type conversion operator converts an OracleDate value to an OracleTimeStamp structure.

• implicit operator OracleTimeStamp(DateTime)

  This static type conversion operator converts a DateTime value to an OracleTimeStamp structure.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

implicit operator OracleTimeStamp(OracleDate)

This static type conversion operator converts an OracleDate value to an OracleTimeStamp structure.

Declaration

// C#
public static implicit operator OracleTimeStamp (OracleDate value1);

Parameters

• value1

  An OracleDate instance.

Return Value

An OracleTimeStamp structure that contains the date and time of the OracleDate structure, value1.

Remarks

If the OracleDate structure has a null value, the returned OracleTimeStamp structure also has a null value.

implicit operator OracleTimeStamp(DateTime)

This static type conversion operator converts a DateTime value to an OracleTimeStamp structure.

Declaration

// C#
public static implicit operator OracleTimeStamp(DateTime value);

Parameters

• value

  A DateTime instance.

Return Value

An OracleTimeStamp structure.

explicit operator DateTime

This static type conversion operator converts an OracleTimeStamp value to a DateTime structure.

Declaration

// C#
public static explicit operator DateTime(OracleTimeStamp value1);

Parameters

• value1

  An OracleTimeStamp instance.

Return Value

A DateTime containing the date and time in the current instance.

Exceptions

OracleNullValueException - The OracleTimeStamp structure has a null value.

Remarks

The precision of the OracleTimeStamp can be lost during the conversion.

OracleTimeStamp Properties

The OracleTimeStamp properties are listed in Table 5-98.

BinData

This property returns an array of bytes that represents an Oracle TIMESTAMP in Oracle internal format.

Declaration

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

Property Value

A byte array that represents an Oracle TIMESTAMP in an internal format.

Exceptions

OracleNullValueException - The current instance has a null value.

Day

This property specifies the day component of an OracleTimeStamp.

Declaration

// C#
public int Day{get;}

Property Value

A number that represents the day. Range of Day is (1 to 31).

Exceptions

OracleNullValueException - The current instance has a null value.

IsNull

This property indicates whether 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.

Hour

This property specifies the hour component of an OracleTimeStamp.

Declaration

// C#
public int Hour{get;}

Property Value

A number that represents the hour. Range of hour is (0 to 23).

Exceptions

OracleNullValueException - The current instance has a null value.

Millisecond

This property gets the millisecond component of an OracleTimeStamp.

Declaration

// C#
public double Millisecond{get;}

Property Value

A number that represents a millisecond. Range of Millisecond is (0 to 999.999999).

Exceptions

OracleNullValueException - The current instance has a null value.

Minute

This property gets the minute component of an OracleTimeStamp.

Declaration

// C#
public int Minute{get;}

Property Value

A number that represent a minute. Range of Minute is (0 to 59).

Exceptions

OracleNullValueException - The current instance has a null value.

Month

This property gets the month component of an OracleTimeStamp.

Declaration

// C#
public int Month{get;}

Property Value

A number that represents a month. Range of Month is (1 to 12).

Exceptions

OracleNullValueException - The current instance has a null value.

Nanosecond

This property gets the nanosecond component of an OracleTimeStamp.

Declaration

// C#
public int Nanosecond{get;}

Property Value

A number that represents a nanosecond. Range of Nanosecond is (0 to 999999999).

Exceptions

OracleNullValueException - The current instance has a null value.

Second

This property gets the second component of an OracleTimeStamp.

Declaration

// C#
public int Second{get;}

Property Value

A number that represents a second. Range of Second is (0 to 59).

Exceptions

OracleNullValueException - The current instance has a null value.

Value

This property specifies the date and time that is stored in the OracleTimeStamp structure.

Declaration

// C#
public DateTime Value{get;}

Property Value

A DateTime.

Exceptions

OracleNullValueException - The current instance has a null value.

Year

This property gets the year component of an OracleTimeStamp.

Declaration

// C#
public int Year{get;}

Property Value

A number that represents a year. The range of Year is (-4712 to 9999).

Exceptions

OracleNullValueException - The current instance has a null value.

OracleTimeStamp Methods

The OracleTimeStamp methods are listed in Table 5-99.

AddDays

This method adds the supplied number of days to the current instance.

Declaration

// C#
public OracleTimeStamp AddDays(double days);

Parameters

• days

  The supplied number of days. Range is (-1,000,000,000 < days < 1,000,000,000)

Return Value

An OracleTimeStamp.

Exceptions

ArgumentOutofRangeException - The argument value is out of the specified range.

OracleNullValueException - The current instance has a null value.

AddHours

This method adds the supplied number of hours to the current instance.

Declaration

// C#
public OracleTimeStamp AddHours(double hours);

Parameters

• hours

  The supplied number of hours. Range is (-24,000,000,000 < hours < 24,000,000,000).

Return Value

An OracleTimeStamp.

Exceptions

ArgumentOutofRangeException - The argument value is out of the specified range.

OracleNullValueException - The current instance has a null value.

AddMilliseconds

This method adds the supplied number of milliseconds to the current instance.

Declaration

// C#
public OracleTimeStamp AddMilliseconds(double milliseconds);

Parameters

• milliseconds

  The supplied number of milliseconds. Range is (-8.64 * 1016< milliseconds < 8.64 * 1016).

Return Value

An OracleTimeStamp.

Exceptions

ArgumentOutofRangeException - The argument value is out of the specified range.

OracleNullValueException - The current instance has a null value.

AddMinutes

This method adds the supplied number of minutes to the current instance.

Declaration

// C#
public OracleTimeStamp AddMinutes(double minutes);

Parameters

• minutes

  The supplied number of minutes. Range is (-1,440,000,000,000 < minutes < 1,440,000,000,000).

Return Value

An OracleTimeStamp.

Exceptions

ArgumentOutofRangeException - The argument value is out of the specified range.

OracleNullValueException - The current instance has a null value.

AddMonths

This method adds the supplied number of months to the current instance.

Declaration

// C#
public OracleTimeStamp AddMonths(long months);

Parameters

• months

  The supplied number of months. Range is (-12,000,000,000 < months < 12,000,000,000).

Return Value

An OracleTimeStamp.

Exceptions

ArgumentOutofRangeException - The argument value is out of the specified range.

OracleNullValueException - The current instance has a null value.

AddNanoseconds

This method adds the supplied number of nanoseconds to the current instance.

Declaration

// C#
public OracleTimeStamp AddNanoseconds(long nanoseconds);

Parameters

• nanoseconds

  The supplied number of nanoseconds.

Return Value

An OracleTimeStamp.

Exceptions

OracleNullValueException - The current instance has a null value.

AddSeconds

This method adds the supplied number of seconds to the current instance.

Declaration

// C#
public OracleTimeStamp AddSeconds(double seconds);

Parameters

• seconds

  The supplied number of seconds. Range is (-8.64 * 1013< seconds < 8.64 * 1013).

Return Value

An OracleTimeStamp.

Exceptions

ArgumentOutofRangeException - The argument value is out of the specified range.

OracleNullValueException - The current instance has a null value.

AddYears

This method adds the supplied number of years to the current instance.

Declaration

// C#
public OracleTimeStamp AddYears(int years);

Parameters

• years

  The supplied number of years. Range is (-999,999,999 <= years < = 999,999,999)

Return Value

An OracleTimeStamp.

Exceptions

ArgumentOutofRangeException - The argument value is out of the specified range.

OracleNullValueException - The current instance has a null value.

CompareTo

This method compares the current OracleTimeStamp 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 to the current OracleTimeStamp instance.

Return Value

The method returns a number that is:

Less than zero: if the current OracleTimeStamp instance value is less than that of obj.

Zero: if the current OracleTimeStamp instance and obj values are equal.

Greater than zero: if the current OracleTimeStamp instance value is greater than that of obj.

Implements

IComparable

Exceptions

ArgumentException - The obj parameter is not of type OracleTimeStamp.

Remarks

The following rules apply to the behavior of this method.

• The comparison must be between OracleTimeStamps. For example, comparing an OracleTimeStamp instance with an OracleBinary instance is not allowed. When an OracleTimeStamp is compared with a different type, an ArgumentException is thrown.

• Any OracleTimeStamp that has a value is greater than an OracleTimeStamp that has a null value.

• Two OracleTimeStamps that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

Equals

Overrides Object

This method determines whether an object has the same date and time as the current OracleTimeStamp instance.

Declaration

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

Parameters

• obj

  The object being compared to the current OracleTimeStamp instance.

Return Value

Returns true if the obj is of type OracleTimeStamp and represents the same date and time; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStamp that has a value is greater than an OracleTimeStamp that has a null value.

• Two OracleTimeStamps that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStamp Structure OracleTimeStamp Members

  
  

GetHashCode

Overrides Object

This method returns a hash code for the OracleTimeStamp instance.

Declaration

// C#
public override int GetHashCode();

Return Value

A number that represents the hash code.

GetDaysBetween

This method subtracts an OracleTimeStamp value from the current instance and returns an OracleIntervalDS that represents the time difference between the supplied OracleTimeStamp structure and the current instance.

Declaration

// C#
public OracleIntervalDS GetDaysBetween(OracleTimeStamp value1);

Parameters

• value1

  The OracleTimeStamp value being subtracted.

Return Value

An OracleIntervalDS that represents the interval between two OracleTimeStamp values.

Remarks

If either the current instance or the parameter has a null value, the returned OracleIntervalDS has a null value.

GetYearsBetween

This method subtracts an OracleTimeStamp value from the current instance and returns an OracleIntervalYM that represents the time difference between the OracleTimeStamp value and the current instance.

Declaration

// C#
public OracleIntervalYM GetYearsBetween(OracleTimeStamp value1);

Parameters

• value1

  The OracleTimeStamp value being subtracted.

Return Value

An OracleIntervalYM that represents the interval between two OracleTimeStamp values.

Remarks

If either the current instance or the parameter has a null value, the returned OracleIntervalYM has a null value.

ToOracleDate

This method converts the current OracleTimeStamp structure to an OracleDate structure.

Declaration

// C#
public OracleDate ToOracleDate();

Return Value

The returned OracleDate contains the date and time in the current instance.

Remarks

The precision of the OracleTimeStamp value can be lost during the conversion.

If the value of the OracleTimeStamp has a null value, the value of the returned OracleDate structure has a null value.

ToOracleTimeStampLTZ

This method converts the current OracleTimeStamp structure to an OracleTimeStampLTZ structure.

Declaration

// C#
public OracleTimeStampLTZ ToOracleTimeStampLTZ();

Return Value

The returned OracleTimeStampLTZ contains date and time in the current instance.

Remarks

If the value of the current instance has a null value, the value of the returned OracleTimeStampLTZ structure has a null value.

ToOracleTimeStampTZ

This method converts the current OracleTimeStamp structure to an OracleTimeStampTZ structure.

Declaration

// C#
public OracleTimeStampTZ ToOracleTimeStampTZ();

Return Value

The returned OracleTimeStampTZ contains the date and time from the OracleTimeStamp and the time zone from the OracleGlobalization.TimeZone of the thread.

Remarks

If the value of the current instance has a null value, the value of the returned OracleTimeStampTZ structure has a null value.

ToString

Overrides Object

This method converts the current OracleTimeStamp structure to a string.

Declaration

// C#
public override string ToString();

Return Value

A string that represents the same date and time as the current OracleTimeStamp structure.

Remarks

The returned value is a string representation of an OracleTimeStamp in the format specified by the OracleGlobalization.TimeStampFormat property of the thread.

The names and abbreviations used for months and days are in the language specified by the OracleGlobalization's DateLanguage and Calendar properties of the thread. If any of the thread's globalization properties are set to null or an empty string, the client computer's settings are used.

Example

// C#
// Set the nls_timestamp_format for the OracleTimeStamp(string)constructor
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.TimeStampFormat   = "DD-MON-YYYY HH:MI:SS.FF AM";
OracleGlobalization.SetThreadInfo(og);

// construct OracleTimeStamp from a string using the format specified.

OracleTimeStamp ts = new OracleTimeStamp("11-NOV-1999 11:02:33.444 AM");

// Set the nls_timestamp_format for the ToString() method
og.TimeStampFormat = "YYYY-MON-DD HH:MI:SS.FF AM";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine(ts.ToString());
// Prints "1999-NOV-11 11:02:33.444000000 AM"

---

OracleTimeStampLTZ Structure

The OracleTimeStampLTZ structure represents the Oracle TIMESTAMP WITH LOCAL TIME ZONE data type to be stored in or retrieved from a database. Each OracleTimeStampLTZ stores the following information: year, month, day, hour, minute, second, and nanosecond.

Class Inheritance

Object

  ValueType

    OracleTimeStampLTZ

Declaration

// C#
public struct OracleTimeStampLTZ : IComparable

Thread Safety

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

Example

// C#
// Illustrates usage of OracleTimeStampLTZ
// Display Local Time Zone Name
Console.WriteLine("Local Time Zone Name = " +
     OracleTimeStampLTZ.GetLocalTimeZoneName());

OracleTimeStampLTZ  tsLocal1 = OracleTimeStampLTZ.GetSysDate();
OracleTimeStampLTZ  tsLocal2 = DateTime.Now;

// Calculate the difference between tsLocal1 and tsLocal2
OracleIntervalDS idsDiff = tsLocal2.GetDaysBetween(tsLocal1);

// Calculate the difference using AddNanoseconds()
int nanoDiff = 0;
while (tsLocal2 > tsLocal1)
{
   nanoDiff += 10;
   tsLocal1 = tsLocal1.AddNanoseconds(10);
}
Console.WriteLine("idsDiff.Nanoseconds = " + idsDiff.Nanoseconds);
Console.WriteLine("nanoDiff = " + nanoDiff);

Requirements

Namespace: Oracle.DataAccess.Types

Assembly: Oracle.DataAccess.dll

OracleTimeStampLTZ Members

OracleTimeStampLTZ members are listed in the following tables:

OracleTimeStampLTZ Constructors

OracleTimeStampLTZ constructors are listed in Table 5-100

OracleTimeStampLTZ Static Fields

The OracleTimeStampLTZ static fields are listed in Table 5-101.

OracleTimeStampLTZ Static Methods

The OracleTimeStampLTZ static methods are listed in Table 5-102.

OracleTimeStampLTZ Static Type Operators

The OracleTimeStampLTZ static type operators are listed in Table 5-103.

OracleTimeStampLTZ Static Type Conversions

The OracleTimeStampLTZ static type conversions are listed in Table 5-104.

OracleTimeStampLTZ Properties

The OracleTimeStampLTZ properties are listed in Table 5-105.

OracleTimeStampLTZ Methods

The OracleTimeStampLTZ methods are listed in Table 5-106.

OracleTimeStampLTZ Constructors

The OracleTimeStampLTZ constructors create new instances of the OracleTimeStampLTZ structure.

Overload List:

• OracleTimeStampLTZ(DateTime)

  This constructor creates a new instance of the OracleTimeStampLTZ structure and sets its value for date and time using the supplied DateTime value.

• OracleTimeStampLTZ(string)

  This constructor creates a new instance of the OracleTimeStampLTZ structure and sets its value for date and time using the supplied string.

• OracleTimeStampLTZ(int, int, int)

  This constructor creates a new instance of the OracleTimeStampLTZ structure and sets its value for date using year, month, and day.

• OracleTimeStampLTZ(int, int, int, int, int, int)

  This constructor creates a new instance of the OracleTimeStampLTZ structure and sets its value for date and time using year, month, day, hour, minute, and second.

• OracleTimeStampLTZ(int, int, int, int, int, int, double)

  This constructor creates a new instance of the OracleTimeStampLTZ structure and sets its value for date and time using year, month, day, hour, minute, second, and millisecond.

• OracleTimeStampLTZ(int, int, int, int, int, int, int)

  This constructor creates a new instance of the OracleTimeStampLTZ structure and sets its value for date and time using year, month, day, hour, minute, second, and nanosecond.

• OracleTimeStampLTZ(byte [ ])

  This constructor creates a new instance of the OracleTimeStampLTZ structure and sets its value to the provided byte array, which is in the internal Oracle TIMESTAMP WITH LOCAL TIME ZONE format.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

OracleTimeStampLTZ(DateTime)

This constructor creates a new instance of the OracleTimeStampLTZ structure and sets its value for date and time using the supplied DateTime value.

Declaration

// C#
public OracleTimeStampLTZ (DateTime dt);

Parameters

• dt

  The supplied DateTime value.

Exceptions

ArgumentException - The dt parameter cannot be used to construct a valid OracleTimeStampLTZ.

OracleTimeStampLTZ(string)

This constructor creates a new instance of the OracleTimeStampLTZ structure and sets its value for date and time using the supplied string.

Declaration

// C#
public OracleTimeStampLTZ(string tsStr);

Parameters

• tsStr

  A string that represents an Oracle TIMESTAMP WITH LOCAL TIME ZONE.

Exceptions

ArgumentException - The tsStr is an invalid string representation of an Oracle TIMESTAMP WITH LOCAL TIME ZONE or the supplied tsStr is not in the timestamp format specified by the OracleGlobalization.TimeStampFormat property of the thread, which represents Oracle's NLS_TIMESTAMP_FORMAT parameter.

ArgumentNullException - The tsStr value is null.

Remarks

The names and abbreviations used for months and days are in the language specified by the DateLanguage and Calendar properties of the thread's OracleGlobalization object. If any of the thread's globalization properties are set to null or an empty string, the client computer's settings are used.

Example

// C#
// Set the nls_timestamp_format for the OracleTimeStampLTZ(string) constructor 
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.TimeStampFormat   = "DD-MON-YYYY HH:MI:SS.FF AM";
OracleGlobalization.SetThreadInfo(og);

// construct OracleTimeStampLTZ from a string using the format specified.

OracleTimeStampLTZ ts=new OracleTimeStampLTZ("11-NOV-1999 11:02:33.444 AM");

// Set the nls_timestamp_format for the ToString() method
og.TimeStampFormat = "YYYY-MON-DD HH:MI:SS.FF AM";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine(ts.ToString()); // Prints "1999-NOV-11 11:02:33.444000000 AM"

OracleTimeStampLTZ(int, int, int)

This constructor creates a new instance of the OracleTimeStampLTZ structure and sets its value for date using year, month, and day.

Declaration

// C#
public OracleTimeStampLTZ(int year, int month, int day);

Parameters

• year

  The year provided. Range of year is (-4712 to 9999).

• month

  The month provided. Range of month is (1 to 12).

• day

  The day provided. Range of day is (1 to 31).

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStampLTZ (that is, the day is out of range for the month).

OracleTimeStampLTZ(int, int, int, int, int, int)

This constructor creates a new instance of the OracleTimeStampLTZ structure and sets its value for date and time using year, month, day, hour, minute, and second.

Declaration

// C#
public OracleTimeStampLTZ (int year, int month, int day, int hour, int minute, int second);

Parameters

• year

  The year provided. Range of year is (-4712 to 9999).

• month

  The month provided. Range of month is (1 to 12).

• day

  The day provided. Range of day is (1 to 31).

• hour

  The hour provided. Range of hour is (0 to 23).

• minute

  The minute provided. Range of minute is (0 to 59).

• second

  The second provided. Range of second is (0 to 59).

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStampLTZ (that is, the day is out of range for the month).

OracleTimeStampLTZ(int, int, int, int, int, int, double)

This constructor creates a new instance of the OracleTimeStampLTZ structure and sets its value for date and time using year, month, day, hour, minute, second, and millisecond.

Declaration

// C#
public OracleTimeStampLTZ(int year, int month, int day, int hour, int minute,
 int second, double millisecond);

Parameters

• year

  The year provided. Range of year is (-4712 to 9999).

• month

  The month provided. Range of month is (1 to 12).

• day

  The day provided. Range of day is (1 to 31).

• hour

  The hour provided. Range of hour is (0 to 23).

• minute

  The minute provided. Range of minute is (0 to 59).

• second

  The second provided. Range of second is (0 to 59).

• milliSeconds

  The milliseconds provided. Range of millisecond is (0 to 999.999999).

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStampLTZ (that is, the day is out of range for the month).

OracleTimeStampLTZ(int, int, int, int, int, int, int)

This constructor creates a new instance of the OracleTimeStampLTZ structure and sets its value for date and time using year, month, day, hour, minute, second, and nanosecond.

Declaration

// C#
public OracleTimeStampLTZ (int year, int month, int day, int hour, int minute, int second, int nanosecond);

Parameters

• year

  The year provided. Range of year is (-4712 to 9999).

• month

  The month provided. Range of month is (1 to 12).

• day

  The day provided. Range of day is (1 to 31).

• hour

  The hour provided. Range of hour is (0 to 23).

• minute

  The minute provided. Range of minute is (0 to 59).

• second

  The second provided. Range of second is (0 to 59).

• nanosecond

  The nanosecond provided. Range of nanosecond is (0 to 999999999).

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStampLTZ (that is, the day is out of range for the month).

OracleTimeStampLTZ(byte [ ])

This constructor creates a new instance of the OracleTimeStampLTZ structure and sets its value to the provided byte array, which is in the internal Oracle TIMESTAMP WITH LOCAL TIME ZONE format.

Declaration

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

Parameters

• bytes

  A byte array that represents an Oracle TIMESTAMP WITH LOCAL TIME ZONE in Oracle internal format.

Exceptions

ArgumentException - bytes is not in an internal Oracle TIMESTAMP WITH LOCAL TIME ZONE format or bytes is not a valid Oracle TIMESTAMP WITH LOCAL TIME ZONE.

ArgumentNullException - bytes is null.

OracleTimeStampLTZ Static Fields

The OracleTimeStampLTZ static fields are listed in Table 5-107.

MaxValue

This static field represents the maximum valid date for an OracleTimeStampLTZ structure, which is December 31, 9999 23:59:59.999999999.

Declaration

// C#
public static readonly OracleTimeStampLTZ MaxValue;

Remarks

This value is the maximum date and time in the client time zone.

MinValue

This static field represents the minimum valid date for an OracleTimeStampLTZ structure, which is January 1, -4712 0:0:0.

Declaration

// C#
public static readonly OracleTimeStampLTZ MinValue;

Remarks

This value is the minimum date and time in the client time zone.

Null

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

Declaration

// C#
public static readonly OracleTimeStampLTZ Null;

OracleTimeStampLTZ Static Methods

The OracleTimeStampLTZ static methods are listed in Table 5-108.

Equals

This static method determines if two OracleTimeStampLTZ values are equal.

Declaration

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

Parameters

• value1

  First OracleTimeStampLTZ.

• value2

  Second OracleTimeStampLTZ.

Return Value

Returns true if two OracleTimeStampLTZ values are equal. Returns false otherwise.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampLTZ that has a value is greater than an OracleTimeStampLTZ that has a null value.

• Two OracleTimeStampLTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

GetLocalTimeZoneName

This static method gets the client's local time zone name.

Declaration

// C#
public static string GetLocalTimeZoneName(); 

Return Value

A string containing the local time zone.

GetLocalTimeZoneOffset

This static method gets the client's local time zone offset relative to Coordinated Universal Time (UTC).

Declaration

// C#
public static TimeSpan OracleTimeStampLTZ GetLocalTimeZoneOffset( );

Return Value

A TimeSpan structure containing the local time zone hours and time zone minutes.

GetSysDate

This static method gets an OracleTimeStampLTZ structure that represents the current date and time.

Declaration

// C#
public static OracleTimeStampLTZ GetSysDate();

Return Value

An OracleTimeStampLTZ structure that represents the current date and time.

GreaterThan

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

Declaration

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

Parameters

• value1

  First OracleTimeStampLTZ.

• value2

  Second OracleTimeStampLTZ.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampLTZ that has a value is greater than an OracleTimeStampLTZ that has a null value.

• Two OracleTimeStampLTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

GreaterThanOrEqual

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

Declaration

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

Parameters

• value1

  First OracleTimeStampLTZ.

• value2

  Second OracleTimeStampLTZ.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampLTZ that has a value is greater than an OracleTimeStampLTZ that has a null value.

• Two OracleTimeStampLTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

LessThan

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

Declaration

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

Parameters

• value1

  First OracleTimeStampLTZ.

• value2

  Second OracleTimeStampLTZ.

Return Value

Returns true if the first of two OracleTimeStampLTZ values is less than the second. Returns false otherwise.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampLTZ that has a value is greater than an OracleTimeStampLTZ that has a null value.

• Two OracleTimeStampLTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

LessThanOrEqual

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

Declaration

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

Parameters

• value1

  First OracleTimeStampLTZ.

• value2

  Second OracleTimeStampLTZ.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampLTZ that has a value is greater than an OracleTimeStampLTZ that has a null value.

• Two OracleTimeStampLTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

NotEquals

This static method determines if two OracleTimeStampLTZ values are not equal.

Declaration

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

Parameters

• value1

  First OracleTimeStampLTZ.

• value2

  Second OracleTimeStampLTZ.

Return Value

Returns true if two OracleTimeStampLTZ values are not equal. Returns false otherwise.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampLTZ that has a value is greater than an OracleTimeStampLTZ that has a null value.

• Two OracleTimeStampLTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

Parse

This static method creates an OracleTimeStampLTZ structure and sets its value using the supplied string.

Declaration

// C#
public static OracleTimeStampLTZ Parse(string tsStr);

Parameters

• tsStr

  A string that represents an Oracle TIMESTAMP WITH LOCAL TIME ZONE.

Return Value

An OracleTimeStampLTZ structure.

Exceptions

ArgumentException - The tsStr parameter is an invalid string representation of an Oracle TIMESTAMP WITH LOCAL TIME ZONE or the tsStr is not in the timestamp format specified by the OracleGlobalization.TimeStampFormat property of the thread, which represents Oracle's NLS_TIMESTAMP_FORMAT parameter.

ArgumentNullException - The tsStr value is null.

Remarks

The names and abbreviations used for months and days are in the language specified by the DateLanguage and Calendar properties of the thread's OracleGlobalization object. If any of the thread's globalization properties are set to null or an empty string, the client computer's settings are used.

Remarks

Example

// C#
// Set the nls_timestamp_format for the Parse() method
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.TimeStampFormat   = "DD-MON-YYYY HH:MI:SS.FF AM";
OracleGlobalization.SetThreadInfo(og);

// construct OracleTimeStampLTZ from a string using the format specified.

OracleTimeStampLTZ ts = OracleTimeStamp.Parse("11-NOV-1999 11:02:33.444 AM");

// Set the nls_timestamp_format for the ToString() method
og.TimeStampFormat = "YYYY-MON-DD HH:MI:SS.FF AM";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine(ts.ToString()); // Prints "1999-NOV-11 11:02:33.444000000 AM"

SetPrecision

This static method returns a new instance of an OracleTimeStampLTZ with the specified fractional second precision.

Declaration

// C#
public static OracleTimeStampLTZ SetPrecision(OracleTimeStampLTZ value1, int fracSecPrecision);

Parameters

• value1

  The provided OracleTimeStampLTZ object.

• fracSecPrecision

  The fractional second precision provided. Range of fractional second precision is (0 to 9).

Return Value

An OracleTimeStampLTZ structure with the specified fractional second precision

Exceptions

ArgumentOutOfRangeException - fracSecPrecision is out of the specified range.

Remarks

The value specified in the supplied fracSecPrecision parameter is used to perform a rounding off operation on the supplied OracleTimeStampLTZ value. Depending on this value, 0 or more trailing zeros are displayed in the string returned by ToString().

Example

The OracleTimeStampLTZ with a value of "December 31, 9999 23:59:59.99" results in the string "December 31, 9999 23:59:59.99000" when SetPrecision() is called with the fractional second precision set to 5.

OracleTimeStampLTZ Static Type Operators

The OracleTimeStampLTZ static type operators are listed in Table 5-109.

operator+

operator+ adds the supplied value to the supplied OracleTimeStampLTZ and returns a new OracleTimeStampLTZ structure.

Overload List:

• operator + (OracleTimeStampLTZ, OracleIntervalDS)

  This static operator adds the supplied OracleIntervalDS to the supplied OracleTimeStampLTZ and returns a new OracleTimeStampLTZ structure.

• operator + (OracleTimeStampLTZ, OracleIntervalYM)

  This static operator adds the supplied OracleIntervalYM to the supplied OracleTimeStampLTZ and returns a new OracleTimeStampLTZ structure.

• operator + (OracleTimeStampLTZ, TimeSpan)

  This static operator adds the supplied TimeSpan to the supplied OracleTimeStampLTZ and returns a new OracleTimeStampLTZ structure.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

operator + (OracleTimeStampLTZ, OracleIntervalDS)

This static operator adds the supplied OracleIntervalDS to the supplied OracleTimeStampLTZ and returns a new OracleTimeStampLTZ structure.

Declaration

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

Parameters

• value1

  An OracleTimeStampLTZ.

• value2

  An OracleIntervalDS.

Return Value

An OracleTimeStampLTZ.

Remarks

If either parameter has a null value, the returned OracleTimeStampLTZ has a null value.

operator + (OracleTimeStampLTZ, OracleIntervalYM)

This static operator adds the supplied OracleIntervalYM to the supplied OracleTimeStampLTZ and returns a new OracleTimeStampLTZ structure.

Declaration

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

Parameters

• value1

  An OracleTimeStampLTZ.

• value2

  An OracleIntervalYM.

Return Value

An OracleTimeStampLTZ.

Remarks

If either parameter has a null value, the returned OracleTimeStampLTZ has a null value.

operator + (OracleTimeStampLTZ, TimeSpan)

This static operator adds the supplied TimeSpan to the supplied OracleTimeStampLTZ and returns a new OracleTimeStampLTZ structure.

Declaration

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

Parameters

• value1

  An OracleTimeStampLTZ.

• value2

  A TimeSpan.

Return Value

An OracleTimeStampLTZ.

Remarks

If the OracleTimeStampLTZ instance has a null value, the returned OracleTimeStampLTZ has a null value.

operator ==

This static operator determines if two OracleTimeStampLTZ values are equal.

Declaration

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

Parameters

• value1

  First OracleTimeStampLTZ.

• value2

  Second OracleTimeStampLTZ.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampLTZ that has a value is greater than an OracleTimeStampLTZ that has a null value.

• Two OracleTimeStampLTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

operator >

This static operator determines if the first of two OracleTimeStampLTZ values is greater than the second.

Declaration

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

Parameters

• value1

  First OracleTimeStampLTZ.

• value2

  Second OracleTimeStampLTZ.

Return Value

Returns true if the first OracleTimeStampLTZ value is greater than the second; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampLTZ that has a value is greater than an OracleTimeStampLTZ that has a null value.

• Two OracleTimeStampLTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

operator >=

This static operator determines if the first of two OracleTimeStampLTZ values is greater than or equal to the second.

Declaration

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

Parameters

• value1

  An OracleTimeStampLTZ.

• value2

  Second OracleTimeStampLTZ.

Return Value

Returns true if the first OracleTimeStampLTZ is greater than or equal to the second; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampLTZ that has a value is greater than an OracleTimeStampLTZ that has a null value.

• Two OracleTimeStampLTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

operator !=

This static operator determines if two OracleTimeStampLTZ values are not equal.

Declaration

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

Parameters

• value1

  First OracleTimeStampLTZ.

• value2

  Second OracleTimeStampLTZ.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampLTZ that has a value is greater than an OracleTimeStampLTZ that has a null value.

• Two OracleTimeStampLTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

operator <

This static operator determines if the first of two OracleTimeStampLTZ values is less than the second.

Declaration

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

Parameters

• value1

  First OracleTimeStampLTZ.

• value2

  Second OracleTimeStampLTZ.

Return Value

Returns true if the first OracleTimeStampLTZ is less than the second; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampLTZ that has a value is greater than an OracleTimeStampLTZ that has a null value.

• Two OracleTimeStampLTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

operator <=

This static operator determines if the first of two OracleTimeStampLTZ values is less than or equal to the second.

Declaration

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

Parameters

• value1

  First OracleTimeStampLTZ.

• value2

  Second OracleTimeStampLTZ.

Return Value

Returns true if the first OracleTimeStampLTZ is less than or equal to the second; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampLTZ that has a value is greater than an OracleTimeStampLTZ that has a null value.

• Two OracleTimeStampLTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

operator -

operator- subtracts the supplied value, from the supplied OracleTimeStampLTZ value, and returns a new OracleTimeStampLTZ structure.

Overload List:

• operator - (OracleTimeStampLTZ, OracleIntervalDS)

  This static operator subtracts the supplied OracleIntervalDS value, from the supplied OracleTimeStampLTZ value, and return a new OracleTimeStampLTZ structure.

• operator - (OracleTimeStampLTZ, OracleIntervalYM)

  This static operator subtracts the supplied OracleIntervalYM value, from the supplied OracleTimeStampLTZ value, and returns a new OracleTimeStampLTZ structure.

• operator - (OracleTimeStampLTZ, TimeSpan)

  This static operator subtracts the supplied TimeSpan value, from the supplied OracleTimeStampLTZ value, and returns a new OracleTimeStampLTZ structure.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

operator - (OracleTimeStampLTZ, OracleIntervalDS)

This static operator subtracts the supplied OracleIntervalDS value, from the supplied OracleTimeStampLTZ value, and return a new OracleTimeStampLTZ structure.

Declaration

// C#
public static operator - (OracleTimeStampLTZ value1, OracleIntervalDS value2);

Parameters

• value1

  An OracleTimeStampLTZ.

• value2

  An OracleIntervalDS instance.

Return Value

An OracleTimeStampLTZ structure.

Remarks

If either parameter has a null value, the returned OracleTimeStampLTZ has a null value.

operator - (OracleTimeStampLTZ, OracleIntervalYM)

This static operator subtracts the supplied OracleIntervalYM value, from the supplied OracleTimeStampLTZ value, and returns a new OracleTimeStampLTZ structure.

Declaration

// C#
public static operator - (OracleTimeStampLTZ value1, OracleIntervalYM value2);

Parameters

• value1

  An OracleTimeStampLTZ.

• value2

  An OracleIntervalYM.

Return Value

An OracleTimeStampLTZ structure.

Remarks

If either parameter has a null value, the returned OracleTimeStampLTZ has a null value.

operator - (OracleTimeStampLTZ, TimeSpan)

This static operator subtracts the supplied TimeSpan value, from the supplied OracleTimeStampLTZ value, and returns a new OracleTimeStampLTZ structure.

Declaration

// C#
public static operator -(OracleTimeStampLTZ value1, TimeSpan value2);

Parameters

• value1

  An OracleTimeStampLTZ.

• value2

  A TimeSpan.

Return Value

An OracleTimeStampLTZ structure.

Remarks

If the OracleTimeStampLTZ instance has a null value, the returned OracleTimeStampLTZ structure has a null value.

OracleTimeStampLTZ Static Type Conversions

The OracleTimeStampLTZ static type conversions are listed in Table 5-110.

explicit operator OracleTimeStampLTZ

explicit operator OracleTimeStampLTZ converts the supplied value to an OracleTimeStampLTZ structure.

Overload List:

• explicit operator OracleTimeStampLTZ(OracleTimeStamp)

  This static type conversion operator converts an OracleTimeStamp value to an OracleTimeStampLTZ structure.

• explicit operator OracleTimeStampLTZ(OracleTimeStampTZ)

  This static type conversion operator converts an OracleTimeStampTZ value to an OracleTimeStampLTZ structure.

• explicit operator OracleTimeStampLTZ(string)

  This static type conversion operator converts the supplied string to an OracleTimeStampLTZ structure.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

explicit operator OracleTimeStampLTZ(OracleTimeStamp)

This static type conversion operator converts an OracleTimeStamp value to an OracleTimeStampLTZ structure.

Declaration

// C#
public static explicit operator OracleTimeStampLTZ (OracleTimeStamp value1);

Parameters

• value1

  An OracleTimeStamp.

Return Value

The OracleTimeStampLTZ structure contains the date and time of the OracleTimeStampTZ structure.

Remarks

If the OracleTimeStamp structure has a null value, the returned OracleTimeStampLTZ structure also has a null value.

explicit operator OracleTimeStampLTZ(OracleTimeStampTZ)

This static type conversion operator converts an OracleTimeStampTZ value to an OracleTimeStampLTZ structure.

Declaration

// C#
public static explicit operator OracleTimeStampLTZ (OracleTimeStampTZ value1);

Parameters

• value1

  An OracleTimeStampTZ instance.

Return Value

The OracleTimeStampLTZ structure contains the date and time in the OracleTimeStampTZ structure (which is normalized to the client local time zone).

Remarks

If the OracleTimeStampTZ structure has a null value, the returned OracleTimeStampLTZ structure also has a null value.

explicit operator OracleTimeStampLTZ(string)

This static type conversion operator converts the supplied string to an OracleTimeStampLTZ structure.

Declaration

// C#
public static explicit operator OracleTimeStampLTZ (string tsStr);

Parameters

• tsStr

  A string representation of an Oracle TIMESTAMP WITH LOCAL TIME ZONE.

Return Value

A OracleTimeStampLTZ.

Exceptions

ArgumentException - ThetsStr parameter is an invalid string representation of an Oracle TIMESTAMP WITH LOCAL TIME ZONE or the tsStr is not in the timestamp format specified by the thread's OracleGlobalization.TimeStampFormat property, which represents Oracle's NLS_TIMESTAMP_FORMAT parameter.

Remarks

The names and abbreviations used for months and days are in the language specified by the DateLanguage and Calendar properties of the thread's OracleGlobalization object. If any of the thread's globalization properties are set to null or an empty string, the client computer's settings are used.

Example

// C#
// Set the nls_timestamp_format for the OracleTimeStampLTZ(string) constructor 
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.TimeStampFormat   = "DD-MON-YYYY HH:MI:SS.FF AM";
OracleGlobalization.SetThreadInfo(og);

// construct OracleTimeStampLTZ from a string using the format specified.

OracleTimeStampLTZ ts=new OracleTimeStampLTZ("11-NOV-1999 11:02:33.444 AM");

// Set the nls_timestamp_format for the ToString() method

og.TimeStampFormat = "YYYY-MON-DD HH:MI:SS.FF AM";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine(ts.ToString()); // Prints "1999-NOV-11 11:02:33.444000000 AM"

implicit operator OracleTimeStampLTZ

implicit operator OracleTimeStampLTZ converts the supplied structure to an OracleTimeStampLTZ structure.

Overload List:

• implicit operator OracleTimeStampLTZ(OracleDate)

  This static type conversion operator converts an OracleDate value to an OracleTimeStampLTZ structure.

• implicit operator OracleTimeStampLTZ(DateTime)

  This static type conversion operator converts a DateTime structure to an OracleTimeStampLTZ structure.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

implicit operator OracleTimeStampLTZ(OracleDate)

This static type conversion operator converts an OracleDate value to an OracleTimeStampLTZ structure.

Declaration

// C#
public static implicit operator OracleTimeStampLTZ(OracleDate value1);

Parameters

• value1

  An OracleDate.

Return Value

The returned OracleTimeStampLTZ structure contains the date and time in the OracleDate structure.

Remarks

If the OracleDate structure has a null value, the returned OracleTimeStampLTZ structure also has a null value.

implicit operator OracleTimeStampLTZ(DateTime)

This static type conversion operator converts a DateTime structure to an OracleTimeStampLTZ structure.

Declaration

// C#
public static implicit operator OracleTimeStampLTZ(DateTime value1);

Parameters

• value1

  A DateTime structure.

Return Value

An OracleTimeStampLTZ structure.

explicit operator DateTime

This static type conversion operator converts an OracleTimeStampLTZ value to a DateTime structure.

Declaration

// C#
public static explicit operator DateTime(OracleTimeStampLTZ value1);

Parameters

• value1

  An OracleTimeStampLTZ instance.

Return Value

A DateTime that contains the date and time in the current instance.

Exceptions

OracleNullValueException - The OracleTimeStampLTZ structure has a null value.

Remarks

The precision of the OracleTimeStampLTZ value can be lost during the conversion.

OracleTimeStampLTZ Properties

The OracleTimeStampLTZ properties are listed in Table 5-111.

BinData

This property returns an array of bytes that represents an Oracle TIMESTAMP WITH LOCAL TIME ZONE in Oracle internal format.

Declaration

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

Property Value

A byte array that represents an Oracle TIMESTAMP WITH LOCAL TIME ZONE internal format.

Exceptions

OracleNullValueException - The current instance has a null value.

Day

This property specifies the day component of an OracleTimeStampLTZ.

Declaration

// C#
public int Day{get;}

Property Value

A number that represents the day. Range of Day is (1 to 31).

Exceptions

OracleNullValueException - The current instance has a null value.

IsNull

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

Declaration

// C#
public bool IsNull{get;}

Property Value

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

Hour

This property specifies the hour component of an OracleTimeStampLTZ.

Declaration

// C#
public int Hour{get;}

Property Value

A number that represents the hour. Range of Hour is (0 to 23).

Exceptions

OracleNullValueException - The current instance has a null value.

Millisecond

This property gets the millisecond component of an OracleTimeStampLTZ.

Declaration

// C#
public double Millisecond{get;}

Property Value

A number that represents a millisecond. Range of Millisecond is (0 to 999.999999)

Exceptions

OracleNullValueException - The current instance has a null value.

Minute

This property gets the minute component of an OracleTimeStampLTZ.

Declaration

// C#
public int Minute{get;}

Property Value

A number that represent a minute. Range of Minute is (0 to 59).

Exceptions

OracleNullValueException - The current instance has a null value.

Month

This property gets the month component of an OracleTimeStampLTZ.

Declaration

// C#
public int Month{get;}

Property Value

A number that represents a month. Range of Month is (1 to 12).

Exceptions

OracleNullValueException - The current instance has a null value.

Nanosecond

This property gets the nanosecond component of an OracleTimeStampLTZ.

Declaration

// C#
public int Nanosecond{get;}

Property Value

A number that represents a nanosecond. Range of Nanosecond is (0 to 999999999).

Exceptions

OracleNullValueException - The current instance has a null value.

Second

This property gets the second component of an OracleTimeStampLTZ.

Declaration

// C#
public int Second{get;}

Property Value

A number that represents a second. Range of Second is (0 to 59).

Exceptions

OracleNullValueException - The current instance has a null value.

Value

This property specifies the date and time that is stored in the OracleTimeStampLTZ structure.

Declaration

// C#
public DateTime Value{get;}

Property Value

A DateTime.

Exceptions

OracleNullValueException - The current instance has a null value.

Year

This property gets the year component of an OracleTimeStampLTZ.

Declaration

// C#
public int Year{get;}

Property Value

A number that represents a year. The range of Year is (-4712 to 9999).

Exceptions

OracleNullValueException - The current instance has a null value.

OracleTimeStampLTZ Methods

The OracleTimeStampLTZ methods are listed in Table 5-112.

AddDays

This method adds the supplied number of days to the current instance.

Declaration

// C#
public OracleTimeStampLTZ AddDays(double days);

Parameters

• days

  The supplied number of days. Range is (-1,000,000,000 < days < 1,000,000,000)

Return Value

An OracleTimeStampLTZ.

Exceptions

OracleNullValueException - The current instance has a null value.

ArgumentOutofRangeException - The argument value is out of the specified range.

AddHours

This method adds the supplied number of hours to the current instance.

Declaration

// C#
public OracleTimeStampLTZ AddHours(double hours);

Parameters

• hours

  The supplied number of hours. Range is (-24,000,000,000 < hours < 24,000,000,000).

Return Value

An OracleTimeStampLTZ.

Exceptions

OracleNullValueException - The current instance has a null value.

ArgumentOutofRangeException - The argument value is out of the specified range.

AddMilliseconds

This method adds the supplied number of milliseconds to the current instance.

Declaration

// C#
public OracleTimeStampLTZ AddMilliseconds(double milliseconds);

Parameters

• milliseconds

  The supplied number of milliseconds. Range is (-8.64 * 1016< milliseconds < 8.64 * 1016).

Return Value

An OracleTimeStampLTZ.

Exceptions

OracleNullValueException - The current instance has a null value.

ArgumentOutofRangeException - The argument value is out of the specified range.

AddMinutes

This method adds the supplied number of minutes to the current instance.

Declaration

// C#
public OracleTimeStampLTZ AddMinutes(double minutes);

Parameters

• minutes

  The supplied number of minutes. Range is (-1,440,000,000,000 < minutes < 1,440,000,000,000).

Return Value

An OracleTimeStampLTZ.

Exceptions

OracleNullValueException - The current instance has a null value.

ArgumentOutofRangeException - The argument value is out of the specified range.

AddMonths

This method adds the supplied number of months to the current instance.

Declaration

// C#
public OracleTimeStampLTZ AddMonths(long months);

Parameters

• months

  The supplied number of months. Range is (-12,000,000,000 < months < 12,000,000,000).

Return Value

An OracleTimeStampLTZ.

Exceptions

OracleNullValueException - The current instance has a null value.

ArgumentOutofRangeException - The argument value is out of the specified range.

AddNanoseconds

This method adds the supplied number of nanoseconds to the current instance.

Declaration

// C#
public OracleTimeStampLTZ AddNanoseconds(long nanoseconds);

Parameters

• nanoseconds

  The supplied number of nanoseconds.

Return Value

An OracleTimeStampLTZ.

Exceptions

OracleNullValueException - The current instance has a null value.

AddSeconds

This method adds the supplied number of seconds to the current instance.

Declaration

// C#
public OracleTimeStampLTZ AddSeconds(double seconds);

Parameters

• seconds

  The supplied number of seconds. Range is (-8.64 * 1013< seconds < 8.64 * 1013).

Return Value

An OracleTimeStampLTZ.

Exceptions

OracleNullValueException - The current instance has a null value.

ArgumentOutofRangeException - The argument value is out of the specified range.

AddYears

This method adds the supplied number of years to the current instance

Declaration

// C#
public OracleTimeStampLTZ AddYears(int years);

Parameters

• years

  The supplied number of years. Range is (-999,999,999 <= years < = 999,999,999)

Return Value

An OracleTimeStampLTZ.

Exceptions

OracleNullValueException - The current instance has a null value.

ArgumentOutofRangeException - The argument value is out of the specified range.

CompareTo

This method compares the current OracleTimeStampLTZ 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 to the current OracleTimeStampLTZ instance.

Return Value

The method returns a number that is:

• Less than zero: if the current OracleTimeStampLTZ instance value is less than that of obj.

• Zero: if the current OracleTimeStampLTZ instance and obj values are equal.

• Greater than zero: if the current OracleTimeStampLTZ instance value is greater than that of obj.

Implements

IComparable

Exceptions

ArgumentException - The obj parameter is not of type OracleTimeStampLTZ.

Remarks

The following rules apply to the behavior of this method.

• The comparison must be between OracleTimeStampLTZs. For example, comparing an OracleTimeStampLTZ instance with an OracleBinary instance is not allowed. When an OracleTimeStampLTZ is compared with a different type, an ArgumentException is thrown.

• Any OracleTimeStampLTZ that has a value is greater than an OracleTimeStampLTZ that has a null value.

• Two OracleTimeStampLTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

Equals

Overrides Object

This method determines whether an object has the same date and time as the current OracleTimeStampLTZ instance.

Declaration

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

Parameters

• obj

  The object being compared to the current OracleTimeStampLTZ instance.

Return Value

Returns true if the obj is of type OracleTimeStampLTZ and represents the same date and time; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampLTZ that has a value is greater than an OracleTimeStampLTZ that has a null value.

• Two OracleTimeStampLTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampLTZ Structure OracleTimeStampLTZ Members

  
  

GetHashCode

Overrides Object

This method returns a hash code for the OracleTimeStampLTZ instance.

Declaration

// C#
public override int GetHashCode();

Return Value

A number that represents the hash code.

GetDaysBetween

This method subtracts an OracleTimeStampLTZ value from the current instance and returns an OracleIntervalDS that represents the difference.

Declaration

// C#
public OracleIntervalDS GetDaysBetween(OracleTimeStampLTZ value1);

Parameters

• value1

  The OracleTimeStampLTZ value being subtracted.

Return Value

An OracleIntervalDS that represents the interval between two OracleTimeStampLTZ values.

Remarks

If either the current instance or the parameter has a null value, the returned OracleIntervalDS has a null value.

GetYearsBetween

This method subtracts an OracleTimeStampLTZ value from the current instance and returns an OracleIntervalYM that represents the time interval.

Declaration

// C#
public OracleIntervalYM GetYearsBetween(OracleTimeStampLTZ value1);

Parameters

• value1

  The OracleTimeStampLTZ value being subtracted.

Return Value

An OracleIntervalYM that represents the interval between two OracleTimeStampLTZ values.

Remarks

If either the current instance or the parameter has a null value, the returned OracleIntervalYM has a null value.

ToOracleDate

This method converts the current OracleTimeStampLTZ structure to an OracleDate structure.

Declaration

// C#
public OracleDate ToOracleDate();

Return Value

The returned OracleDate structure contains the date and time in the current instance.

Remarks

The precision of the OracleTimeStampLTZ value can be lost during the conversion.

If the current instance has a null value, the value of the returned OracleDate structure has a null value.

ToOracleTimeStamp

This method converts the current OracleTimeStampLTZ structure to an OracleTimeStamp structure.

Declaration

// C#
public OracleTimeStamp ToOracleTimeStamp();

Return Value

The returned OracleTimeStamp contains the date and time in the current instance.

Remarks

If the current instance has a null value, the value of the returned OracleTimeStamp structure has a null value.

ToOracleTimeStampTZ

This method converts the current OracleTimeStampLTZ structure to an OracleTimeStampTZ structure.

Declaration

// C#
public OracleTimeStampTZ ToOracleTimeStampTZ();

Return Value

The returned OracleTimeStampTZ contains the date and time of the current instance, with the time zone set to the OracleGlobalization.TimeZone from the thread.

Remarks

If the current instance has a null value, the value of the returned OracleTimeStampTZ structure has a null value.

ToString

Overrides Object

This method converts the current OracleTimeStampLTZ structure to a string.

Declaration

// C#
public override string ToString();

Return Value

A string that represents the same date and time as the current OracleTimeStampLTZ structure.

Remarks

The returned value is a string representation of the OracleTimeStampLTZ in the format specified by the OracleGlobalization.TimeStampFormat property of the thread.

The names and abbreviations used for months and days are in the language specified by the DateLanguage and Calendar properties of the thread's OracleGlobalization object. If any of the thread's globalization properties are set to null or an empty string, the client computer's settings are used.

Example

// C#
// Set the nls_timestamp_format for the OracleTimeStampLTZ(string) constructor
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.TimeStampFormat   = "DD-MON-YYYY HH:MI:SS.FF AM";
OracleGlobalization.SetThreadInfo(og);

// construct OracleTimeStampLTZ from a string using the format specified.

OracleTimeStampLTZ ts=new OracleTimeStampLTZ("11-NOV-1999 11:02:33.444 AM");

// Set the nls_timestamp_format for the ToString() method
og.TimeStampFormat = "YYYY-MON-DD HH:MI:SS.FF AM";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine(ts.ToString()); // Prints "1999-NOV-11 11:02:33.444000000 AM"

ToUniversalTime

This method converts the current local time to Coordinated Universal Time (UTC).

Declaration

// C#
public OracleTimeStampTZ ToUniversalTime();

Return Value

An OracleTimeStampTZ structure.

Remarks

If the current instance has a null value, the value of the returned OracleTimeStampTZ structure has a null value.

---

OracleTimeStampTZ Structure

The OracleTimeStampTZ structure represents the Oracle TIMESTAMP WITH TIME ZONE data type to be stored in or retrieved from a database. Each OracleTimeStampTZ stores the following information: year, month, day, hour, minute, second, nanosecond, and time zone.

Class Inheritance

Object

  ValueType

    OracleTimeStampTZ

Declaration

// C#
public struct OracleTimeStampTZ : IComparable

Thread Safety

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

Remarks

Example

// C#
// Illustrates usage of OracleTimeStampTZ

// Set the nls parameters for the current thread
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.TimeZone = "US/Eastern";
og.TimeStampFormat   = "DD-MON-YYYY HH:MI:SS.FF AM";
og.TimeStampTZFormat = "DD-MON-YYYY HH:MI:SS.FF AM TZR";
OracleGlobalization.SetThreadInfo(og);

// Create an OracleTimeStampTZ in US/Pacific time zone
OracleTimeStampTZ tstz1=new OracleTimeStampTZ("11-NOV-1999 "+ 
    "11:02:33.444 AM US/Pacific");

// Note that ToOracleTimeStampTZ uses the thread's time zone region,"US/Eastern"
OracleTimeStamp ts = new OracleTimeStamp("11-NOV-1999 11:02:33.444 AM");
OracleTimeStampTZ  tstz2 = ts.ToOracleTimeStampTZ();

// Calculate the difference between tstz1 and tstz2
OracleIntervalDS idsDiff = tstz1.GetDaysBetween(tstz2);

// Display information
Console.WriteLine("tstz1.TimeZone  = " + tstz1.TimeZone); //Prints "US/Pacific"
Console.WriteLine("tstz2.TimeZone  = " + tstz2.TimeZone); // Prints "US/Eastern"
Console.WriteLine("idsDiff.Hours   = " + idsDiff.Hours);  // Prints 3

Console.WriteLine("idsDiff.Minutes = " + idsDiff.Minutes); // Prints 0

Requirements

Namespace: Oracle.DataAccess.Types

Assembly: Oracle.DataAccess.dll

OracleTimeStampTZ Members

OracleTimeStampTZ members are listed in the following tables:

OracleTimeStampTZ Constructors

OracleTimeStampTZ constructors are listed in Table 5-113

OracleTimeStampTZ Static Fields

The OracleTimeStampTZ static fields are listed in Table 5-114.

OracleTimeStampTZ Static Methods

The OracleTimeStampTZ static methods are listed in Table 5-115.

OracleTimeStampTZ Static Operators

The OracleTimeStampTZ static operators are listed in Table 5-116.

OracleTimeStampTZ Static Type Conversions

The OracleTimeStampTZ static type conversions are listed in Table 5-117.

OracleTimeStampTZ Properties

The OracleTimeStampTZ properties are listed in Table 5-118.

OracleTimeStampTZ Methods

The OracleTimeStampTZ methods are listed in Table 5-119.

OracleTimeStampTZ Constructors

The OracleTimeStampTZ constructors create new instances of the OracleTimeStampTZ structure.

Overload List:

• OracleTimeStampTZ(DateTime)

  This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using the supplied DateTime value.

• OracleTimeStampTZ(DateTime, string)

  This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using the supplied DateTime value and the supplied time zone data.

• OracleTimeStampTZ(string)

  This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using the supplied string.

• OracleTimeStampTZ(int, int, int)

  This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using year, month, and day.

• OracleTimeStampTZ(int, int, int, string)

  This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using year, month, day, and time zone data.

• OracleTimeStampTZ(int, int, int, int, int, int)

  This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using year, month, day, hour, minute, and second.

• OracleTimeStampTZ(int, int, int, int, int, int, string)

  This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using year, month, day, hour, minute, second, and time zone data.

• OracleTimeStampTZ(int, int, int, int, int, int, double)

  This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using year, month, day, hour, minute, second, and millisecond.

• OracleTimeStampTZ(int, int, int, int, int, int, double, string)

  This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using year, month, day, hour, minute, second, millisecond, and time zone data.

• OracleTimeStampTZ(int, int, int, int, int, int, int)

  This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using year, month, day, hour, minute, second, and nanosecond.

• OracleTimeStampTZ(int, int, int, int, int, int, int, string)

  This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using year, month, day, hour, minute, second, nanosecond, and time zone data.

• OracleTimeStampTZ(byte [ ])

  This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value to the provided byte array, that represents the internal Oracle TIMESTAMP WITH TIME ZONE format.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

OracleTimeStampTZ(DateTime)

This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using the supplied DateTime value.

Declaration

// C#
public OracleTimeStampTZ (DateTime dt);

Parameters

• dt

  The supplied DateTime value.

Remarks

The time zone is set to the OracleGlobalization.TimeZone of the thread.

Exceptions

ArgumentException - The dt parameter cannot be used to construct a valid OracleTimeStampTZ.

OracleTimeStampTZ(DateTime, string)

This constructor creates a new instance of the OracleTimeStampTZ structure with the supplied DateTime value and the time zone data.

Declaration

// C#
public OracleTimeStampTZ (DateTime value1, string timeZone);

Parameters

• value1

  The supplied DateTime value.

• timeZone

  The time zone data provided.

Exceptions

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStampTZ.

Remarks

timeZone can be either an hour offset, for example, 7:00, or a valid time zone region name that is provided in V$TIMEZONE_NAMES, such as US/Pacific. Time zone abbreviations are not supported.

If time zone is null, the OracleGlobalization.TimeZone of the thread is used.

OracleTimeStampTZ(string)

This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using the supplied string.

Declaration

// C#
public OracleTimeStampTZ (string tsStr);

Parameters

• tsStr

  A string that represents an Oracle TIMESTAMP WITH TIME ZONE.

Exceptions

ArgumentException - The tsStr is an invalid string representation of an Oracle TIMESTAMP WITH TIME ZONE or the tsStr is not in the timestamp format specified by the OracleGlobalization.TimeStampTZFormat property of the thread.

ArgumentNullException - The tsStr value is null.

Remarks

The names and abbreviations used for months and days are in the language specified by the DateLanguage and Calendar properties of the thread's OracleGlobalization object. If any of the thread's globalization properties are set to null or an empty string, the client computer's settings are used.

Example

// C#
// Set the nls_timestamp_tz_format OracleTimeStampTZ(string) constructor
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.TimeStampTZFormat = "DD-MON-YYYY HH:MI:SS.FF AM TZR";
OracleGlobalization.SetThreadInfo(og);

// construct OracleTimeStampTZ from a string using the format specified.
OracleTimeStampTZ tstz = new OracleTimeStampTZ("11-NOV-1999" +
       "11:02:33.444 AM US/Pacific");

// Set the nls_timestamp_tz_format for the ToString() method
og.TimeStampTZFormat = "YYYY-MON-DD HH:MI:SS.FF AM TZR";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine(tstz.ToString()); 
// Prints "1999-NOV-11 11:02:33.444000000 AM  US/Pacific"

OracleTimeStampTZ(int, int, int)

This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using year, month, and day.

Declaration

// C#
public OracleTimeStampTZ(int year, int month, int day);

Parameters

• year

  The year provided. Range of year is (-4712 to 9999).

• month

  The month provided. Range of month is (1 to 12).

• day

  The day provided. Range of day is (1 to 31).

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStampTZ (that is, the day is out of range for the month).

Remarks

The time zone is set to the OracleGlobalization.TimeZone of the thread.

OracleTimeStampTZ(int, int, int, string)

This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using year, month, day, and time zone data.

Declaration

// C#
public OracleTimeStampTZ(int year, int month, int day, string timeZone);

Parameters

• year

  The year provided. Range of year is (-4712 to 9999).

• month

  The month provided. Range of month is (1 to 12).

• day

  The day provided. Range of day is (1 to 31).

• timeZone

  The time zone data provided.

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStampTZ (that is, the day is out of range for the month or the time zone is invalid).

Remarks

timeZone can be either an hour offset, for example, 7:00, or a valid time zone region name that is provided in V$TIMEZONE_NAMES, such as US/Pacific. Time zone abbreviations are not supported.

If time zone is null, the OracleGlobalization.TimeZone of the thread is used.

OracleTimeStampTZ(int, int, int, int, int, int)

This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using year, month, day, hour, minute, and second.

Declaration

// C#
public OracleTimeStampTZ(int year, int month, int day, int hour, int minute,
int second);

Parameters

• year

  The year provided. Range of year is (-4712 to 9999).

• month

  The month provided. Range of month is (1 to 12).

• day

  The day provided. Range of day is (1 to 31).

• hour

  The hour provided. Range of hour is (0 to 23).

• minute

  The minute provided. Range of minute is (0 to 59).

• second

  The second provided. Range of second is (0 to 59).

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStampTZ (that is, the day is out of range for the month).

Remarks

The time zone is set to the OracleGlobalization.TimeZone of the thread.

OracleTimeStampTZ(int, int, int, int, int, int, string)

This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using year, month, day, hour, minute, second, and time zone data.

Declaration

// C#
public OracleTimeStampTZ (int year, int month, int day, int hour, int minute, 
 int second, string timeZone);

Parameters

• year

  The year provided. Range of year is (-4712 to 9999).

• month

  The month provided. Range of month is (1 to 12).

• day

  The day provided. Range of day is (1 to 31).

• hour

  The hour provided. Range of hour is (0 to 23).

• minute

  The minute provided. Range of minute is (0 to 59).

• second

  The second provided. Range of second is (0 to 59).

• timeZone

  The time zone data provided.

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStampTZ (that is, the day is out of range of the month or the time zone is invalid).

Remarks

timeZone can be either an hour offset, for example, 7:00, or a valid time zone region name that is provided in V$TIMEZONE_NAMES, such as US/Pacific. Time zone abbreviations are not supported.

If time zone is null, the OracleGlobalization.TimeZone of the thread is used.

OracleTimeStampTZ(int, int, int, int, int, int, double)

This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using year, month, day, hour, minute, second, and millisecond.

Declaration

// C#
public OracleTimeStampTZ(int year, int month, int day, int hour, int minute, 
 int second, double millisecond);

Parameters

• year

  The year provided. Range of year is (-4712 to 9999).

• month

  The month provided. Range of month is (1 to 12).

• day

  The day provided. Range of day is (1 to 31).

• hour

  The hour provided. Range of hour is (0 to 23).

• minute

  The minute provided. Range of minute is (0 to 59).

• second

  The second provided. Range of second is (0 to 59).

• millisecond

  The millisecond provided. Range of millisecond is (0 to 999.999999).

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStampTZ (that is, the day is out of range for the month).

Remarks

The time zone is set to the OracleGlobalization.TimeZone of the thread.

OracleTimeStampTZ(int, int, int, int, int, int, double, string)

This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using year, month, day, hour, minute, second, millisecond, and time zone data.

Declaration

// C#
public OracleTimeStampTZ(int year, int month, int day, int hour, int minute,
 int second, double millisecond, string timeZone);

Parameters

• year

  The year provided. Range of year is (-4712 to 9999).

• month

  The month provided. Range of month is (1 to 12).

• day

  The day provided. Range of day is (1 to 31).

• hour

  The hour provided. Range of hour is (0 to 23).

• minute

  The minute provided. Range of minute is (0 to 59).

• second

  The second provided. Range of second is (0 to 59).

• millisecond

  The millisecond provided. Range of millisecond is (0 to 999.999999).

• timeZone

  The time zone data provided.

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStampTZ (that is, the day is out of range for the month or the time zone is invalid).

Remarks

timeZone can be either an hour offset, for example, 7:00, or a valid time zone region name that is provided in V$TIMEZONE_NAMES, such as US/Pacific. Time zone abbreviations are not supported.

If time zone is null, the OracleGlobalization.TimeZone of the thread is used.

OracleTimeStampTZ(int, int, int, int, int, int, int)

This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using year, month, day, hour, minute, second, and nanosecond.

Declaration

// C#
public OracleTimeStampTZ(int year, int month, int day, int hour, int minute,
  int second, int nanosecond);

Parameters

• year

  The year provided. Range of year is (-4712 to 9999).

• month

  The month provided. Range of month is (1 to 12).

• day

  The day provided. Range of day is (1 to 31).

• hour

  The hour provided. Range of hour is (0 to 23).

• minute

  The minute provided. Range of minute is (0 to 59).

• second

  The second provided. Range of second is (0 to 59).

• nanosecond

  The nanosecond provided. Range of nanosecond is (0 to 999999999).

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStampTZ (that is, the day is out of range for the month).

Remarks

The time zone is set to the OracleGlobalization.TimeZone of the thread.

OracleTimeStampTZ(int, int, int, int, int, int, int, string)

This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value for date and time using year, month, day, hour, minute, second, nanosecond, and time zone data.

Declaration

// C#
public OracleTimeStampTZ(int year, int month, int day, int hour, int minute,
 int second, int nanosecond, string timeZone);

Parameters

• year

  The year provided. Range of year is (-4712 to 9999).

• month

  The month provided. Range of month is (1 to 12).

• day

  The day provided. Range of day is (1 to 31).

• hour

  The hour provided. Range of hour is (0 to 23).

• minute

  The minute provided. Range of minute is (0 to 59).

• second

  The second provided. Range of second is (0 to 59).

• nanosecond

  The nanosecond provided. Range of nanosecond is (0 to 999999999).

• timeZone

  The time zone data provided.

Exceptions

ArgumentOutOfRangeException - The argument value for one or more of the parameters is out of the specified range.

ArgumentException - The argument values of the parameters cannot be used to construct a valid OracleTimeStampTZ (that is, the day is out of range for the month or the time zone is invalid).

Remarks

timeZone can be either an hour offset, for example, 7:00, or a valid time zone region name that is provided in V$TIMEZONE_NAMES, such as US/Pacific. Time zone abbreviations are not supported.

If time zone is null, the OracleGlobalization.TimeZone of the thread is used.

OracleTimeStampTZ(byte [ ])

This constructor creates a new instance of the OracleTimeStampTZ structure and sets its value to the provided byte array, that represents the internal Oracle TIMESTAMP WITH TIME ZONE format.

Declaration

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

Parameters

• bytes

  The provided byte array that represents an Oracle TIMESTAMP WITH TIME ZONE in Oracle internal format.

Exceptions

ArgumentException - bytes is not in internal Oracle TIMESTAMP WITH TIME ZONE format or bytes is not a valid Oracle TIMESTAMP WITH TIME ZONE.

ArgumentNullException - bytes is null.

OracleTimeStampTZ Static Fields

The OracleTimeStampTZ static fields are listed in Table 5-120.

MaxValue

This static field represents the maximum valid datetime time for an OracleTimeStampTZ structure in UTC, which is December 31, 999923:59:59.999999999.

Declaration

// C#
public static readonly OracleTimeStampTZ MaxValue;

MinValue

This static field represents the minimum valid datetime for an OracleTimeStampTZ structure in UTC, which is January 1, -4712 0:0:0.

Declaration

// C#
public static readonly OracleTimeStampTZ MinValue;

Null

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

Declaration

// C#
public static readonly OracleTimeStampTZ Null;

OracleTimeStampTZ Static Methods

The OracleTimeStampTZ static methods are listed in Table 5-121.

Equals

This static method determines if two OracleTimeStampTZ values are equal.

Declaration

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

Parameters

• value1

  First OracleTimeStampTZ.

• value2

  Second OracleTimeStampTZ.

Return Value

Returns true if two OracleTimeStampTZ values are equal. Returns false otherwise.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampTZ that has a value is greater than an OracleTimeStampTZ that has a null value.

• Two OracleTimeStampTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

GetSysDate

This static method gets an OracleTimeStampTZ structure that represents the current date and time.

Declaration

// C#
public static OracleTimeStampTZ GetSysDate();

Return Value

An OracleTimeStampTZ structure that represents the current date and time.

GreaterThan

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

Declaration

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

Parameters

• value1

  First OracleTimeStampTZ.

• value2

  Second OracleTimeStampTZ.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampTZ that has a value is greater than an OracleTimeStampTZ that has a null value.

• Two OracleTimeStampTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

GreaterThanOrEqual

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

Declaration

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

Parameters

• value1

  First OracleTimeStampTZ.

• value2

  Second OracleTimeStampTZ.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampTZ that has a value is greater than an OracleTimeStampTZ that has a null value.

• Two OracleTimeStampTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

LessThan

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

Declaration

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

Parameters

• value1

  First OracleTimeStampTZ.

• value2

  Second OracleTimeStampTZ.

Return Value

Returns true if the first of two OracleTimeStampTZ values is less than the second. Returns false otherwise.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampTZ that has a value is greater than an OracleTimeStampTZ that has a null value.

• Two OracleTimeStampTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

LessThanOrEqual

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

Declaration

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

Parameters

• value1

  First OracleTimeStampTZ.

• value2

  Second OracleTimeStampTZ.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampTZ that has a value is greater than an OracleTimeStampTZ that has a null value.

• Two OracleTimeStampTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

NotEquals

This static method determines if two OracleTimeStampTZ values are not equal.

Declaration

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

Parameters

• value1

  First OracleTimeStampTZ.

• value2

  Second OracleTimeStampTZ.

Return Value

Returns true if two OracleTimeStampTZ values are not equal. Returns false otherwise.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampTZ that has a value is greater than an OracleTimeStampTZ that has a null value.

• Two OracleTimeStampTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

Parse

This static method returns an OracleTimeStampTZ structure and sets its value for date and time using the supplied string.

Declaration

// C#
public static OracleTimeStampTZ Parse(string tsStr);

Parameters

• tsStr

  A string that represents an Oracle TIMESTAMP WITH TIME ZONE.

Return Value

An OracleTimeStampTZ structure.

Exceptions

ArgumentException - The tsStr is an invalid string representation of an Oracle TIMESTAMP WITH TIME ZONE or the tsStr is not in the timestamp format specified by the OracleGlobalization.TimeStampTZFormat property of the thread, which represents Oracle's NLS_TIMESTAMP_TZ_FORMAT parameter.

ArgumentNullException - The tsStr value is null.

Remarks

The names and abbreviations used for months and days are in the language specified by the DateLanguage and Calendar properties of the thread's OracleGlobalization object. If any of the thread's globalization properties are set to null or an empty string, the client computer's settings are used.

Example

// C#
// Set the nls_timestamp_tz_format for the Parse() method
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.TimeStampTZFormat = "DD-MON-YYYY HH:MI:SS.FF AM TZR";
OracleGlobalization.SetThreadInfo(og);

// construct OracleTimeStampTZ from a string using the format specified.

OracleTimeStampTZ tstz = OracleTimeStampTZ.Parse("11-NOV-1999 " +
     "11:02:33.444 AM US/Pacific");

// Set the nls_timestamp_tz_format for the ToString() method
og.TimeStampTZFormat = "YYYY-MON-DD HH:MI:SS.FF AM TZR";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine(tstz.ToString()); 
// Prints "1999-NOV-11 11:02:33.444000000 AM  US/Pacific"

SetPrecision

This static method returns a new instance of an OracleTimeStampTZ with the specified fractional second precision.

Declaration

// C#
public static OracleTimeStampTZ SetPrecision(OracleTimeStampTZ value1, int fracSecPrecision);

Parameters

• value1

  The provided OracleTimeStampTZ object.

• fracSecPrecision

  The fractional second precision provided. Range of fractional second precision is (0 to 9).

Return Value

An OracleTimeStampTZ structure with the specified fractional second precision

Exceptions

ArgumentOutOfRangeException - fracSecPrecision is out of the specified range.

Remarks

The value specified in the supplied fracSecPrecision is used to perform a rounding off operation on the supplied OracleTimeStampTZ value. Depending on this value, 0 or more trailing zeros are displayed in the string returned by ToString().

Example

The OracleTimeStampTZ with a value of "December 31, 9999 23:59:59.99 US/Pacific" results in the string "December 31, 9999 23:59:59.99000 US/Pacific" when SetPrecision() is called with the fractional second precision set to 5.

OracleTimeStampTZ Static Operators

The OracleTimeStampTZ static operators are listed in Table 5-122.

operator +

operator+ adds the supplied structure to the supplied OracleTimeStampTZ and returns a new OracleTimeStampTZ structure.

Overload List:

• operator +(OracleTimeStampTZ, OracleIntervalDS)

  This static operator adds the supplied OracleIntervalDS to the supplied OracleTimeStampTZ and returns a new OracleTimeStampTZ structure.

• operator +(OracleTimeStampTZ, OracleIntervalYM)

  This static operator adds the supplied OracleIntervalYM to the supplied OracleTimeStampTZ and returns a new OracleTimeStampTZ structure.

• operator +(OracleTimeStampTZ, TimeSpan)

  This static operator adds the supplied TimeSpan to the supplied OracleTimeStampTZ and returns a new OracleTimeStampTZ structure.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

operator +(OracleTimeStampTZ, OracleIntervalDS)

This static operator adds the supplied OracleIntervalDS to the supplied OracleTimeStampTZ and returns a new OracleTimeStampTZ structure.

Declaration

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

Parameters

• value1

  An OracleTimeStampTZ.

• value2

  An OracleIntervalDS.

Return Value

An OracleTimeStampTZ.

Remarks

If either parameter has a null value, the returned OracleTimeStampTZ has a null value.

operator +(OracleTimeStampTZ, OracleIntervalYM)

This static operator adds the supplied OracleIntervalYM to the supplied OracleTimeStampTZ and returns a new OracleTimeStampTZ structure.

Declaration

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

Parameters

• value1

  An OracleTimeStampTZ.

• value2

  An OracleIntervalYM.

Return Value

An OracleTimeStampTZ.

Remarks

If either parameter has a null value, the returned OracleTimeStampTZ has a null value.

operator +(OracleTimeStampTZ, TimeSpan)

This static operator adds the supplied TimeSpan to the supplied OracleTimeStampTZ and returns a new OracleTimeStampTZ structure.

Declaration

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

Parameters

• value1

  An OracleTimeStampTZ.

• value2

  A TimeSpan.

Return Value

An OracleTimeStampTZ.

Remarks

If the OracleTimeStampTZ instance has a null value, the returned OracleTimeStampTZ has a null value.

operator ==

This static operator determines if two OracleTimeStampTZ values are equal.

Declaration

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

Parameters

• value1

  First OracleTimeStampTZ.

• value2

  Second OracleTimeStampTZ.

Return Value

Returns true if they are equal; otherwise returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampTZ that has a value is greater than an OracleTimeStampTZ that has a null value.

• Two OracleTimeStampTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

operator >

This static operator determines if the first of two OracleTimeStampTZ values is greater than the second.

Declaration

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

Parameters

• value1

  First OracleTimeStampTZ.

• value2

  Second OracleTimeStampTZ.

Return Value

Returns true if the first OracleTimeStampTZ value is greater than the second; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampTZ that has a value is greater than an OracleTimeStampTZ that has a null value.

• Two OracleTimeStampTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

operator >=

This static operator determines if the first of two OracleTimeStampTZ values is greater than or equal to the second.

Declaration

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

Parameters

• value1

  First OracleTimeStampTZ.

• value2

  Second OracleTimeStampTZ.

Return Value

Returns true if the first OracleTimeStampTZ is greater than or equal to the second; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampTZ that has a value is greater than an OracleTimeStampTZ that has a null value.

• Two OracleTimeStampTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

operator !=

This static operator determines if two OracleTimeStampTZ values are not equal.

Declaration

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

Parameters

• value1

  First OracleTimeStampTZ.

• value2

  Second OracleTimeStampTZ.

Return Value

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

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampTZ that has a value is greater than an OracleTimeStampTZ that has a null value.

• Two OracleTimeStampTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

operator <

This static operator determines if the first of two OracleTimeStampTZ values is less than the second.

Declaration

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

Parameters

• value1

  First OracleTimeStampTZ.

• value2

  Second OracleTimeStampTZ.

Return Value

Returns true if the first OracleTimeStampTZ is less than the second; otherwise returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampTZ that has a value is greater than an OracleTimeStampTZ that has a null value.

• Two OracleTimeStampTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

operator <=

This static operator determines if the first of two OracleTimeStampTZ values is less than or equal to the second.

Declaration

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

Parameters

• value1

  First OracleTimeStampTZ.

• value2

  Second OracleTimeStampTZ.

Return Value

Returns true if the first OracleTimeStampTZ is less than or equal to the second; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampTZ that has a value is greater than an OracleTimeStampTZ that has a null value.

• Two OracleTimeStampTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

operator -

operator- subtracts the supplied value, from the supplied OracleTimeStampTZ value, and returns a new OracleTimeStampTZ structure.

Overload List:

• operator - (OracleTimeStampTZ, OracleIntervalDS)

  This static operator subtracts the supplied OracleIntervalDS value, from the supplied OracleTimeStampTZ value, and return a new OracleTimeStampTZ structure.

• operator - (OracleTimeStampTZ, OracleIntervalYM)

  This static operator subtracts the supplied OracleIntervalYM value, from the supplied OracleTimeStampTZ value, and returns a new OracleTimeStampTZ structure.

• operator - (OracleTimeStampTZ value1, TimeSpan value2)

  This static operator subtracts the supplied TimeSpan value, from the supplied OracleTimeStampTZ value, and returns a new OracleTimeStampTZ structure.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

operator - (OracleTimeStampTZ, OracleIntervalDS)

This static operator subtracts the supplied OracleIntervalDS value, from the supplied OracleTimeStampTZ value, and return a new OracleTimeStampTZ structure.

Declaration

// C#
public static operator - (OracleTimeStampTZ value1, OracleIntervalDS value2);

Parameters

• value1

  An OracleTimeStampTZ.

• value2

  An OracleIntervalDS.

Return Value

An OracleTimeStampTZ structure.

Remarks

If either parameter has a null value, the returned OracleTimeStampTZ has a null value.

operator - (OracleTimeStampTZ, OracleIntervalYM)

This static operator subtracts the supplied OracleIntervalYM value, from the supplied OracleTimeStampTZ value, and returns a new OracleTimeStampTZ structure.

Declaration

// C#
public static operator - (OracleTimeStampTZ value1, OracleIntervalYM value2);

Parameters

• value1

  An OracleTimeStampTZ.

• value2

  An OracleIntervalYM.

Return Value

An OracleTimeStampTZ structure.

Remarks

If either parameter has a null value, the returned OracleTimeStampTZ has a null value.

operator - (OracleTimeStampTZ value1, TimeSpan value2)

This static operator subtracts the supplied TimeSpan value, from the supplied OracleTimeStampTZ value, and returns a new OracleTimeStampTZ structure.

Declaration

// C#
public static operator - (OracleTimeStampTZ value1, TimeSpan value2);

Parameters

• value1

  An OracleTimeStampTZ.

• value2

  A TimeSpan.

Return Value

An OracleTimeStampTZ structure.

Remarks

If the OracleTimeStampTZ instance has a null value, the returned OracleTimeStampTZ structure has a null value.

OracleTimeStampTZ Static Type Conversions

The OracleTimeStampTZ static type conversions are listed in Table 5-123.

explicit operator OracleTimeStampTZ

explicit operator OracleTimeStampTZ converts an instance value to an OracleTimeStampTZ structure.

Overload List:

• explicit operator OracleTimeStampTZ(OracleTimeStamp)

  This static type conversion operator converts an OracleTimeStamp value to an OracleTimeStampTZ structure.

• explicit operator OracleTimeStampTZ(OracleTimeStampLTZ)

  This static type conversion operator converts an OracleTimeStampLTZ value to an OracleTimeStampTZ structure.

• explicit operator OracleTimeStampTZ(string)

  This static type conversion operator converts the supplied string value to an OracleTimeStampTZ structure.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members "OracleGlobalization Class" "Globalization Support"

  
  

explicit operator OracleTimeStampTZ(OracleTimeStamp)

This static type conversion operator converts an OracleTimeStamp value to an OracleTimeStampTZ structure.

Declaration

// C#
public static explicit operator OracleTimeStampTZ(OracleTimeStamp value1);

Parameters

• value1

  An OracleTimeStamp.

Return Value

The returned OracleTimeStampTZ contains the date and time from the OracleTimeStamp and the time zone from the OracleGlobalization.TimeZone of the thread.

Remarks

The OracleGlobalization.TimeZone of the thread is used to convert from an OracleTimeStamp structure to an OracleTimeStampTZ structure.

If the OracleTimeStamp structure has a null value, the returned OracleTimeStampTZ structure also has a null value.

explicit operator OracleTimeStampTZ(OracleTimeStampLTZ)

This static type conversion operator converts an OracleTimeStampLTZ value to an OracleTimeStampTZ structure.

Declaration

// C#
public static explicit operator OracleTimeStampTZ(OracleTimeStampLTZ value1);

Parameters

• value1

  An OracleTimeStampLTZ.

Return Value

The returned OracleTimeStampTZ contains the date and time from the OracleTimeStampLTZ and the time zone from the OracleGlobalization.TimeZone of the thread.

Remarks

If the OracleTimeStampLTZ structure has a null value, the returned OracleTimeStampTZ structure also has a null value.

explicit operator OracleTimeStampTZ(string)

This static type conversion operator converts the supplied string value to an OracleTimeStampTZ structure.

Declaration

// C#
public static explicit operator OracleTimeStampTZ(string tsStr);

Parameters

• tsStr

  A string representation of an Oracle TIMESTAMP WITH TIME ZONE.

Return Value

A OracleTimeStampTZ value.

Exceptions

ArgumentException - The tsStr is an invalid string representation of an Oracle TIMESTAMP WITH TIME ZONE. or the tsStr is not in the timestamp format specified by the thread's OracleGlobalization.TimeStampTZFormat property, which represents Oracle's NLS_TIMESTAMP_TZ_FORMAT parameter.

Remarks

The names and abbreviations used for months and days are in the language specified by the DateLanguage and Calendar properties of the thread's OracleGlobalization object. If any of the thread's globalization properties are set to null or an empty string, the client computer's settings are used.

Example

// C#
// Set the nls_timestamp_tz_format for the explicit operator
// OracleTimeStampTZ(string)
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.TimeStampTZFormat = "DD-MON-YYYY HH:MI:SS.FF AM TZR";
OracleGlobalization.SetThreadInfo(og);

// construct OracleTimeStampTZ from a string using the format specified.
OracleTimeStampTZ tstz = new OracleTimeStampTZ("11-NOV-1999" +
       "11:02:33.444 AM US/Pacific");

// Set the nls_timestamp_tz_format for the ToString() method
og.TimeStampTZFormat = "YYYY-MON-DD HH:MI:SS.FF AM TZR";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine(tstz.ToString()); 
// Prints "1999-NOV-11 11:02:33.444000000 AM  US/Pacific"

implicit operator OracleTimeStampTZ

implicit operator OracleTimeStampTZ converts a DateTime structure to an OracleTimeStampTZ structure.

Overload List:

• implicit operator OracleTimeStampTZ(OracleDate)

  This static type conversion operator converts an OracleDate value to an OracleTimeStampTZ structure.

• implicit operator OracleTimeStampTZ(DateTime)

  This static type conversion operator converts a DateTime structure to an OracleTimeStampTZ structure.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members "OracleGlobalization Class" "Globalization Support"

  
  

implicit operator OracleTimeStampTZ(OracleDate)

This static type conversion operator converts an OracleDate value to an OracleTimeStampTZ structure.

Declaration

// C#
public static implicit operator OracleTimeStampTZ(OracleDate value1);

Parameters

• value1

  An OracleDate.

Return Value

The returned OracleTimeStampTZ contains the date and time from the OracleDate and the time zone from the OracleGlobalization.TimeZone of the thread.

Remarks

The OracleGlobalization.TimeZone of the thread is used to convert from an OracleDate to an OracleTimeStampTZ structure. If the OracleDate structure has a null value, the returned OracleTimeStampTZ structure also has a null value.

implicit operator OracleTimeStampTZ(DateTime)

This static type conversion operator converts a DateTime structure to an OracleTimeStampTZ structure.

Declaration

// C#
public static implicit operator OracleTimeStampTZ (DateTime value1);

Parameters

• value1

  A DateTime structure.

Return Value

The returned OracleTimeStampTZ contains the date and time from the DateTime and the time zone from the OracleGlobalization.TimeZone of the thread.

Remarks

The OracleGlobalization.TimeZone of the thread is used to convert from a DateTime to an Oracle TimeStampTZ structure.

explicit operator DateTime

This static type conversion operator converts an OracleTimeStampTZ value to a DateTime structure in the current time zone.

Declaration

// C#
public static explicit operator DateTime(OracleTimeStampTZ value1);

Parameters

• value1

  An OracleTimeStampTZ.

Return Value

A DateTime containing the date and time in the current instance, but with the time zone information in the current instance truncated.

Exceptions

OracleNullValueException - The OracleTimeStampTZ structure has a null value.

Remarks

The precision of the OracleTimeStampTZ value can be lost during the conversion, and the time zone information in the current instance is truncated

OracleTimeStampTZ Properties

The OracleTimeStampTZ properties are listed in Table 5-124.

BinData

This property returns an array of bytes that represents an Oracle TIMESTAMP WITH TIME ZONE in Oracle internal format.

Declaration

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

Property Value

The provided byte array that represents an Oracle TIMESTAMP WITH TIME ZONE in Oracle internal format.

Exceptions

OracleNullValueException - The current instance has a null value.

Day

This property specifies the day component of an OracleTimeStampTZ in the current time zone.

Declaration

// C#
public int Day{get;}

Property Value

A number that represents the day. Range of Day is (1 to 31).

Exceptions

OracleNullValueException - The current instance has a null value.

IsNull

This property indicates whether 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.

Hour

This property specifies the hour component of an OracleTimeStampTZ in the current time zone.

Declaration

// C#
public int Hour{get;}

Property Value

A number that represents the hour. Range of Hour is (0 to 23).

Exceptions

OracleNullValueException - The current instance has a null value.

Millisecond

This property gets the millisecond component of an OracleTimeStampTZ in the current time zone.

Declaration

// C#
public double Millisecond{get;}

Property Value

A number that represents a millisecond. Range of Millisecond is (0 to 999.999999)

Exceptions

OracleNullValueException - The current instance has a null value.

Minute

This property gets the minute component of an OracleTimeStampTZ in the current time zone.

Declaration

// C#
public int Minute{get;}

Property Value

A number that represent a minute. Range of Minute is (0 to 59).

Exceptions

OracleNullValueException - The current instance has a null value.

Month

This property gets the month component of an OracleTimeStampTZ in the current time zone

Declaration

// C#
public int Month{get;}

Property Value

A number that represents a month. Range of Month is (1 to 12).

Exceptions

OracleNullValueException - The current instance has a null value.

Nanosecond

This property gets the nanosecond component of an OracleTimeStampTZ in the current time zone.

Declaration

// C#
public int Nanosecond{get;}

Property Value

A number that represents a nanosecond. Range of Nanosecond is (0 to 999999999).

Exceptions

OracleNullValueException - The current instance has a null value.

Second

This property gets the second component of an OracleTimeStampTZ in the current time zone.

Declaration

// C#
public int Second{get;}

Property Value

A number that represents a second. Range of Second is (0 to 59).

Exceptions

OracleNullValueException - The current instance has a null value.

TimeZone

This property returns the time zone of the OracleTimeStampTZ instance.

Declaration

// C#
public string TimeZone{get;}

Property Value

A string that represents the time zone.

Remarks

If no time zone is specified in the constructor, this property is set to the thread's OracleGlobalization.TimeZone by default

Value

This property returns the date and time that is stored in the OracleTimeStampTZ structure in the current time zone.

Declaration

// C#
public DateTime Value{get;}

Property Value

A DateTime in the current time zone.

Exceptions

OracleNullValueException - The current instance has a null value.

Year

This property sets the year component of an OracleTimeStampTZ in the current time zone.

Declaration

// C#
public int Year{get;}

Property Value

A number that represents a year. The range of Year is (-4712 to 9999).

Exceptions

OracleNullValueException - The current instance has a null value.

OracleTimeStampTZ Methods

The OracleTimeStampTZ methods are listed in Table 5-125.

AddDays

This method adds the supplied number of days to the current instance.

Declaration

// C#
public OracleTimeStampTZ AddDays(double days);

Parameters

• days

  The supplied number of days. Range is (-1,000,000,000 < days < 1,000,000,000)

Return Value

An OracleTimeStampTZ.

Exceptions

OracleNullValueException - The current instance has a null value.

ArgumentOutofRangeException - The argument value is out of the specified range.

AddHours

This method adds the supplied number of hours to the current instance.

Declaration

// C#
public OracleTimeStampTZ AddHours(double hours);

Parameters

• hours

  The supplied number of hours. Range is (-24,000,000,000 < hours < 24,000,000,000).

Return Value

An OracleTimeStampTZ.

Exceptions

OracleNullValueException - The current instance has a null value.

ArgumentOutofRangeException - The argument value is out of the specified range.

AddMilliseconds

This method adds the supplied number of milliseconds to the current instance.

Declaration

// C#
public OracleTimeStampTZ AddMilliseconds(double milliseconds);

Parameters

• milliseconds

  The supplied number of milliseconds. Range is (-8.64 * 1016< milliseconds < 8.64 * 1016).

Return Value

An OracleTimeStampTZ.

Exceptions

OracleNullValueException - The current instance has a null value.

ArgumentOutofRangeException - The argument value is out of the specified range.

AddMinutes

This method adds the supplied number of minutes to the current instance.

Declaration

// C#
public OracleTimeStampTZ AddMinutes(double minutes);

Parameters

• minutes

  The supplied number of minutes. Range is (-1,440,000,000,000 < minutes < 1,440,000,000,000).

Return Value

An OracleTimeStampTZ.

Exceptions

OracleNullValueException - The current instance has a null value.

ArgumentOutofRangeException - The argument value is out of the specified range.

AddMonths

This method adds the supplied number of months to the current instance.

Declaration

// C#
public OracleTimeStampTZ AddMonths(long months);

Parameters

• months

  The supplied number of months. Range is (-12,000,000,000 < months < 12,000,000,000).

Return Value

An OracleTimeStampTZ.

Exceptions

OracleNullValueException - The current instance has a null value.

ArgumentOutofRangeException - The argument value is out of the specified range.

AddNanoseconds

This method adds the supplied number of nanoseconds to the current instance.

Declaration

// C#
public OracleTimeStampTZ AddNanoseconds(long nanoseconds);

Parameters

• nanoseconds

  The supplied number of nanoseconds.

Return Value

An OracleTimeStampTZ.

Exceptions

OracleNullValueException - The current instance has a null value.

AddSeconds

This method adds the supplied number of seconds to the current instance.

Declaration

// C#
public OracleTimeStampTZ AddSeconds(double seconds);

Parameters

• seconds

  The supplied number of seconds. Range is (-8.64 * 1013< seconds < 8.64 * 1013).

Return Value

An OracleTimeStampTZ.

Exceptions

OracleNullValueException - The current instance has a null value.

ArgumentOutofRangeException - The argument value is out of the specified range.

AddYears

This method adds the supplied number of years to the current instance

Declaration

// C#
public OracleTimeStampTZ AddYears(int years);

Parameters

• years

  The supplied number of years. Range is (-999,999,999 <= years < = 999,999,999).

Return Value

An OracleTimeStampTZ.

Exceptions

OracleNullValueException - The current instance has a null value.

ArgumentOutofRangeException - The argument value is out of the specified range.

CompareTo

This method compares the current OracleTimeStampTZ 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 to the current OracleTimeStampTZ instance.

Return Value

The method returns a number that is:

Less than zero: if the current OracleTimeStampTZ instance value is less than that of obj.

Zero: if the current OracleTimeStampTZ instance and obj values are equal.

Greater than zero: if the current OracleTimeStampTZ instance value is greater than that of obj.

Implements

IComparable

Exceptions

ArgumentException - The obj is not of type OracleTimeStampTZ.

Remarks

The following rules apply to the behavior of this method.

• The comparison must be between OracleTimeStampTZs. For example, comparing an OracleTimeStampTZ instance with an OracleBinary instance is not allowed. When an OracleTimeStampTZ is compared with a different type, an ArgumentException is thrown.

• Any OracleTimeStampTZ that has a value is greater than an OracleTimeStampTZ that has a null value.

• Two OracleTimeStampTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

Equals

Overrides Object

This method determines whether an object has the same date and time as the current OracleTimeStampTZ instance.

Declaration

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

Parameters

• obj

  The object being compared to the current OracleTimeStampTZ instance.

Return Value

Returns true if the obj is of type OracleTimeStampTZ and represents the same date and time; otherwise, returns false.

Remarks

The following rules apply to the behavior of this method.

• Any OracleTimeStampTZ that has a value is greater than an OracleTimeStampTZ that has a null value.

• Two OracleTimeStampTZs that contain a null value are equal.

  
  

  See Also: Oracle.DataAccess.Types Namespace (ODP.NET Types) OracleTimeStampTZ Structure OracleTimeStampTZ Members

  
  

GetDaysBetween

This method subtracts an OracleTimeStampTZ value from the current instance and returns an OracleIntervalDS that represents the time interval.

Declaration

// C#
public OracleIntervalDS GetDaysBetween(OracleTimeStampTZ value1);

Parameters

• value1

  The OracleTimeStampTZ value being subtracted.

Return Value

An OracleIntervalDS that represents the interval between two OracleTimeStampTZ values.

Remarks

If either the current instance or the parameter has a null value, the returned OracleIntervalDS has a null value.

GetHashCode

Overrides Object

This method returns a hash code for the OracleTimeStampTZ instance.

Declaration

// C#
public override int GetHashCode();

Return Value

A number that represents the hash code.

GetTimeZoneOffset

This method gets the time zone portion in hours and minutes of the current OracleTimeStampTZ.

Declaration

// C#
public TimeSpan GetTimeZoneOffset();

Return Value

A TimeSpan.

Exceptions

OracleNullValueException - The current instance has a null value.

GetYearsBetween

This method subtracts an OracleTimeStampTZ value from the current instance and returns an OracleIntervalYM that represents the time interval.

Declaration

// C#
public OracleIntervalYM GetYearsBetween(OracleTimeStampTZ val);

Parameters

• val

  The OracleTimeStampTZ value being subtracted.

Return Value

An OracleIntervalYM that represents the interval between two OracleTimeStampTZ values.

Remarks

If either the current instance or the parameter has a null value, the returned OracleIntervalYM has a null value.

ToLocalTime

This method converts the current OracleTimeStampTZ instance to local time.

Declaration

// C#
public OracleTimeStampLTZ ToLocalTime();

Return Value

An OracleTimeStampLTZ that contains the date and time, which is normalized to the client local time zone, in the current instance.

Remarks

If the current instance has a null value, the returned OracleTimeStampLTZ has a null value.

ToOracleDate

This method converts the current OracleTimeStampTZ structure to an OracleDate structure.

Declaration

// C#
public OracleDate ToOracleDate();

Return Value

The returned OracleDate contains the date and time in the current instance, but the time zone information in the current instance is truncated

Remarks

The precision of the OracleTimeStampTZ value can be lost during the conversion, and the time zone information in the current instance is truncated.

If the current instance has a null value, the value of the returned OracleDate structure has a null value.

ToOracleTimeStampLTZ

This method converts the current OracleTimeStampTZ structure to an OracleTimeStampLTZ structure.

Declaration

// C#
public OracleTimeStampLTZ ToOracleTimeStampLTZ();

Return Value

The returned OracleTimeStampLTZ structure contains the date and time, which is normalized to the client local time zone, in the current instance.

Remarks

If the value of the current instance has a null value, the value of the returned OracleTimeStampLTZ structure has a null value.

ToOracleTimeStamp

This method converts the current OracleTimeStampTZ structure to an OracleTimeStamp structure.

Declaration

// C#
public OracleTimeStamp ToOracleTimeStamp();

Return Value

The returned OracleTimeStamp contains the date and time in the current instance, but the time zone information is truncated.

Remarks

If the value of the current instance has a null value, the value of the returned OracleTimeStamp structure has a null value.

ToString

Overrides Object

This method converts the current OracleTimeStampTZ structure to a string.

Declaration

// C#
public override string ToString();

Return Value

A string that represents the same date and time as the current OracleTimeStampTZ structure.

Remarks

The returned value is a string representation of an OracleTimeStampTZ in the format specified by the OracleGlobalization.TimeStampTZFormat property of the thread. The names and abbreviations used for months and days are in the language specified by the OracleGlobalization.DateLanguage and the OracleGlobalization.Calendar properties of the thread. If any of the thread's globalization properties are set to null or an empty string, the client computer's settings are used.

Example

// C#
// Set the nls_timestamp_tz_format for the TimeStampTZFormat(string) constructor
OracleGlobalization og = OracleGlobalization.GetClientInfo();
og.TimeStampTZFormat = "DD-MON-YYYY HH:MI:SS.FF AM TZR";
OracleGlobalization.SetThreadInfo(og);

// construct OracleTimeStampTZ from a string using the format specified.
OracleTimeStampTZ tstz = new OracleTimeStampTZ("11-NOV-1999" +  
      "11:02:33.444 AM US/Pacific");

// Set the nls_timestamp_tz_format for the ToString() method
og.TimeStampTZFormat = "YYYY-MON-DD HH:MI:SS.FF AM TZR";
OracleGlobalization.SetThreadInfo(og);

Console.WriteLine(tstz.ToString()); 
// Prints "1999-NOV-11 11:02:33.444000000 AM  US/Pacific"

ToUniversalTime

This method converts the current datetime to Coordinated Universal Time (UTC).

Declaration

// C#
public OracleTimeStampTZ ToUniversalTime();

Return Value

An OracleTimeStampTZ structure.

Remarks

If the current instance has a null value, the value of the returned OracleTimeStampTZ structure has a null value.