Release 9.2.0.2
Part Number A96160-01
 Contents |
 Index |
| Oracle Data Provider for .NET Developer's Guide Release 9.2.0.2 Part Number A96160-01 |
|
Oracle.DataAccess.Types Namespace (ODP.NET Types), 5 of 17
The OracleIntervalDS structure represents the Oracle INTERVAL DAY TO SECOND datatype to be stored in or retrieved from a database. Each OraIntervalDS stores a period of time in term of days, hours, minutes, seconds, and fractional seconds.
Object
ValueType
OracleIntervalDS
// C#
public struct OracleIntervalDS : IComparable
All public static methods are thread-safe, although instance methods do not guarantee thread safety.
// 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());
Namespace: Oracle.DataAccess.Types
Assembly: Oracle.DataAccesss.dll
OracleIntervalDS members are listed in the following tables:
OracleIntervalDS constructors are listed in Table 5-48
| Constructor | Description |
|---|---|
|
Instantiates a new instance of OracleIntervalDS structure (Overloaded) |
The OracleIntervalDS static fields are listed in Table 5-49.
The OracleIntervalDS static methods are listed in Table 5-50.
The OracleIntervalDS static operators are listed in Table 5-51.
The OracleIntervalDS type conversions are listed in Table 5-52.
| Operator | Description |
|---|---|
|
Converts an |
|
|
Converts a string to an |
|
|
Converts a |
The OracleIntervalDS properties are listed in Table 5-53.
The OracleIntervalDS methods are listed in Table 5-54.
OracleIntervalDS constructors create a new instance of the OracleIntervalDS structure.
This constructor creates a new instance of the OracleIntervalDS structure and sets its value using a TimeSpan structure.
This constructor creates a new instance of the OracleIntervalDS structure and sets its value using a string that indicates a period of time.
This constructor creates a new instance of the OracleIntervalDS structure and sets its value using the total number of days.
This constructor creates a new instance of the OracleIntervalDS structure and sets its value using the supplied days, hours, minutes, seconds and milliseconds.
This constructor creates a new instance of the OracleIntervalDS structure and sets its value using the supplied days, hours, minutes, seconds, and nanoseconds.
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.
This constructor creates a new instance of the OracleIntervalDS structure and sets its value using a TimeSpan structure.
// C# public OracleIntervalDS(TimeSpan ts);
This constructor creates a new instance of the OracleIntervalDS structure and sets its value using a string that indicates a period of time.
// C# public OracleIntervalDS(string intervalStr);
ArgumentException - The intervalStr parameter is not in the valid format or has an invalid value.
ArgumentNullException - The intervalStr parameter is null.
The value specified in the supplied intervalStr must be in Day HH:MI:SSxFF format.
"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.
This constructor creates a new instance of the OracleIntervalDS structure and sets its value using the total number of days.
// C# public OracleIntervalDS(double totalDays);
totalDays
The supplied total number of days for a time interval. Range of days is -1000,000,000 < totalDays < 1000,000,000.
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.
This constructor creates a new instance of the OracleIntervalDS structure and sets its value using the supplied days, hours, minutes, seconds, and milliseconds.
// C# public OracleIntervalDS (int days, int hours, int minutes, int seconds, double milliSeconds);
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).
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.
The sign of all the arguments must be the same.
This constructor creates a new instance of the OracleIntervalDS structure and sets its value using the supplied days, hours, minutes, seconds, and nanoseconds.
// C#public OracleIntervalDS (intdays, inthours, intminutes, intseconds,intnanoseconds);
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)
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.
The sign of all the arguments must be the same.
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.
// C#
public OracleIntervalDS (byte[ ] bytes);
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.
The OracleIntervalDS static fields are listed in Table 5-55.
This static field represents the maximum value for an OracleIntervalDS structure.
// C# public static readonly OracleIntervalDS MaxValue;
Maximum values:
This static field represents the minimum value for an OracleIntervalDS structure.
// C# public static readonly OracleIntervalDS MinValue;
Minimum values:
This static field represents a null value that can be assigned to an OracleIntervalDS instance.
// C# public static readonly OracleIntervalDS Null;
This static field represents a zero value for an OracleIntervalDS structure.
// C# public static readonly OracleIntervalDS Zero;
The OracleIntervalDS static methods are listed in Table 5-56.
This static method determines whether two OracleIntervalDS values are equal.
// C# public static bool Equals(OracleIntervalDS val1, OracleIntervalDS val2);
If the two OracleIntervalDS structures represent the same time interval, returns true; otherwise, returns false.
The following rules apply to the behavior of this method.
OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.
OracleIntervalDSs that contain a null value are equal.
This static method determines whether the first of two OracleIntervalDS values is greater than the second.
// C# public static bool GreaterThan(OracleIntervalDS val1, OracleIntervalDS val2);
Returns true if the first of two OracleIntervalDS values is greater than the second; otherwise, returns false.
The following rules apply to the behavior of this method.
OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.
OracleIntervalDSs that contain a null value are equal.
This static method determines whether the first of two OracleIntervalDS values is greater than or equal to the second.
// C# public static bool GreaterThanOrEqual(OracleIntervalDS val1, OracleIntervalDS val2);
Returns true if the first of two OracleIntervalDS values is greater than or equal to the second; otherwise, returns false.
The following rules apply to the behavior of this method.
OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.
OracleIntervalDSs that contain a null value are equal.
This static method determines whether the first of two OracleIntervalDS values is less than the second.
// C# public static bool LessThan(OracleIntervalDS val1, OracleIntervalDS val2);
Returns true if the first of two OracleIntervalDS values is less than the second; otherwise, returns false.
The following rules apply to the behavior of this method.
OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.
OracleIntervalDSs that contain a null value are equal.
This static method determines whether the first of two OracleIntervalDS values is less than or equal to the second.
// C# public static bool LessThanOrEqual(OracleIntervalDS val1, OracleIntervalDS val2);
Returns true if the first of two OracleIntervalDS values is less than or equal to the second; otherwise, returns false.
The following rules apply to the behavior of this method.
OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.
OracleIntervalDSs that contain a null value are equal.
This static method determines whether two OracleIntervalDS values are not equal.
// C# public static bool NotEquals(OracleIntervalDS val1, OracleIntervalDS val2);
Returns true if two OracleIntervalDS values are not equal; otherwise, returns false.
The following rules apply to the behavior of this method.
OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.
OracleIntervalDSs that contain a null value are equal.
This static method returns an OracleIntervalDS instance and sets its value for time interval using a string.
// C# public static OracleIntervalDS Parse(string intervalStr);
Returns an OracleIntervalDS instance representing the time interval from the supplied string.
ArgumentException - The intervalStr parameter is not in the valid format or intervalStr has an invalid value.
ArgumentNullException - The intervalStr parameter is null.
The value specified in intervalStr must be in Day HH:MI:SSxFF format.
"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.
This static method returns a new instance of an OracleIntervalDS with the specified day precision and fractional second precision.
// C# public static OracleIntervalDS SetPrecision(OracleIntervalDS value1,int dayPrecision, int fracSecPrecision);
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).
An OracleIntervalDS instance.
ArgumentOutOfRangeException - An argument value is out of the specified range.
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().
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.
The OracleIntervalDS static operators are listed in Table 5-57.
This static operator adds two OracleIntervalDS values.
// C# public static OracleIntervalDS operator + (OracleIntervalDS val1, OracleIntervalDS val2);
An OracleIntervalDS.
If either argument has a null value, the returned OracleIntervalDS structure has a null value.
This static operator determines if two OracleIntervalDS values are equal.
// C# public static bool operator == (OracleIntervalDS val1, OracleIntervalDS val2);
Returns true if the two OracleIntervalDS values are the same; otherwise returns false.
The following rules apply to the behavior of this method.
OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.
OracleIntervalDSs that contain a null value are equal.
This static operator determines if the first of two OracleIntervalDS values is greater than the second.
// C# public static bool operator > (OracleIntervalDS val1, OracleIntervalDS val2);
Returns true if one OracleIntervalDS value is greater than another; otherwise, returns false.
The following rules apply to the behavior of this method.
OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.
OracleIntervalDSs that contain a null value are equal.
This static operator determines if the first of two OracleIntervalDS values is greater than or equal to the second.
// C# public static bool operator >= (OracleIntervalDS val1, OracleIntervalDS val2);
Returns true if the first of two OracleIntervalDS values is greater than or equal to the second; otherwise, returns false.
The following rules apply to the behavior of this method.
OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.
OracleIntervalDSs that contain a null value are equal.
This static operator determines if the two OracleIntervalDS values are not equal.
// C# public static bool operator != (OracleIntervalDS val1, OracleIntervalDS val2);
Returns true if the two OracleIntervalDS values are not equal; otherwise, returns false.
The following rules apply to the behavior of this method.
OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.
OracleIntervalDSs that contain a null value are equal.
This static operator determines if the first of two OracleIntervalDS values is less than the second.
// C# public static bool operator < (OracleIntervalDS val1, OracleIntervalDS val2);
Returns true if the first of two OracleIntervalDS values is less than the second; otherwise, returns false.
The following rules apply to the behavior of this method.
OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.
OracleIntervalDSs that contain a null value are equal.
This static operator determines if the first of two OracleIntervalDS values is less than or equal to the second.
// C# public static bool operator <= (OracleIntervalDS val1, OracleIntervalDS val2);
Returns true if the first of two OracleIntervalDS values is less than or equal to the second; otherwise, returns false.
The following rules apply to the behavior of this method.
OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.
OracleIntervalDSs that contain a null value are equal.
This static operator subtracts one OracleIntervalDS structure from another.
// C# public static OracleIntervalDS operator - (OracleIntervalDS val1, OracleIntervalDS val2);
An OracleIntervalDS structure.
If either argument has a null value, the returned OracleIntervalDS structure has a null value.
This static operator negates the supplied OracleIntervalDS structure.
// C# public static OracleIntervalDS operator - (OracleIntervalDS val);
An OracleIntervalDS structure.
If the supplied OracleIntervalDS structure has a null value, the returned OracleIntervalDS structure has a null value.
This static operator multiplies an OracleIntervalDS value by a number.
// C# public static OracleIntervalDS operator * (OracleIntervalDS val1, int multiplier);
A new OracleIntervalDS instance.
If the OracleIntervalDS structure has a null value, the returned OracleIntervalDS structure has a null value.
This static operator divides an OracleIntervalDS value by a number.
// C# public static OracleIntervalDS operator / (OracleIntervalDS val1, int divisor);
An OracleIntervalDS structure.
If the OracleIntervalDS structure has a null value, the returned OracleIntervalDS structure has a null value.
The OracleIntervalDS type conversions are listed in Table 5-58.
| Operator | Description |
|---|---|
|
Converts an |
|
|
Converts a string to an |
|
|
Converts a |
This type conversion operator converts an OracleIntervalDS structure to a TimeSpan structure.
// C# public staticexplicit operator TimeSpan(OracleIntervalDSval);
A TimeSpan structure.
OracleNullValueException - The OracleIntervalDS structure has a null value.
This type conversion operator converts a string to an OracleIntervalDS structure.
// C# public static explicit operator OracleIntervalDS (string intervalStr);
An OracleIntervalDS structure.
ArgumentException - The supplied intervalStr parameter is not in the correct format or has an invalid value.
ArgumentNullException - The intervalStr parameter is null.
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.
"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.
This type conversion operator converts a TimeSpan structure to an OracleIntervalDS structure.
// C# public static implicit operator OracleIntervalDS(TimeSpan val);
An OracleIntervalDS structure.
The returned OracleIntervalDS structure contains the same days, hours, seconds, and milliseconds as the supplied TimeSpan val.
The OracleIntervalDS properties are listed in Table 5-59.
This property returns an array of bytes that represents the Oracle INTERVAL DAY TO SECOND in Oracle internal format.
// C# public byte[] BinData {get;}
A byte array that represents an Oracle INTERVAL DAY TO SECOND in Oracle internal format.
OracleNullValueException - The current instance has a null value.
This property gets the days component of an OracleIntervalDS.
// C# public int Days {get;}
An int representing the days component.
OracleNullValueException - The current instance has a null value.
This property gets the hours component of an OracleIntervalDS.
// C# public int Hours {get;}
An int representing the hours component.
OracleNullValueException - The current instance has a null value.
This property indicates whether the current instance has a null value.
// C# public bool IsNull {get;}
Returns true if the current instance has a null value; otherwise, returns false.
This property gets the milliseconds component of an OracleIntervalDS.
// C# public double Milliseconds {get;}
A double that represents milliseconds component.
OracleNullValueException - The current instance has a null value.
This property gets the minutes component of an OracleIntervalDS.
// C# public int Minutes {get;}
A int that represents minutes component.
OracleNullValueException - The current instance has a null value.
This property gets the nanoseconds component of an OracleIntervalDS.
// C# public int Nanoseconds {get;}
An int that represents nanoseconds component.
OracleNullValueException - The current instance has a null value.
This property gets the seconds component of an OracleIntervalDS.
// C# public int Seconds {get;}
An int that represents seconds component.
OracleNullValueException - The current instance has a null value.
This property returns the total number, in days, that represent the time period in the OracleIntervalDS structure.
// C# public double TotalDays {get;}
A double that represents the total number of days.
OracleNullValueException - The current instance has a null value.
This property specifies the time interval that is stored in the OracleIntervalDS structure.
// C# public TimeSpan Value {get;}
A time interval.
OracleNullValueException - The current instance has a null value.
The OracleIntervalDS methods are listed in Table 5-60.
This method compares the current OracleIntervalDS instance to an object, and returns an integer that represents their relative values.
// C# public int CompareTo(object obj);
The method returns:
OracleIntervalDS represents a shorter time interval than obj.
OracleIntervalDS and obj represent the same time interval.
OracleIntervalDS represents a longer time interval than obj.
IComparable
ArgumentException - The obj parameter is not of type OracleIntervalDS.
The following rules apply to the behavior of this method.
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.
OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.
OracleIntervalDSs that contain a null value are equal.
This method determines whether the specified object has the same time interval as the current instance.
// C# public override bool Equals(object obj);
Returns true if obj is of type OracleIntervalDS and has the same time interval as the current instance; otherwise, returns false.
The following rules apply to the behavior of this method.
OracleIntervalDS that has a value compares greater than an OracleIntervalDS that has a null value.
OracleIntervalDSs that contain a null value are equal.
Overrides Object
This method returns a hash code for the OracleIntervalDS instance.
// C# public override int GetHashCode();
Overrides Object
This method converts the current OracleIntervalDS structure to a string.
// C# public override string ToString();
Returns a string.
If the current instance has a null value, the returned string contains "null".
|
 Copyright © 2002 Oracle Corporation. All Rights Reserved. |
|