Gemstone.Common
Defines extension methods for actions.
Attempts to execute an action and processes exceptions using the given exception handler.
The action to be executed.
The handler to be called in the event of an error.
true if the action was executed without errors; otherwise, false.
or is null
Execute an action on the thread pool after a specified number of milliseconds.
The action to be executed.
The amount of time to wait before execution, in milliseconds.
The token used to cancel execution.
The action to be performed if an exception is thrown from the action.
End users should attach to the or
events to log exceptions if the is not defined.
Execute a cancellable action on the thread pool after a specified number of milliseconds.
The action to be executed.
The amount of time to wait before execution, in milliseconds.
The token used to cancel execution.
The action to be performed if an exception is thrown from the action.
End users should attach to the or
events to log exceptions if the is not defined.
Execute an action on the thread pool after a specified number of milliseconds.
The action to be executed.
The amount of time to wait before execution, in milliseconds.
The action to be performed if an exception is thrown from the action.
A function to call which will cancel the operation.
Cancel function returns true if is canceled in time, false if not.
End users should attach to the or
events to log exceptions if the is not defined.
Execute a cancellable action on the thread pool after a specified number of milliseconds.
The action to be executed.
The amount of time to wait before execution, in milliseconds.
The action to be performed if an exception is thrown from the action.
A function to call which will cancel the operation.
Cancel function returns true if is canceled, false if not.
End users should attach to the or
events to log exceptions if the is not defined.
Contains extension methods for delegates.
Defines extension functions related to manipulation.
Zero the given buffer in a way that will not be optimized away.
Buffer to zero.
of array.
Validates that the specified and are valid within the given .
Array to validate.
0-based start index into the .
Valid number of items within from .
is null.
or is less than 0 -or-
and will exceed length.
of array.
Returns a copy of the specified portion of the array.
Source array.
Offset into array.
Length of array to copy at offset.
An array of data copied from the specified portion of the source array.
Returned array will be extended as needed to make it the specified , but
it will never be less than the source array length - .
If an existing array of primitives is already available, using the directly
instead of this extension method may be optimal since this method always allocates a new return array.
Unlike , however, this function also works with non-primitive types.
is outside the range of valid indexes for the source array -or-
is less than 0.
of array.
Combines arrays together into a single array.
Source array.
Other array to combine to array.
Combined arrays.
Only use this function if you need a copy of the combined arrays, it will be optimal
to use the Linq function if you simply need to
iterate over the combined arrays.
This function can easily throw an out of memory exception if there is not enough
contiguous memory to create an array sized with the combined lengths.
of array.
Combines specified portions of arrays together into a single array.
Source array.
Offset into array to begin copy.
Number of bytes to copy from array.
Other array to combine to array.
Offset into array to begin copy.
Number of bytes to copy from array.
Combined specified portions of both arrays.
or is outside the range of valid indexes for the associated array -or-
or is less than 0 -or-
or ,
and or do not specify a valid section in the associated array.
Only use this function if you need a copy of the combined arrays, it will be optimal
to use the Linq function if you simply need to
iterate over the combined arrays.
This function can easily throw an out of memory exception if there is not enough
contiguous memory to create an array sized with the combined lengths.
of array.
Combines arrays together into a single array.
Source array.
First array to combine to array.
Second array to combine to array.
Combined arrays.
Only use this function if you need a copy of the combined arrays, it will be optimal
to use the Linq function if you simply need to
iterate over the combined arrays.
This function can easily throw an out of memory exception if there is not enough
contiguous memory to create an array sized with the combined lengths.
of array.
Combines arrays together into a single array.
Source array.
First array to combine to array.
Second array to combine to array.
Third array to combine to array.
Combined arrays.
Only use this function if you need a copy of the combined arrays, it will be optimal
to use the Linq function if you simply need to
iterate over the combined arrays.
This function can easily throw an out of memory exception if there is not enough
contiguous memory to create an array sized with the combined lengths.
of array.
Combines arrays together into a single array.
Source array.
First array to combine to array.
Second array to combine to array.
Third array to combine to array.
Fourth array to combine to array.
Combined arrays.
Only use this function if you need a copy of the combined arrays, it will be optimal
to use the Linq function if you simply need to
iterate over the combined arrays.
This function can easily throw an out of memory exception if there is not enough
contiguous memory to create an array sized with the combined lengths.
of array.
Combines array of arrays together into a single array.
Array of arrays to combine.
Combined arrays.
Only use this function if you need a copy of the combined arrays, it will be optimal
to use the Linq function if you simply need to
iterate over the combined arrays.
This function can easily throw an out of memory exception if there is not enough
contiguous memory to create an array sized with the combined lengths.
of arrays.
Searches for the specified and returns the index of the first occurrence within the .
Array to search.
Sequence of items to search for.
The zero-based index of the first occurrence of the in the , if found; otherwise, -1.
of array.
Searches for the specified and returns the index of the first occurrence within the range of elements in the
that starts at the specified index.
Array to search.
Sequence of items to search for.
Start index in the to start searching.
The zero-based index of the first occurrence of the in the , if found; otherwise, -1.
of array.
Searches for the specified and returns the index of the first occurrence within the range of elements in the
that starts at the specified index and contains the specified number of elements.
Array to search.
Sequence of items to search for.
Start index in the to start searching.
Number of bytes in the to search through.
The zero-based index of the first occurrence of the in the , if found; otherwise, -1.
is null or has zero length.
is outside the range of valid indexes for the source array -or-
is less than 0.
of array.
Searches for the specified and returns the occurrence count within the .
Array to search.
Sequence of items to search for.
The occurrence count of the in the , if found; otherwise, -1.
of array.
Searches for the specified and returns the occurence count within the range of elements in the
that starts at the specified index.
Array to search.
Sequence of items to search for.
Start index in the to start searching.
The occurrence count of the in the , if found; otherwise, -1.
of array.
Searches for the specified and returns the occurrence count within the range of elements in the
that starts at the specified index and contains the specified number of elements.
Array to search.
Sequence of items to search for.
Start index in the to start searching.
Number of bytes in the to search through.
The occurrence count of the in the , if found; otherwise, -1.
is null or has zero length.
is outside the range of valid indexes for the source array -or-
is less than 0.
of array.
Returns comparison results of two binary arrays.
Source array.
Other array to compare to array.
Note that if both arrays are null the arrays will be considered equal.
If one array is null and the other array is not null, the non-null array will be considered larger.
If the array lengths are not equal, the array with the larger length will be considered larger.
If the array lengths are equal, the arrays will be compared based on content.
A signed integer that indicates the relative comparison of array and array.
Return Value
Description
-
Less than zero
Source array is less than other array.
-
Zero
Source array is equal to other array.
-
Greater than zero
Source array is greater than other array.
of array.
Returns comparison results of two binary arrays.
Source array.
Offset into array to begin compare.
Other array to compare to array.
Offset into array to begin compare.
Number of bytes to compare in both arrays.
Note that if both arrays are null the arrays will be considered equal.
If one array is null and the other array is not null, the non-null array will be considered larger.
A signed integer that indicates the relative comparison of array and array.
Return Value
Description
-
Less than zero
Source array is less than other array.
-
Zero
Source array is equal to other array.
-
Greater than zero
Source array is greater than other array.
or is outside the range of valid indexes for the associated array -or-
is less than 0 -or-
or and do not specify a valid section in the associated array.
of array.
Combines buffers together as a single image.
Source buffer.
First buffer to combine to buffer.
Second buffer to combine to buffer.
Combined buffers.
Cannot create a byte array with more than 2,147,483,591 elements.
Only use this function if you need a copy of the combined buffers, it will be optimal
to use the Linq function if you simply need to
iterate over the combined buffers.
Combines buffers together as a single image.
Source buffer.
First buffer to combine to buffer.
Second buffer to combine to buffer.
Third buffer to combine to buffer.
Combined buffers.
Cannot create a byte array with more than 2,147,483,591 elements.
Only use this function if you need a copy of the combined buffers, it will be optimal
to use the Linq function if you simply need to
iterate over the combined buffers.
Combines buffers together as a single image.
Source buffer.
First buffer to combine to buffer.
Second buffer to combine to buffer.
Third buffer to combine to buffer.
Fourth buffer to combine to buffer.
Combined buffers.
Cannot create a byte array with more than 2,147,483,591 elements.
Only use this function if you need a copy of the combined buffers, it will be optimal
to use the Linq function if you simply need to
iterate over the combined buffers.
Combines an array of buffers together as a single image.
Array of byte buffers.
Combined buffers.
Cannot create a byte array with more than 2,147,483,591 elements.
Only use this function if you need a copy of the combined buffers, it will be optimal
to use the Linq function if you simply need to
iterate over the combined buffers.
Reads a structure from a byte array.
Type of structure to read.
Bytes containing structure.
A structure from .
Reads a structure from a .
Type of structure to read.
positioned at desired structure.
A structure read from .
Contains extension methods for values.
Defines a set of big-endian byte order interoperability functions.
This class is setup to support aggressive in-lining of big endian conversions. Bounds
will not be checked as part of this function call, if bounds are violated, the exception
will be thrown at the level.
Returns a value converted from one byte at a specified position in a byte array.
An array of bytes.
true if the byte at startIndex in value is nonzero; otherwise, false.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a Unicode character converted from two bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A character formed by two bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a double-precision floating point number converted from eight bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A double-precision floating point number formed by eight bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 16-bit signed integer converted from two bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A 16-bit signed integer formed by two bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 32-bit signed integer converted from four bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A 32-bit signed integer formed by four bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 64-bit signed integer converted from eight bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A 64-bit signed integer formed by eight bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a single-precision floating point number converted from four bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A single-precision floating point number formed by four bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 16-bit unsigned integer converted from two bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A 16-bit unsigned integer formed by two bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 32-bit unsigned integer converted from four bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A 32-bit unsigned integer formed by four bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 64-bit unsigned integer converted from eight bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A 64-bit unsigned integer formed by eight bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 128-bit decimal converted from 16 bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A 128-bit decimal formed by 16 bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a value converted from one byte at a specified position in a byte array.
An array of bytes.
The starting position within value.
true if the byte at startIndex in value is nonzero; otherwise, false.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a Unicode character converted from two bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A character formed by two bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a double-precision floating point number converted from eight bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A double-precision floating point number formed by eight bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 16-bit signed integer converted from two bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 16-bit signed integer formed by two bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 32-bit signed integer converted from four bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 32-bit signed integer formed by four bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 64-bit signed integer converted from eight bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 64-bit signed integer formed by eight bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a single-precision floating point number converted from four bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A single-precision floating point number formed by four bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 16-bit unsigned integer converted from two bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 16-bit unsigned integer formed by two bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 32-bit unsigned integer converted from four bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 32-bit unsigned integer formed by four bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 64-bit unsigned integer converted from eight bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 64-bit unsigned integer formed by eight bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 128-bit decimal converted from 16 bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 128-bit decimal formed by 16 bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns the specified value as an array of bytes in the target endian-order.
The value to convert.
An array of bytes with length 1.
Native value type to get bytes for.
type is not primitive.
Cannot get bytes for type.
Returns the specified value as an array of bytes in the target endian-order.
The value to convert.
An array of bytes with length 1.
Returns the specified Unicode character value as an array of bytes in the target endian-order.
The Unicode character value to convert.
An array of bytes with length 2.
Returns the specified double-precision floating point value as an array of bytes in the target endian-order.
The number to convert.
An array of bytes with length 8.
Returns the specified 16-bit signed integer value as an array of bytes.
The number to convert.
An array of bytes with length 2.
Returns the specified 32-bit signed integer value as an array of bytes.
The number to convert.
An array of bytes with length 4.
Returns the specified 64-bit signed integer value as an array of bytes.
The number to convert.
An array of bytes with length 8.
Returns the specified single-precision floating point value as an array of bytes in the target endian-order.
The number to convert.
An array of bytes with length 4.
Returns the specified 16-bit unsigned integer value as an array of bytes.
The number to convert.
An array of bytes with length 2.
Returns the specified 32-bit unsigned integer value as an array of bytes.
The number to convert.
An array of bytes with length 4.
Returns the specified 64-bit unsigned integer value as an array of bytes.
The number to convert.
An array of bytes with length 8.
Returns the specified 128-bit decimal value as an array of bytes.
The number to convert.
An array of bytes with length 16.
Copies the specified primitive type value as an array of bytes in the target endian-order to the destination array.
The value to convert and copy.
The destination buffer.
The byte offset into .
Native value type to get bytes for.
type is not primitive.
Cannot get bytes for type.
Length of bytes copied into array based on size of .
Copies the specified value as an array of 1 byte in the target endian-order to the destination array.
The value to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified Unicode character value as an array of 2 bytes in the target endian-order to the destination array.
The Unicode character value to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified double-precision floating point value as an array of 8 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 16-bit signed integer value as an array of 2 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 32-bit signed integer value as an array of 4 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 64-bit signed integer value as an array of 8 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified single-precision floating point value as an array of 4 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 16-bit unsigned integer value as an array of 2 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 32-bit unsigned integer value as an array of 4 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 64-bit unsigned integer value as an array of 8 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 128-bit decimal value as an array of 16 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified primitive type value as an array of bytes in the target endian-order to the destination array.
The value to convert and copy.
The destination buffer.
Native value type to get bytes for.
type is not primitive.
Cannot get bytes for type.
Length of bytes copied into array based on size of .
Copies the specified value as an array of 1 byte in the target endian-order to the destination array.
The value to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified Unicode character value as an array of 2 bytes in the target endian-order to the destination array.
The Unicode character value to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified double-precision floating point value as an array of 8 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified 16-bit signed integer value as an array of 2 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified 32-bit signed integer value as an array of 4 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified 64-bit signed integer value as an array of 8 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified single-precision floating point value as an array of 4 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified 16-bit unsigned integer value as an array of 2 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified 32-bit unsigned integer value as an array of 4 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified 64-bit unsigned integer value as an array of 8 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified 128-bit decimal value as an array of 16 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Defines extension methods related to bit operations.
Gets the bit value for the specified bit index (0 - 63).
Bit index (0 - 63)
Value of the specified .
Parameter must be between 0 and 63.
Returns value with specified set.
Value source.
to set.
value with specified set.
Returns value with specified set.
Value source.
Bit-mask of the bits to set.
value with specified set.
Returns value with specified set.
Value source.
to set.
value with specified set.
Returns value with specified set.
Value source.
Bit-mask of the bits to set.
value with specified set.
Returns value with specified set.
Value source.
to set.
value with specified set.
Returns value with specified set.
Value source.
Bit-mask of the bits to set.
value with specified set.
Returns value with specified set.
Value source.
to set.
value with specified set.
Returns value with specified set.
Value source.
Bit-mask of the bits to set.
value with specified set.
Returns value with specified set.
Value source.
to set.
value with specified set.
Returns value with specified set.
Value source.
Bit-mask of the bits to set.
value with specified set.
Returns value with specified set.
Value source.
to set.
value with specified set.
Returns value with specified set.
Value source.
Bit-mask of the bits to set.
value with specified set.
Returns value with specified set.
Value source.
to set.
value with specified set.
Returns value with specified set.
Value source.
Bit-mask of the bits to set.
value with specified set.
Returns value with specified set.
Value source.
to set.
value with specified set.
Returns value with specified set.
Value source.
Bit-mask of the bits to set.
value with specified set.
Returns value with specified cleared.
Value source.
to clear.
value with specified cleared.
Returns value with specified cleared.
Value source.
Bit-mask of the bits to clear.
value with specified cleared.
Returns value with specified cleared.
Value source.
to clear.
value with specified cleared.
Returns value with specified cleared.
Value source.
Bit-mask of the bits to clear.
value with specified cleared.
Returns value with specified cleared.
Value source.
to clear.
value with specified cleared.
Returns value with specified cleared.
Value source.
Bit-mask of the bits to clear.
value with specified cleared.
Returns value with specified cleared.
Value source.
to clear.
value with specified cleared.
Returns value with specified cleared.
Value source.
Bit-mask of the bits to clear.
value with specified cleared.
Returns value with specified cleared.
Value source.
to clear.
value with specified cleared.
Returns value with specified cleared.
Value source.
Bit-mask of the bits to clear.
value with specified cleared.
Returns value with specified cleared.
Value source.
to clear.
value with specified cleared.
Returns value with specified cleared.
Value source.
Bit-mask of the bits to clear.
value with specified cleared.
Returns value with specified cleared.
Value source.
to clear.
value with specified cleared.
Returns value with specified cleared.
Value source.
Bit-mask of the bits to clear.
value with specified cleared.
Returns value with specified cleared.
Value source.
to clear.
value with specified cleared.
Returns value with specified cleared.
Value source.
Bit-mask of the bits to clear.
value with specified cleared.
Determines if specified are set.
Value source.
to check.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
Bit-mask of the bits to check.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
to check.
true to check if all are set; otherwise false.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
Bit-mask of the bits to check.
true to check if all are set; otherwise false.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
to check.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
Bit-mask of the bits to check.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
to check.
true to check if all are set; otherwise false.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
Bit-mask of the bits to check.
true to check if all are set; otherwise false.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
to check.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
Bit-mask of the bits to check.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
to check.
true to check if all are set; otherwise false.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
Bit-mask of the bits to check.
true to check if all are set; otherwise false.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
to check.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
Bit-mask of the bits to check.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
to check.
true to check if all are set; otherwise false.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
Bit-mask of the bits to check.
true to check if all are set; otherwise false.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
to check.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
Bit-mask of the bits to check.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
to check.
true to check if all are set; otherwise false.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
Bit-mask of the bits to check.
true to check if all are set; otherwise false.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
to check.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
Bit-mask of the bits to check.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
to check.
true to check if all are set; otherwise false.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
Bit-mask of the bits to check.
true to check if all are set; otherwise false.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
to check.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
Bit-mask of the bits to check.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
to check.
true to check if all are set; otherwise false.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
Bit-mask of the bits to check.
true to check if all are set; otherwise false.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
to check.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
Bit-mask of the bits to check.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
to check.
true to check if all are set; otherwise false.
true if specified are set in value; otherwise false.
Determines if specified are set.
Value source.
Bit-mask of the bits to check.
true to check if all are set; otherwise false.
true if specified are set in value; otherwise false.
Returns value with specified toggled.
Value source.
to toggle.
value with specified toggled.
Returns value with specified toggled.
Value source.
Bit-mask of the bits to toggle.
value with specified toggled.
Returns value with specified toggled.
Value source.
to toggle.
value with specified toggled.
Returns value with specified toggled.
Value source.
Bit-mask of the bits to toggle.
value with specified toggled.
Returns value with specified toggled.
Value source.
to toggle.
value with specified toggled.
Returns value with specified toggled.
Value source.
Bit-mask of the bits to toggle.
value with specified toggled.
Returns value with specified toggled.
Value source.
to toggle.
value with specified toggled.
Returns value with specified toggled.
Value source.
Bit-mask of the bits to toggle.
value with specified toggled.
Returns value with specified toggled.
Value source.
to toggle.
value with specified toggled.
Returns value with specified toggled.
Value source.
Bit-mask of the bits to toggle.
value with specified toggled.
Returns value with specified toggled.
Value source.
to toggle.
value with specified toggled.
Returns value with specified toggled.
Value source.
Bit-mask of the bits to toggle.
value with specified toggled.
Returns value with specified toggled.
Value source.
to toggle.
value with specified toggled.
Returns value with specified toggled.
Value source.
Bit-mask of the bits to toggle.
value with specified toggled.
Returns value with specified toggled.
Value source.
to toggle.
value with specified toggled.
Returns value with specified toggled.
Value source.
Bit-mask of the bits to toggle.
value with specified toggled.
Returns value stored in the bits represented by the specified .
Value source.
that make-up the bit-mask.
value.
Returns value stored in the bits represented by the specified .
Value source.
Bit-mask of the bits involved.
value.
Returns value stored in the bits represented by the specified .
Value source.
that make-up the bit-mask.
value.
Returns value stored in the bits represented by the specified .
Value source.
Bit-mask of the bits involved.
value.
Returns value stored in the bits represented by the specified .
Value source.
that make-up the bit-mask.
value.
Returns value stored in the bits represented by the specified .
Value source.
Bit-mask of the bits involved.
value.
Returns value stored in the bits represented by the specified .
Value source.
that make-up the bit-mask.
value.
Returns value stored in the bits represented by the specified .
Value source.
Bit-mask of the bits involved.
value.
Returns value stored in the bits represented by the specified .
Value source.
that make-up the bit-mask.
value.
Returns value stored in the bits represented by the specified .
Value source.
Bit-mask of the bits involved.
value.
Returns value stored in the bits represented by the specified .
Value source.
that make-up the bit-mask.
value.
Returns value stored in the bits represented by the specified .
Value source.
Bit-mask of the bits involved.
value.
Returns value stored in the bits represented by the specified .
Value source.
that make-up the bit-mask.
value.
Returns value stored in the bits represented by the specified .
Value source.
Bit-mask of the bits involved.
value.
Returns value stored in the bits represented by the specified .
Value source.
that make-up the bit-mask.
value.
Returns value stored in the bits represented by the specified .
Value source.
Bit-mask of the bits involved.
value.
Returns value after setting a new for the bits specified by the .
Value source.
that make-up the bit-mask.
New value.
value.
Returns value after setting a new for the bits specified by the .
Value source.
Bit-mask of the bits involved.
New value.
value.
Returns value after setting a new for the bits specified by the .
Value source.
that make-up the bit-mask.
New value.
value.
Returns value after setting a new for the bits specified by the .
Value source.
Bit-mask of the bits involved.
New value.
value.
Returns value after setting a new for the bits specified by the .
Value source.
that make-up the bit-mask.
New value.
value.
Returns value after setting a new for the bits specified by the .
Value source.
Bit-mask of the bits involved.
New value.
value.
Returns value after setting a new for the bits specified by the .
Value source.
that make-up the bit-mask.
New value.
value.
Returns value after setting a new for the bits specified by the .
Value source.
Bit-mask of the bits involved.
New value.
value.
Returns value after setting a new for the bits specified by the .
Value source.
that make-up the bit-mask.
New value.
value.
Returns value after setting a new for the bits specified by the .
Value source.
Bit-mask of the bits involved.
New value.
value.
Returns value after setting a new for the bits specified by the .
Value source.
that make-up the bit-mask.
New value.
value.
Returns value after setting a new for the bits specified by the .
Value source.
Bit-mask of the bits involved.
New value.
value.
Returns value after setting a new for the bits specified by the .
Value source.
that make-up the bit-mask.
New value.
value.
Returns value after setting a new for the bits specified by the .
Value source.
Bit-mask of the bits involved.
New value.
value.
Returns value after setting a new for the bits specified by the .
Value source.
that make-up the bit-mask.
New value.
value.
Returns value after setting a new for the bits specified by the .
Value source.
Bit-mask of the bits involved.
New value.
value.
Performs rightwise bit-rotation for the specified number of rotations.
Value used for bit-rotation.
Number of rotations to perform.
Value that has its bits rotated to the right the specified number of times.
Actual rotation direction is from a big-endian perspective - this is an artifact of the native
.NET bit shift operators. As a result bits may actually appear to rotate right on little-endian
architectures.
Performs rightwise bit-rotation for the specified number of rotations.
Value used for bit-rotation.
Number of rotations to perform.
Value that has its bits rotated to the right the specified number of times.
Actual rotation direction is from a big-endian perspective - this is an artifact of the native
.NET bit shift operators. As a result bits may actually appear to rotate right on little-endian
architectures.
Performs rightwise bit-rotation for the specified number of rotations.
Value used for bit-rotation.
Number of rotations to perform.
Value that has its bits rotated to the right the specified number of times.
Actual rotation direction is from a big-endian perspective - this is an artifact of the native
.NET bit shift operators. As a result bits may actually appear to rotate right on little-endian
architectures.
Performs rightwise bit-rotation for the specified number of rotations.
Value used for bit-rotation.
Number of rotations to perform.
Value that has its bits rotated to the right the specified number of times.
Actual rotation direction is from a big-endian perspective - this is an artifact of the native
.NET bit shift operators. As a result bits may actually appear to rotate right on little-endian
architectures.
Performs rightwise bit-rotation for the specified number of rotations.
Value used for bit-rotation.
Number of rotations to perform.
Value that has its bits rotated to the right the specified number of times.
Actual rotation direction is from a big-endian perspective - this is an artifact of the native
.NET bit shift operators. As a result bits may actually appear to rotate right on little-endian
architectures.
Performs rightwise bit-rotation for the specified number of rotations.
Value used for bit-rotation.
Number of rotations to perform.
Value that has its bits rotated to the right the specified number of times.
Actual rotation direction is from a big-endian perspective - this is an artifact of the native
.NET bit shift operators. As a result bits may actually appear to rotate right on little-endian
architectures.
Performs rightwise bit-rotation for the specified number of rotations.
Value used for bit-rotation.
Number of rotations to perform.
Value that has its bits rotated to the right the specified number of times.
Actual rotation direction is from a big-endian perspective - this is an artifact of the native
.NET bit shift operators. As a result bits may actually appear to rotate right on little-endian
architectures.
Performs rightwise bit-rotation for the specified number of rotations.
Value used for bit-rotation.
Number of rotations to perform.
Value that has its bits rotated to the right the specified number of times.
Actual rotation direction is from a big-endian perspective - this is an artifact of the native
.NET bit shift operators. As a result bits may actually appear to rotate right on little-endian
architectures.
Performs rightwise bit-rotation for the specified number of rotations.
Value used for bit-rotation.
Number of rotations to perform.
Value that has its bits rotated to the right the specified number of times.
Actual rotation direction is from a big-endian perspective - this is an artifact of the native
.NET bit shift operators. As a result bits may actually appear to rotate left on little-endian
architectures.
Performs rightwise bit-rotation for the specified number of rotations.
Value used for bit-rotation.
Number of rotations to perform.
Value that has its bits rotated to the right the specified number of times.
Actual rotation direction is from a big-endian perspective - this is an artifact of the native
.NET bit shift operators. As a result bits may actually appear to rotate left on little-endian
architectures.
Performs rightwise bit-rotation for the specified number of rotations.
Value used for bit-rotation.
Number of rotations to perform.
Value that has its bits rotated to the right the specified number of times.
Actual rotation direction is from a big-endian perspective - this is an artifact of the native
.NET bit shift operators. As a result bits may actually appear to rotate left on little-endian
architectures.
Performs rightwise bit-rotation for the specified number of rotations.
Value used for bit-rotation.
Number of rotations to perform.
Value that has its bits rotated to the right the specified number of times.
Actual rotation direction is from a big-endian perspective - this is an artifact of the native
.NET bit shift operators. As a result bits may actually appear to rotate left on little-endian
architectures.
Performs rightwise bit-rotation for the specified number of rotations.
Value used for bit-rotation.
Number of rotations to perform.
Value that has its bits rotated to the right the specified number of times.
Actual rotation direction is from a big-endian perspective - this is an artifact of the native
.NET bit shift operators. As a result bits may actually appear to rotate left on little-endian
architectures.
Performs rightwise bit-rotation for the specified number of rotations.
Value used for bit-rotation.
Number of rotations to perform.
Value that has its bits rotated to the right the specified number of times.
Actual rotation direction is from a big-endian perspective - this is an artifact of the native
.NET bit shift operators. As a result bits may actually appear to rotate left on little-endian
architectures.
Performs rightwise bit-rotation for the specified number of rotations.
Value used for bit-rotation.
Number of rotations to perform.
Value that has its bits rotated to the right the specified number of times.
Actual rotation direction is from a big-endian perspective - this is an artifact of the native
.NET bit shift operators. As a result bits may actually appear to rotate left on little-endian
architectures.
Performs rightwise bit-rotation for the specified number of rotations.
Value used for bit-rotation.
Number of rotations to perform.
Value that has its bits rotated to the right the specified number of times.
Actual rotation direction is from a big-endian perspective - this is an artifact of the native
.NET bit shift operators. As a result bits may actually appear to rotate left on little-endian
architectures.
Contains extension methods for .
Contains some random and useful functions.
Determines if the number is a power of 2.
The value to check power of two properties.
true if is a power of 2; otherwise, false.
If is less than zero
Determines if the number is a power of 2.
The value to check power of two properties.
true if is a power of 2; otherwise, false.
If is less than zero
Determines if the number is a power of 2.
The value to check power of two properties.
true if is a power of 2; otherwise, false.
Determines if the number is a power of 2.
The value to check power of two properties.
true if is a power of 2; otherwise, false.
Counts the number of bits that are set
Value with bits to count.
Count of the number of bits set in .
Counts the number of bits that are set
Value with bits to count.
Count of the number of bits set in .
Counts the number of bits that are not set
Value with bits to count.
Count of the number of bits set in .
Counts the number of bits that are not set
Count of the number of bits set in .
Rounds a number up to the nearest power of 2.
If the value is a power of two, the same value is returned.
If the value is larger than the largest power of 2. It is rounded down.
Value to round.
rounded to the nearest power of 2.
Method based on a method found at: http://graphics.stanford.edu/~seander/bithacks.htm
Subtitle: Round up to the next highest power of 2
Rounds a number up to the nearest power of 2.
If the value is a power of two, the same value is returned.
If the value is larger than the largest power of 2. It is rounded down.
Value to round.
rounded to the nearest power of 2.
Method based on a method found at: http://graphics.stanford.edu/~seander/bithacks.htm
Subtitle: Round up to the next highest power of 2
Rounds a number down to the nearest power of 2.
If the value is a power of two, the same value is returned.
If value is zero, one is returned.
Value to round.
rounded to the nearest power of 2.
Rounds a number down to the nearest power of 2.
If the value is a power of two, the same value is returned.
If value is zero, 1 is returned.
Value to round.
rounded to the nearest power of 2.
Creates a bit mask for a number with the given number of bits.
Bit count.
Bit mask for a number with the given number of bits.
Counts the number of consecutive 0's starting from the lowest bit working up.
Target value for bit counting.
Number of consecutive 0's starting from the lowest bit working up.
Unfortunately, c# cannot call the cpu instruction ctz
Example from http://en.wikipedia.org/wiki/Find_first_set
Counts the number of consecutive 0's starting from the lowest bit working up.
Target value for bit counting.
Number of consecutive 0's starting from the lowest bit working up.
Unfortunately, c# cannot call the cpu instruction ctz
Example from http://en.wikipedia.org/wiki/Find_first_set
Counts the number of consecutive 0's starting from the highest bit working down.
Target value for bit counting.
Number of consecutive 0's starting from the highest bit working down.
Unfortunately, c# cannot call the cpu instruction clz
Example from http://en.wikipedia.org/wiki/Find_first_set
Counts the number of consecutive 0's starting from the highest bit working down.
Target value for bit counting.
Number of consecutive 0's starting from the highest bit working down.
Unfortunately, c# cannot call the cpu instruction clz
Example from http://en.wikipedia.org/wiki/Find_first_set
Counts the number of consecutive 1's starting from the lowest bit working up.
Target value for bit counting.
Number of consecutive 1's starting from the lowest bit working up.
Counts the number of consecutive 1's starting from the lowest bit working up.
Target value for bit counting.
Number of consecutive 1's starting from the lowest bit working up.
Counts the number of consecutive 1's starting from the highest bit working down.
Target value for bit counting.
Number of consecutive 1's starting from the highest bit working down.
Counts the number of consecutive 1's starting from the highest bit working down.
Target value for bit counting.
Number of consecutive 1's starting from the highest bit working down.
Returns the bit position for every bit that is set in the provided value.
Bit positions are defined as 0-63;
Target value for bit check enumeration.
Enumeration of all set bit positions.
Returns the bit position for every bit that is set in the provided value.
Bit positions are defined as 0-31;
Target value for bit check enumeration.
Enumeration of all set bit positions.
Returns the bit position for every bit that is cleared in the provided value.
Bit positions are defined as 0-31;
Target value for bit check enumeration.
Enumeration of all cleared bit positions.
Returns the bit position for every bit that is cleared in the provided value.
Bit positions are defined as 0-63;
Target value for bit check enumeration.
Enumeration of all cleared bit positions.
Represents bits in a signed or unsigned integer value.
No bits set (0x0000000000000000)
Bit 00 (0x0000000000000001)
Bit 01 (0x0000000000000002)
Bit 02 (0x0000000000000004)
Bit 03 (0x0000000000000008)
Bit 04 (0x0000000000000010)
Bit 05 (0x0000000000000020)
Bit 06 (0x0000000000000040)
Bit 07 (0x0000000000000080)
Bit 08 (0x0000000000000100)
Bit 09 (0x0000000000000200)
Bit 10 (0x0000000000000400)
Bit 11 (0x0000000000000800)
Bit 12 (0x0000000000001000)
Bit 13 (0x0000000000002000)
Bit 14 (0x0000000000004000)
Bit 15 (0x0000000000008000)
Bit 16 (0x0000000000010000)
Bit 17 (0x0000000000020000)
Bit 18 (0x0000000000040000)
Bit 19 (0x0000000000080000)
Bit 20 (0x0000000000100000)
Bit 21 (0x0000000000200000)
Bit 22 (0x0000000000400000)
Bit 23 (0x0000000000800000)
Bit 24 (0x0000000001000000)
Bit 25 (0x0000000002000000)
Bit 26 (0x0000000004000000)
Bit 27 (0x0000000008000000)
Bit 28 (0x0000000010000000)
Bit 29 (0x0000000020000000)
Bit 30 (0x0000000040000000)
Bit 31 (0x0000000080000000)
Bit 32 (0x0000000100000000)
Bit 33 (0x0000000200000000)
Bit 34 (0x0000000400000000)
Bit 35 (0x0000000800000000)
Bit 36 (0x0000001000000000)
Bit 37 (0x0000002000000000)
Bit 38 (0x0000004000000000)
Bit 39 (0x0000008000000000)
Bit 40 (0x0000010000000000)
Bit 41 (0x0000020000000000)
Bit 42 (0x0000040000000000)
Bit 43 (0x0000080000000000)
Bit 44 (0x0000100000000000)
Bit 45 (0x0000200000000000)
Bit 46 (0x0000400000000000)
Bit 47 (0x0000800000000000)
Bit 48 (0x0001000000000000)
Bit 49 (0x0002000000000000)
Bit 50 (0x0004000000000000)
Bit 51 (0x0008000000000000)
Bit 52 (0x0010000000000000)
Bit 53 (0x0020000000000000)
Bit 54 (0x0040000000000000)
Bit 55 (0x0080000000000000)
Bit 56 (0x0100000000000000)
Bit 57 (0x0200000000000000)
Bit 58 (0x0400000000000000)
Bit 59 (0x0800000000000000)
Bit 60 (0x1000000000000000)
Bit 61 (0x2000000000000000)
Bit 62 (0x4000000000000000)
Bit 63 (0x8000000000000000)
Defines a set of methods used to convert byte buffers to and from user presentable data formats.
Handles conversion of byte buffers to and from a hexadecimal data format.
Decodes given string back into a byte buffer.
Encoded hexadecimal data string to decode.
Original spacing character that was inserted between encoded bytes.
Decoded bytes.
Encodes given buffer into a user presentable representation.
Bytes to encode.
Offset into buffer to begin encoding.
Length of buffer to encode.
Spacing character to place between encoded bytes.
String of encoded bytes.
Handles conversion of byte buffers to and from a decimal data format.
Decodes given string back into a byte buffer.
Encoded decimal data string to decode.
Original spacing character that was inserted between encoded bytes.
Decoded bytes.
Encodes given buffer into a user presentable representation.
Bytes to encode.
Offset into buffer to begin encoding.
Length of buffer to encode.
Spacing character to place between encoded bytes.
String of encoded bytes.
Handles conversion of byte buffers to and from a binary (i.e., 0 and 1's) data format.
Decodes given string back into a byte buffer.
Encoded binary data string to decode.
Original spacing character that was inserted between encoded bytes.
Decoded bytes.
Encodes given buffer into a user presentable representation.
Bytes to encode.
Offset into buffer to begin encoding.
Length of buffer to encode.
Spacing character to place between encoded bytes.
String of encoded bytes.
Handles conversion of byte buffers to and from a base64 data format.
Decodes given string back into a byte buffer.
Encoded binary data string to decode.
Original spacing character that was inserted between encoded bytes.
Decoded bytes.
Encodes given buffer into a user presentable representation.
Bytes to encode.
Offset into buffer to begin encoding.
Length of buffer to encode.
Spacing character to place between encoded bytes.
String of encoded bytes.
Handles conversion of byte buffers to and from a ASCII data format.
Decodes given string back into a byte buffer.
Encoded binary data string to decode.
Original spacing character that was inserted between encoded bytes.
Decoded bytes.
Encodes given buffer into a user presentable representation.
Bytes to encode.
Offset into buffer to begin encoding.
Length of buffer to encode.
Spacing character to place between encoded bytes.
String of encoded bytes.
Constant used to specify that "no spacing" should be used for data conversion.
Encodes given buffer into a user presentable representation.
Bytes to encode.
String representation of byte array.
Encodes given buffer into a user presentable representation.
Bytes to encode.
Spacing character to place between encoded bytes.
String of encoded bytes.
Encodes given buffer into a user presentable representation.
Bytes to encode.
Offset into buffer to begin encoding.
Length of buffer to encode.
String of encoded bytes.
Encodes given buffer into a user presentable representation.
Bytes to encode.
Offset into buffer to begin encoding.
Length of buffer to encode.
Spacing character to place between encoded bytes.
String of encoded bytes.
Decodes given string back into a byte buffer.
Encoded string to decode.
Decoded bytes.
Decodes given string back into a byte buffer.
Encoded string to decode.
Original spacing character that was inserted between encoded bytes.
Decoded bytes
Handles encoding and decoding of a byte buffer into a hexadecimal-based presentation format.
Handles encoding and decoding of a byte buffer into an integer-based presentation format.
Handles encoding and decoding of a byte buffer into a big-endian binary (i.e., 0 and 1's) based
presentation format.
Although endianness is typically used in the context of byte order to handle byte
order swapping), this property allows you visualize "bits" in big-endian order,
right-to-left. Note that bits are normally stored in the same order as their bytes.
Handles encoding and decoding of a byte buffer into a little-endian binary (i.e., 0 and 1's) based
presentation format.
Although endianness is typically used in the context of byte order to handle byte
order swapping), this property allows you visualize "bits" in little-endian order,
left-to-right. Note that bits are normally stored in the same order as their bytes.
Handles encoding and decoding of a byte buffer into a base64 presentation format.
Handles encoding and decoding of a byte buffer into an ASCII character presentation format.
Handles byte to string conversions for implementations that are available from Byte.ToString.
Encoded string to decode.
Offset into byte array to begin decoding string.
Number of bytes to decode starting at
Character to insert between each byte
String decoding format.
Decoded string
Represents a generic sliding memory cache for a specific type .
Type of value to cache.
Each type T should be unique unless cache can be safely shared.
Keeps a cache entry alive by resetting its expiration time.
Name to use as cache key -- this should be unique per .
true if value was found in cache; otherwise, false.
Try to get a value from the memory cache.
Name to use as cache key -- this should be unique per .
Value from cache if already cached; otherwise, default value for .
true if value was found in cache; otherwise, false.
Gets or adds a value, based on result of , to the memory cache. Cache defaults to a 1-minute expiration.
Name to use as cache key -- this should be unique per .
Function to generate value to add to cache -- only called if value is not already cached.
Optional function to call when cache entry is removed.
Value from cache if already cached; otherwise, new value generated by .
Gets or adds a value, based on result of , to the memory cache.
Name to use as cache key -- this should be unique per .
Expiration time, in minutes, for cached value.
Function to generate value to add to cache -- only called if value is not already cached.
Optional function to call when cache entry is removed.
Value from cache if already cached; otherwise, new value generated by .
Removes a value from the memory cache.
Specific named memory cache instance to remove from cache.
Defines extension functions related to character manipulation.
Encodes the specified Unicode character in proper Regular Expression format.
Unicode character to encode in Regular Expression format.
Specified Unicode character in proper Regular Expression format.
Tests a character to determine if it marks the end of a typical English word.
Input character to check.
true if character is a work separator.
Performs no testing for ASCII codes > 127.
Does not separate words based on punctuation of ' % - _
However does include the angle bracket symbols < > as separators
For reference the standard char tests are:
- "IsSperator (1) == simple space (32 or 160) only.
- IsPunctuation (23) == . , ! ? : ; " ' [ ] { } ( ) \ / @ % # * & - _ (plus other char's > 127)
- IsSymbol (8) == $ + < > = ^ ` ~
- IsWhiteSpace (6) == control char's 9 thru 13, plus 32 -- TAB, LF, VT, FF, CR, SP
Tests a character to determine if is a common part of a numeric string (digits or one of "+ - , .")
The character to check.
true if numeric character.
Determines if a character matches any character in a sent array.
The character to check.
The array of characters to test.
Boolean value indicating a that the character is in the array.
Tests a character to determine if it is between a specified character range
Input character to process.
Beginning of range character.
End of range character.
true is the character is within the range.
Converts to lower case.
to convert to lower case.
converted to lower case.
Converts to upper case.
to convert to upper case.
converted to upper case.
Returns true if char is hexadecimal digit.
The character to be tested.
true if char is hexadecimal digit; false otherwise
Contains extension methods for values.
Defines extension functions related to manipulation of arrays and collections.
Gets a row of data out of a 2-dimensional array.
Type of array.
Source array.
Row index, i.e., dimension zero value, to retrieve.
Values from specified .
Gets a column of data out of a 2-dimensional array.
Type of array.
Source array.
Column index, i.e., dimension one value, to retrieve.
Values from specified .
Gets a to paginate enumeration for
a given and specified .
Type of to paginate.
Source enumeration to paginate.
Page number (1-based).
Page size.
Total records in source if known.
Set of items on a given for specified .
If count is known or can be calculated early, specify the value in the
parameter as an optimization to prevent a full
enumeration on to get a count.
Merges elements of multiple dictionaries into a single dictionary with no duplicate key values overwritten.
Type of to merge.
Type of keys.
Type of values.
Source dictionary to merge with another dictionary.
Other dictionaries to merge with source dictionary.
A merged collection of all unique dictionary elements, all merged left to the source with no duplicate
key values overwritten (i.e., first encountered key value pair is the one that remains in the returned merged dictionary).
Merges elements of multiple dictionaries into a single dictionary.
Type of to merge.
Type of keys.
Type of values.
Source dictionary to merge with another dictionary.
Set to true to overwrite duplicate key values as they are encountered.
Other dictionaries to merge with source dictionary.
A merged collection of all unique dictionary elements, all merged left to the source.
Attempts to get the value for the given key and returns the default value instead if the key does not exist in the .
The type of the keys in the dictionary.
The type of the values in the dictionary.
The dictionary to check for the given key.
The key to be checked for the existence of a value.
The value of the key in the dictionary or the default value if no such value exists.
Attempts to get the value for the given key and returns the default value instead if the key does not exist in the .
The type of the keys in the dictionary.
The type of the values in the dictionary.
The dictionary to check for the given key.
The key to be checked for the existence of a value.
The function used to generate the default value if no value exists for the given key.
The value of the key in the dictionary or the default value if no such value exists.
Adds a key/value pair to the if the key does not already exist.
The type of the keys in the dictionary.
The type of the values in the dictionary.
The dictionary to add the key/value pair to if the key does not already exist.
The key to be added to the dictionary if it does not already exist.
The function used to generate a value for the key.
The value of the key in the dictionary.
Adds a key/value pair to the if the key does not already exist.
The type of the keys in the dictionary.
The type of the values in the dictionary.
The dictionary to add the key/value pair to if the key does not already exist.
The key to be added to the dictionary if it does not already exist.
The value to assign to the key if the key does not already exist.
The value of the key in the dictionary.
Adds a key/value pair to the if the key does not already exist,
or updates a key/value pair in the if the key already exists.
The type of the keys in the dictionary.
The type of the values in the dictionary.
The dictionary to add the key/value pair to if the key does not already exist.
The key to be added or whose value should be updated
The function used to generate a value for an absent key
The function used to generate a new value for an existing key based on the key's existing value
The new value for the key. This will be either be the result of addValueFactory (if the key was absent) or the result of updateValueFactory (if the key was present).
Adds a key/value pair to the if the key does not already exist,
or updates a key/value pair in the if the key already exists.
The type of the keys in the dictionary.
The type of the values in the dictionary.
The dictionary to add the key/value pair to if the key does not already exist.
The key to be added or whose value should be updated
The value to be added for an absent key
The function used to generate a new value for an existing key based on the key's existing value
The new value for the key. This will be either be the result of addValueFactory (if the key was absent) or the result of updateValueFactory (if the key was present).
Adds a key/value pair to the if the key does not already exist,
or updates a key/value pair in the if the key already exists.
The type of the keys in the dictionary.
The type of the values in the dictionary.
The dictionary to add the key/value pair to if the key does not already exist.
The key to be added or updated.
The function used to generate a value for the key.
The value of the key in the dictionary after updating.
Adds a key/value pair to the if the key does not already exist,
or updates a key/value pair in the if the key already exists.
The type of the keys in the dictionary.
The type of the values in the dictionary.
The dictionary to add the key/value pair to if the key does not already exist.
The key to be added or updated.
The value to be assigned to the key.
The value of the key in the dictionary after updating.
Converts a name/value collection to a dictionary.
Name/value collection.
Dictionary converted from a name/value collection.
Returns true if any item in is equal to .
Source .
value to test for.
true if any item in is equal to .
Returns true if all items in are equal to .
Source .
value to test for.
true if all items in are equal to .
Determines whether all elements of a sequence satisfy a condition with each item being tested in parallel.
An that contains the elements to apply the predicate to.
A function to test each element for a condition.
Any to apply.
true if every element of the source sequence passes the test in the specified predicate, or if the sequence is empty; otherwise, false.
The type of the elements of .
or is null.
Gets the median item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths.
If enumeration length is even, two items will be returned representing the items in the middle of the set;
otherwise, if the enumeration length is odd, one item will be returned from exactly the middle of the set.
of elements in the
An enumeration over which to find the median element(s).
The median item(s) from an enumeration, or null if is null.
Gets the middle item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths.
If enumeration length is even, two items will be returned representing the items in the middle of the set;
otherwise, if the enumeration length is odd, one item will be returned from exactly the middle of the set.
of elements in the
An enumeration over which to find the middle element(s).
The middle item(s) from an enumeration, or null if is null.
Returns the majority value in the collection, or default type value if no item represents the majority.
of elements in the .
The generic of the objects to be compared.
An enumeration over which to find the majority element.
A delegate that takes an object and produces the key for comparison.
true to search forward in ; otherwise false to search backwards.
The implementation to use when comparing keys, or null to use the default comparer for the type of the key.
The majority value in the collection.
Returns the majority value in the collection, or if no item represents the majority.
of elements in the .
The generic of the objects to be compared.
An enumeration over which to find the majority element.
Default value to return if no item represents the majority.
A delegate that takes an object and produces the key for comparison.
true to search forward in ; otherwise false to search backwards.
The implementation to use when comparing keys, or null to use the default comparer for the type of the key.
The majority value in the collection.
Returns the majority value in the collection, or default type value if no item represents the majority.
of elements in the .
An enumeration over which to find the majority element.
true to search forward in ; otherwise false to search backwards.
The implementation to use when comparing keys, or null to use the default comparer for the type of the key.
The majority value in the collection.
Returns the majority value in the collection, or if no item represents the majority.
of elements in the .
An enumeration over which to find the majority element.
Default value to return if no item represents the majority.
true to search forward in ; otherwise false to search backwards.
The implementation to use when comparing keys, or null to use the default comparer for the type of the key.
The majority value in the collection.
Returns the minority value in the collection, or default type value if no item represents the majority.
of elements in the .
The generic of the objects to be compared.
An enumeration over which to find the majority element.
A delegate that takes an object and produces the key for comparison.
true to search forward in ; otherwise false to search backwards.
The implementation to use when comparing keys, or null to use the default comparer for the type of the key.
The minority value in the collection.
Returns the minority value in the collection, or if no item represents the majority.
of elements in the .
of the objects to be compared.
An enumeration over which to find the majority element.
Default value to return if no item represents the majority.
A delegate that takes an object and produces the key for comparison.
true to search forward in ; otherwise false to search backwards.
The implementation to use when comparing keys, or null to use the default comparer for the type of the key.
The majority value in the collection.
Returns the minority value in the collection, or default type value if no item represents the minority.
of elements in the .
An enumeration over which to find the minority element.
true to search forward in ; otherwise false to search backwards.
The implementation to use when comparing keys, or null to use the default comparer for the type of the key.
The minority value in the collection.
Returns the minority value in the collection, or if no item represents the minority.
of elements in the .
An enumeration over which to find the minority element.
Default value to return if no item represents the minority.
true to search forward in ; otherwise false to search backwards.
The implementation to use when comparing keys, or null to use the default comparer for the type of the key.
The minority value in the collection.
Adds the specified to the .
of elements in the .
The collection to which the are to be added.
The elements to be added to the .
Updates starting at the with the specified .
of elements in the .
The collection whose elements are to be updated with the specified .
The zero-based index in the at which elements are to be updated.
The elements that will replace the elements starting at the .
The specified is present in the .
Returns elements in the specified range from the .
of elements in the .
The collection from which elements are to be retrieved.
The 0-based index position in the from which elements are to be retrieved.
The number of elements to be retrieved from the starting at the .
An object.
Returns the index of the first element of the sequence that satisfies a condition or -1 if no such element is found.
A to find an index in.
A function to test each element for a condition.
Index of the first element in that matches the specified ; otherwise, -1.
of elements of .
Returns a copy of the .
of the to be copied.
The source whose elements are to be copied.
The source array index from where the elements are to be copied.
The number of elements to be copied starting from the startIndex.
An of elements copied from the specified portion of the source .
Returned will be extended as needed to make it the specified , but
it will never be less than the source length - .
is outside the range of valid indexes for the source -or-
is less than 0.
Returns the smallest item from the enumeration.
of .
An enumeration that is compared against.
A delegate that takes two generic types to compare, and returns an integer based on the comparison.
Returns a generic type.
Returns the smallest item from the enumeration.
of .
An enumeration that is compared against.
A comparer object.
Returns a generic type.
Returns the largest item from the enumeration.
of .
An enumeration that is compared against.
A delegate that takes two generic types to compare, and returns an integer based on the comparison.
Returns a generic type.
Returns the largest item from the enumeration.
of .
An enumeration that is compared against.
A comparer object.
Returns a generic type.
Returns only the elements whose keys are distinct.
The type of the source objects in the collection.
The type of the keys to be compared.
The collection of source objects.
The function used to access the keys of the source objects.
true to search forward in ; otherwise false to search backwards.
The elements from whose keys are distinct.
Converts an enumeration to a string, using the default delimiter ("|") that can later be
converted back to a list using LoadDelimitedString.
of .
The source object to be converted into a delimited string.
Returns a that is result of combining all elements in the list delimited by the '|' character.
Converts an enumeration to a string that can later be converted back to a list using
LoadDelimitedString.
of .
The source object to be converted into a delimited string.
The delimiting character used.
Returns a that is result of combining all elements in the list delimited by .
Converts an enumeration to a string that can later be converted back to a list using
LoadDelimitedString.
of .
The source object to be converted into a delimited string.
The delimiting used.
Returns a that is result of combining all elements in the list delimited by .
Converts an enumeration to a string that can later be converted back to a list using
LoadDelimitedString.
of .
of .
The source object to be converted into a delimited string.
The delimiter of type TDelimiter used.
Returns a that is result of combining all elements in the list delimited by .
Appends items parsed from delimited string, created with ToDelimitedString, using the default
delimiter ("|") into the given list.
Items that are converted are added to list. The list is not cleared in advance.
of .
The list we are adding items to.
The delimited string to parse for items.
Delegate that takes one parameter and converts from string to type TSource.
Appends items parsed from delimited string, created with ToDelimitedString, into the given list.
Items that are converted are added to list. The list is not cleared in advance.
of .
The list we are adding items to.
The delimited string to parse for items.
The value to look for in the as the delimiter.
Delegate that takes one parameter and converts from string to type TSource.
Appends items parsed from delimited string, created with ToDelimitedString, into the given list.
Items that are converted are added to list. The list is not cleared in advance.
of .
The list we are adding items to.
The delimited string to parse for items.
An array of delimiters to look for in the as the delimiter.
Delegate that takes a and converts to type TSource.
Iterates through each item in the list. Allowing items to be removed from the list.
of .
the list to iterate though
the function to call to determine
if the items should be removed from the list.
The number of items removed from the list.
In order to minimize the overhead of a removal. Any item removed with be replaced with
the last item in the list. Sequence will not be preserved using this method.
Rearranges all the elements in the list into a highly-random order.
of .
The input list of generic types to scramble.
This function uses a cryptographically strong random number generator to perform the scramble.
Rearranges all the elements in the list into a repeatable pseudo-random order.
of .
The input list of generic types to scramble.
A number used to calculate a starting value for the pseudo-random number sequence.
This function uses the generator to perform the scramble using a sequence that is repeatable.
Rearranges all the elements in the list previously scrambled with back into their original order.
of .
The input list of generic types to unscramble.
The same number used in call to scramble original list.
This function uses the generator to perform unscramble using a sequence that is repeatable.
Compares two arrays.
The first type array to compare to.
The second type array to compare against.
true if order of elements should be considered for equality; otherwise, false.
An which returns 0 if they are equal, 1 if is larger, or -1 if is larger.
of the array.
Cannot compare multidimensional arrays.
Compares two arrays.
The first to compare to.
The second to compare against.
An interface that exposes a method to compare the two arrays.
true if order of elements should be considered for equality; otherwise, false.
An which returns 0 if they are equal, 1 if is larger, or -1 if is larger.
This is a default comparer to make arrays comparable.
Cannot compare multidimensional arrays.
Contains extension methods for collections.
Defines extension functions related to manipulation of implementations.
Sets the to be passed to when
iterating and configures how awaits on the tasks returned from an async iteration will be performed, defaults to not capturing.
The type of the objects being iterated.
The source enumerable being iterated.
The to use.
Whether to capture and marshal back to the current context.
The configured enumerable.
The extension method sets to
true, this extension method allows the to be set false, the default value for
this extension method.
Contains extension methods for implementations.
A self growing array of items. This class is thread safe.
Creates an .
Creates an .
Gets/Sets the items in this array. Returns the default(t) if the item does not exist,
or default(t) is the item in the list.
the index position to lookup
Sets all items to their default value
Defines an interface for instances that is usable
regardless of any specified type.
Gets total count of elements in enumeration.
Gets calculated page count based on page size and total items count.
Gets current page number.
Gets current page size.
A faster and functionally equivalent implementation of
The type of the element in the collection
is based upon an . This means any simple call
to the class is a function call that cannot be in-lined. This implementation forces the underlying
item to be and shadows many of the methods to call
instead of .
Since this class references the same underlying object, it can be
successfully implemented as a or casted it its underlying type
.
Profiling this class yield a ForEach loop and For loop that executes between
2-4 times faster than . This depends on the number of items in the
list. The fewer the faster. Other operations such as Add/Insert/Remove are closer to 50% faster.
Count is now in-lined (~20 times faster).
This performance is negated if accessing this class via the IList interface. When possible, use
only strongly typed names.
Creates a
a list to wrap this class around.
Creates a
Gets the number of elements contained in the .
The number of elements contained in the .
Gets or sets the element at the specified index.
The element at the specified index.
The zero-based index of the element to get or set.
is not a valid index in the .
The property is set and the is read-only.
Gets a wrapper around the .
A wrapper around the .
Adds an item to the .
The object to add to the .
The is read-only.
Removes all items from the .
The is read-only.
Removes all elements from the .
Determines whether the contains a specific value.
true if is found in the ; otherwise, false.
The object to locate in the .
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from .
The must have zero-based indexing.The zero-based index in at which copying begins.
is null.
is less than 0.
The number of elements in the source is greater than the available space from to the end of the destination .
Returns an enumerator that iterates through the .
An for the .
Determines the index of a specific item in the .
The index of if found in the list; otherwise, -1.
The object to locate in the .
Inserts an item to the at the specified index.
The zero-based index at which should be inserted.
The object to insert into the .
is not a valid index in the .
The is read-only.
Inserts an element into the at the specified index.
The zero-based index at which should be inserted.
The object to insert. The value can be null for reference types.
is less than zero.-or- is greater than .
Removes the first occurrence of a specific object from the .
true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original .
The object to remove from the .
The is read-only.
Removes the element at the specified index of the .
The zero-based index of the element to remove.
is less than zero.-or- is equal to or greater than .
Removes the element at the specified index of the .
The zero-based index of the element to remove.
is less than zero.-or- is equal to or greater than .
Replaces the element at the specified index.
The zero-based index of the element to replace.
The new value for the element at the specified index. The value can be null for reference types.
is less than zero.-or- is greater than .
Contains classes related to collection operations.
Defines a paged list for an enumeration.
Type of to paginate.
This class returns the elements for the specified page number for a given page size and
also provides the calculated page count based on input parameters.
Creates a new .
Source enumeration to paginate.
Page number (1-based).
Page size.
Total records in source if known.
If count is known or can be calculated early, specify the value in the
parameter as an optimization to prevent a full
enumeration on to get a count.
Gets total count of elements in enumeration.
Gets calculated page count based on page size and total items count.
Gets current page number.
Gets current page size.
Defines common global functions.
Determines if the current system is a POSIX style environment.
Since a .NET application compiled under Mono can run under both Windows and Unix style platforms,
you can use this property to easily determine the current operating environment.
This property will return true for both MacOSX and Unix environments. Use the Platform property
of the to determine more specific platform type, e.g.,
MacOSX or Unix.
Gets the name of the current application.
Converts to a using an appropriate .
Value to convert to a .
converted to a .
If fails, the value's ToString() value will be returned.
Returned value will never be null, if no value exists an empty string ("") will be returned.
You can use the string extension
method or to convert the string back to its
original .
Converts to a using an appropriate .
Value to convert to a .
to use for the conversion.
Set to true to throw exception if conversion fails; otherwise, false to fall back on .ToString().
converted to a .
If fails, the value's ToString() value will be returned.
Returned value will never be null, if no value exists an empty string ("") will be returned.
You can use the string
extension method or to convert
the string back to its original .
Converts this string into the specified type.
Source string to convert to type.
to convert string to.
converted to specified ; default value of
specified type if conversion fails.
This function makes use of a to convert
to the specified , the best way to make sure
can be converted back to its original type is to use the same to
convert the original object to a ; see the
method for an easy way to do this.
This function varies from in that it
will use the default value for the parameter if
is empty or null.
Converts this string into the specified type.
Source string to convert to type.
to convert string to.
to use for the conversion.
Set to true to suppress conversion exceptions and return null; otherwise, false
converted to specified ; default value of
specified type if conversion fails.
This function makes use of a to convert
to the specified , the best way to make sure
can be converted back to its original type is to use the same to
convert the original object to a ; see the
method for an easy way to do this.
This function varies from
in that it will use the default value for the parameter if
is empty or null.
Determines if given item is equal to its default value (e.g., null or 0.0).
Object to evaluate.
Result of evaluation as a .
Native types default to zero, not null, therefore this can be used to evaluate if an item is its default (i.e., uninitialized) value.
Determines if given item is a reference type.
Object to evaluate.
Result of evaluation as a .
Determines if given item is a reference type but not a string.
Object to evaluate.
Result of evaluation as a .
Determines if is a numeric type, i.e., one of:
, , ,
, , ,
, ,
, or .
value to check.
true if is a numeric type; otherwise, false.
Determines if is a numeric type, i.e., has a that is one of:
, , ,
, , ,
, ,
, or .
to check.
true if is a numeric type; otherwise, false.
Determines if is a numeric type, i.e., has a that is one of:
, , ,
, , ,
, ,
, or .
to check.
true if is a numeric type; otherwise, false.
Determines if of is a numeric type, i.e.,
is and has a that is one of:
, , ,
, , ,
, ,
, or .
Object to evaluate.
true if is a numeric type; otherwise, false.
Determines if given is or can be interpreted as numeric.
Object to evaluate.
true if is or can be interpreted as numeric; otherwise, false.
If type of is a or a , then if value can be parsed as a numeric
value, result will be true.
Returns the smallest item from a list of parameters.
Return type that is the minimum value in the .
A variable number of parameters of the specified type.
Result is the minimum value of type in the .
Returns the largest item from a list of parameters.
Return type that is the maximum value in the .
A variable number of parameters of the specified type .
Result is the maximum value of type in the .
Returns the value that is neither the largest nor the smallest.
of the objects passed to and returned from this method.
Value 1.
Value 2.
Value 3.
Result is the value that is neither the largest nor the smallest.
Gets the operating system
The operating system .
This function will properly detect the platform ID, even if running on Mac.
ReSharper disable once InconsistentNaming
Gets the operating system product name.
Operating system product name.
Gets the total physical system memory.
Total physical system memory in bytes.
Gets the available physical system memory.
Available physical system memory in bytes.
Represents a for validating Acronyms, i.e., expressions
that consist only of upper case letters, numbers, '!', '-', '@', '#', '_' , '.' or '$'.
Defines the regular expression pattern used to validate value.
Defines the default error message used when pattern fails validation.
Creates a new .
Represents a for validating e-mail addresses.
Defines the regular expression pattern used to validate value.
Defines the default error message used when pattern fails validation.
Creates a new .
Defines an attribute that will define an initial value script for a modeled table field
that will get evaluated and assigned in the target use environment, e.g., Javascript.
Example to set initial value to 30 days from now using a Javascript expression:
[InitialValueScript("(new Date()).addDays(30)")]
Note that the should be used to set any constant values
for new modeled record instances and the gemstone.expressions.model.DefaultValueExpressionAttribute should
be used for applying any needed server-side run-time expression defaults, either of these will
get assigned when using the gemstone.data.model.TableOperations<T>.NewRecord function.
The is used to initialize the property value using
an expression that gets evaluated in the target environment.
Gets the initial value expression for a modeled table field.
Expression should be in target language, e.g., Javascript.
Creates a new /
Initial value expression for a modeled table field.
Defines an attribute that will define the field name that represents a record marked for deletion.
Field name used as is-deleted record marker.
Creates a new .
Field name used as is-deleted record marker.
Defines an attribute that will define a UI label.
Gets UI label for modeled table field.
Creates a new .
UI label for modeled table field.
Contains classes and attributes used for component modeling used with data annotations.
Represents metadata for a method parameter, including its name, a UI label, and an optional description.
Name of the method parameter this metadata applies to.
Label to show in the UI.
Optional description.
Defines an attribute that will define the field name that best represents the row identification to a user.
An example of when this would be used is during a record deletion confirmation, e.g:
Are you sure you want to delete "PrimaryLabel.FieldName.Value"?
Field name used as primary label.
Creates a new .
Field name used as primary label.
Specifies that a property should render a toggle switch in the UI that allows the user to disable and/or reset the properties value.
Specifies that a property should render a toggle switch in the UI that allows the user to disable and/or reset the properties value.
Gets the label to display on the toggle switch.
Gets the boolean value of the toggle that triggers the hide/reset behavior.
Represents a for validating URL's.
Defines the regular expression pattern used to validate value.
Defines the default error message used when pattern fails validation.
Creates a new .
Defines whether to use an alternate UI for the associated property or field.
Defines whether to use an alternate UI for the associated property or field.
Flag that determines whether to use the alternate UI for the associated property or field.
Defines extensions for managing app settings.
Adds an for app settings to the given .
The configuration builder.
The action to build app settings.
The configuration builder.
This extension provides a simple way to add default values as well as descriptions for app settings
directly into an application. The source for these is a simple in-memory collection, and additional
key/value pairs are added so that the initial value and descriptions of these settings can still be
retrieved even if the settings themselves get overridden by another configuration source.
Gets the initial value of the app setting with the given name.
The configuration that contains the app setting.
The name of the app setting.
The initial value of the app setting.
Gets the description of the app setting with the given name.
The configuration that contains the app setting.
The name of the app setting.
The initial value of the app setting.
Gets the initial value of the given app setting.
The app setting.
The initial value of the app setting.
Gets the description of the given app setting.
The app setting.
The description of the app setting.
Builder for app settings with descriptions.
Adds an app setting to the builder.
The name of the setting.
The value of the setting.
A description of the setting.
The app settings builder.
is a duplicate of a previously added app setting
Converts the app settings into a collection of key/value pairs.
The collection of key/value pairs.
The namespace contains extension functions related
to the definition of default app settings for Gemstone projects.
Defines as interface that specifies that this object can define settings for a config file.
Establishes default settings for the config file.
Settings instance used to hold configuration.
The config file settings category under which the settings are defined.
Defines the options for generating INI files.
Generate all settings with their values commented.
Generate all settings with their values uncommented.
Generate all settings with their values uncommented, but only if the value is different from the default.
Defines extensions for setting up configuration defaults for Gemstone projects.
Generates the contents of an INI file based on the configuration settings.
Source configuration.
Setting for how to generate values in the INI file.
Flag that determines whether long description lines should be split into multiple lines.
Generated INI file contents.
Contains helper and extension methods for INI configuration files.
Defines helper functions for working with INI configuration files.
Gets file path for INI configuration file.
Target file INI file name.
Any configured path for the INI file.
INI file path.
Gets an INI file writer for the specified path.
Path for INI file.
INI file write at specified path.
Gets an INI file reader for the specified path.
Path for INI file.
INI file reader at specified path.
Defines as interface that specifies that this object can persist settings to a config file.
Determines whether the object settings are to be persisted to the config file.
Gets or sets the category name under which the object settings are persisted in the config file.
Saves settings to the config file.
Loads saved settings from the config file.
The namespace contains a wrapper for
to prevent calls to
from
reaching the underlying .
Defines extensions for adding read-only configuration providers.
Configures an with read-only configuration sources.
The configuration builder.
The action to set up configuration sources that will be made read-only.
The configuration builder.
This method is intended to encapsulate the builder action that creates a group of read-only providers.
IConfiguration configuration = new ConfigurationBuilder()
.ConfigureReadOnly(readOnlyBuilder => readOnlyBuilder
.AddInMemoryCollection(defaultSettings)
.AddIniFile("usersettings.ini"))
.AddSQLite()
.Build();
// This will only update the SQLite configuration provider
configuration["Hello"] = "World";
Converts the most recently added configuration source into a read-only configuration source.
The configuration builder.
The configuration builder.
This method is intended to be chained after each source that needs to be made read-only.
IConfiguration configuration = new ConfigurationBuilder()
.AddInMemoryCollection(defaultSettings).AsReadOnly()
.AddIniFile("usersettings.ini").AsReadOnly()
.AddSQLite()
.Build();
// This will only update the SQLite configuration provider
configuration["Hello"] = "World";
Wrapper for to block calls
to .
Creates a new instance of the class.
Returns the immediate descendant configuration keys for a given parent path based
on this s data and the set of keys returned by
all the preceding s.
The child keys returned by the preceding providers for the same parent path.
The parent path.
The child keys.
Returns a change token if this provider supports change tracking, null otherwise.
The change token.
Loads configuration values from the source represented by this .
Sets a configuration value for the specified key.
The key.
The value.
Tries to get a configuration value for the specified key.
The key.
The value.
True if a value for the specified key was found, otherwise false.
Wrapper for to block calls
to .
Configuration providers are typically designed to load configuration into an in-memory
dictionary from their configuration source. Subsequently, the in-memory dictionary can be
modified programmatically via the indexer.
This class blocks calls to
on the underlying configuration source's provider so that static defaults won't be
modified when updating configuration.
Creates a new instance of the class.
The source to be made read-only.
Builds the for this source.
The configuration builder
The read-only configuration provider.
Defines the operation mode for configuration settings.
Configuration settings are disabled.
Configuration settings are read-only.
Configuration settings are read-write.
Defines system settings for an application.
Configuration settings are loaded from common sources for a Gemstone project. The properties
, , and
control the configuration sources that are available and how they are managed. Handling of
available settings are defined in a hierarchy where the settings are loaded are in the
following priority order, from lowest to highest:
- INI file (defaults.ini) - Machine Level, %programdata% folder
- INI file (settings.ini) - Machine Level, %programdata% folder
- SQLite database (settings.db) - User Level, %appdata% folder
- Environment variables - Machine Level
- Environment variables - User Level
Command line arguments can also be added to the hierarchy to override settings.
For example:
Settings settings = new()
{
INIFile = ConfigurationOperation.ReadWrite,
SQLite = ConfigurationOperation.Disabled
};
// Bind settings to configuration sources
settings.Bind(new ConfigurationBuilder()
.ConfigureGemstoneDefaults(settings)
.AddCommandLine(args, settings.SwitchMappings));
See the property for defining command line switches.
Defines the configuration section name for system settings.
Creates a new instance.
Gets the source for settings.
Gets or sets configuration operation mode for INI file settings.
Gets or sets any configured INI path. Set to null for default %ProgramData% path.
Gets or sets configuration operation mode for SQLite settings.
Gets or sets configuration operation mode for environmental variables.
Environmental variables cannot be used for read-write configuration operations.
Gets or sets the option for how to generate values in the INI file when saving settings.
Gets or sets flag that determines if description lines, e.g., those encoded into an INI file,
should be split into multiple lines.
Gets the names for the settings sections.
Gets the sections count for the settings.
Gets the command line switch mappings for .
Gets the for the specified key.
Section key.
Gets flag that determines if any settings have been changed.
Attempts to bind the instance to configuration values by matching property
names against configuration keys recursively.
Configuration builder used to bind settings.
Configures the for .
Builder used to configure settings.
Saves any changed settings.
Determines if save operation should wait for completion.
Determines if save operation should be forced, i.e., whether settings are dirty or not.
Saves any changed settings.
Settings instance.
Determines if save operation should be forced, i.e., whether settings are dirty or not.
This method will not return until the save operation has completed.
Gets the default instance of .
Gets the default instance of as a dynamic object.
Default instance of as a dynamic object.
Settings have not been initialized.
Updates the default instance of .
New default instance of .
This changes the default singleton instance of to the specified instance.
Use this method with caution as it can lead to unexpected behavior if the default instance is changed.
Pattern:
;?\\s*(?<key>\\w+)\\s*=.*
Options:
RegexOptions.Compiled
Explanation:
â—‹ Match ';' atomically, optionally.
â—‹ Match a whitespace character atomically any number of times.
â—‹ "key" capture group.
â—‹ Match a word character atomically at least once.
â—‹ Match a whitespace character atomically any number of times.
â—‹ Match '='.
â—‹ Match a character other than '\n' atomically any number of times.
Defines a dynamic section with typed values.
Gets the name of the settings section.
Gets the keys for the settings section.
Gets flag that determines if the settings section has been modified.
Gets the typed value for the specified key.
Setting key name.
Defines a setting for the section.
Key name of setting to get, case-insensitive.
Default value if key does not exist.
Description of the setting.
Optional array of switch mappings for the setting.
Gets the value of the setting with the specified key, if it exists;
otherwise, the default value for the parameter.
Key name of setting to get, case-insensitive.
Default value if key does not exist.
Description of the setting.
Optional array of switch mappings for the setting.
Value of the setting with the specified key, if it exists; otherwise,
the default value for the parameter.
Gets the parsed type and value of a configuration setting value.
Configuration setting value that can be prefixed with a type.
Tuple containing the parsed type and, value.
Failed to load specified type.
Type name is parsed from the beginning of the setting value, if it exists, and is enclosed in brackets,
e.g.: [int]:123 or [System.Int32]:123. If no type name is specified, the assumed default
type will always be .
Common C# names like long and DateTime can be used as type names as well as custom type names.
Custom type names require the full type name with a namespace, e.g.: [MyNamespace.MyType]:TypeValue.
Type name lookups are not case-sensitive.
Failed to load type.
Converts a value to a typed string representation.
Value to convert to a typed representation.
String formatted as a type-prefixed value, e.g.: [int]:123.
Pattern:
,\\s*Version\\s*=\\s*[^,]+,\\s*Culture\\s*=\\s*[^,]+,\\s*PublicKeyToken\\s*=\\s*[^,\\]]+
Options:
RegexOptions.IgnoreCase | RegexOptions.Compiled
Explanation:
â—‹ Match ','.
â—‹ Match a whitespace character atomically any number of times.
â—‹ Match a character in the set [Vv].
â—‹ Match a character in the set [Ee].
â—‹ Match a character in the set [Rr].
â—‹ Match a character in the set [Ss].
â—‹ Match a character in the set [Ii].
â—‹ Match a character in the set [Oo].
â—‹ Match a character in the set [Nn].
â—‹ Match a whitespace character atomically any number of times.
â—‹ Match '='.
â—‹ Match a whitespace character greedily any number of times.
â—‹ Match a character other than ',' atomically at least once.
â—‹ Match ','.
â—‹ Match a whitespace character atomically any number of times.
â—‹ Match a character in the set [Cc].
â—‹ Match a character in the set [Uu].
â—‹ Match a character in the set [Ll].
â—‹ Match a character in the set [Tt].
â—‹ Match a character in the set [Uu].
â—‹ Match a character in the set [Rr].
â—‹ Match a character in the set [Ee].
â—‹ Match a whitespace character atomically any number of times.
â—‹ Match '='.
â—‹ Match a whitespace character greedily any number of times.
â—‹ Match a character other than ',' atomically at least once.
â—‹ Match ','.
â—‹ Match a whitespace character atomically any number of times.
â—‹ Match a character in the set [Pp].
â—‹ Match a character in the set [Uu].
â—‹ Match a character in the set [Bb].
â—‹ Match a character in the set [Ll].
â—‹ Match a character in the set [Ii].
â—‹ Match a character in the set [Cc].
â—‹ Match a character in the set [Kk\u212A].
â—‹ Match a character in the set [Ee].
â—‹ Match a character in the set [Yy].
â—‹ Match a character in the set [Tt].
â—‹ Match a character in the set [Oo].
â—‹ Match a character in the set [Kk\u212A].
â—‹ Match a character in the set [Ee].
â—‹ Match a character in the set [Nn].
â—‹ Match a whitespace character atomically any number of times.
â—‹ Match '='.
â—‹ Match a whitespace character greedily any number of times.
â—‹ Match a character in the set [^,]] atomically at least once.
Represents an ordered set of arguments along with optional arguments parsed from a command-line.
This example shows how to parse a command-line command that does not contain an executable name:
using System;
using GSF;
using GSF.Console;
class Program
{
static void Main()
{
Arguments args = new Arguments("Sample.txt -wrap=true");
string file = args["OrderedArg1"];
bool wrapText = args["wrap"].ParseBoolean();
Console.WriteLine(string.Format("File: {0}", file));
Console.WriteLine(string.Format("Wrap text: {0}", wrapText));
Console.ReadLine();
}
}
This example shows how to parse a command-line command that contains an executable name in it:
using System;
using GSF.Console;
class Program
{
static void Main()
{
// Environment.CommandLine = @"""c:\program files\tva\theme application\app.exe"" Document1.dcx -theme=default"
Arguments args = new Arguments(Environment.CommandLine, true);
string doc = args["OrderedArg1"];
string theme = args["theme"];
Console.WriteLine(string.Format("Document: {0}", doc));
Console.WriteLine(string.Format("Application theme: {0}", theme));
Console.ReadLine();
}
}
Regular expression pattern for tokenizing a list of arguments.
Default value for .
Initializes a new instance of the class.
The command-line command to be parsed.
Initializes a new instance of the class.
The command-line command to be parsed.
true if the first argument in the command-line command is to be skipped from being processed; otherwise false.
Initializes a new instance of the class.
The command-line command to be parsed.
The prefix to be used in the identifier of ordered arguments.
Initializes a new instance of the class.
The command-line command to be parsed.
The prefix to be used in the identifier of ordered arguments.
true if the first argument in the command-line command is to be skipped from being processed; otherwise false.
Creates a new from serialization parameters.
The with populated with data.
The source for this deserialization.
Gets the value for the specified argument from the command-line command.
The argument whose value is to retrieved.
Value for the specified argument if found; otherwise null.
Gets the total number of arguments (ordered and optional) present in the command-line command.
Gets the prefix text in the identifier of ordered arguments present in the command-line command.
Gets the total number of ordered arguments in the command-line command.
Gets the ordered arguments as an array of strings.
Gets a boolean value that indicates whether the command-line command contains request for displaying help.
Gets the dictionary containing all of the arguments present in the command-line command.
Gets the value associated with the specified argument in the command-line command.
The argument whose value is to be retrieved.
Value associated with the specified argument if it exists in the command-line command, otherwise null.
true if argument existed and was returned; otherwise false.
Gets a boolean value that indicates whether the specified argument is present in the command-line command.
The argument to be checked.
true if the argument exists in the command-line command; otherwise false.
Gets a string representation of the object.
A string representation of the object.
Returns an for iterating through all the command-line command arguments.
An for the command-line command arguments.
Returns an for iterating through all the command-line command arguments.
An for the command-line command arguments.
Populates a with the data needed to serialize the target object.
The to populate with data.
The destination (see ) for this serialization.
The caller does not have the required permission.
This function can be used to parse a single parameterized string and turn it into an array of parameters.
String of parameters.
Array of parameters.
Provides an array of arguments parsed from the given command
using parsing rules similar to those used in POSIX environments.
The command to be parsed.
An array of arguments.
This function processes a set of command line arguments using a simple set of rules based on
those used in popular POSIX command shells. It is important to note that these rules do not apply
to instances of the class or the function.
The motivation for this function was to provide a more user-friendly set of rules by which to
specify command-line arguments. This is of course helpful for the user who has to type the
command-line arguments by hand, but it also ends up being useful for systems that have to
programmatically escape arguments to be consumed by other command-line applications (see
the function).
Also note that Windows has historically not provided a standard method for handling
command-line arguments and that some of the command-line tools in Windows have rolled their
own (potentially faulty) methods for doing so. More recently, Microsoft has provided the
function for .NET applications to retrieve their
own command line arguments using a standard format, but this function lacks the appropriate
supporting functions for programmatically handling arbitrary command strings within an
application. Furthermore, the rules for escaping spaces, quotes, and backslashes are very
inconsistent, making it difficult to write a robust method for escaping individual arguments,
let alone fully reproducing the same command parsing rules. For this reason, some programmers
may be interested in using this method in conjunction with
for parsing their own command line arguments.
Escapes a string so that it will be parsed as a
single argument by the method.
The argument to be escaped.
The escaped argument.
Defines methods related to command line operations
Creates a new instance.
File name to execute.
Command line parameters, if any. Set to empty string for none.
Releases the unmanaged resources before the object is reclaimed by .
Gets any standard output from process after execution.
Gets any standard error from process after execution.
Gets exit code assuming process
Releases all the resources used by the object.
Attempts to execute process.
Timeout, in milliseconds, to wait for command line operation to complete.
true if process completed; otherwise, false if process timed-out.
Executes a command line operation and returns its standard output and exit code or throws an exception with the standard error.
Command line file name to execute.
Command line arguments to use, if any.
Timeout, in milliseconds, to wait for command line operation to complete.
A containing the standard output received from command and the exit code.
Exception occurs when executed command process reports standard error output or process times-out.
Executes a command line operation and returns true if there was no standard error reported.
Command line file name to execute.
Command line arguments to use, if any.
Any standard output reported by the command line operation.
Any standard error reported by the command line operation.
Exit code of the process, assuming process successfully completed.
true if there was no standard error reported; otherwise, false.
This function waits indefinitely for the command line operation to complete.
Executes a command line operation and returns true if there was no standard error reported.
Command line file name to execute.
Command line arguments to use, if any.
Any standard output reported by the command line operation.
Any standard error reported by the command line operation.
Flag that determines if process completed or timed-out. This is only relevant if is not -1.
Exit code of the process, assuming process successfully completed.
Timeout, in milliseconds, to wait for command line operation to complete. Set to , i.e., -1, for infinite wait.
true if there was no standard error reported; otherwise, false.
Shell encodes a command line parameter by converting "\" to "\\".
Parameter to shell encode.
Shell encoded .
Decodes a command line parameter previously encoded by .
Parameter to decode.
Decoded .
Represents an exception that is thrown when reports standard error output.
Creates a new .
Creates a new with the specified parameters.
The error message that explains the reason for the exception.
Flag that determines if the source of command exception completed processing.
Exit code of command process, assuming process successfully completed.
The exception that is the cause of the current exception, or a null reference if no inner exception is specified.
Gets flag that determines if the source of this command exception completed processing.
Gets exit code from command process, assuming successful process completion.
Represents a response that is returned from with standard output and exit code.
Creates a new .
Standard output of command process.
Exit code of command process.
Gets standard output reported by command process.
Gets exit code from command process.
Contains classes used for parsing command line parameters and managing console applications.
Defines extension functions related to Date/Time manipulation.
Determines if the specified UTC time is valid, by comparing it to the system clock.
UTC time to test for validity.
The allowed lag time, in seconds, before assuming time is too old to be valid.
The allowed lead time, in seconds, before assuming time is too advanced to be
valid.
True, if time is within the specified range.
Time is considered valid if it exists within the specified lag time/lead time range of current
time.
Note that lag time and lead time must be greater than zero, but can be set to sub-second
intervals.
LagTime and LeadTime must be greater than zero, but can
be less than one.
Determines if the specified local time is valid, by comparing it to the system clock.
Time to test for validity.
The allowed lag time, in seconds, before assuming time is too old to be valid.
The allowed lead time, in seconds, before assuming time is too advanced to be
valid.
True, if time is within the specified range.
Time is considered valid if it exists within the specified lag time/lead time range of current
time.
Note that lag time and lead time must be greater than zero, but can be set to sub-second
intervals.
LagTime and LeadTime must be greater than zero, but can
be less than one.
Determines if time is valid, by comparing it to the specified current time.
Time to test for validity.
Specified current time (e.g., could be Date.Now or Date.UtcNow).
The allowed lag time, in seconds, before assuming time is too old to be valid.
The allowed lead time, in seconds, before assuming time is too advanced to be
valid.
True, if time is within the specified range.
Time is considered valid if it exists within the specified lag time/lead time range of current
time.
Note that lag time and lead time must be greater than zero, but can be set to sub-second
intervals.
LagTime and LeadTime must be greater than zero, but can
be less than one.
Gets the distance, in , beyond the top of the second.
Timestamp to evaluate.
Timestamp's tick distance from the top of the second.
Creates a baselined timestamp which begins at the specified time interval.
Timestamp to baseline.
to which should be baselined.
A new value that represents a baselined timestamp that begins at the
specified .
Baselining to the would return the
value starting at zero milliseconds.
Baselining to the would return the
value starting at zero seconds and milliseconds.
Baselining to the would return the
value starting at zero minutes, seconds and milliseconds.
Baselining to the would return the
value starting at zero hours, minutes, seconds and milliseconds.
Baselining to the would return the
value starting at day one, zero hours, minutes, seconds and milliseconds.
Baselining to the would return the
value starting at month one, day one, zero hours, minutes, seconds and milliseconds.
Converts given local time to Eastern time.
Timestamp in local time to be converted to Eastern time.
Timestamp in Eastern time.
Converts given local time to Central time.
Timestamp in local time to be converted to Central time.
Timestamp in Central time.
Converts given local time to Mountain time.
Timestamp in local time to be converted to Mountain time.
Timestamp in Mountain time.
Converts given local time to Pacific time.
Timestamp in local time to be converted to Pacific time.
Timestamp in Pacific time.
Converts given local time to Universally Coordinated Time (a.k.a., Greenwich Meridian Time).
This function is only provided for the sake of completeness. All it does is call the
"ToUniversalTime" property on the given timestamp.
Timestamp in local time to be converted to Universal time.
Timestamp in UniversalTime (a.k.a., GMT).
Converts given local time to time in specified time zone.
Timestamp in local time to be converted to time in specified time zone.
Standard name of desired end time zone for given
timestamp.
Timestamp in specified time zone.
Converts given local time to time in specified time zone.
Timestamp in local time to be converted to time in specified time zone.
Desired end time zone for given timestamp.
Timestamp in specified time zone.
Converts the specified Universally Coordinated Time timestamp to Eastern time timestamp.
The Universally Coordinated Time timestamp that is to be converted.
The timestamp in Eastern time.
Converts the specified Universally Coordinated Time timestamp to Central time timestamp.
The Universally Coordinated Time timestamp that is to be converted.
The timestamp in Central time.
Converts the specified Universally Coordinated Time timestamp to Mountain time timestamp.
The Universally Coordinated Time timestamp that is to be converted.
The timestamp in Mountain time.
Converts the specified Universally Coordinated Time timestamp to Pacific time timestamp.
The Universally Coordinated Time timestamp that is to be converted.
The timestamp in Pacific time.
Converts the specified Universally Coordinated Time timestamp to timestamp in specified time zone.
The Universally Coordinated Time timestamp that is to be converted.
The time zone standard name to which the Universally
Coordinated Time timestamp is to be converted to.
The timestamp in the specified time zone.
Converts the specified Universally Coordinated Time timestamp to timestamp in specified time zone.
The Universally Coordinated Time timestamp that is to be converted.
The time zone to which the Universally Coordinated Time timestamp
is to be converted to.
The timestamp in the specified time zone.
Converts given timestamp from one time zone to another using standard names for time zones.
Timestamp in source time zone to be converted to time in destination time zone.
Standard name of time zone for given source timestamp.
Standard name of desired end time zone for given source
timestamp.
Timestamp in destination time zone.
Converts given timestamp from one time zone to another.
Timestamp in source time zone to be converted to time in destination time
zone.
Time zone for given source timestamp.
Desired end time zone for given source timestamp.
Timestamp in destination time zone.
Gets the abbreviated month name for month of the timestamp.
Timestamp from which month name is extracted.
String representation of the month name based on
Gets the full month name for month of the timestamp.
Timestamp from which month name is extracted.
String representation of the month name based on
Gets the abbreviated weekday name for weekday of the timestamp.
Timestamp from which weekday name is extracted.
String representation of the weekday name based on
Gets the shortest weekday name for weekday of the timestamp.
Timestamp from which weekday name is extracted.
String representation of the short weekday name based on
Gets the full weekday name for weekday of the timestamp.
Timestamp from which weekday name is extracted.
String representation of the weekday name based on
Contains extension methods for values.
Manages the suppression of log messages
Gets the item for the current thread.
Note: No exchange compare is needed since
is local only to the current thread.
This information is maintained in a ThreadLocal variable and is about
messages and log suppression applied at higher levels of the calling stack.
Gets if Log Messages should be suppressed.
Gets if First Chance Exception Log Messages should be suppressed.
Sets a flag that will prevent log messages from being raised on this thread.
Remember to dispose of the callback to remove this suppression.
Sets a flag that will prevent First Chance Exception log messages from being raised on this thread.
Remember to dispose of the callback to remove this suppression.
Sets a flag that will allow log messages to be raised again.
Remember to dispose of the callback to remove this override.
A class that will undo a temporary change in the stack variables. Note, this class
will be reused, therefore setting some kind of disposed flag will cause make this
class unusable. The side effect of multiple calls to Dispose is tolerable.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Enumeration that represents a state of either "automatic", "on" or "off".
Represents the automatic, i.e., default, state.
Represents the on, i.e., enabled, state.
Represents the off, i.e., disabled, state.
Defines 7-bit encoding functions.
Gets the number of bytes required to write the provided value.
Value to measure
Number of bytes required to write the provided value.
Gets the number of bytes for the supplied value in the stream.
Source byte stream.
Number of bytes for the supplied value in the stream.
Gets the number of bytes for the supplied value in the stream.
Source byte stream.
Start position in stream.
Number of bytes for the supplied value in the stream.
Gets the number of bytes for the supplied value in the stream.
Source byte stream.
Start position in stream.
Number of bytes for the supplied value in the stream.
Writes the 7-bit encoded value to the provided stream.
Source stream.
Value to write. Cannot be negative.
Number of bytes required to store the value.
Writes the 7-bit encoded value to the provided stream.
Source stream.
Reference position in stream.
This field will be updated when the function returns.
Value to write.
Writes the 7-bit encoded value to the provided stream.
Source stream.
Reference position in stream.
This field will be updated when the function returns.
Value to write.
Writes the 7-bit encoded value to the provided stream.
Method to write a byte.
Value to write.
Reads a 7-bit encoded short.
Source stream.
Reference position in stream. Position will be updated after reading.
7-bit encoded short.
Reads a 7-bit encoded short.
Source stream.
Reference position in stream. Position will be updated after reading.
7-bit encoded short.
Reads a 7-bit encoded short.
Source stream.
t7-bit encoded short.
This method will check for the end of the stream.
Occurs if the end of the stream was reached.
Reads a 7-bit encoded short.
Function used to read next byte.
7-bit encoded short.
Gets the number of bytes required to write the provided value.
Value to measure.
Number of bytes required to write the provided value.
Gets the number of bytes for the supplied value in the stream.
Source stream.
Number of bytes for the supplied value in the stream.
Gets the number of bytes for the supplied value in the stream.
Source stream.
Reference position in stream. Position will be updated after reading.
Number of bytes for the supplied value in the stream.
Gets the number of bytes for the supplied value in the stream.
Source stream.
Reference position in stream. Position will be updated after reading.
Number of bytes for the supplied value in the stream.
Writes the 7-bit encoded value to the provided stream.
Source stream.
Value to write.
Number of bytes required to store the value.
Writes the 7-bit encoded value to the provided stream.
Source stream.
Reference position in stream.
This field will be updated when the function returns.
Value to write.
Writes the 7-bit encoded value to the provided stream.
Source stream.
Reference position in stream.
This field will be updated when the function returns.
Value to write.
Writes the 7-bit encoded value to the provided stream.
Method to write a byte.
Value to write.
Reads a 7-bit encoded uint.
Source stream.
Reference position in stream. Position will be updated after reading.
7-bit encoded uint.
Reads a 7-bit encoded uint.
Source stream.
Reference position in stream. Position will be updated after reading.
7-bit encoded uint.
Reads a 7-bit encoded uint.
Source stream.
7-bit encoded uint.
This method will check for the end of the stream.
Occurs if the end of the stream was reached.
Reads a 7-bit encoded uint.
Function used to read next byte.
7-bit encoded uint.
Gets the number of bytes required to write the provided value.
Value to measure.
The number of bytes needed to store the provided value.
Gets the number of bytes for the supplied value in the stream.
Source stream.
Number of bytes for the supplied value in the stream.
Gets the number of bytes for the supplied value in the stream.
Source stream.
Reference position in stream. Position will be updated after reading.
Number of bytes for the supplied value in the stream.
Gets the number of bytes for the supplied value in the stream.
Source stream.
Reference position in stream. Position will be updated after reading.
Number of bytes for the supplied value in the stream.
Writes the 7-bit encoded value to the provided stream.
Source stream.
Value to write.
Number of bytes required to store the value.
Writes the 7-bit encoded value to the provided stream.
Source stream.
Reference position in stream.
This field will be updated when the function returns.
Value to write.
Writes the 7-bit encoded value to the provided stream.
Source stream.
Reference position in stream.
This field will be updated when the function returns.
Value to write.
Writes the 7-bit encoded value to the provided stream.
Method to write a byte.
Value to write.
Reads a 7-bit encoded ulong.
Source stream.
Reference position in stream. Position will be updated after reading.
7-bit encoded ulong.
Reads a 7-bit encoded ulong.
Source stream.
Reference position in stream. Position will be updated after reading.
7-bit encoded ulong.
Reads a 7-bit encoded ulong.
Source stream.
7-bit encoded ulong.
This method will check for the end of the stream.
Occurs if the end of the stream was reached.
Reads a 7-bit encoded ulong.
Function used to read next byte.
7-bit encoded ulong.
Endian Byte Order Enumeration.
Big-endian byte order.
Little-endian byte order.
Represents a big-endian byte order interoperability class.
Constructs a new instance of the class.
Returns the default instance of the class.
Represents a little-endian byte order interoperability class.
Constructs a new instance of the class.
Returns the default instance of the class.
Represents a native-endian byte order interoperability class.
Constructs a new instance of the class.
Returns the default instance of the class.
Represents an endian byte order interoperability class.
Intel systems use little-endian byte order, other systems, such as Unix, use big-endian byte ordering.
Little-endian ordering means bits are ordered such that the bit whose in-memory representation is right-most is the most-significant-bit in a byte.
Big-endian ordering means bits are ordered such that the bit whose in-memory representation is left-most is the most-significant-bit in a byte.
Constructs a new instance of the class.
Endianness parameter.
Returns the target endian-order of this representation.
Returns a value converted from one byte at a specified position in a byte array.
An array of bytes.
The starting position within value.
true if the byte at startIndex in value is nonzero; otherwise, false.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a Unicode character converted from two bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A character formed by two bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a double-precision floating point number converted from eight bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A double-precision floating point number formed by eight bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 16-bit signed integer converted from two bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 16-bit signed integer formed by two bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 32-bit signed integer converted from four bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 32-bit signed integer formed by four bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 64-bit signed integer converted from eight bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 64-bit signed integer formed by eight bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a single-precision floating point number converted from four bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A single-precision floating point number formed by four bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 16-bit unsigned integer converted from two bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 16-bit unsigned integer formed by two bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 32-bit unsigned integer converted from four bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 32-bit unsigned integer formed by four bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 64-bit unsigned integer converted from eight bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 64-bit unsigned integer formed by eight bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns the specified value as an array of bytes in the target endian-order.
The value to convert.
An array of bytes with length 1.
Native value type to get bytes for.
type is not primitive.
Cannot get bytes for type.
Returns the specified value as an array of bytes in the target endian-order.
The value to convert.
An array of bytes with length 1.
Returns the specified Unicode character value as an array of bytes in the target endian-order.
The Unicode character value to convert.
An array of bytes with length 2.
Returns the specified double-precision floating point value as an array of bytes in the target endian-order.
The number to convert.
An array of bytes with length 8.
Returns the specified 16-bit signed integer value as an array of bytes.
The number to convert.
An array of bytes with length 2.
Returns the specified 32-bit signed integer value as an array of bytes.
The number to convert.
An array of bytes with length 4.
Returns the specified 64-bit signed integer value as an array of bytes.
The number to convert.
An array of bytes with length 8.
Returns the specified single-precision floating point value as an array of bytes in the target endian-order.
The number to convert.
An array of bytes with length 4.
Returns the specified 16-bit unsigned integer value as an array of bytes.
The number to convert.
An array of bytes with length 2.
Returns the specified 32-bit unsigned integer value as an array of bytes.
The number to convert.
An array of bytes with length 4.
Returns the specified 64-bit unsigned integer value as an array of bytes.
The number to convert.
An array of bytes with length 8.
Copies the specified primitive type value as an array of bytes in the target endian-order to the destination array.
The value to convert and copy.
The destination buffer.
The byte offset into .
Native value type to get bytes for.
type is not primitive.
Cannot get bytes for type.
Length of bytes copied into array based on size of .
Copies the specified value as an array of 1 byte in the target endian-order to the destination array.
The value to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified Unicode character value as an array of 2 bytes in the target endian-order to the destination array.
The Unicode character value to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified double-precision floating point value as an array of 8 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 16-bit signed integer value as an array of 2 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 32-bit signed integer value as an array of 4 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 64-bit signed integer value as an array of 8 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified single-precision floating point value as an array of 4 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 16-bit unsigned integer value as an array of 2 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 32-bit unsigned integer value as an array of 4 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 64-bit unsigned integer value as an array of 8 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Gets the native of the executing architecture.
Default instance of the conversion class.
Default instance of the conversion class.
Default instance of the conversion class.
Defines extension methods related to enumerations.
Retrieves the description of the value that this represents extracted from the , or the enumeration name
if no description is available.
to operate on.
Description of the if specified, otherwise the representation of this .
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
Type of enumeration.
Value to attempt to return from enumeration.
Value to return if enumeration value is not found.
Enumeration value specified, if found, or a default value.
If a default value is not defined, first enumeration value will be used.
is null.
is not an enum. -or-
The type of is not of type . -or-
The type of is not an underlying type of .
is not type , ,
, , , ,
, or , or .
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
Value to attempt to return from enumeration.
of the enumeration.
Value to return if enumeration value is not found.
Enumeration value specified, if found, or a default value.
If a default value is not defined, first enumeration value will be used.
or is null.
is not an enum. -or-
The type of is not of type . -or-
The type of is not an underlying type of .
is not type , ,
, , , ,
, or , or .
Gets the enumeration of the specified whose description matches this .
Description to be used for lookup of the enumeration.
of the enumeration.
true to ignore case during the comparison; otherwise, false.
An enumeration of the specified if a match is found, otherwise null.
The is not an enumeration.
Gets the enumeration value with the specified name.
Name to search for.
of the enumeration.
true to ignore case during the comparison; otherwise, false.
Specific value of the enumerated constant in terms of its underlying type associated with the specified , or null
if no matching enumerated value was found.
Retrieves a formatted name of the value that this represents for visual display.
Enum string name is converted to a label with spaces before each capital letter, other than the first.
to operate on.
Formatted enumeration name of the specified value for visual display.
Contains extension methods for values.
Represents a generic event arguments class with one data argument.
Type of data argument for this event arguments instance.
Gets or sets the data argument for the event using for its .
Initializes a new instance of the class.
Initializes a new instance of the class.
The argument data for the event.
Represents a generic event arguments class with two data arguments.
The type of the first data argument for this event arguments instance.
The type of the second data argument for this event arguments instance.
Gets or sets the first data argument for the event using for its .
Gets or sets the second data argument for the event using for its .
Initializes a new instance of the class.
Initializes a new instance of the class.
The first data argument for the event.
The second data argument for the event.
Represents a generic event arguments class with three data arguments.
The type of the first data argument for this event arguments instance.
The type of the second data argument for this event arguments instance.
The type of the third data argument for this event arguments instance.
Gets or sets the first data argument for the event using for its .
Gets or sets the second data argument for the event using for its .
Gets or sets the third data argument for the event using for its .
Initializes a new instance of the class.
Initializes a new instance of the class.
The first data argument for the event.
The second data argument for the event.
The third data argument for the event.
Represents a generic event arguments class with three data arguments.
The type of the first data argument for this event arguments instance.
The type of the second data argument for this event arguments instance.
The type of the third data argument for this event arguments instance.
The type of the fourth data argument for this event arguments instance.
Gets or sets the first data argument for the event using for its .
Gets or sets the second data argument for the event using for its .
Gets or sets the third data argument for the event using for its .
Gets or sets the fourth data argument for the event using for its .
Initializes a new instance of the class.
Initializes a new instance of the class.
The first data argument for the event.
The second data argument for the event.
The third data argument for the event.
The fourth data argument for the event.
Defines extension methods related to event handlers.
Safely invokes event propagation, continuing even if an attached user handler throws an exception.
type commonly derived from .
Type derived from .
Source to safely invoke.
Event source.
Event arguments.
Call event handlers in parallel, when attached handlers are greater than one.
Event handler invocation list access will be locked on .
Any exceptions will be suppressed, see and other overloads for custom exception handling.
Safely invokes event propagation with custom exception handler, continuing even if an attached user handler throws an exception.
type commonly derived from .
Type derived from .
Source to safely invoke.
Custom delegate to handle encountered exceptions; when set to null, exception will be suppressed, see .
Event source.
Event arguments.
Call event handlers in parallel, when attached handlers are greater than one.
Event handler invocation list access will be locked on .
Safely invokes event propagation with custom exception handler that accepts user handler delegate, continuing even if an attached user handler throws an exception.
type commonly derived from .
Type derived from .
Source to safely invoke.
Custom delegate to handle encountered exceptions which includes parameter for event handler that threw the exception; when set to null, exception will be suppressed, see .
Event source.
Event arguments.
Call event handlers in parallel, when attached handlers are greater than one.
Event handler invocation list access will be locked on .
Safely invokes event propagation with custom exception handler, continuing even if an attached user handler throws an exception.
type commonly derived from .
Type derived from .
Source to safely invoke.
Locking object for accessing event handler invocation list; when set to null, lock will be on .
Custom delegate to handle encountered exceptions; when set to null, exception will be suppressed, see .
Event source.
Event arguments.
Call event handlers in parallel, when attached handlers are greater than one.
Safely invokes event propagation with custom event lock and exception handler that accepts user handler delegate, continuing even if an attached user handler throws an exception.
type commonly derived from .
Type derived from .
Source to safely invoke.
Locking object for accessing event handler invocation list; when set to null, lock will be on .
Custom delegate to handle encountered exceptions which includes parameter for event handler that threw the exception; when set to null, exception will be suppressed, see .
Event source.
Event arguments.
Call event handlers in parallel, when attached handlers are greater than one.
Safely invokes event propagation asynchronously, continuing even if an attached user handler throws an exception.
type commonly derived from .
Type derived from .
Source to safely invoke.
Event source.
Event arguments.
Call event handlers in parallel, when attached handlers are greater than one.
Event handler invocation list access will be locked on .
Any exceptions will be suppressed, see and other overloads for custom exception handling.
Safely invokes event propagation asynchronously with custom exception handler, continuing even if an attached user handler throws an exception.
type commonly derived from .
Type derived from .
Source to safely invoke.
Custom delegate to handle encountered exceptions; when set to null, exception will be suppressed, see .
Event source.
Event arguments.
Call event handlers in parallel, when attached handlers are greater than one.
Event handler invocation list access will be locked on .
Safely invokes event propagation asynchronously with custom exception handler that accepts user handler delegate, continuing even if an attached user handler throws an exception.
type commonly derived from .
Type derived from .
Source to safely invoke.
Custom delegate to handle encountered exceptions which includes parameter for event handler that threw the exception; when set to null, exception will be suppressed, see .
Event source.
Event arguments.
Call event handlers in parallel, when attached handlers are greater than one.
Event handler invocation list access will be locked on .
Safely invokes event propagation asynchronously with custom exception handler, continuing even if an attached user handler throws an exception.
type commonly derived from .
Type derived from .
Source to safely invoke.
Locking object for accessing event handler invocation list; when set to null, lock will be on .
Custom delegate to handle encountered exceptions; when set to null, exception will be suppressed, see .
Event source.
Event arguments.
Call event handlers in parallel, when attached handlers are greater than one.
Safely invokes event propagation asynchronously with custom event lock and exception handler that accepts user handler delegate, continuing even if an attached user handler throws an exception.
type commonly derived from .
Type derived from .
Source to safely invoke.
Locking object for accessing event handler invocation list; when set to null, lock will be on .
Custom delegate to handle encountered exceptions which includes parameter for event handler that threw the exception; when set to null, exception will be suppressed, see .
Event source.
Event arguments.
Call event handlers in parallel, when attached handlers are greater than one.
Gets the method name attached to an event handler.
type representing single handler of .
Attached event handler.
Name of event handler method including parameters and class name.
Contains extension methods for values.
Extension methods for .
Encodes a following RFC 4122.
The to serialize.
Destination buffer to hold serialized .
Starting index in .
Bytes encoded.
Encodes a following RFC 4122.
The to serialize.
Destination buffer to hold serialized .
Bytes encoded.
Encodes a following RFC 4122.
to serialize.
A array that represents a big-endian encoded .
Decodes a following RFC 4122
Buffer containing a serialized big-endian encoded .
deserialized from .
Decodes a following RFC 4122
Buffer containing a serialized big-endian encoded .
deserialized from .
Decodes a following RFC 4122
Buffer containing a serialized big-endian encoded .
Starting index in .
deserialized from .
Gets the little endian encoded bytes of the .
the to serialize
A [] that represents a big endian encoded Guid.
Writes a in Little Endian byte order.
the to serialize
where to store the
the starting index in
Bytes written.
Writes a in Little Endian byte order.
the to serialize
where to store the
Bytes written.
Reads a in Little Endian byte order.
where to read the .
Decoded .
Mimicks the encoding that was present in LittleEndianOrder on a Little Endian CPU.
where to read the .
the starting index in
Decoded .
Reads a Guid in Little Endian byte order.
where to read the .
Decoded .
Contains extension methods for values.
Internal interface that represents common properties and methods needed by
implemented in both Windows and Unix flavors.
Gets flag that determines if domain is responding to user existence.
true if domain responds and user exists; otherwise false.
Note that when the domain is unavailable, this function will return false.
Gets flag that determines if user exists.
true if user is found to exist; otherwise false.
Gets or sets enabled state.
Gets the last login time of the user.
Gets the when the account was created.
Gets the , in UTC, of next password change for the user.
Gets the account control information of the local user.
Gets this maximum password age for the user.
Gets all the groups associated with the user - this includes local groups and Active Directory groups if applicable.
Groups names are prefixed with their associated domain, computer name or BUILTIN.
Gets the local groups the user is a member of.
Groups names are prefixed with BUILTIN or computer name.
Gets the full user name for local accounts.
Gets flag that determines if this instance is based on a local WinNT account instead of found through LDAP.
Initializes the object.
true if successfully initialized; otherwise, false.
Attempts to change the user's password.
Old password.
New password.
Returns the value for specified active directory property.
Name of the active directory property whose value is to be retrieved.
value for the specified active directory property.
Contains classes used to simplify and standardize access to information about user identity.
Represents information about a local user or a domain user (e.g., from Active Directory).
Initializes a new instance of the class.
Login ID in 'domain\accountName' format of the user's account whose information is to be retrieved. Login ID
can also be specified in 'accountName' format without the domain name, in which case the domain name will be
approximated based on the privileged user domain if specified, default login domain of the host machine
if available, or the domain of the identity that owns the host process.
is a null or empty string.
Gets the domain for the user.
Gets the user name of the user.
Gets the Login ID of the user.
Gets the ID of the user in LDAP format.
Localized version of Windows "BUILTIN" local permissions group name.
For non-English based OS languages, this name may be different. For example, on a German OS this is "VORDEFINIERT".
Localized version of Windows "NT AUTHORITY" local permissions group name.
For non-English based OS languages, this name may be different. For example, on a French OS this is "NT-AUTORITÄT".
Localized version of Windows "NT SERVICE" local Windows services group name.
For non-English based OS languages, this name may be different.
Gets the ID name of the current user.
The ID name returned is that of the user account under which the code is executing.
Gets the object for the .
Converts the given user name to the SID corresponding to that name.
The user name for which to look up the SID.
The SID for the given user name, or the user name if no SID can be found.
If the cannot be converted to a SID,
will be the return value.
Determines whether the given security identifier identifies a user account.
The security identifier.
true if the security identifier identifies a user account; false otherwise.
Converts the given group name to the SID corresponding to that name.
The group name for which to look up the SID.
The SID for the given group name, or the group name if no SID can be found.
If the cannot be converted to a SID,
will be the return value.
Determines whether the given security identifier identifies a group.
The security identifier.
true if the security identifier identifies a group; false otherwise.
Determines if specified is the local domain (i.e., local machine).
Domain name to check.
trueif specified is the local domain (i.e., local machine); otherwise, false.
Represents an interface for common INI functions.
File name of the INI file.
Gets the value of the specified key.
Section key exists in.
Name of key.
Default value of key.
Value of key.
This is the default member of this class.
Gets or sets the value of the specified key.
Section key exists in.
Name of key.
The new key value to store in the INI file.
Value of key.
This is the default member of this class.
Gets an array of keys from the specified section in the INI file.
Section to retrieve keys from.
Array of keys from the specified section of the INI file.
Gets an array of that section names that exist in the INI file.
Array of section names from the INI file.
Represents a Windows INI style configuration file.
Creates a new .
INI file name defaults to "Win.ini" - change using FileName property.
Creates a new using the specified INI file name.
Specified INI file name to use.
File name of the INI file.
Gets the value of the specified key.
Section key exists in.
Name of key.
Default value of key.
Value of key.
This is the default member of this class.
Gets or sets the value of the specified key.
Section key exists in.
Name of key.
The new key value to store in the INI file.
Value of key.
This is the default member of this class.
Gets the value of the specified key.
Section key exists in.
Name of key.
Value of key.
Gets the value of the specified key.
Section key exists in.
Name of key.
Default value of key.
Value of key.
Sets the value of the specified key.
Section key exists in.
Name of key.
The new key value to store in the INI file.
Gets an array of keys from the specified section in the INI file.
Section to retrieve keys from.
Array of keys from the specified section of the INI file.
Gets an array of that section names that exist in the INI file.
Array of section names from the INI file.
The namespace defines classes used to handle interoperability
with older legacy applications. The root namespace also includes classes, e.g.,
and
Represents a Unix INI style configuration file.
Creates a new using the specified INI file name.
Specified INI file name to use.
File name of the INI file.
Gets the value of the specified key.
Section key exists in.
Name of key.
Default value of key.
Value of key.
This is the default member of this class.
Gets or sets the value of the specified key.
Section key exists in.
Name of key.
The new key value to store in the INI file.
Value of key.
This is the default member of this class.
Gets an array of keys from the specified section in the INI file.
Section to retrieve keys from.
Array of keys from the specified section of the INI file.
Gets an array of that section names that exist in the INI file.
Array of section names from the INI file.
Represents an old style Visual Basic array descriptor.
This class is used to mimic the binary array descriptor used when an array is serialized
into a file using older Visual Basic applications (VB 6 and prior), this way old VB apps
can still deserialize an array stored in a file written by a .NET application and vice versa.
Initializes a new instance of the class.
Length of array per dimension.
Lower bound of array per dimension.
Gets the length of serialized .
Generates binary image of the object and copies it into the given buffer, for bytes.
Buffer used to hold generated binary image of the source object.
0-based starting index in the to start writing.
The number of bytes written to the .
is null.
or is less than 0 -or-
and will exceed length.
Returns a object for a one dimensional array with zero-based index.
Length of the array.
A object.
Returns a object for a one dimensional array with one-based index.
Length of the array.
A object.
Returns a object for a two dimensional array with zero-based index.
Length of array in dimension one.
Length of array in dimension two.
A object.
Returns a object for a two dimensional array with one-based index.
Length of array in dimension one.
Length of array in dimension two.
A object.
Defines common Windows API constants, enumerations, structures and functions.
Formats and returns a .NET string containing the Windows API level error message from the last Win32 call.
A formatted error message corresponding to the last Win32 call error code.
Win32 FormatMessage function.
Formats and returns a .NET string containing the Windows API level error message corresponding to the specified error code.
An value corresponding to the specified error code.
A formatted error message corresponding to the specified error code.
Represents a Windows INI style configuration file.
Creates a new using the specified INI file name.
Specified INI file name to use.
File name of the INI file.
Gets the value of the specified key.
Section key exists in.
Name of key.
Default value of key.
Value of key.
This is the default member of this class.
Gets or sets the value of the specified key.
Section key exists in.
Name of key.
The new key value to store in the INI file.
Value of key.
This is the default member of this class.
Gets an array of keys from the specified section in the INI file.
Section to retrieve keys from.
Array of keys from the specified section of the INI file.
Gets an array of that section names that exist in the INI file.
Array of section names from the INI file.
Defines a stream whose backing store is memory. Externally this class operates similar to a ,
internally it uses dynamically allocated buffer blocks instead of one large contiguous array of data.
The has two primary benefits over a normal , first, the
allocation of a large contiguous array of data in can fail when the requested amount of contiguous
memory is unavailable - the prevents this; second, a will
constantly reallocate the buffer size as the stream grows and shrinks and then copy all the data from the old buffer to the
new - the maintains its blocks over its life cycle, unless manually cleared, thus
eliminating unnecessary allocations and garbage collections when growing and reusing a stream.
Important: Unlike , the will not use a user provided buffer
as its backing buffer. Any user provided buffers used to instantiate the class will be copied into internally managed reusable
memory buffers. Subsequently, the does not support the notion of a non-expandable
stream. If you are using a with your own buffer, the will
not provide any immediate benefit.
Note that the will maintain all allocated blocks for stream use until the
method is called or the class is disposed.
No members in the are guaranteed to be thread safe. Make sure any calls are
synchronized when simultaneously accessed from different threads.
Initializes a new instance of .
Initializes a new instance of from specified .
Initial buffer to copy into stream.
is null.
Unlike , the will not use the provided
as its backing buffer. The buffer will be copied into internally managed reusable
memory buffers. Subsequently, the notion of a non-expandable stream is not supported.
Initializes a new instance of from specified region of .
Initial buffer to copy into stream.
0-based start index into the .
Valid number of bytes within from .
is null.
or is less than 0 -or-
and will exceed length.
Unlike , the will not use the provided
as its backing buffer. The buffer will be copied into internally managed reusable
memory buffers. Subsequently, the notion of a non-expandable stream is not supported.
Initializes a new instance of for specified .
Initial length of the stream.
Gets a value that indicates whether the object supports reading.
This is always true.
Gets a value that indicates whether the object supports seeking.
This is always true.
Gets a value that indicates whether the object supports writing.
This is always true.
Gets current stream length for this instance.
The stream is closed.
Gets current stream position for this instance.
Seeking was attempted before the beginning of the stream.
The stream is closed.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; otherwise, false to release only unmanaged resources.
Clears the entire contents and releases any allocated memory blocks.
Sets the within the current stream to the specified value relative the .
The new position within the stream, calculated by combining the initial reference point and the offset.
The new position within the stream. This is relative to the parameter, and can be positive or negative.
A value of type , which acts as the seek reference point.
Seeking was attempted before the beginning of the stream.
The stream is closed.
Sets the length of the current stream to the specified value.
The value at which to set the length.
If this length is larger than the previous length, the data is initialized to 0's between the previous length and the current length.
Reads a block of bytes from the current stream and writes the data to .
When this method returns, contains the specified byte array with the values between and ( + - 1) replaced by the characters read from the current stream.
The byte offset in at which to begin reading.
The maximum number of bytes to read.
The total number of bytes written into the buffer. This can be less than the number of bytes requested if that number of bytes are not currently available, or zero if the end of the stream is reached before any bytes are read.
is null.
or is less than 0 -or-
and will exceed length.
The stream is closed.
Reads a byte from the current stream.
The current byte cast to an , or -1 if the end of the stream has been reached.
The stream is closed.
Writes a block of bytes to the current stream using data read from .
The buffer to write data from.
The byte offset in at which to begin writing from.
The maximum number of bytes to write.
is null.
or is less than 0 -or-
and will exceed length.
The stream is closed.
Writes a byte to the current stream at the current position.
The byte to write.
The stream is closed.
Writes the stream contents to a byte array, regardless of the property.
A [] containing the current data in the stream
This may fail if there is not enough contiguous memory available to hold current size of stream.
When possible use methods which operate on streams directly instead.
Cannot create a byte array with more than 2,147,483,591 elements.
The stream is closed.
Reads specified number of bytes from source stream into this
starting at the current position.
The stream containing the data to copy
The number of bytes to copy
The stream is closed.
Writes the entire stream into destination, regardless of , which remains unchanged.
The stream onto which to write the current contents.
The stream is closed.
Overrides the method so that no action is performed.
This method overrides the method.
Because any data written to a object is
written into RAM, this method is superfluous.
Makes sure desired can be accommodated by future data accesses.
Minimum desired stream capacity.
Initializes all of the bytes to zero.
Provides a thread safe queue that acts as a buffer pool.
Creates a new .
The size of buffers in the pool.
the ideal number of buffers that are always pending on the queue.
Removes a buffer from the queue. If one does not exist, one is created.
Adds a buffer back to the queue.
The buffer to queue.
Contains File and Path manipulation methods.
Connects to a network share with the specified user's credentials.
UNC share name to connect to.
Username to use for connection.
Password to use for connection.
Domain name to use for connection. Specify the computer name for local system accounts.
Disconnects the specified network share.
UNC share name to disconnect from.
Disconnects the specified network share.
UNC share name to disconnect from.
true to force a disconnect; otherwise false.
Gets the instance of the host application.
Failed to derive host assembly info.
Gets the application path of the host application.
Failed to derive host application path.
Tries to get the free space values for a given path. This path can be a network share or a mount point.
The path to the location
The number of user space bytes
The total number of bytes on the drive.
true if successful; otherwise false if there was an error.
Determines if the specified is contained with the current executable path.
File name or relative file path.
true if the specified is contained with the current executable path; otherwise false.
Gets the path to the folder where data related to the current
application can be stored as well as shared among different users.
Path to the folder where data related to the current application can be stored.
Gets the path to the folder where data related to the current application can be stored.
Path to the folder where data related to the current application can be stored.
Gets the absolute file path for the specified file name or relative file path.
File name or relative file path.
Absolute file path for the specified file name or relative file path.
Gets a unique file path for the given file by checking for name collisions and
adding a sequence number to the end of the file name if there is a collision.
The path to the original file before adding the sequence number.
The unique path to the file.
This method is designed to handle the case where the user wishes to create a file in a folder
with a given name when there is a possibility that the name is already taken. Using this method,
it is possible to create files with names in the following format:
- File.ext
- File (1).ext
- File (2).ext
- ...
This method uses a linear search to find a unique file name, so it is suitable for situations where
there are a small number of collisions for each file name. This will detect and fill gaps that can
occur when files are deleted (for instance, if "File (1).ext" were deleted from the list above).
Gets a unique file path for the given file by checking for name collisions and
adding a sequence number to the end of the file name if there is a collision.
The path to the original file before adding the sequence number.
The unique path to the file.
This method is designed to handle the case where the user wishes to create a file in a folder
with a given name when there is a possibility that the name is already taken. Using this method,
it is possible to create files with names in the following format:
- File.ext
- File (1).ext
- File (2).ext
- ...
This method uses a binary search to find a unique file name, so it is suitable for situations where
a large number of files will be created with the same file name, and the next unique file name needs
to be found relatively quickly. It will not always detect gaps in the sequence numbers that can occur
when files are deleted (for instance, if "File (1).ext" were deleted from the list above).
Returns the names of the subdirectories (including their paths) that match the specified search pattern in the specified directory, and optionally searches subdirectories.
The relative or absolute path to the directory to search. This string is not case-sensitive.
The search string to match against the names of subdirectories in . This parameter can contain a combination of valid literal and wild-card characters, but doesn't support regular expressions.
One of the enumeration values that specifies whether the search operation should include all subdirectories or only the current directory.
Handles exceptions thrown during directory enumeration.
An array of the full names (including paths) of the subdirectories that match the specified criteria, or an empty array if no directories are found.
Returns an enumerable collection of subdirectories that match a search pattern in a specified path, and optionally searches subdirectories.
The relative or absolute path to the directory to search. This string is not case-sensitive.
The search string to match against the names of subdirectories in . This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but doesn't support regular expressions.
One of the enumeration values that specifies whether the search operation should include only the current directory or should include all subdirectories.
Handles exceptions thrown during directory enumeration.
An enumerable collection of the full names (including paths) for the directories in the directory specified by and that match the specified search pattern and option.
Returns the names of files (including their paths) that match the specified search pattern in the specified directory, using a value to determine whether to search subdirectories.
The relative or absolute path to the directory to search. This string is not case-sensitive.
The search string to match against the names of files in . This parameter can contain a combination of valid literal path and wild-card (* and ?) characters, but doesn't support regular expressions.
One of the enumeration values that specifies whether the search operation should include all subdirectories or only the current directory.
Handles exceptions thrown during file enumeration.
An array of the full names (including paths) for the files in the specified directory that match the specified search pattern and option, or an empty array if no files are found.
Returns an enumerable collection of file names that match a search pattern in a specified path, and optionally searches subdirectories.
The relative or absolute path to the directory to search. This string is not case-sensitive.
The search string to match against the names of files in . This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but doesn't support regular expressions.
One of the enumeration values that specifies whether the search operation should include only the current directory or should include all subdirectories.
Handles exceptions thrown during file enumeration.
An enumerable collection of the full names (including paths) for the files in the directory specified by and that match the specified search pattern and option.
Returns the subdirectories that match the specified search pattern in the specified directory, and optionally searches subdirectories.
The directory to search.
The search string to match against the names of subdirectories in the . This parameter can contain a combination of valid literal and wildcard characters, but doesn't support regular expressions.
One of the enumeration values that specifies whether the search operation should include all subdirectories or only the current directory.
Handles exceptions thrown during directory enumeration.
An array of the objects representing the subdirectories that match the specified search criteria.
Returns an enumerable collection of subdirectories that match a search pattern in a specified path, and optionally searches subdirectories.
The directory to search.
The search string to match against the names of subdirectories in the . This parameter can contain a combination of valid literal and wildcard characters, but doesn't support regular expressions.
One of the enumeration values that specifies whether the search operation should include only the current directory or should include all subdirectories.
Handles exceptions thrown during directory enumeration.
An enumerable collection of the objects representing the subdirectories that match the specified search criteria.
Returns the files that match the specified search pattern in the specified directory, using a value to determine whether to search subdirectories.
The directory to search.
The search string to match against the names of files in the . This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but doesn't support regular expressions.
One of the enumeration values that specifies whether the search operation should include all subdirectories or only the current directory.
Handles exceptions thrown during file enumeration.
An array of the objects representing the files in the specified directory that match the specified search pattern, or an empty array if no files are found.
Returns an enumerable collection of files that match a search pattern in a specified path, and optionally searches subdirectories.
The directory to search.
The search string to match against the names of files in the . This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but doesn't support regular expressions.
One of the enumeration values that specifies whether the search operation should include only the current directory or should include all subdirectories.
Handles exceptions thrown during file enumeration.
An enumerable collection of the objects representing the files in the specified directory that match the specified search pattern, or an empty array if no files are found.
Ensures the supplied path name is valid.
The file path to be validated.
Throws argument exceptions if the is invalid.
Determines whether the specified file name matches any of the given file specs (wild-cards are defined as '*' or '?' characters).
The file specs used for matching the specified file name.
The file path to be tested against the specified file specs for a match.
true to specify a case-insensitive match; otherwise false.
true if the specified file name matches any of the given file specs; otherwise false.
contains one or more of the invalid characters defined in .
The syntax for adheres to the following rules:
- Either '\' or '/' (as defined by and ) can match the other.
- A single '\' or '/' at the beginning of the pattern matches any valid path root (such as "C:\" or "\\server\share").
- A '?' matches a single character which would be valid in a file name (as defined by ).
- A '*' matches any number of characters which would be valid in a file name.
- A sequence of "**\" or "**/" matches any number of sequential directories.
- Any other character matches itself.
Determines whether the specified file name matches the given file spec (wild-cards are defined as '*' or '?' characters).
The file spec used for matching the specified file name.
The file path to be tested against the specified file spec for a match.
true to specify a case-insensitive match; otherwise false.
true if the specified file name matches the given file spec; otherwise false.
contains one or more of the invalid characters defined in .
The syntax for adheres to the following rules:
- Either '\' or '/' (as defined by and ) can match the other.
- A single '\' or '/' at the beginning of the pattern matches any valid path root (such as "C:\" or "\\server\share").
- A '?' matches a single character which would be valid in a file name (as defined by ).
- A '*' matches any number of characters which would be valid in a file name.
- A sequence of "**\" or "**/" matches any number of sequential directories.
- Any other character matches itself.
Determines if the specified file name and path is valid.
The file name with optional path to test for validity.
true if the specified is a valid name; otherwise false.
Gets a valid file name by replacing invalid file name characters with .
File name to validate.
Character to replace invalid file name characters with. Set to '\0' to remove invalid file name characters.
A valid file name with no invalid file name characters.
This function expects a file name, not a file name with a path. To properly get a valid file path, where all directory
names and the file name are validated, use the . Calling the
function will a full path will yield all directory separators replaced with the .
Gets a valid file path by replacing invalid file or directory name characters with .
File path to validate.
Character to replace invalid file or directory name characters with. Set to '\0' to remove invalid file or directory name characters.
A valid file path with no invalid file or directory name characters.
Gets the file name and extension from the specified file path.
The file path from which the file name and extension is to be obtained.
File name and extension if the file path has it; otherwise empty string.
Gets the extension from the specified file path.
The file path from which the extension is to be obtained.
File extension.
Gets the file name without extension from the specified file path.
The file path from which the file name is to be obtained.
File name without the extension if the file path has it; otherwise empty string.
Gets the size of the specified file.
Name of file whose size is to be retrieved.
The size of the specified file.
Gets a list of files under the specified path. Search wild card pattern (c:\Data\*.dat) can be used for
including only the files matching the pattern or path wild-card pattern (c:\Data\*\*.dat) to indicate the
inclusion of files under all subdirectories in the list.
The path for which a list of files is to be returned.
Handles exceptions thrown during file enumeration.
A list of files under the given path.
Gets a regular expression pattern that simulates wild-card matching for filenames (wild-cards are defined as '*' or '?' characters).
The file spec for which the regular expression pattern if to be generated.
Regular expression pattern that simulates wild-card matching for filenames.
Gets the directory information from the specified file path.
The file path from which the directory information is to be obtained.
Directory information.
This differs from in that it will see if last name in path is
a directory and, if it exists, will properly treat that part of path as a directory. The .NET path
function always assumes last entry is a file name if path is not suffixed with a slash. For example:
Path.GetDirectoryName(@"C:\Music") will return "C:\", however,
FilePath.GetDirectoryName(@"C:\Music") will return "C:\Music\", so long as Music directory exists.
Gets the last directory name from a file path.
The file path from where the last directory name is to be retrieved.
The last directory name from a file path.
would return sub2 from c:\windows\sub2\filename.ext.
Makes sure path is suffixed with standard .
The file path to be suffixed.
Suffixed path.
Makes sure path is not suffixed with or .
The file path to be unsuffixed.
Unsuffixed path.
Remove any path root present in the path.
The file path whose root is to be removed.
The path with the root removed if it was present.
Returns a file name, for display purposes, of the specified length using "..." to indicate a longer name.
The file path to be trimmed.
The maximum length of the trimmed file path.
Trimmed file path.
Minimum value for the parameter is 12. 12 will be used for any value
specified as less than 12.
Gets a lock on the file using the given lock function.
The return value of the lock function.
The name of the on which the lock is to be obtained.
The function to be called in order to get the file lock.
The number of seconds to wait before giving up on the file lock.
The number of milliseconds to wait between attempts to obtain the file lock.
The return value of the lock function.
The intent of this function is to provide a sane method for opening
a file which may produce errors due to read/write contention.
Usage of this class is fairly simple using the static methods
built into the class.
using (StreamReader reader = GetFileLock(File.OpenText))
{
// Read lines from the file
}
using (FileStream stream = GetFileLock(File.Create))
{
// Write bytes into the file
}
This method will only retry if an
occurs while executing the .
After retrying for at least
seconds, this function will throw the last IOException it encountered.
Attempts to get read access on a file.
The file to check for read access.
True if read access is obtained; false otherwise.
Attempts to get read access on a file.
The file to check for read access.
True if read access is obtained; false otherwise.
Attempts to get write access on a file.
The file to check for write access.
True if write access is obtained; false otherwise.
Waits for the default duration (5 seconds) for read access on a file.
The name of the file to wait for to obtain read access.
Waits for read access on a file for the specified number of seconds.
The name of the file to wait for to obtain read access.
The time to wait for in seconds to obtain read access on a file. Set to zero to wait infinitely.
Waits for the default duration (5 seconds) for read access on a file.
The name of the file to wait for to obtain read access.
Waits for read access on a file for the specified number of seconds.
The name of the file to wait for to obtain read access.
The time to wait for in seconds to obtain read access on a file. Set to zero to wait infinitely.
Waits for the default duration (5 seconds) for write access on a file.
The name of the file to wait for to obtain write access.
Waits for write access on a file for the specified number of seconds.
The name of the file to wait for to obtain write access.
The time to wait for in seconds to obtain write access on a file. Set to zero to wait infinitely.
Waits for the default duration (5 seconds) for a file to exist.
The name of the file to wait for until it is created.
Waits for a file to exist for the specified number of seconds.
The name of the file to wait for until it is created.
The time to wait for in seconds for the file to be created. Set to zero to wait infinitely.
Represents a serialized data cache that can be saved or read from multiple applications using inter-process synchronization.
Note that all file data in this class gets serialized to and from memory, as such, the design intention for this class is for
use with smaller data sets such as serialized lists or dictionaries that need inter-process synchronized loading and saving.
The uses a to synchronize access to cache as an inter-process shared resource.
On POSIX systems, the exhibits kernel persistence, meaning instances will remain active beyond the lifespan of
the creating process. The named semaphore must be explicitly removed by invoking when the last
interprocess cache instance is no longer needed. Kernel persistence necessitates careful design consideration regarding process
responsibility for invoking the method. Since the common use case for named semaphores is across
multiple applications, it is advisable for the last exiting process to handle the cleanup. In cases where an application may crash before
calling the method, the semaphore persists in the system, potentially leading to resource leakage.
Implementations should include strategies to address and mitigate this risk.
Default maximum retry attempts allowed for loading .
Default wait interval, in milliseconds, before retrying load of .
Creates a new instance of the .
Creates a new instance of the with the specified number of .
Maximum concurrent reader locks to allow.
Releases the unmanaged resources before the object is reclaimed by .
Path and file name for the cache needing inter-process synchronization.
Gets or sets file data for the cache to be saved or that has been loaded.
Setting value to null will create a zero-length file.
Gets or sets flag that determines if should automatically initiate a save when has been updated.
Gets or sets flag that enables system to monitor for changes in and automatically reload .
Gets the maximum concurrent reader locks allowed.
Maximum retry attempts allowed for loading or saving cache file data.
Wait interval, in milliseconds, before retrying load or save of cache file data.
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Releases the inter-process resources used by the .
On POSIX systems, calling this method removes the named semaphore used by the inter-process cache.
The semaphore name is removed immediately and is destroyed once all other processes that have the
semaphore open close it. Calling this method on Windows systems does nothing.
Initiates inter-process synchronized cache file save.
Subclasses should always call before calling this method.
Initiates inter-process synchronized cache file load.
Subclasses should always call before calling this method.
Blocks current thread and waits for any pending load to complete; wait time is * .
Blocks current thread and waits for specified for any pending load to complete.
The number of milliseconds to wait, or (-1) to wait indefinitely.
Blocks current thread and waits for any pending save to complete; wait time is * .
Blocks current thread and waits for specified for any pending save to complete.
The number of milliseconds to wait, or (-1) to wait indefinitely.
Handles serialization of file to disk; virtual method allows customization (e.g., pre-save encryption and/or data merge).
used to serialize data.
File data to be serialized.
Consumers overriding this method should not directly call property to avoid potential dead-locks.
Handles deserialization of file from disk; virtual method allows customization (e.g., pre-load decryption and/or data merge).
used to deserialize data.
Deserialized file data.
Consumers overriding this method should not directly call property to avoid potential dead-locks.
Synchronously writes file data when no reads are active.
Synchronously reads file data when no writes are active.
Initiates a retry for specified event type.
Exception causing retry.
Event type to retry.
Retries specified serialize or deserialize event in case of file I/O failures.
Reload file upon external modification.
The object that triggered the event.
An object which provides data for directory events.
Contains classes used for input/output functionality.
Represents an outage as a start time and an end time.
Creates a new with the same start and end time as the given range.
Creates a new with the specified start and end time.
Start time for outage.
End time for outage.
Determines if this equals another object.
The object to be compared.
True if the objects are equal; false otherwise.
Determines if this equals another outage.
The outage to be compared.
True if the outages are equal; false otherwise.
Gets the hash code for this .
The hash code for the outage.
Merges all consecutive groups of overlapping ranges in a
collection and returns the resulting collection of outages.
The collection of outages.
The collection of merged outages.
This method does not preserve the order of the source collection.
Represents a persisted log of outages as a list of start and stop times.
This class serializes a list of outages (e.g., a connection outage or data loss) where each outage
consists of a start and end time. The outages are persisted in a log file so that the log can be
operated on even through host application restarts until the outages are processed.
All members in the are guaranteed to be thread safe. File locks are used to
provide synchronization so that the file can stay up-to-date with changes made in the application.
Date-time format used by .
Event is raised when the outage log is modified.
Event is raised when there is an exception encountered while processing outage log.
is the exception that was thrown.
Raised after the outage log has been properly disposed.
Creates a new .
Releases the unmanaged resources before the object is reclaimed by .
Gets or sets the file name for the outage log; file name can be set with a relative path.
Gets the full list of outages in the log.
Gets the number of outages in the log.
Gets the current status details about .
Gets a flag that indicates whether the object has been disposed.
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Initialize the outage log.
Initialization performs initial outage log read.
It is important to separate initialization from construction such that consumer can attach to events before class
is initialized in case initialization causes events to be raised.
Adds an outage to the .
Start time of outage.
End time of outage.
Adds an outage to the .
Outage to be added.
Gets the first outage in the list of outages.
The first outage, or null if there are no outages.
Removes the given outage from the outage log.
The outage to be removed from the outage log.
True if the outage was removed; false otherwise.
Represents a thread-safe processor that will operate on each with a consumer provided function on independent threads.
Creates a using a pre-initialized .
Pre-initialized to process.
A delegate that defines a processing function for an .
A delegate that determines if an can currently be processed.
Delegate to handle any exceptions encountered while processing as .
Processing interval, in milliseconds.
Releases the unmanaged resources before the object is reclaimed by .
Enables or disables the .
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Defines a base class that represents binary images for parsing or generation in terms of a header, body and footer.
Gets the length of the object.
This property is not typically overridden since it is the sum of the header, body and footer lengths.
Gets the length of the header portion of the object.
This property is typically overridden by a specific protocol implementation.
Gets the length of the body portion of the object.
This property is typically overridden by a specific protocol implementation.
Gets the length of the footer portion of the object.
This property is typically overridden by a specific protocol implementation.
Initializes object by parsing the specified containing a binary image.
Buffer containing binary image to parse.
0-based starting index in the to start parsing.
Valid number of bytes within from .
The number of bytes used for initialization in the (i.e., the number of bytes parsed).
is null.
or is less than 0 -or-
and will exceed length.
This method is not typically overridden since it is parses the header, body and footer images in sequence.
Parses the binary header image.
Buffer containing binary image to parse.
0-based starting index in the to start parsing.
Valid number of bytes within from .
The number of bytes used for initialization in the (i.e., the number of bytes parsed).
This method is typically overridden by a specific protocol implementation.
Parses the binary body image.
Buffer containing binary image to parse.
0-based starting index in the to start parsing.
Valid number of bytes within from .
The number of bytes used for initialization in the (i.e., the number of bytes parsed).
This method is typically overridden by a specific protocol implementation.
Parses the binary footer image.
Buffer containing binary image to parse.
0-based starting index in the to start parsing.
Valid number of bytes within from .
The number of bytes used for initialization in the (i.e., the number of bytes parsed).
This method is typically overridden by a specific protocol implementation.
Generates binary image of the object and copies it into the given buffer, for bytes.
Buffer used to hold generated binary image of the source object.
0-based starting index in the to start writing.
The number of bytes written to the .
is null.
or is less than 0 -or-
and will exceed length.
This property is not typically overridden since it is the generates the combination of the header, body and footer images.
Generates the binary header image and copies it into the given buffer, for bytes.
Buffer used to hold generated binary image of the source object.
0-based starting index in the to start writing.
The number of bytes written to the .
This method is typically overridden by a specific protocol implementation.
Generates the binary body image and copies it into the given buffer, for bytes.
Buffer used to hold generated binary image of the source object.
0-based starting index in the to start writing.
The number of bytes written to the .
This method is typically overridden by a specific protocol implementation.
Generates the binary footer image and copies it into the given buffer, for bytes.
Buffer used to hold generated binary image of the source object.
0-based starting index in the to start writing.
The number of bytes written to the .
This method is typically overridden by a specific protocol implementation.
This class defines the fundamental functionality for parsing any stream of binary data.
This parser is designed as a write-only stream such that data can come from any source.
Specifies the default value for the property.
Occurs when data image fails deserialized due to an exception.
is the remaining portion of the binary image that failed to parse.
Occurs when an is encountered while attempting to parse data.
is the encountered while parsing data.
Occurs when buffer parsing has completed.
Tracks if data stream has been initialized.
Only relevant if is true.
Remaining unparsed buffer from last parsing execution, if any.
Creates a new instance of the class.
Gets or sets a boolean value that indicates whether the data parser is currently enabled.
Setting to true will start the if it is not started,
setting to false will stop the if it is started.
Gets flag that determines if this protocol parsing implementation uses synchronization bytes.
Gets or sets synchronization bytes for this parsing implementation, if used.
Gets the total amount of time, in seconds, that the has been active.
Gets the total number of buffer images processed so far.
Total number of buffer images processed so far.
Gets a value indicating whether the current stream supports reading.
The is implemented as a WriteOnly stream, so this defaults to false.
Gets a value indicating whether the current stream supports seeking.
The is implemented as a WriteOnly stream, so this defaults to false.
Gets a value indicating whether the current stream supports writing.
The is implemented as a WriteOnly stream, so this defaults to true.
Gets current status of .
Gets the name of .
Start the streaming data parser.
Stops the streaming data parser.
Parses the object implementing the interface.
Object to be parsed that implements the interface.
This function takes the binary image from and writes the buffer to the stream for parsing.
Writes a sequence of bytes onto the stream for parsing.
An array of bytes. This method copies count bytes from buffer to the current stream.
The zero-based byte offset in buffer at which to begin copying bytes to the current stream.
The number of bytes to be written to the current stream.
When overridden in a derived class, clears all buffers for this stream and causes any buffered data
to be written to the underlying device.
The parser is designed as a write only stream, so this method is not implemented.
Cannot read from WriteOnly stream.
Array of s.
An value for the offset.
An value for the count.
An as the number of bytes read. Well. It would, if implemented.
The parser is designed as a write only stream, so this method is not implemented.
WriteOnly stream has no position.
A value for the offset.
A .
Returns a value indicating the point that was sought.
The parser is designed as a write only stream, so this method is not implemented.
WriteOnly stream has no length.
A value.
The parser is designed as a write only stream, so this method is not implemented.
WriteOnly stream has no length. Returned value will always be -1.
The parser is designed as a write only stream, so this method is not implemented.
WriteOnly stream has no position. Returned value will always be -1 and any assigned value will be ignored.
Protocol specific frame parsing algorithm.
Buffer containing data to parse.
Offset index into buffer that represents where to start parsing.
Maximum length of valid data from offset.
The length of the data that was parsed.
Implementers can choose to focus on parsing a single frame in the buffer even if there are other frames available in the buffer.
Base class will continue to move through buffer on behalf of derived class until all the buffer has been processed. Just return
the total amount of data was parsed and the remaining unparsed will be prepended to next received buffer.
Derived implementations should return an integer value that represents the length of the data that was parsed, and zero if not
enough data was able to be parsed. Note that exceptions are expensive when parsing fast moving streaming data and a good coding
practice for implementations of this method will be to not throw an exception when there is not enough data to parse the data,
instead check the property to verify there is enough buffer data to represent the desired image. If
there is not enough data to represent the image return zero and base class will prepend buffer onto next incoming set of data.
Because of the expense incurred when an exception is thrown, any exceptions encountered in the derived implementations of this method
will cause the current data buffer to be discarded and a event to be raised. Doing this prevents
exceptions from being thrown repeatedly for the same data. If your code implementation recognizes a malformed image, you can raise
a custom event to indicate this instead of throwing as exception and keep moving through the buffer as an optimization.
Raises the event.
Source buffer that contains output that failed to parse.
Raises the event.
The that was encountered during parsing.
Raises the event.
Represents a boolean expression that can be parsed and executed at runtime.
Binary operators have the same level of precedence and are evaluated from right to left.
Represents a variable that can be tweaked at runtime.
The identifier used to refer to the variable.
The value of the variable.
Creates a new instance of the class.
The identifier used to refer to the variable.
Creates a new instance of the class.
The expression text to be parsed as a boolean expression.
The default comparer for identifiers is .
Creates a new instance of the class.
The expression text to be parsed as a boolean expression.
Comparer used to compare identifiers.
Gets the list of variables found while parsing the boolean expression.
Gets the variable identified by the given identifier.
The identifier used to refer to the variable.
The variable identified by the given identifier.
Evaluates the expression using the
current values of the variables.
The result of the evaluation.
Attempts to get the variable identified by the given identifier.
The identifier used to refer to the variable.
The variable identified by the given identifier.
True if the variable is present in the expression; false otherwise.
This interface represents the protocol independent representation of a streaming data parser.
Occurs when data image fails deserialization due to an exception.
is the remaining portion of the binary image that failed to parse.
Occurs when an is encountered while attempting to parse data.
is the encountered while parsing data.
Start the streaming data parser.
Stops the streaming data parser.
Gets or sets a boolean value that indicates whether the data parser is currently enabled.
Gets the total number of buffer images processed so far.
Writes a sequence of bytes onto the stream for parsing.
An array of bytes. This method copies count bytes from buffer to the current stream.
The zero-based byte offset in buffer at which to begin copying bytes to the current stream.
The number of bytes to be written to the current stream.
Specifies that an object can support production or consumption of a binary image that represents the object.
Gets the length of the binary image.
Generates binary image of the object and copies it into the given buffer, for bytes.
Buffer used to hold generated binary image of the source object.
0-based starting index in the to start writing.
The number of bytes written to the .
Implementers should validate and against length.
The method can be used to perform this validation.
Initializes object by parsing the specified containing a binary image.
Buffer containing binary image to parse.
0-based starting index in the to start parsing.
Valid number of bytes within to read from .
The number of bytes used for initialization in the (i.e., the number of bytes parsed).
Implementers should validate and against length.
The method can be used to perform this validation.
Defines extension functions related to implementations.
Returns a binary image of an object that implements .
source.
Clears any rented buffers of their contents so that a subsequent consumer will not
see the previous consumer's content. If false, default, the array's contents
are left unchanged.
A binary image of an object that implements .
cannot be null.
This is a convenience method. It is often optimal to use
directly using a common buffer instead of always allocating new buffers.
Asynchronously returns a binary image of an object that implements .
The source from which the binary image is generated.
Clears any rented buffers of their contents so that a subsequent consumer will not
see the previous consumer's content. If false, default, the array's contents
are left unchanged.
A token to monitor for cancellation requests.
A task that represents the asynchronous operation. The task result contains the binary image of the object.
Thrown when is null.
This method provides an asynchronous alternative to . It is often optimal to use
directly with a common buffer instead of always
allocating new buffers.
Copies the binary image of the specified to the provided .
The source object implementing whose binary image will be copied.
The to which the binary image will be written.
Clears any rented buffers of their contents so that a subsequent consumer will not
see the previous consumer's content. If false, default, the array's contents
are left unchanged.
Thrown if or is null.
Asynchronously copies the binary image of an object that implements to the specified .
The source whose binary image will be copied.
The to which the binary image will be written.
Clears any rented buffers of their contents so that a subsequent consumer will not
see the previous consumer's content. If false, default, the array's contents
are left unchanged.
A token to monitor for cancellation requests.
A task that represents the asynchronous operation.
Thrown if or is null.
This method uses a buffer rented from a shared to optimize memory usage.
The buffer is returned to the pool after the operation completes.
Parses a binary image from the specified into an object that implements .
The instance into which the binary image will be parsed.
The from which the binary image will be read.
Clears any rented buffers of their contents so that a subsequent consumer will not
see the previous consumer's content. If false, default, the array's contents
are left unchanged.
The number of bytes successfully read and parsed from the stream.
Thrown if or is null.
This method reads a binary image from the provided and parses it into the specified
instance. It uses a shared buffer pool to minimize memory allocations.
Asynchronously parses a binary image from the specified into an object that implements .
The instance into which the binary image will be parsed.
The from which the binary image will be read.
Specifies whether the method should read exactly the number of bytes required to
fill the binary image. If true, the method will ensure the exact number of
bytes is read; otherwise, it reads as many bytes as are available.
Clears any rented buffers of their contents so that a subsequent consumer will not
see the previous consumer's content. If false, default, the array's contents
are left unchanged.
A token to monitor for cancellation requests.
A task that represents the asynchronous operation. The task result contains the number of bytes successfully parsed.
Thrown if or is null.
Thrown if the operation is canceled via the .
This method uses a buffer rented from a shared to read the binary image.
The buffer is returned to the pool after the operation completes.
Span-optimized binary image production/consumption with buffered I/O helpers.
Optional companion to ; most callers only need to
implement the two span methods. Everything else has sensible defaults.
Writes this object's binary image to .
The number of bytes written.
Parses this object's state from .
The number of bytes consumed.
Determines how many bytes are required to parse this instance from the given sequence.
Default assumes fixed-size and returns .
Override for variable-length formats (peek a header, etc.).
Attempts to write this object's binary image to the specified span.
The span to which the binary image will be written.
When this method returns, contains the number of bytes written to .
true if the binary image was successfully written to ;
otherwise, false if the span is too small.
Attempts to parse this object's state from the specified span.
The span from which the binary image will be parsed.
When this method returns, contains the number of bytes consumed from
if the parsing was successful; otherwise, 0.
true if the binary image was successfully parsed from ;
otherwise, false if the span is too small.
Writes this object's binary image to the specified .
The to which the binary image will be written.
Thrown when is null.
Thrown when the number of bytes written exceeds the available buffer space.
Parses from a and returns bytes consumed.
The source sequence from which to parse.
Clears any rented buffers of their contents so that a subsequent consumer will not
see the previous consumer's content. If false, default, the array's contents
are left unchanged.
Default: fixed-size fast paths, pooled copy only when necessary.
Override for variable-length formats to avoid copies entirely.
Parses from a streaming reader; advances by bytes consumed.
Implemented in terms of .
Contains classes used to simplify, standardize and automate any kind of IO based parsing operation.
Like the Excel CSV Parser, only better.
Returns the string that is between two delimiter strings beginning the first startDelimiter found.
ALSO, returns the index of the payload (the index of the first char past the startDelimiter)
The input string
The beginning token or delimiter
The ending token or delimiter
The index on which to begin searching inString
set to FALSE for case insensitive test for delimiters
set to TRUE for the return string to include the opening and closing tokens.
A string, and the string starting index (payload Index)
Returns an array indices where the token char was found. Null for no tokens found.
The string to process
The token string sought
The index from which to begin searching inString
Set to FALSE for case insensitive search
Returns an array of indices where the token string was found
The string to process
The token string sought
The index from which to begin searching inString
Set to FALSE for case insensitive search
null for no tokens found
Returns an array of the indices where the token chars were found. Null for no tokens found.
The string to process
The char array of the tokens
The index from which to begin searching inString
Set to FALSE for case insensitive search
Finds the index of the "n" occurrence of a character (a token) within a string
The string to process.
The token character sought
The index from which to begin searching inString
The occurrence sought
Set to FALSE for case insensitive search
Returns the starting index of the nth occurrence of a character.
Returns -1 if nth occurrence does not exist.
Finds the index of the "n" occurrence of one string (a token) within another
The string to process.
The string to find
The index from which to begin searching inString
The occurrence of the token sought
Set to FALSE for case insensitive search
Returns the starting index of the nth occurrence of a string.
Returns -1 if nth occurrence does not exist.
Finds the index of the "n" occurrence any one of the chars in the token array within a string
The string to process.
The token characters sought
The index from which to begin searching inString
Set to FALSE for case insensitive search
Returns the starting index of the nth occurrence of a character.
Returns -1 if nth occurrence does not exist.
Processing from RIGHT to LEFT, finds the index of the "n" occurrence of a character (a token) within a string
The string to process.
The token character sought
Default of zero (0) begins testing end of inString, otherwise
The index from with to begin processing inString from RIGHT to LEFT
The occurrence sought
Set to FALSE for case insensitive search
Returns the starting index of the nth occurrence of a character.
Returns -1 if nth occurrence does not exist.
Processing from RIGHT to LEFT, finds the index of the "n"occurrence of one string (a token) within a string
The string to process.
The token string sought
Default of zero (0) begins testing end of inString, otherwise
The index from with to begin processing inString from RIGHT to LEFT
The occurrence sought
Set to FALSE for case insensitive search
Returns the starting index of the nth occurrence of a string.
Returns -1 if nth occurrence does not exist.
Looks to the RIGHT for the first open token and returns the matching close token
The string to process
The index from with to begin processing inString
Set to FALSE for case insensitive search
Looks to the RIGHT for the first open token and returns the matching close token
The string to process
The index from with to begin processing inString
Set to FALSE for case insensitive search
Parses a line based on a comma as the separator. Commas wrapped in matched double quotes are not separators.
Matched double quotes are normally removed prior to field return. Fields are NOT trimmed of white spaces prior to return.
The string to parse.
The index in the line from which to start parsing.
Set to TRUE to unwrap quotes in returned array vis-a-vis Excel.
An array of the parsed strings (the fields within the line)
The string.split method is about 4 times faster.
Parses a line based on a collection of quote and delimiter characters,
The string to parse
An array of characters to be used as the framing within fields or the "quote" characters. Quotes must matched.
Set to null to disable (split line at delimiter regardless of quotes).
An array of characters to be used as delimiter characters. These characters have equal weight in breaking up the line.
The index in the line from which to start parsing.
Set to TRUE to unwrap quotes in returned array vis-a-vis Excel.
An array of the parsed strings
The string.split method is about 12 times faster.
Parses strings and validates they match expected type codes.
the returned values from the try parse.
TRUE if all values parse successfully.
Validates that expected field names match field names found.
The string array of expected field names.
The string array of actual field names.
Set to TRUE to require case to match.
The number of fields to check. Less than 1 sets length to expectedFieldName length
The index to use to start matching test.
Finds the index of the first matching (or containing) field name
the field name to find
the string array of fields
set to FALSE for case insensitive tests
Set to TRUE to find index that CONTAINS the fileNameValueSought
Represents a persisted run-time log that tracks last start, stop and running times.
Date-time format used by .
Log file key name for last start time used by .
Log file key name for last stop time used by .
Log file key name for last running time used by .
Event is raised when there is an exception encountered while processing run-time log.
is the exception that was thrown.
Raised after the run-time log has been properly disposed.
Creates a new run-time log.
Releases the unmanaged resources before the object is reclaimed by .
Gets or sets the file name for the run-time log; file name can be set with a relative path.
Gets last known start-time.
Gets last known stop-time.
Gets last known running-time (10-second resolution).
Gets the up-time calculation for run-time log, i.e., - (10-second resolution).
Gets or sets a boolean value that indicates whether the run-time log is enabled.
This property controls the automatic write log timer.
Gets a flag that indicates whether the object has been disposed.
Gets the current status details about .
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Initialize the run-time log.
Initialization performs initial run-time log read, establishes new start time and enables automatic write log timer.
Last logged stop time will be validated against last logged running time. If the last logged running time is later
than the last logged stop time, the stop time will be set to the running time with the assumption that the log file
was not properly shut down (e.g., due to abnormal host termination).
It is important to separate initialization from construction such that consumer can attach to events before class
is initialized in case initialization causes events to be raised.
Reads the run-time log.
Writes the run-time log - times are in a human-readable format.
Raises event.
Processing .
Represents a wrapper around the native .NET that avoids problems with
dangling references when using a file watcher instance as a class member that never gets disposed.
The design goal of the SafeFileWatcher is to avoid accidental memory leaks caused by use of .NET's native
file system watcher when used as a member of a class that consumers fail to properly dispose. If a class
has a reference to a file watcher as a member variable and attaches to the file watcher's events, the
file watcher will maintain a reference the parent class so it can call its event handler. If the parent
class is not disposed properly, the file watcher will thus not be disposed and will maintain the
reference to the parent class - the garbage collector will never collect the parent because it has a
valid reference and no collection means the parent finalizer will never get called and the file system
watcher will never get disposed. Creating multiple instances of parent class and not disposing of them
will cause a memory leak even with a properly designed disposable pattern. Using the SafeFileWatcher
instead of directly using the FileSystemWatcher will resolve this potential issue.
Note that component model implementation is not fully replicated - if you are using a file system watcher
on a design surface, this safety wrapper will usually not be needed. This class has benefit when a class
will dynamically use a file watcher and needs to make sure any unmanaged resources get properly released
even if a consumer neglects to call the dispose function.
Occurs when a file or directory in the specified is changed.
Occurs when a file or directory in the specified is created.
Occurs when a file or directory in the specified is deleted.
Occurs when a file or directory in the specified is renamed.
Occurs when the internal buffer overflows.
Initializes a new instance of the class.
Initializes a new instance of the class, given the specified directory to monitor.
The directory to monitor, in standard or Universal Naming Convention (UNC) notation.
The parameter is null.
The parameter is an empty string (""). -or-
The path specified through the parameter does not exist.
Initializes a new instance of the class, given the specified directory and type of files to monitor.
The directory to monitor, in standard or Universal Naming Convention (UNC) notation.
The type of files to watch. For example, "*.txt" watches for changes to all text files.
The parameter is null. -or-
The parameter is null.
The parameter is an empty string (""). -or-
The path specified through the parameter does not exist.
Terminates instance making sure to release unmanaged resources.
Gets or sets the path of the directory to watch.
The path to monitor. The default is an empty string ("").
The specified path does not exist or could not be found. -or-
The specified path contains wildcard characters. -or-
The specified path contains invalid path characters.
Gets or sets the filter string used to determine what files are monitored in a directory.
The filter string. The default is "*.*" (Watches all files.)
Gets or sets the type of changes to watch for.
One of the values. The default is the bitwise OR combination of LastWrite, FileName, and DirectoryName.
The value is not a valid bitwise OR combination of the values.
The value that is being set is not valid.
Gets or sets a value indicating whether the component is enabled.
true if the component is enabled; otherwise, false. The default is false. If you are using the component on a designer in Visual Studio 2005, the default is true.
The object has been disposed.
The current operating system is not Microsoft Windows NT or later.
The directory specified in could not be found.
has not been set or is invalid.
Gets or sets a value indicating whether subdirectories within the specified path should be monitored.
true if you want to monitor subdirectories; otherwise, false. The default is false.
Gets or sets the size of the internal buffer.
The internal buffer size. The default is 8192 (8K).
Gets or sets the object used to marshal the event handler calls issued as a result of a directory change.
The that represents the object used to marshal the event handler calls issued as a result of a directory change. The default is null.
Gets or sets an for the .
An for the .
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
A synchronous method that returns a structure that contains specific information on the change that occurred, given the type of change you want to monitor.
A that contains specific information on the change that occurred.
The to watch for.
A synchronous method that returns a structure that contains specific information on the change that occurred, given the type of change you want to monitor and the time (in milliseconds) to wait before timing out.
A that contains specific information on the change that occurred.
The to watch for.
The time (in milliseconds) to wait before timing out.
Begins the initialization of a used on a form or used by another component. The initialization occurs at run time.
Ends the initialization of a used on a form or used by another component. The initialization occurs at run time.
Contains extension methods for values.
Defines extension functions related to manipulation.
Writes the contents of a stream to the provided stream.
the destination stream.
the source stream
the number of bytes to copy. If the source is not long enough,
and end of stream exception will be thrown.
A buffer to use to copy the data from one stream to another.
This keeps the function from always allocating a new buffer for the copy
Reads entire contents, and returns array of data.
The to be converted to array.
An array of .
Encodes an object on a stream.
Destination stream.
Object to encode.
Reads an object from a stream.
Source stream.
Decoded object.
Writes the supplied to
in little endian format.
the stream to write to
the value to write
Read a byte from the stream.
Will throw an exception if the end of the stream has been reached.
the stream to read from.
Value read.
Reads the value from the stream in little endian format.
the stream to read from.
Value read.
Writes the supplied to
in little endian format.
the stream to write to
the value to write
Writes the supplied to
in little endian format.
the stream to write to
the value to write
Reads the value from the stream in little endian format.
the stream to read from.
Value read.
Writes the supplied to
in little endian format.
the stream to write to
the value to write
Writes the supplied to
in little endian format.
the stream to write to
the value to write
Writes the supplied to
in little endian format.
the stream to write to
the value to write
Reads the value from the stream in little endian format.
the stream to read from.
Value read.
Reads the value from the stream in little endian format.
the stream to read from.
Value read.
Reads the value from the stream in little endian format.
the stream to read from.
Value read.
Writes the supplied to
in little endian format.
the stream to write to
the value to write
Writes the supplied to
in little endian format.
the stream to write to
the value to write
Writes the supplied to
in little endian format.
the stream to write to
the value to write
Reads the value from the stream in little endian format.
the stream to read from.
Value read.
Reads the value from the stream in little endian format.
the stream to read from.
Value read.
Reads the value from the stream in little endian format.
the stream to read from.
Value read.
Writes the supplied to
in little endian format.
the stream to write to
the value to write
Writes the supplied to
in little endian format.
the stream to write to
the value to write
Writes the supplied to
in little endian format.
the stream to write to
the value to write
Writes the supplied to
in little endian format.
the stream to write to
the value to write
Reads the value from the stream in little endian format.
the stream to read from.
Value read.
Reads the value from the stream in little endian format.
the stream to read from.
Value read.
Reads the value from the stream in little endian format.
the stream to read from.
Value read.
Reads the value from the stream in little endian format.
the stream to read from.
Value read.
Writes the supplied string to a in UTF8 encoding.
Source stream.
Value to write.
Writes a guid in little endian bytes to the stream
Source stream.
Value to write.
Reads a decimal from the stream in Little Endian bytes.
the stream to read the decimal from.
the decimal value
Reads a Guid from the stream in Little Endian bytes.
the stream to read the guid from.
the guid value
Writes the entire buffer to the
the stream to write to
the value to write
Writes the supplied to
along with prefixing the length
so it can be properly read as a unit.
the stream to write to
the value to write
Reads a byte array from a .
The number of bytes should be prefixed in the stream.
the stream to read from
A new array containing the bytes.
Reads a byte array from a .
The number of bytes should be prefixed in the stream.
the stream to read from
gets the number of bytes to read.
A new array containing the bytes.
Reads all of the provided bytes. Will not return prematurely,
but continue to execute a command until the entire
has been read.
The stream to read from
The buffer to write to
the start position in the
the number of bytes to read
occurs if the end of the stream has been reached.
Writes the supplied string to a in UTF8 encoding.
Source stream.
Value to write.
Writes the supplied Collection to a .
Source stream.
Collection to write.
Writes the supplied Collection to a .
Source stream.
Collection to write.
Writes the supplied string to a
in UTF8 encoding with a prefix if the value is null
Source stream.
Value to write.
Reads the 7-bit encoded value from the stream.
Source stream.
Value read.
Reads a string from a that was encoded in UTF8.
Source stream.
Value read.
Reads a string from a that was encoded in UTF8.
Value can be null and is prefixed with a boolean.
Source stream.
Value read.
Writes the supplied string to a in UTF8 encoding.
Source stream.
Strings read.
Writes the supplied string to a in UTF8 encoding.
Source stream.
Integers read.
Defines an interface for any object to allow it to provide a name and status
that can be displayed for informational purposes.
Gets the name of the object providing status information.
Gets the current status details about object providing status information.
Specifies that this object provides support for performing tasks during the key stages of object life-cycle.
Life-cycle Stage
Equivalent Member
-
Birth
-
Life (Work/Sleep)
-
Death
Raised after the source object has been properly disposed.
Initializes the state of the object.
Typical implementation of should allow the object state to be initialized only
once. should be called automatically from one or more key entry points of the
object. For example, if the object is a and it implements
the interface then should
be called from the method so that the object
gets initialized automatically when consumed through the IDE designer surface. In addition to this
should also be called from key or mandatory methods of the object, like 'Start()'
or 'Connect()', so that the object gets initialized even when not consumed through the IDE designer surface.
Gets or sets a boolean value that indicates whether the object is enabled.
Typical implementation of should suspend the internal processing when the object is
disabled and resume processing when the object is enabled.
Gets a flag that indicates whether the object has been disposed.
Defines extension methods for JArray.
Rebuilds original array so that items from originalArray are replaced by any same‑key items in the override array
Defines library-level static events.
The class automatically attaches to the event so that
any unobserved task exceptions encountered will be marked as observed and exposed via the event.
To disable this feature and only use custom event handling, call the
method during program initialization.
Enables automatic handling of events. When enabled, any unobserved
task exceptions encountered are marked as observed and exposed via the event.
This functionality is enabled by default. This method would only ever need to be called to re-enable unobserved
task exception handling after being disabled by a call to .
Disables automatic handling of events. When disabled, any unobserved
task exceptions encountered will not be marked as observed nor exposed via the event.
Exposes exceptions that were suppressed but otherwise unhandled.
End users should attach to this event so that suppressed exceptions can be exposed to a log.
The class automatically attaches to the event so that
any unobserved task exceptions encountered will be marked as observed and exposed via the event.
To disable this feature and only use custom event handling, call the
method during program initialization.
Gemstone libraries only raise this event, no library functions attach to this end user-only event.
Defines a set of little-endian byte order interoperability functions.
This class is setup to support aggressive in-lining of little endian conversions. Bounds
will not be checked as part of this function call, if bounds are violated, the exception
will be thrown at the level.
Returns a value converted from one byte at a specified position in a byte array.
An array of bytes.
true if the byte at startIndex in value is nonzero; otherwise, false.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a Unicode character converted from two bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A character formed by two bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a double-precision floating point number converted from eight bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A double-precision floating point number formed by eight bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 16-bit signed integer converted from two bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A 16-bit signed integer formed by two bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 32-bit signed integer converted from four bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A 32-bit signed integer formed by four bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 64-bit signed integer converted from eight bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A 64-bit signed integer formed by eight bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a single-precision floating point number converted from four bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A single-precision floating point number formed by four bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 16-bit unsigned integer converted from two bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A 16-bit unsigned integer formed by two bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 32-bit unsigned integer converted from four bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A 32-bit unsigned integer formed by four bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 64-bit unsigned integer converted from eight bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A 64-bit unsigned integer formed by eight bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 128-bit decimal converted from 16 bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
A 128-bit decimal formed by 16 bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a value converted from one byte at a specified position in a byte array.
An array of bytes.
The starting position within value.
true if the byte at startIndex in value is nonzero; otherwise, false.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a Unicode character converted from two bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A character formed by two bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a double-precision floating point number converted from eight bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A double-precision floating point number formed by eight bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 16-bit signed integer converted from two bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 16-bit signed integer formed by two bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 32-bit signed integer converted from four bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 32-bit signed integer formed by four bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 64-bit signed integer converted from eight bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 64-bit signed integer formed by eight bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a single-precision floating point number converted from four bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A single-precision floating point number formed by four bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 16-bit unsigned integer converted from two bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 16-bit unsigned integer formed by two bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 32-bit unsigned integer converted from four bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 32-bit unsigned integer formed by four bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 64-bit unsigned integer converted from eight bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 64-bit unsigned integer formed by eight bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns a 128-bit decimal converted from 16 bytes, accounting for target endian-order, at a specified position in a byte array.
An array of bytes (i.e., buffer containing binary image of value).
The starting position within value.
A 128-bit decimal formed by 16 bytes beginning at startIndex.
value is null.
startIndex is less than zero or greater than the length of value minus 1.
Returns the specified value as an array of bytes in the target endian-order.
The value to convert.
An array of bytes with length 1.
Native value type to get bytes for.
type is not primitive.
Cannot get bytes for type.
Returns the specified value as an array of bytes in the target endian-order.
The value to convert.
An array of bytes with length 1.
Returns the specified Unicode character value as an array of bytes in the target endian-order.
The Unicode character value to convert.
An array of bytes with length 2.
Returns the specified double-precision floating point value as an array of bytes in the target endian-order.
The number to convert.
An array of bytes with length 8.
Returns the specified 16-bit signed integer value as an array of bytes.
The number to convert.
An array of bytes with length 2.
Returns the specified 32-bit signed integer value as an array of bytes.
The number to convert.
An array of bytes with length 4.
Returns the specified 64-bit signed integer value as an array of bytes.
The number to convert.
An array of bytes with length 8.
Returns the specified single-precision floating point value as an array of bytes in the target endian-order.
The number to convert.
An array of bytes with length 4.
Returns the specified 16-bit unsigned integer value as an array of bytes.
The number to convert.
An array of bytes with length 2.
Returns the specified 32-bit unsigned integer value as an array of bytes.
The number to convert.
An array of bytes with length 4.
Returns the specified 64-bit unsigned integer value as an array of bytes.
The number to convert.
An array of bytes with length 8.
Returns the specified 128-bit decimal value as an array of bytes.
The number to convert.
An array of bytes with length 16.
Copies the specified primitive type value as an array of bytes in the target endian-order to the destination array.
The value to convert and copy.
The destination buffer.
The byte offset into .
Native value type to get bytes for.
type is not primitive.
Cannot get bytes for type.
Length of bytes copied into array based on size of .
Copies the specified value as an array of 1 byte in the target endian-order to the destination array.
The value to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified Unicode character value as an array of 2 bytes in the target endian-order to the destination array.
The Unicode character value to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified double-precision floating point value as an array of 8 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 16-bit signed integer value as an array of 2 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 32-bit signed integer value as an array of 4 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 64-bit signed integer value as an array of 8 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified single-precision floating point value as an array of 4 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 16-bit unsigned integer value as an array of 2 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 32-bit unsigned integer value as an array of 4 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 64-bit unsigned integer value as an array of 8 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified 128-bit decimal value as an array of 16 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
The byte offset into .
Length of bytes copied into array based on size of .
Copies the specified primitive type value as an array of bytes in the target endian-order to the destination array.
The value to convert and copy.
The destination buffer.
Native value type to get bytes for.
type is not primitive.
Cannot get bytes for type.
Length of bytes copied into array based on size of .
Copies the specified value as an array of 1 byte in the target endian-order to the destination array.
The value to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified Unicode character value as an array of 2 bytes in the target endian-order to the destination array.
The Unicode character value to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified double-precision floating point value as an array of 8 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified 16-bit signed integer value as an array of 2 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified 32-bit signed integer value as an array of 4 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified 64-bit signed integer value as an array of 8 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified single-precision floating point value as an array of 4 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified 16-bit unsigned integer value as an array of 2 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified 32-bit unsigned integer value as an array of 4 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified 64-bit unsigned integer value as an array of 8 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
Copies the specified 128-bit decimal value as an array of 16 bytes in the target endian-order to the destination array.
The number to convert and copy.
The destination buffer.
Length of bytes copied into array based on size of .
The namespace organizes all common Gemstone library functionality.
The root namespace also includes classes, e.g.,
, , and .
Defines helper functions for handling URLs.
Determines if the string contains a valid URL.
The string to check for a valid URL.
True if the URL is valid; otherwise false.
Opens the user's default browser to the given URL.
The URL to navigate to in the user's browser.
The input string is not a valid URL.
Navigation attempted on a platform other than Windows, Linux, or OSX.
The CertificateGenerator searches certificate stores for existing certificates and creates
self-signed certificates if no matching certificate exists in any accessible store.
It then generates a certificate file at the specified certificate path.
Creates a new instance of the class.
Gets or sets the name of the entity issuing the certificate.
Gets or sets the subject names (common names)
of the entity that this certificate identifies.
Gets or sets the path to the certificate file
that is generated by this certificate generator.
Gets or sets the number of years self-signed generated
certificates should be valid.
Defaults to 1.
Gets a list of detailed log messages
Generates the certificate.
The certificate that was generated by this certificate generator.
Exports the private key of the certificate that is currently in use to the given path,
encrypting the file with the given password.
The path to which the certificate will be exported.
The password used to encrypt the certificate file.
Imports the given certificate into the current user store and then exports the public key.
The file with the certificate and private key to be imported.
The password used to encrypt the certificate file with the private key.
Represents a set of flags to be checked when validating remote certificates.
Creates a new instance of the class.
Gets or sets the set of valid policy errors used when
validating remote certificates using this policy.
Gets or sets the set of valid chain flags used when
validating remote certificates using this policy.
Certificate checker that validates remote certificates based
on certificate policies associated with each certificate.
Creates a new instance of the class.
Gets the default certificate policy used to validate
certificates that do not have their own certificate policy.
Gets the reason why the remote certificate validation
failed, or null if certificate validation did not fail.
Trusts the given certificate, using the default policy for validation.
The certificate to be trusted.
Trusts the given certificate, using the given policy for validation.
The certificate to be trusted.
The policy by which to evaluate the certificate.
Removes the given certificate from the list of trusted certificates.
The certificate to be distrusted.
true if certificate was removed; otherwise, false.
Removes all certificates from the list of trusted certificates.
Verifies the remote certificate used for authentication.
An object that contains state information for this validation.
The certificate used to authenticate the remote party.
The chain of certificate authorities associated with the remote certificate.
One or more errors associated with the remote certificate.
A flag that determines whether the specified certificate is accepted for authentication.
Searches the list of trusted certificates for a certificate that matches the given remote certificate.
Remote certificate to search for.
Trusted X509 certificate, if found; otherwise, null.
Defines the interface for a generic X.509 certificate checker.
Gets the reason why the remote certificate validation
failed, or null if certificate validation did not fail.
Verifies the remote certificate used for authentication.
An object that contains state information for this validation.
The certificate used to authenticate the remote party.
The chain of certificate authorities associated with the remote certificate.
One or more errors associated with the remote certificate.
A flag that determines whether the specified certificate is accepted for authentication.
Contains classes used to simplify and standardize operations for network streams used for secure
communications between hosts.
Simple implementation of .
Creates a new instance of the class.
Gets the list of certificates on the system which are
considered trusted when validating remote certificates.
Gets or sets the set of invalid policy errors.
Gets or sets the set of invalid chain flags.
Gets the reason why the remote certificate validation
failed, or null if certificate validation did not fail.
Validates the given remote certificate to determine if the host is trusted.
Certificate of the remote host.
True if the remote certificate is trusted; false otherwise.
Verifies the remote certificate used for authentication.
An object that contains state information for this validation.
The certificate used to authenticate the remote party.
The chain of certificate authorities associated with the remote certificate.
One or more errors associated with the remote certificate.
A flag that determines whether the specified certificate is accepted for authentication.
Simple implementation of .
Creates a new instance of the class.
Gets or sets the set of invalid policy errors.
Gets or sets the set of invalid chain flags.
Gets the reason why the remote certificate validation
failed, or null if certificate validation did not fail.
Verifies the remote certificate used for authentication.
An object that contains state information for this validation.
The certificate used to authenticate the remote party.
The chain of certificate authorities associated with the remote certificate.
One or more errors associated with the remote certificate.
A flag that determines whether the specified certificate is accepted for authentication.
A wrapper class to the class that simplifies sending mail messages.
This example shows how to send an email message with attachment:
using System;
using Gemstone.Net.Smtp;
class Program
{
static void Main(string[] args)
{
Mail email = new Mail("sender@email.com", "recipient@email.com", "smtp.email.com");
email.Subject = "Test Message";
email.Body = "This is a test message.";
email.IsBodyHtml = true;
email.Attachments = @"c:\attachment.txt";
email.Send();
email.Dispose();
Console.ReadLine();
}
}
Default to be used if one is not specified.
Initializes a new instance of the class.
Initializes a new instance of the class.
The e-mail address of the message sender.
Initializes a new instance of the class.
The e-mail address of the message sender.
A comma-separated or semicolon-separated e-mail address list of the message recipients.
Initializes a new instance of the class.
The e-mail address of the message sender.
A comma-separated or semicolon-separated e-mail address list of the message recipients.
The name or IP address of the SMTP server to be used for sending the message.
Releases the unmanaged resources before the object is reclaimed by .
Gets or sets the e-mail address of the message sender.
Value being assigned is a null or empty string.
Gets or sets the comma-separated or semicolon-separated e-mail address list of the message recipients.
Value being assigned is a null or empty string.
Gets or sets the comma-separated or semicolon-separated e-mail address list of the message carbon copy (CC) recipients.
Gets or sets the comma-separated or semicolon-separated e-mail address list of the message blank carbon copy (BCC) recipients.
Gets or sets the subject of the message.
Gets or sets the body of the message.
Gets or sets the name or IP address of the SMTP server to be used for sending the message.
Value being assigned is a null or empty string.
Gets or sets the comma-separated or semicolon-separated list of file names to be attached to the message.
Gets or sets a boolean value that indicating whether the message is to be formatted as HTML.
Gets or sets the username used to authenticate to the SMTP server.
Gets or sets the password used to authenticate to the SMTP server.
Gets or sets the password used to authenticate to the SMTP server.
Gets or sets the flag that determines whether
to use SSL when communicating with the SMTP server.
Gets the object used for sending the message.
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Send the message with to the ,
and using the specified .
Sends a message.
The e-mail address of the message sender.
A comma-separated or semicolon-separated e-mail address list of the message recipients.
The subject of the message.
The body of the message.
true if the message body is to be formated as HTML; otherwise false.
The name or IP address of the SMTP server to be used for sending the message.
Sends a message.
The e-mail address of the message sender.
A comma-separated or semicolon-separated e-mail address list of the message recipients.
A comma-separated or semicolon-separated e-mail address list of the message carbon copy (CC) recipients.
A comma-separated or semicolon-separated e-mail address list of the message blank carbon copy (BCC) recipients.
The subject of the message.
The body of the message.
true if the message body is to be formated as HTML; otherwise false.
The name or IP address of the SMTP server to be used for sending the message.
Sends a message.
The e-mail address of the message sender.
A comma-separated or semicolon-separated e-mail address list of the message recipients.
The subject of the message.
The body of the message.
true if the message body is to be formated as HTML; otherwise false.
A comma-separated or semicolon-separated list of file names to be attached to the message.
The name or IP address of the SMTP server to be used for sending the message.
Sends a message.
The e-mail address of the message sender.
A comma-separated or semicolon-separated e-mail address list of the message recipients.
A comma-separated or semicolon-separated e-mail address list of the message carbon copy (CC) recipients.
A comma-separated or semicolon-separated e-mail address list of the message blank carbon copy (BCC) recipients.
The subject of the message.
The body of the message.
true if the message body is to be formated as HTML; otherwise false.
A comma-separated or semicolon-separated list of file names to be attached to the message.
The name or IP address of the SMTP server to be used for sending the message.
Sends a secure message.
The e-mail address of the message sender.
A comma-separated or semicolon-separated e-mail address list of the message recipients.
The subject of the message.
The body of the message.
true if the message body is to be formated as HTML; otherwise false.
The name or IP address of the SMTP server to be used for sending the message.
The username of the account used to authenticate to the SMTP server.
The password of the account used to authenticate to the SMTP server.
Sends a secure message.
The e-mail address of the message sender.
A comma-separated or semicolon-separated e-mail address list of the message recipients.
The subject of the message.
The body of the message.
true if the message body is to be formated as HTML; otherwise false.
The name or IP address of the SMTP server to be used for sending the message.
The username of the account used to authenticate to the SMTP server.
The password of the account used to authenticate to the SMTP server.
Sends a secure message.
The e-mail address of the message sender.
A comma-separated or semicolon-separated e-mail address list of the message recipients.
The subject of the message.
The body of the message.
true if the message body is to be formated as HTML; otherwise false.
The name or IP address of the SMTP server to be used for sending the message.
The username of the account used to authenticate to the SMTP server.
The password of the account used to authenticate to the SMTP server.
The flag that determines whether to use SSL when communicating with the SMTP server.
Sends a secure message.
The e-mail address of the message sender.
A comma-separated or semicolon-separated e-mail address list of the message recipients.
The subject of the message.
The body of the message.
true if the message body is to be formated as HTML; otherwise false.
The name or IP address of the SMTP server to be used for sending the message.
The username of the account used to authenticate to the SMTP server.
The password of the account used to authenticate to the SMTP server.
The flag that determines whether to use SSL when communicating with the SMTP server.
Contains classes used to simplify and standardize operations related to sending e-mail messages.
Represents a standard Network Time Protocol (NTP) time-tag.
As recommended by RFC-2030, all NTP timestamps earlier than 3h 14m 08s UTC on 20 January 1968
are reckoned from 6h 28m 16s UTC on 7 February 2036. This gives the
class a functioning range of 1968-01-20 03:14:08 to 2104-02-26 09:42:23.
Creates a new , given number of seconds since 1/1/1900.
Number of seconds since 1/1/1900.
Creates a new , given number of seconds and fractional seconds since 1/1/1900.
Number of seconds since 1/1/1900.
Number of fractional seconds, in whole picoseconds.
Creates a new , given 64-bit NTP timestamp.
NTP timestamp containing number of seconds since 1/1/1900 in high-word and fractional seconds in low-word.
Creates a new , given specified .
Timestamp in to create NTP time-tag from (minimum valid date is 1/1/1900).
This constructor will accept a parameter since is implicitly castable to a .
Creates a new from serialization parameters.
The with populated with data.
The source for this deserialization.
Gets 64-bit NTP timestamp.
Number of ticks since 1/1/1900.
NTP dates are measured as the number of seconds since 1/1/1900.
Number of ticks since 2/7/2036 at 6h 28m 16s UTC when MSB is set.
According to RFC-2030, NTP dates can also be measured as the number of seconds since 2/7/2036
at 6h 28m 16s UTC if MSB is set.
Gets proper NTP offset based on value, see RFC-2030.
Seconds value.
Proper NTP offset.
Gets proper NTP offset based on value, see RFC-2030.
timestamp value.
Proper NTP offset.
Gets proper NTP offset based on most significant byte on value, see RFC-2030.
NTP seconds timestamp value.
Proper NTP offset.
Gets 64-bit NTP timestamp given in .
Timestamp in .
Seconds in NTP from given .
A implementation that can have the object set to null.
Natively, setting to null will throw an ,
Creates a
the object to maintain the weak reference to. Cannot be null.
Gets an indication whether the object referenced by the current object has been cleared or garbage collected.
true if the object referenced by the current object has not been garbage collected or cleared
and is still accessible; otherwise, false.
Gets the object (the target) referenced by the current object.
Set will only accept null.
null if the object referenced by the current object has been garbage collected or cleared;
otherwise, a reference to the object referenced by the current object.
If setting this property to anything other than null
Sets to null so subsequent calls to returns null.
A serializable class that can be used to track the current and previous state of an object.
Type of the state to track.
Initializes a new instance of the class.
The text label for the object whose state is being tracked.
Initializes a new instance of the class.
The text label for the object whose state is being tracked.
The current state of the object.
Initializes a new instance of the class.
The text label for the object whose state is being tracked.
The current state of the object.
The previous state of the object.
Gets or sets a text label for the object whose state is being tracked.
The value being assigned is a null or empty string.
Gets or sets the current state of the object.
Gets or sets the previous state of the object.
Represents information about the system's multimedia timer capabilities.
Minimum supported period in milliseconds.
Maximum supported period in milliseconds.
Represents an exception that is thrown when a fails to start.
Initializes a new instance of the class.
The error message that explains the reason for the exception.
Represents a high-resolution timer and timestamp class.
For Windows deployments, implementation is based on the Windows multimedia timer. For other
deployments, e.g., POSIX, implementation uses a basic timer for compatibility - this should
have ~10ms of resolution when used on standard Linux systems.
Occurs when the has started.
Occurs when the has stopped.
Initializes a new instance of the class.
Releases the unmanaged resources before the object is reclaimed by .
Gets or sets the time between events, in milliseconds.
If the timer has already been disposed.
Gets or sets the resolution, in milliseconds.
If the timer has already been disposed.
The resolution is in milliseconds. The resolution increases with smaller values;
a resolution of 0 indicates periodic events should occur with the greatest possible
accuracy. To reduce system overhead, however, you should use the maximum value
appropriate for your application.
This property is currently ignored under Mono deployments.
Gets or sets a value indicating whether the should raise the
event each time the specified period elapses or only after the first
time it elapses.
truetrue if the should raise the
event each time the interval elapses; false if it should raise the event only once
after the first time the interval elapses. The default is true.
Gets a value indicating whether the is running.
Gets specified in used to pass into event.
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Starts the .
The timer has already been disposed.
The timer failed to start.
Starts the with the specified .
User defined event arguments to pass into raised event.
The timer has already been disposed.
The timer failed to start.
Stops .
If the timer has already been disposed.
Gets the system multimedia timer capabilities.
Requests a minimum resolution for periodic timers such as the .
Minimum timer resolution, in milliseconds, for the application. A lower value specifies a higher (more accurate) resolution.
Call this function immediately before using the and call
immediately after you are finished using the PrecisionTimer. You must match each call to
with a call to ClearMinimumTimerResolution specifying the same minimum resolution in both calls.
An application can make multiple ClearMinimumTimerResolution calls as long as each call is matched with a call to ClearMinimumTimerResolution.
This function affects a global Windows setting. Windows uses the lowest value (that is, highest resolution) requested by any process.
Setting a higher resolution can improve the accuracy of time-out intervals in wait functions. However, it can also reduce overall system
performance, because the thread scheduler switches tasks more often. High resolutions can also prevent the CPU power management system from
entering power-saving modes. See timeBeginPeriod Windows API for more information.
This method is currently ignored under Mono deployments.
Clears a previously set minimum timer resolution established using .
Minimum timer resolution specified in the previous call to the function.
Call this function immediately after you are finished using the . You must match each call to
with a call to , specifying the same minimum
resolution in both calls. An application can make multiple SetMinimumTimerResolution calls as long
as each call is matched with a call to ClearMinimumTimerResolution.
This method is currently ignored under Mono deployments.
Represents current process progress for an operation.
Used to track total progress of an identified operation.
Unit of progress used (long, double, int, etc.)
Constructs a new instance of the class using specified process name.
Name of process for which progress is being monitored.
Represents current process progress for an operation.
Used to track total progress of an identified operation.
Unit of progress used (long, double, int, etc.)
Constructs a new instance of the class using specified process name.
Name of process for which progress is being monitored.
Gets or sets name of process for which progress is being monitored.
Gets or sets current progress message (e.g., current file being copied, etc.)
Gets or sets total number of units to be processed.
Gets or sets number of units completed processing so far.
Defines a delegate handler for a instance.
This handler is used by methods with an delegate parameter (e.g., Action<ProcessProgress<long>>)
providing a simple callback mechanism for reporting progress on a long operation.
Unit of progress used (long, double, int, etc.)
Constructs a new process progress handler for the specified parameters.
Delegate callback to invoke as process progresses.
Descriptive name of process, if useful.
Constructs a new process progress handler for the specified parameters.
Delegate callback to invoke as process progresses.
Descriptive name of process, if useful.
Total number of units to be processed.
Gets instance of used to track progress for this handler.
Gets or sets reference to delegate handler used as a callback to report process progress.
Gets or sets current process progress (i.e., number of units completed processing so far) - note that when this
property value is assigned, the callback function is automatically called with updated
instance so consumer can track progress.
Number of units completed processing so far.
Gets or sets total number of units to be processed.
Calls callback function with updated instance so consumer can track progress.
Number of units completed processing so far.
Note that assigning a value to the property will have the same effect as calling this method.
Represents a range of values defined by start and end value.
Creates a new instance of the class using the default comparer.
The start value of the range.
The end value of the range.
Gets the start value of the range.
Gets the end value of the range.
Determines whether the range contains the given value.
The value to be compared with.
True if the value exists within the range; false otherwise.
Determines whether the range contains the given value.
The value to be compared with.
The comparer used to compare objects of type .
True if the value exists within the range; false otherwise.
Determines whether the range contains the given value.
The value to be compared with.
The comparison used to compare objects of type .
True if the value exists within the range; false otherwise.
Determines whether the range contains the given range.
The range to be compared with.
True if the given range exists within this range; false otherwise.
Determines whether the range contains the given range.
The range to be compared with.
The comparer used to compare objects of type .
True if the given range exists within this range; false otherwise.
Determines whether the range contains the given range.
The range to be compared with.
The comparison used to compare objects of type .
True if the given range exists within this range; false otherwise.
Determines whether the range overlaps with the given range.
The range to be compared with.
True if the ranges overlap; false otherwise.
Determines whether the range overlaps with the given range.
The range to be compared with.
The comparer used to compare objects of type .
True if the ranges overlap; false otherwise.
Determines whether the range overlaps with the given range.
The range to be compared with.
The comparison used to compare objects of type .
True if the ranges overlap; false otherwise.
Merges two ranges into one range that fully encompasses both ranges.
The range to be merged with this one.
The range that fully encompasses the merged ranges.
Merges two ranges into one range that fully encompasses both ranges.
The range to be merged with this one.
The comparer used to compare objects of type .
The range that fully encompasses the merged ranges.
Merges two ranges into one range that fully encompasses both ranges.
The range to be merged with this one.
The comparison used to compare objects of type .
The range that fully encompasses the merged ranges.
Merges all ranges in a collection of ranges.
The collection of ranges to be merged.
A range that is the result of merging all ranges in the collection.
Merges all ranges in a collection of ranges.
The collection of ranges to be merged.
The comparer used to compare objects of type .
A range that is the result of merging all ranges in the collection.
Merges all ranges in a collection of ranges.
The collection of ranges to be merged.
The comparison used to compare objects of type .
A range that is the result of merging all ranges in the collection.
Merges all consecutive groups of overlapping ranges in a
collection and returns the resulting collection of ranges.
The collection of ranges.
The collection of merged ranges.
Merges all consecutive groups of overlapping ranges in a
collection and returns the resulting collection of ranges.
The collection of ranges.
The comparer used to compare objects of type .
The collection of merged ranges.
Merges all consecutive groups of overlapping ranges in a
collection and returns the resulting collection of ranges.
The collection of ranges.
The comparison used to compare objects of type .
The collection of merged ranges.
Merges all consecutive groups of overlapping ranges in a
collection and returns the resulting collection of ranges.
The collection of ranges.
The collection of merged ranges.
This method does not preserve the order of the source collection.
Merges all consecutive groups of overlapping ranges in a
collection and returns the resulting collection of ranges.
The collection of ranges.
The comparison used to compare objects of type .
The collection of merged ranges.
This method does not preserve the order of the source collection.
Merges all consecutive groups of overlapping ranges in a
collection and returns the resulting collection of ranges.
The collection of ranges.
The comparer used to compare objects of type .
The collection of merged ranges.
This method does not preserve the order of the source collection.
Represents a range of values defined by a start and end value with encapsulated state.
This class provides flexibility in allowing the user to define their own state and how it is merged.
Because of potentially undesirable behavior which could result from merging objects inherited from
this class, the class has been sealed to prevent inheritance.
Creates a new instance of the class using the default comparer.
The start value of the range.
The end value of the range.
The state object encapsulated by the range.
Gets the start value of the range.
Gets the end value of the range.
Gets the state encapsulated by the range.
Determines whether the range contains the given value.
The value to be compared with.
True if the value exists within the range; false otherwise.
Determines whether the range contains the given value.
The value to be compared with.
The comparer used to compare objects of type .
True if the value exists within the range; false otherwise.
Determines whether the range contains the given value.
The value to be compared with.
The comparison used to compare objects of type .
True if the value exists within the range; false otherwise.
Determines whether the range contains the given range.
The range to be compared with.
True if the given range exists within this range; false otherwise.
Determines whether the range contains the given range.
The range to be compared with.
The comparer used to compare objects of type .
True if the given range exists within this range; false otherwise.
Determines whether the range contains the given range.
The range to be compared with.
The comparison used to compare objects of type .
True if the given range exists within this range; false otherwise.
Determines whether the range overlaps with the given range.
The range to be compared with.
True if the ranges overlap; false otherwise.
Determines whether the range overlaps with the given range.
The range to be compared with.
The comparer used to compare objects of type .
True if the ranges overlap; false otherwise.
Determines whether the range overlaps with the given range.
The range to be compared with.
The comparison used to compare objects of type .
True if the ranges overlap; false otherwise.
Merges two ranges into one range that fully encompasses both ranges.
The range to be merged with this one.
The range that fully encompasses the merged ranges.
is not .
Merges two ranges into one range that fully encompasses both ranges.
The range to be merged with this one.
The comparer used to compare objects of type .
The range that fully encompasses the merged ranges.
is not .
Merges two ranges into one range that fully encompasses both ranges.
The range to be merged with this one.
The comparison used to compare objects of type .
The range that fully encompasses the merged ranges.
is not .
Merges all ranges in a collection of ranges.
The collection of ranges to be merged.
A range that is the result of merging all ranges in the collection.
Merges all ranges in a collection of ranges.
The collection of ranges to be merged.
The comparer used to compare objects of type .
A range that is the result of merging all ranges in the collection.
Merges all ranges in a collection of ranges.
The collection of ranges to be merged.
The comparison used to compare objects of type .
A range that is the result of merging all ranges in the collection.
Merges all consecutive groups of overlapping ranges in a
collection and returns the resulting collection of ranges.
The collection of ranges.
The collection of merged ranges.
Merges all consecutive groups of overlapping ranges in a
collection and returns the resulting collection of ranges.
The collection of ranges.
The comparer used to compare objects of type .
The collection of merged ranges.
Merges all consecutive groups of overlapping ranges in a
collection and returns the resulting collection of ranges.
The collection of ranges.
The comparison used to compare objects of type .
The collection of merged ranges.
Merges all consecutive groups of overlapping ranges in a
collection and returns the resulting collection of ranges.
The collection of ranges.
The collection of merged ranges.
This method does not preserve the order of the source collection.
Merges all consecutive groups of overlapping ranges in a
collection and returns the resulting collection of ranges.
The collection of ranges.
The comparison used to compare objects of type .
The collection of merged ranges.
This method does not preserve the order of the source collection.
Merges all consecutive groups of overlapping ranges in a
collection and returns the resulting collection of ranges.
The collection of ranges.
The comparer used to compare objects of type .
The collection of merged ranges.
This method does not preserve the order of the source collection.
Represents a type of object that is mergeable with another type of object.
The type of object to be merged with.
This interface was primarily designed for objects which are mergeable with other objects of the same type.
Therefore, should typically be the actual type of the object.
Merges this object with another.
The other mergeable object.
The result of merging this object with another.
Defines a lookup class that searches all assemblies in the current for all .
Creates a AppDomainTypeLookup
Gets flag that determines if there is a possibility that a new assembly has been loaded and new types are available.
Searches all assemblies of this for all s.
List of found types.
Defines extension functions related to Assemblies.
Returns only assembly name and version from full assembly name.
An to get the short name of.
The assembly name and version from the full assembly name.
Gets the specified embedded resource from the assembly.
Source assembly.
The full name (including the namespace) of the embedded resource to get.
The embedded resource.
Gets the title information of the assembly.
Source assembly.
The title information of the assembly.
Gets the description information of the assembly.
Source assembly.
The description information of the assembly.
Gets the company name information of the assembly.
Source assembly.
The company name information of the assembly.
Gets the product name information of the assembly.
Source assembly.
The product name information of the assembly.
Gets the copyright information of the assembly.
Source assembly.
The copyright information of the assembly.
Gets the trademark information of the assembly.
Source assembly.
The trademark information of the assembly.
Gets the configuration information of the assembly.
Source assembly.
The configuration information of the assembly.
Gets a boolean value indicating if the assembly has been built as delay-signed.
Source assembly.
true, if the assembly has been built as delay-signed; otherwise, false.
Gets the version information of the assembly.
Source assembly.
The version information of the assembly
Gets the name of the file containing the key pair used to generate a strong name for the attributed assembly.
Source assembly.
A string containing the name of the file that contains the key pair.
Gets the culture name of the assembly.
Source assembly.
The culture name of the assembly.
Gets the assembly version used to instruct the to ask for
a particular version of a satellite assembly to simplify updates of the main assembly of an application.
Source assembly.
The satellite contract version of the assembly.
Gets the string representing the assembly version used to indicate to a COM client that all classes in the
current version of the assembly are compatible with classes in an earlier version of the assembly.
Source assembly.
The string representing the assembly version in MajorVersion.MinorVersion.RevisionNumber.BuildNumber format.
Gets a boolean value indicating if the assembly is exposed to COM.
Source assembly.
true, if the assembly is exposed to COM; otherwise, false.
Gets a boolean value indicating if the was built in debug mode.
Source assembly.
true, if the assembly was built in debug mode; otherwise, false.
Gets the assembly GUID that is used as an ID if the assembly is exposed to COM.
Source assembly.
The assembly GUID that is used as an ID if the assembly is exposed to COM.
Gets a boolean value indicating whether the indicated program element is CLS-compliant.
Source assembly.
true, if the program element is CLS-compliant; otherwise, false.
Gets the date and time when the assembly was last built.
Source assembly.
The date and time when the assembly was last built.
Gets the root namespace of the assembly.
Source assembly.
The root namespace of the assembly.
Gets a name/value collection of assembly attributes exposed by the assembly.
Source assembly.
A NameValueCollection of assembly attributes.
Recursively attempts to load all assemblies referenced from the given assembly.
The assembly whose references are to be loaded.
true if the references were successfully loaded; false otherwise.
If an object is created from a type that is loaded from an assembly, and if that
assembly's references fail to load during instantiation, an exception may be thrown
from both the constructor and the finalizer of the object that was instantiated.
This method allows us to ensure that all referenced assemblies can be loaded
before attempting to instantiate a type from that assembly.
Contains extension methods for values.
Represents a common information provider for an assembly.
Initializes a new instance of the class.
An object.
Gets the underlying being represented by this object.
Gets the title information of the .
Gets the description information of the .
Gets the company name information of the .
Gets the product name information of the .
Gets the copyright information of the .
Gets the trademark information of the .
Gets the configuration information of the .
Gets a boolean value indicating if the has been built as delay-signed.
Gets the version information of the .
Gets the name of the file containing the key pair used to generate a strong name for the attributed .
Gets the culture name of the .
Gets the assembly version used to instruct the System.Resources.ResourceManager to ask for a particular
version of a satellite assembly to simplify updates of the main assembly of an application.
Gets the string representing the assembly version used to indicate to a COM client that all classes
in the current version of the assembly are compatible with classes in an earlier version of the assembly.
Gets a boolean value indicating if the is exposed to COM.
Gets a boolean value indicating if the was built in debug mode.
Gets the GUID that is used as an ID if the is exposed to COM.
Gets a boolean value indicating whether the is CLS-compliant.
Gets the path or UNC location of the loaded file that contains the manifest.
Gets the display name of the .
Gets the simple, unencrypted name of the .
Gets the major, minor, revision, and build numbers of the .
Gets the string representing the version of the common language runtime (CLR) saved in the file
containing the manifest.
Gets the date and time when the was built.
Gets the root namespace of the .
Gets a collection of assembly attributes exposed by the assembly.
A System.Specialized.KeyValueCollection of assembly attributes.
Gets the specified assembly attribute if it is exposed by the assembly.
Type of the attribute to get.
The requested assembly attribute if it exists; otherwise null.
This method always returns null under Mono deployments.
Gets the specified embedded resource from the assembly.
The full name (including the namespace) of the embedded resource to get.
The embedded resource.
Finds the specified searching through all loaded assemblies.
Fully qualified type name.
The found; otherwise null.
Gets the object of the assembly that invoked the currently executing method.
Gets the object of the process executable in the default application domain.
Gets the object of the assembly that contains the code that is currently executing.
Loads the specified assembly that is embedded as a resource in the assembly.
Name of the assembly to load.
Note that this function cannot be used to load Gemstone.Core itself, since this is where function resides.
Maintains a version number that increments every time an event is raised.
The number of times that the AppDomains's assembly could have changed; initial value starts at 1.
Defines extensions methods related to objects and derived types (e.g., ,
, , etc.).
Gets the friendly class name of the provided object, trimming generic parameters.
The object over which to get friendly class name.
of instance to retrieve.
Friendly class name of the provided member, or if is null.
Returns a boolean flag that determines if the specified exists.
The object over which to search attributes.
or derived type to get from.
of to attempt to retrieve.
true if attribute exists; otherwise, false.
Attempts to get the specified from a object, returning true if it does.
The object over which to search attributes.
The that was found, if any.
true if was found; otherwise false.
or derived type to get from.
of to attempt to retrieve.
If more than of the same type of attribute exists on the member, only the first one is returned.
Attempts to get the specified from a object, returning true if it does.
The object over which to search attributes.
The array of objects that were found, if any.
true if was found; otherwise false.
or derived type to get from.
of to attempt to retrieve.
Attempts to get the specified from a object, returning true if it does.
The object over which to search attributes.
The actual type of the to look for.
The that was found, if any.
true if was found; otherwise false.
or derived type to get from.
If more than of the same type of attribute exists on the member, only the first one is returned.
Attempts to get the specified from a object, returning true if it does.
The object over which to search attributes.
The actual type of the objects to look for.
The array of objects that were found, if any.
true if was found; otherwise false.
or derived type to get from.
Attempts to get the specified from a object, returning true if it does.
The object over which to search attributes.
The name of the type of the to look for.
The that was found, if any.
true if was found; otherwise false.
or derived type to get from.
If more than of the same type of attribute exists on the member, only the first one is returned.
Attempts to get the specified from a object, returning true if it does.
The object over which to search attributes.
The name of the type of the objects to look for.
The array of objects that were found, if any.
true if was found; otherwise false.
or derived type to get from.
Contains extension methods for values.
Defines extensions methods related to extension functions for instances.
Gets the friendly method name of the provided type, trimming generic parameters.
Type to get friendly method name for.
Friendly method name of the provided type, or if is null.
Gets the friendly method name with class of the provided type, trimming generic parameters.
Type to get friendly method name with class for.
Friendly method name with class of the provided type, or if is null.
Contains extension methods for values.
Defines extensions methods related to .
Many of these functions help generate compiled IL code that can execute a method of a class.
Turns a into an that can be called with objects of the specified type.
the method that should be compiled.
The compiled method.
Turns a into an that can be called with objects of the specified type.
the method that should be compiled.
The type of the second parameter of the method that this delegate encapsulates.
The compiled method.
Turns a into an that can be called with objects of the specified type.
the method that should be compiled.
The type of the second parameter of the method that this delegate encapsulates.
The type of the third parameter of the method that this delegate encapsulates.
The compiled method.
Turns a into an that can be called with objects of the specified type.
the method that should be compiled.
The type of the second parameter of the method that this delegate encapsulates.
The type of the third parameter of the method that this delegate encapsulates.
The type of the forth parameter of the method that this delegate encapsulates.
The compiled method.
Turns a into a that can be called with objects of the specified type.
the method that should be compiled.
The type of the result of the function that this delegate encapsulates.
The compiled method.
Turns a into a that can be called with objects of the specified type.
the method that should be compiled.
The type of the second parameter of the function that this delegate encapsulates.
The type of the result of the function that this delegate encapsulates.
The compiled method.
Turns a into a that can be called with objects of the specified type.
the method that should be compiled.
The type of the second parameter of the function that this delegate encapsulates.
The type of the third parameter of the function that this delegate encapsulates.
The type of the result of the function that this delegate encapsulates.
The compiled method.
Turns a into a that can be called with objects of the specified type.
the method that should be compiled.
The type of the second parameter of the function that this delegate encapsulates.
The type of the third parameter of the function that this delegate encapsulates.
The type of the forth parameter of the function that this delegate encapsulates.
The type of the result of the function that this delegate encapsulates.
The compiled method.
Contains extension methods for values.
Contains classes and extension functions used to simplify and standardize access to assembly information and attributes in applications.
Contains classes used to schedule operations using standard UNIX crontab syntax.
Represents a schedule defined using UNIX crontab syntax.
Operators:
There are several ways of specifying multiple date/time values in a field:
-
The comma (',') operator specifies a list of values, for example: "1,3,4,7,8"
-
The dash ('-') operator specifies a range of values, for example: "1-6",
which is equivalent to "1,2,3,4,5,6"
-
The asterisk ('*') operator specifies all possible values for a field.
For example, an asterisk in the hour time field would be equivalent to
'every hour' (subject to matching other specified fields).
-
The slash ('/') operator (called "step"), which can be used to skip a given
number of values. For example, "*/3" in the hour time field is equivalent
to "0,3,6,9,12,15,18,21". So "*" specifies 'every hour' but the "*/3" means
only those hours divisible by 3.
Fields:
+---------------- minute (0 - 59)
| +------------- hour (0 - 23)
| | +---------- day of month (1 - 31)
| | | +------- month (1 - 12)
| | | | +---- day of week (0 - 7) (Sunday=0 or 7)
| | | | |
* * * * *
Each of the patterns from the first five fields may be either * (an asterisk), which matches all legal values,
or a list of elements separated by commas.
See http://en.wikipedia.org/wiki/Cron for more information.
Initializes a new instance of the class.
Initializes a new instance of the class.
Name of the schedule.
Rule formated in UNIX crontab syntax.
Flag that determines whether to use local time for schedule.
Gets or sets the name of the .
The value being assigned is null or empty string.
Gets or sets the rule of the defined in UNIX crontab syntax.
The value being assigned is null or empty string.
The number of in the rule is not exactly 5.
Gets or sets a flag that determines whether the scheduler uses local time or UTC time for scheduling.
Gets the of the that represents minute .
Gets the of the that represents hour .
Gets the of the that represents day of month .
Gets the of the that represents month .
Gets the of the that represents day of week .
Gets a description of the .
A default description is created automatically when the is set.
Gets the when the was last due.
Gets the current status of the .
Checks whether the is due at the present system time.
true if the is due at the present system time; otherwise, false.
Determines the nearest timestamp older than
the given timestamp that matches the schedule.
The target timestamp
The timestamp prior to the target that the schedule was previously due
Determines the nearest timestamp past the
given timestamp that matches the schedule.
The target timestamp
The timestamp past the target that the schedule will next be due
Gets a hash code for the .
An based hash-code.
Determines whether the specified is equal to the current .
The to compare with the current .
true if the specified is equal to the current ; otherwise, false.
Gets the string representation of .
String representation of .
Monitors multiple at an interval of one minute to check if they are due.
This example shows how to use the component:
using System;
using Gemstone;
using Gemstone.Scheduling;
class Program
{
static void Main(string[] args)
{
ScheduleManager scheduler = new ScheduleManager();
// Add event handlers.
scheduler.Starting += scheduler_Starting;
scheduler.Started += scheduler_Started;
scheduler.ScheduleDue += scheduler_ScheduleDue;
// Add test schedules.
scheduler.AddSchedule("Run.Notepad", "* * * * *");
scheduler.AddSchedule("Run.Explorer", "* * * * *");
// Start the scheduler.
scheduler.Start();
Console.ReadLine();
}
static void scheduler_Started(object? sender, EventArgs e)
{
Console.WriteLine("Scheduler has started successfully.");
}
static void scheduler_Starting(object? sender, EventArgs e)
{
Console.WriteLine("Scheduler is waiting to be started.");
}
static void scheduler_ScheduleDue(object? sender, EventArgs;lt;Schedule> e)
{
Console.WriteLine(string.Format("{0} schedule is due for processing.", e.Argument.Name));
}
}
Number of milliseconds between timer ticks.
Occurs while the is waiting to start at the top of the minute.
Occurs when the has started at the top of the minute.
Occurs asynchronously when a is due according to the rule specified for it.
is the that is due.
Occurs when the a particular is being checked to see if it is due.
is the that is being checked to see if it is due.
Initializes a new instance of the class.
Gets or sets the name of the .
The value being assigned is null or empty string.
Gets a list of all monitored by the object.
Gets a boolean value that indicates whether the is running.
Gets or sets a boolean value that indicates whether the object is currently enabled.
property is not be set by user-code directly.
Gets the descriptive status of the .
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Starts the asynchronously if not running.
Stops the if running.
Checks all of the to determine if they are due.
Attempts to add a new .
Name of the new .
Rule of the new .
Flag that determines whether to use local time for schedule.
Flag that determines whether to update existing with the specified .
true if a new was added or an existing one was updated; otherwise false.
Attempts to remove a with the specified name if one exists.
Name of the to be removed.
true if the was removed; otherwise, false.
Searches for the with the specified name.
Name of the to be obtained.
object if a match is found; otherwise null.
Raises the event.
Raises the event.
Raises the event.
to send to event.
Raises the event.
Event data.
Indicates the date/time element that a represents.
This enumeration specifically corresponds to the UNIX crontab date/time elements.
represents minutes. Legal values are 0 through 59, or 60 which maps to 0.
represents hours. Legal values are 0 through 23, or 24 which maps to 0.
represents day of month. Legal values are 1 through 31.
represents months. Legal values are 1 through 12.
represents day of week. Legal values are 0 through 6, or 7 which maps to 0. Sunday is 0 and Saturday is 6.
Indicates the syntax used in a for specifying its values.
Values for the were specified using the '*' text syntax. Included values are
all legal values for the that the represents.
Values for the were specified using the '*/n' text syntax. Included values are
legal values for the that the represents that are
divisible by 'n'.
Values for the were specified using the 'n1-nn' text syntax. Included values
are legal values for the that the represents that
are within the specified range.
Values for the were specified using the 'n1,n2,nn' text syntax. Included values
are specific legal values for the that the represents.
Values for the were specified using the 'n1-nn/n' text syntax. Included values
are legal values for the that the represents that
are within the specified range and that are divisible by 'n'.
Represents a part of the .
Initializes a new instance of the class.
The text that specifies the values for the object.
The that the object represents.
Gets the text used to specify the values for the object.
Gets the that the object represents.
Gets the used in the for specifying the
values of the object.
Gets a meaningful description of the object.
Gets the list of values for the object specified using .
Determines if the for the that the
object represents matches the specified .
The against which the are to be matches.
true if one of the matches the ; otherwise, false.
Defines a group of characters that can
appear in an automatically generated password.
Creates a new instance of the class.
Creates a new instance of the class.
String representing the characters in the character group.
Creates a new instance of the class.
String representing the characters in the character group.
The minimum number of occurrences of this character group in the password.
The collection of characters in the character group.
The minimum number of occurrences of any of the
characters in this character group in the password.
Provides methods for encrypting and decrypting data.
This is a safety wrapper around the class such that it can be used with
LocalMachine scope regardless of current user. This is especially important for applications
that may be running as user account that has no association to the current user, e.g., an Azure AD
user or database account when authenticated using AdoSecurityProvider.
Folder name for data protection keys.
Default settings category for cryptography services.
Default timeout, in minutes, for user-specific data protection provider.
Encrypts the data in a specified byte array and returns a byte array that contains the encrypted data.
A byte array representing the encrypted data.
A byte array that contains data to encrypt.
An optional additional byte array used to increase the complexity of the encryption, or null for no additional complexity.
Set to true to protect data to the local machine; otherwise, set to false to protect data to the current user.
The config file settings category under which the settings are defined.
The parameter is null.
The encryption failed.
Decrypts the data in a specified byte array and returns a byte array that contains the decrypted data.
A byte array representing the decrypted data.
A byte array containing data encrypted using the method.
An optional additional byte array that was used to encrypt the data, or null if the additional byte array was not used.
Set to true to protect data to the local machine; otherwise, set to false to protect data to the current user.
The config file settings category under which the settings are defined.
The parameter is null.
The decryption failed.
Defines extension functions related to cryptographic objects.
Gets the Base64 encoded hash of the provided string .
to use for encryption.
String value to hash.
Base64 encoded hash of provided string .
Contains extension methods for implementations.
Contains classes and extension functions used to simplify and standardize usage of basic cryptography using a combination
of standard and proprietary encryption algorithms to produce decent obfuscations of strings, buffers and streams of data.
Generates random passwords.
Creates a new instance of the class.
Creates a new instance of the class.
The list of character groups used to generate passwords.
Gets the collection of character groups used by this .
Gets a string representing the total collection
of characters across all character groups.
Gets the absolute minimum length of password that can be
generated by the based
on the minimum occurrence of each character group.
Generates a random password with 8 characters or
if it is greater than 8 characters.
A randomly generated password.
Generates a password with length between the given
and .
The minimum length of the generated password.
The maximum length of the generated password.
A randomly generated password.
Generates a password with the given length.
The length of the password to be generated.
A randomly generated password.
Default set of character groups used by the .
Defines the default password generator.
Generates cryptographically strong random numbers.
Generates a semi cryptographically strong double-precision floating-point random number between zero and one.
The cryptographic service provider (CSP) cannot be acquired.
Generates a semi cryptographically strong random decimal between zero and one.
The cryptographic service provider (CSP) cannot be acquired.
Generates a semi cryptographically strong random integer between specified values.
A that is the low end of our range.
A that is the high end of our range.
The cryptographic service provider (CSP) cannot be acquired.
A that is generated between the and the , or an exception.
Fills an array of bytes with a cryptographically strong sequence of random values.
The array to fill with a cryptographically strong sequence of random values.
The length of the byte array determines how many cryptographically strong random bytes are produced.
This method is thread safe.
The cryptographic service provider (CSP) cannot be acquired.
buffer is null.
Generates a cryptographically strong random boolean (i.e., a coin toss).
The cryptographic service provider (CSP) cannot be acquired.
Generates a cryptographically strong 8-bit random integer.
The cryptographic service provider (CSP) cannot be acquired.
Generates a cryptographically strong 8-bit random integer between specified values.
The cryptographic service provider (CSP) cannot be acquired.
A that is the low end of our range.
A that is the high end of our range.
A that is generated between the and the .
Generates a cryptographically strong 16-bit random integer.
The cryptographic service provider (CSP) cannot be acquired.
Generates a cryptographically strong 16-bit random integer between specified values.
The cryptographic service provider (CSP) cannot be acquired.
A that is the low end of our range.
A that is the high end of our range.
A that is generated between the and the .
Generates a cryptographically strong unsigned 16-bit random integer.
The cryptographic service provider (CSP) cannot be acquired.
Generates a cryptographically strong unsigned 16-bit random integer between specified values.
The cryptographic service provider (CSP) cannot be acquired.
A that is the low end of our range.
A that is the high end of our range.
A that is generated between the and the .
Generates a cryptographically strong 32-bit random integer.
The cryptographic service provider (CSP) cannot be acquired.
Generates a cryptographically strong 32-bit random integer between specified values.
The cryptographic service provider (CSP) cannot be acquired.
A that is the low end of our range.
A that is the high end of our range.
A that is generated between the and the .
Generates a cryptographically strong unsigned 32-bit random integer.
The cryptographic service provider (CSP) cannot be acquired.
Generates a cryptographically strong unsigned 32-bit random integer between specified values.
The cryptographic service provider (CSP) cannot be acquired.
A that is the low end of our range.
A that is the high end of our range.
A that is generated between the and the .
Generates a cryptographically strong 64-bit random integer.
The cryptographic service provider (CSP) cannot be acquired.
Generates a cryptographically strong 64-bit random integer between specified values.
The cryptographic service provider (CSP) cannot be acquired.
A that is the low end of our range.
A that is the high end of our range.
A that is generated between the and the .
Generates a cryptographically strong unsigned 64-bit random integer.
The cryptographic service provider (CSP) cannot be acquired.
Generates a cryptographically strong unsigned 64-bit random integer between specified values.
The cryptographic service provider (CSP) cannot be acquired.
A that is the low end of our range.
A that is the high end of our range.
A that is generated between the and the .
Returns a cryptographically strong number that is less than the supplied value.
the max value to return exclusive
if 0 is provided, 0 is returned
Returns a cryptographically strong number that is less than the supplied value.
the max value to return exclusive
if 0 is provided, 0 is returned
Returns a cryptographically strong number that is less than the supplied value.
the max value to return exclusive
A number less than a negative number rolls down to long.MinValue, then to long.MaxValue
if 0 is provided, 0 is returned
Returns a cryptographically strong number that is less the supplied value.
the max value to return exclusive
A number less than a negative number rolls down to int.MinValue, then to int.MaxValue
if 0 is provided, 0 is returned
This class is used internally do define a standard buffer size.
Contains extension methods for implementations.
Defines extension functions related to cryptographic objects.
Returns a binary array of encrypted data for the given parameters.
to use for encryption.
Source buffer containing data to encrypt.
Offset into buffer.
Number of bytes in buffer to encrypt starting from offset.
The secret key to use for the symmetric algorithm.
The initialization vector to use for the symmetric algorithm.
Encrypted version of buffer.
Encrypts input stream onto output stream for the given parameters.
to use for encryption.
Source stream that contains data to encrypt.
Destination stream used to hold encrypted data.
The secret key to use for the symmetric algorithm.
The initialization vector to use for the symmetric algorithm.
Returns a binary array of decrypted data for the given parameters.
to use for decryption.
Source buffer containing data to decrypt.
Offset into buffer.
Number of bytes in buffer to decrypt starting from offset.
The secret key to use for the symmetric algorithm.
The initialization vector to use for the symmetric algorithm.
Decrypted version of buffer.
Decrypts input stream onto output stream for the given parameters.
to use for decryption.
Source stream that contains data to decrypt.
Destination stream used to hold decrypted data.
The secret key to use for the symmetric algorithm.
The initialization vector to use for the symmetric algorithm.
Common serialization related functions.
Serialization binder used to deserialize files that were serialized using the old library frameworks
(TVA Code Library, Time Series Framework, TVA.PhasorProtocols, and PMU Connection Tester) into classes
in the Grid Solutions Framework.
Controls the binding of a serialized object to a type.
Specifies the name of the serialized object.
Specifies the name of the serialized object.
The type of the object the formatter creates a new instance of.
Gets value for specified ; otherwise .
Type of parameter to get from .
object that contains deserialized values.
Name of deserialized parameter to retrieve.
Default value to return if does not exist or cannot be deserialized.
Value for specified ; otherwise
do not have a direct way of determining if an item with a specified name exists, so when calling
one of the Get(n) functions you will simply get a if the parameter does not exist; similarly
you will receive this exception if the parameter fails to properly deserialize. This extension method protects against both of
these failures and returns a default value if the named parameter does not exist or cannot be deserialized.
Gets values of a instance compatible with Linq operations.
Target instance.
Enumeration of objects from instance.
Represents a high resolution time that is very granular but may drift
if trying to accurately measure long time durations (Such as hours).
This time is not adjusted with changes to the system clock.
Typical clock drifts by about 2-3 ms per minute as apposed to 0.4ms
per minute for standard .
Call times are about 40+ million calls per second.
Calculates the approximate represented by this time.
The elapsed time in seconds.
The elapsed time in milliseconds.
The elapsed time in microseconds.
The elapsed time in ticks.
Gets the time that has elapsed since the creation of this time.
The elapsed time in seconds
The elapsed time in milliseconds
The elapsed time in microseconds
The elapsed time in ticks
The elapsed time
Adds milliseconds to this struct
Adds seconds to this struct
Adds ticks to this struct
Adds timespan to this struct
The current time in
Tests Less Than
Tests Greater Than
Tests Less Than or equal
Tests Greater than or equal Than
Subtracts two times.
Are 2 times equal
Are 2 times not equal
Indicates whether this instance and a specified object are equal.
true if and this instance are the same type and represent the same value; otherwise, false.
The object to compare with the current instance.
2
Indicates whether the current object is equal to another object of the same type.
true if the current object is equal to the parameter; otherwise, false.
An object to compare with this object.
Returns the hash code for this instance.
A 32-bit signed integer that is the hash code for this instance.
2
Shows the UTC time.
Fuzzy string comparison tolerances.
Strong comparison tolerance.
Normal comparison tolerance.
Weak comparison tolerance.
Manual comparison tolerance.
Contains extension methods for values.
Defines extension functions related to string manipulation.
Gets appropriate for the specified .
type.
for the specified .
Throws an if is null -or-
an if is Empty.
The reference type argument to validate as non-null and non-empty.
The name of the parameter with which corresponds.
Parses a string intended to represent a boolean value.
String representing a boolean value.
Parsed boolean value.
This function, unlike Boolean.Parse, correctly parses a boolean value, even if the string value
specified is a number (e.g., 0 or -1). Boolean.Parse expects a string to be represented as
"True" or "False" (i.e., Boolean.TrueString or Boolean.FalseString respectively).
Converts this string into the specified type.
to convert string to.
Source string to convert to type.
converted to specified ; default value of specified type T if conversion fails.
This function makes use of a to convert this to the specified type T,
the best way to make sure can be converted back to its original type is to use the same
to convert the original object to a ; see the
method for an easy way to do this.
Converts this string into the specified type.
to convert string to.
Source string to convert to type.
to use for the conversion.
converted to specified ; default value of specified type T if conversion fails.
This function makes use of a to convert this to the specified type T,
the best way to make sure can be converted back to its original type is to use the same
to convert the original object to a ; see the
method for an easy way to do this.
Converts this string into the specified type.
Source string to convert to type.
to convert string to.
converted to specified ; default value of specified type if conversion fails.
This function makes use of a to convert this to the specified ,
the best way to make sure can be converted back to its original type is to use the same
to convert the original object to a ; see the
method for an easy way to do this.
Converts this string into the specified type.
Source string to convert to type.
to convert string to.
to use for the conversion.
Set to true to suppress conversion exceptions and return null; otherwise, false
converted to specified ; default value of specified type if conversion fails.
This function makes use of a to convert this to the specified ,
the best way to make sure can be converted back to its original type is to use the same
to convert the original object to a ; see the
method for an easy way to do this.
Converts value to string; null objects (or DBNull objects) will return an empty string ("").
of to convert to string.
Value to convert to string.
as a string; if is null, empty string ("") will be returned.
Converts value to string; null objects (or DBNull objects) will return specified .
of to convert to string.
Value to convert to string.
to return if is null.
as a string; if is null, will be returned.
cannot be null.
Makes sure returned string value is not null; if this string is null, empty string ("") will be returned.
to verify is not null.
value; if is null, empty string ("") will be returned.
Converts value to string; null objects, DBNull objects or empty strings will return specified .
of to convert to string.
Value to convert to string.
to return if is null.
as a string; if is null, DBNull or an empty string will be returned.
must not be null or an empty string.
Converts value to string; null objects, DBNull objects, empty strings or all white space strings will return specified .
of to convert to string.
Value to convert to string.
to return if is null.
as a string; if is null, DBNull, empty or all white space, will be returned.
must not be null, an empty string or white space.
Converts string into a stream using the specified .
Input to string to convert to a string.
String encoding to use; defaults to .
String encoded onto a stream.
Asynchronously converts string into a stream using the specified .
Input to string to convert to a string.
String encoding to use; defaults to .
String encoded onto a stream.
Turns source string into an array of string segments - each with a set maximum width - for parsing or displaying.
Input string to break up into segments.
Maximum size of returned segment.
Array of string segments as parsed from source string.
Returns a single element array with an empty string if source string is null or empty.
Combines a dictionary of key-value pairs in to a string.
Dictionary of key-value pairs.
Character that delimits one key-value pair from another (e.g. ';').
Character that delimits a key from its value (e.g. '=').
Optional character that marks the start of a value such that value could contain other
or characters (e.g., "{").
Optional character that marks the end of a value such that value could contain other
or characters (e.g., "}").
A string of key-value pairs.
Values will be escaped within and
to contain nested key/value pair expressions like the following: normalKVP=-1; nestedKVP={p1=true; p2=0.001},
when either the or are detected in the
value of the key/value pair.
Parses key/value pair expressions from a string. Parameter pairs are delimited by
and multiple pairs separated by . Supports encapsulated nested expressions.
String containing key/value pair expressions to parse.
Character that delimits one key/value pair from another.
Character that delimits key from value.
Optional character that marks the start of a value such that value could contain other
or characters.
Optional character that marks the end of a value such that value could contain other
or characters.
Flag determines whether duplicates are ignored. If flag is set to false an
will be thrown when all key parameters are not unique.
Dictionary of key/value pairs.
Parses a string containing key/value pair expressions (e.g., "localPort=5001; transportProtocol=UDP; interface=0.0.0.0").
This method treats all "keys" as case-insensitive. Nesting of key/value pair expressions is allowed by encapsulating the
value using the and values (e.g.,
"dataChannel={Port=-1;Clients=localhost:8800}; commandChannel={Port=8900}; dataFormat=FloatingPoint;"). There must be one
for each encountered in the value or a
will be thrown. Multiple levels of nesting is supported. If the
flag is set to false an will be thrown when all key parameters are not unique. Note
that keys within nested expressions are considered separate key/value pair strings and are not considered when checking
for duplicate keys.
value is null.
All delimiters must be unique -or- all keys must be unique when
is set to false.
Total nested key/value pair expressions are mismatched -or- encountered
before .
Ensures parameter is not an empty or null string. Returns a single space if test value is empty.
Value to test for null or empty.
A non-empty string.
Ensures parameter is not an empty or null string.
Value to test for null or empty.
Value to return if testValue is null or empty.
A non-empty string.
Replaces all characters passing delegate test with specified replacement character.
Input string.
Character used to replace characters passing delegate test.
Delegate used to determine whether or not character should be replaced.
Returns with all characters passing delegate test replaced.
Allows you to specify a replacement character (e.g., you may want to use a non-breaking space: Convert.ToChar(160)).
Removes all characters passing delegate test from a string.
Input string.
Delegate used to determine whether or not character should be removed.
Returns with all characters passing delegate test removed.
Removes all characters matching the given .
Input string.
The specific character to remove.
Returns with all characters matching the given character removed.
Removes all white space (as defined by IsWhiteSpace) from a string.
Input string.
Returns with all white space removed.
Replaces all white space characters (as defined by IsWhiteSpace) with specified replacement character.
Input string.
Character used to "replace" white space characters.
Returns with all white space characters replaced.
Allows you to specify a replacement character (e.g., you may want to use a non-breaking space: Convert.ToChar(160)).
Removes all control characters from a string.
Input string.
Returns with all control characters removed.
Replaces all control characters in a string with a single space.
Input string.
Returns with all control characters replaced as a single space.
Replaces all control characters in a string with specified replacement character.
Input string.
Character used to "replace" control characters.
Returns with all control characters replaced.
Allows you to specify a replacement character (e.g., you may want to use a non-breaking space: Convert.ToChar(160)).
Removes all carriage returns and line feeds from a string.
Input string.
Returns with all CR and LF characters removed.
Replaces all carriage return and line feed characters (as well as CR/LF sequences) in a string with specified replacement character.
Input string.
Character used to "replace" CR and LF characters.
Returns with all CR and LF characters replaced.
Allows you to specify a replacement character (e.g., you may want to use a non-breaking space: Convert.ToChar(160)).
Removes duplicate character strings (adjoining replication) in a string.
Input string.
String whose duplicates are to be removed.
Returns with all duplicated removed.
Removes the terminator ('\0') from a null terminated string.
Input string.
Returns with all characters to the left of the terminator.
Replaces all repeating white space with a single space.
Input string.
Returns with all duplicate white space removed.
Replaces all repeating white space with specified spacing character.
Input string.
Character value to use to insert as single white space value.
Returns with all duplicate white space removed.
This function allows you to specify spacing character (e.g., you may want to use a non-breaking space: Convert.ToChar(160)).
Removes all invalid file name characters (\ / : * ? " < > |) from a string.
Input string.
Returns with all invalid file name characters removed.
Replaces all invalid file name characters (\ / : * ? " < > |) in a string with the specified .
Input string.
Character used to replace the invalid characters.
>Returns with all invalid file name characters replaced.
Wraps in the .
Input string to process
The char to wrap
wrapped in
Counts the total number of the occurrences of a character in the given string.
Input string.
Character to be counted.
Total number of the occurrences of in the given string.
Tests to see if a string is contains only digits based on Char.IsDigit function.
Input string.
True, if all string's characters are digits; otherwise, false.
Tests to see if a string contains only numbers based on Char.IsNumber function.
Input string.
True, if all string's characters are numbers; otherwise, false.
Tests to see if a string's letters are all upper case.
Input string.
True, if all string's letter characters are upper case; otherwise, false.
Tests to see if a string's letters are all lower case.
Input string.
True, if all string's letter characters are lower case; otherwise, false.
Tests to see if a string contains only letters.
Input string.
True, if all string's characters are letters; otherwise, false.
Any non-letter character (e.g., punctuation marks) causes this function to return false (See overload to ignore punctuation
marks.).
Tests to see if a string contains only letters.
Input string.
Set to True to ignore punctuation.
True, if all string's characters are letters; otherwise, false.
Tests to see if a string contains only letters or digits.
Input string.
True, if all string's characters are either letters or digits; otherwise, false.
Any non-letter, non-digit character (e.g., punctuation marks) causes this function to return false (See overload to ignore
punctuation marks.).
Tests to see if a string contains only letters or digits.
Input string.
Set to True to ignore punctuation.
True, if all string's characters are letters or digits; otherwise, false.
Decodes the specified Regular Expression character back into a standard Unicode character.
Regular Expression character to decode back into a Unicode character.
Standard Unicode character representation of specified Regular Expression character.
Encodes a string into a base-64 string.
Input string.
Performs a base-64 style of string encoding useful for data obfuscation or safe XML data string transmission.
Note: This function encodes a "String". Use the Convert.ToBase64String function to encode a binary data buffer.
A value representing the encoded input of .
Decodes a given base-64 encoded string encoded with .
Input string.
Note: This function decodes value back into a "String". Use the Convert.FromBase64String function to decode a base-64 encoded
string back into a binary data buffer.
A value representing the decoded input of .
Converts the given string into a .
The string to be converted.
The given string as a .
Converts the given into a .
The to be converted.
The given as a .
This method is not safe, as it stores your secure string data in clear text in memory.
Since strings are immutable, that memory cannot be cleaned up until all references to
the string are removed and the garbage collector deallocates it. Only use this method
to interface with APIs that do not support the use of for
sensitive text data.
Converts the provided string, assumed to be title, pascal or camel case formatted, to a label with spaces before each capital letter, other than the first.
Input string.
Formatted enumeration name of the specified value for visual display.
Converts the provided string into title case (upper case first letter of each word).
Input string.
The that corresponds to the language rules applied for title casing of words; defaults to .
Note: This function performs "ToLower" in input string then applies for specified .
This way, even strings formatted in all-caps will still be properly formatted.
A that has the first letter of each word capitalized.
Converts first letter of string to upper-case.
String to convert to pascal case.
with first letter as upper-case.
This function will automatically trim .
Converts first letter of string to lower-case.
String to convert to camel case.
with first letter as lower-case.
This function will automatically trim .
Truncates the provided string from the left if it is longer that specified length.
A value that is to be truncated.
The maximum number of characters that can be.
A that is the truncated version of the string.
Truncates the provided string from the right if it is longer that specified length.
A value that is to be truncated.
The maximum number of characters that can be.
A that is the truncated version of the string.
Centers text within the specified maximum length, biased to the left.
Text will be padded to the left and right with spaces.
If value is greater than specified maximum length, value returned will be truncated from the right.
Handles multiple lines of text separated by Environment.NewLine.
A to be centered.
An that is the maximum length of padding.
The centered string value.
Centers text within the specified maximum length, biased to the left.
Text will be padded to the left and right with specified padding character.
If value is greater than specified maximum length, value returned will be truncated from the right.
Handles multiple lines of text separated by Environment.NewLine.
A to be centered.
An that is the maximum length of padding.
The value to pad with.
The centered string value.
Performs a case insensitive string replacement.
The string to examine.
The value to replace.
The new value to be inserted
A string with replacements.
Ensures a string starts with a specific character.
Input string to process.
The character desired at string start.
The sent string with character at the start.
Ensures a string starts with a specific character.
Input string to process.
The character desired at string start.
Set to true to ensure one and only one instance of .
The sent string with character at the start.
Ensures a string starts with a specific string.
Input string to process.
The string desired at string start.
The sent string with string at the start.
Ensures a string ends with a specific character.
Input string to process.
The character desired at string's end.
The sent string with character at the end.
Ensures a string ends with a specific character.
Input string to process.
The character desired at string's end.
Set to true to ensure one and only one instance of .
The sent string with character at the end.
Ensures a string ends with a specific string.
Input string to process.
The string desired at string's end.
The sent string with string at the end.
Reverses the order of the characters in a string.
Input string to process.
The reversed string.
Searches a string for a repeated instance of the specified from specified .
The string to process.
The character of interest.
The index from which to begin the search.
The index of the first instance of the character that is repeated or (-1) if no repeated chars found.
Searches a string for a repeated instance of the specified .
The string to process.
The character of interest.
The index of the first instance of the character that is repeated or (-1) if no repeated chars found.
Searches a string for an instance of a repeated character.
The string to process.
The index of the first instance of any character that is repeated or (-1) if no repeated chars found.
Searches a string for an instance of a repeated character from specified .
The string to process.
The index from which to begin the search.
The index of the first instance of any character that is repeated or (-1) if no repeated chars found.
Returns the index of the last repeated index of the first group of repeated characters that begin with the .
String to process.
The character of interest.
The index from which to begin the search.
The index of the last instance of the character that is repeated or (-1) if no repeated chars found.
Places an ellipsis in the middle of a string as it is trimmed to length specified.
The string to process.
The maximum returned string length; minimum value is 5.
A trimmed string of the specified or empty string if is null or empty.
Returned string is not padded to fill field length if is shorter than length.
Places an ellipsis at the end of a string as it is trimmed to length specified.
The string to process.
The maximum returned string length; minimum value is 5.
A trimmed string of the specified or empty string if is null or empty.
Returned string is not padded to fill field length if is shorter than length.
Escapes string using URL encoding.
The string to escape.
URL encoded string.
Removes one or more instances of a specified string from the beginning of a string.
The string to process
The string to remove
Set to false for case insensitive search
A string with deleted from the beginning
Removes one or more instances of a specified char from the beginning of a string.
The string to process
The char to remove
Set to false for case insensitive search
A string with deleted from the beginning
Assures that numeric value is a well formed number
Adds a leading zero in front of a decimal, if present
The string to process
Set to TRUE to assure that value parses to Double
A string with deleted from the beginning
Note: AssureParseDouble also removes trailing zeros following a decimal which implies loss of precision in the value
Removes one or more instances of a string from the end of a string
The string to process
The string to remove
Set to false for case insensitive search
A string with deleted from the end
Removes one or more instances of a character from the end of a string
The string to process
The char to remove
Set to false for case insensitive search
A string with deleted from the end
Returns a string consisting of a specified number of characters from the end of a string "to the left"
The string to process
The number of characters from the end of the string to return
A string of length
Returns a string consisting of a specified number of characters to the left (previous chars) from the provided startIndex
The string to process
The index in at the end of the desired returned string.
The number of characters from the of the string to return
A string to the left of of length up to
Searches a string from right to left for the next instance of a specified string.
Input string to process.
The string to find.
The index in from which to begin looking for . Typically length of minus 1."
Set to false for case insensitive search
The start (or left most) index of within or (-1) if not found.
Searches a string from right to left for the next instance of a specified character.
Input string to process.
The char to find.
The index in from which to begin looking for . Typically length of minus 1."
The index of within or (-1) if not found.
Searches a string from right to left for the next instance of a character passing the specified delegate.
Input string to process.
The delegate function used to match characters.
The index in from which to begin executing test function. Typically length of minus 1."
The index of the matching character within or (-1) if not found.
Searches a string from right to left for the next instance of a character that is not the specified character.
Input string to process.
The char to ignore.
The index in from which to begin looking for a character that is not . Typically length of minus 1."
The index of the character within or (-1) if not found.
Searches a string from right to left for the next instance of a character that is not contained in the specified collection of characters.
Input string to process.
The characters to use to test find.
The index in from which to begin looking for characters not in . Typically length of minus 1."
The index of the character within or (-1) if not found.
Searches a string from right to left for the next instance of a character that does not pass the given delegate function.
Input string to process.
The character test to use.
The index in from which to begin testing characters. Typically length of minus 1."
The index of the character within or (-1) if not found.
Finds the first index that is NOT included in testChars
String to process
the characters use to test
the index at which to begin testing
The first index of a character NOT included in .
Finds the first index that does not match the given .
String to process
the character use to test
the index at which to begin testing
The first index of a character that does NOT match .
Finds the first index that does NOT pass the delegate function.
String to process
the character test to use
the index at which to begin testing
The first index of a character that does NOT pass the .
Counts the total number of the occurrences of string within a string
Input string to process.
String to be counted.
The index at which to begin
Set to false for case insensitive search
Total number of the occurrences of in the given string.
Unwraps quotes similar to Excel. However, a little more predictable for unusual edge cases.
The string to process
The quote char to use. Default is double quote. Due to trimming, quoteChar of whitespace is not allowed.
To remove all quote chars at beginning and end of a string regardless of match use .Trim('"') It's faster.
Three consecutive quotes assures a singe quote char in output.
The sent string with matched surrounding quotes removed.
Unwraps quotes similar to Excel. However, a little more predictable for unusual edge cases.
The string to process
The collection of quote chars to use. Due to trimming, whitespace is not allowed.
The sent string with matched surrounding quote chars removed.
Applies string interpolation to the given format string at runtime.
The type of the object that defines the parameters for the format string.
The format string to be interpolated.
The parameters that can be referenced by the format string.
A copy of in which the format items have been replaced by the string representation of the
corresponding .
This overload uses reflection to obtain the name and value of ' properties
to make those available to the interpolated format string by name. This can be used with user-defined
types, but is mainly intended to be used with anonymous types.
string format = "{hello} {world}!";
var parameters = new { hello = "Hello", world = "World" };
Console.WriteLine(format.Interpolate(parameters));
If can be safely cast to IEnumerable{KeyValuePair{string, object}}, this function
will skip the reflection and call directly.
Applies string interpolation to the given format string at runtime.
The format string to be interpolated.
The parameters that can be referenced by the format string.
A copy of in which the format items have been replaced by the string representation of the
corresponding .
This overload is intended to be used for scenarios in which the parameters available to the format string
are stored in a or .
Note that dynamic variables cannot be used when calling extension functions.
string format = "{hello} {world}!";
dynamic parameters = new ExpandoObject();
parameters.hello = "Hello";
parameters.world = "World";
Console.WriteLine(format.Interpolate(parameters)); // This raises a compiler error
Console.WriteLine(format.Interpolate((ExpandoObject)parameters); // This is okay
Console.WriteLine(StringExtensions.Interpolate(format, parameters); // This is also okay
Parses the string as a CSV document
The string to be parsed
An array of rows parsed as CSV data.
Excel compatible parsing is used, which includes support for quoted fields and embedded commas and quotes.
Reads characters from the string and returns a single row of CSV data.
Row of CSV data to parse
An array of fields in one row of CSV data or null if the row is empty.
Excel compatible parsing is used, which includes support for quoted fields and embedded commas and quotes.
Reads characters from the text reader and returns a single row of CSV data.
The text reader providing the CSV data
An array of fields in one row of CSV data or null if there is no more data available from the text reader.
Excel compatible parsing is used, which includes support for quoted fields and embedded commas and quotes.
Represents a string matcher that can perform various types of string matching operations.
Gets the used.
Gets the string that is being matched.
Gets a flag indicating whether the match is case sensitive.
Generates a new instance.
Sets the used to match.
The string being matched.
A flag indicating if the match is case sensitive.
Compares the specified against the match criteria.
The string that is being matched.
Defines a set of string matching modes.
Exact string matching.
String starts with matching.
String ends with matching.
String contains matching.
Regular expression string matching.
Represents a token that can be used to cancel an asynchronous operation.
Event that will be raised when this is cancelled.
Gets a value that indicates whether the operation has been cancelled.
Cancels the operation.
true if the operation was cancelled; otherwise false.
Implicitly converts a GSF cancellation token to an associated .
Existing GSF cancellation token that is converted to an associated .
A based on an existing GSF cancellation token.
Implicitly converts a GSF cancellation token to an associated .
Existing GSF cancellation token that is converted to an associated .
A based on an existing GSF cancellation token.
Represents a compatible implementation of the interface
that inter-operates with the and can be
used to cancel an asynchronous operation.
Creates a based on an existing system cancellation token source.
Existing system cancellation token source.
Creates a based on an existing system cancellation token.
Existing system token.
A created from an existing system cancellation token
cannot be cancelled since the source for the provided token will not be available.
Creates a based on an existing GSF cancellation token.
Existing GSF token.
Handle disposing of locally allocated resources, if any.
Gets a value that indicates whether the operation has been cancelled.
Cancels the operation.
true if the operation was cancelled; otherwise false.
The token can only be cancelled if a was provided.
not available, token cannot be cancelled.
Gets a associated with this .
A associated with this .
This function will return null when the was created
from an existing system cancellation token and not its source or a GSF cancellation token.
Gets a associated with this .
A associated with this .
Implicitly converts existing system cancellation token to a .
Existing system cancellation token that is converted to a .
A based on an existing system cancellation token.
Implicitly converts existing system cancellation token source to a .
Existing system cancellation token source that is converted to a .
A based on an existing system cancellation token source.
Implicitly converts a to an associated .
Existing GSF cancellation token that is converted to an associated .
A based on an existing GSF cancellation token.
Implicitly converts a to an associated .
Existing GSF cancellation token that is converted to an associated .
A based on an existing GSF cancellation token.
Represents a token that can be used to cancel an asynchronous operation.
Gets a value that indicates whether the operation has been cancelled.
Cancels the operation.
true if the operation was cancelled; otherwise false.
Defines helper methods related to inter-process locking.
Default value for global flag.
Default value for maximum count.
Default value for initial count.
Default value for global flag.
Gets a uniquely named inter-process associated with the running application, typically used to detect whether an instance
of the application is already running.
Indicates whether to generate a different name for the dependent upon the user running the application.
A uniquely named inter-process specific to the application; is created if it does not exist.
This function uses a hash of the assembly's GUID when creating the , if it is available. If it is not available, it uses a hash
of the simple name of the assembly. Although the name is hashed to help guarantee uniqueness, it is still entirely possible that another application
may use that name with the same hashing algorithm to generate its name. Therefore, it is best to ensure that the
is defined in the AssemblyInfo of your application.
The named mutex exists, but the user does not have the minimum needed security access rights to use it.
Gets a uniquely named inter-process associated with the specified that identifies a source object
needing concurrency locking.
Identifying name of source object needing concurrency locking (e.g., a path and file name).
Determines if mutex should be marked as global; set value to false for local.
A uniquely named inter-process specific to ; is created if it does not exist.
This function uses a hash of the when creating the , not the actual - this way
restrictions on the length do not need to be a user concern. All processes needing an inter-process need
to use this same function to ensure access to the same .
The can be a string of any length (must not be empty, null or white space) and is not case-sensitive. All hashes of the
used to create the global are first converted to lower case.
Argument cannot be empty, null or white space.
The named mutex exists, but the user does not have the minimum needed security access rights to use it.
Gets a uniquely named inter-process associated with the running application, typically used to detect whether some number of
instances of the application are already running.
Indicates whether to generate a different name for the dependent upon the user running the application.
The maximum number of requests for the semaphore that can be granted concurrently.
The initial number of requests for the semaphore that can be granted concurrently, or -1 to default to .
A uniquely named inter-process specific to entry assembly; is created if it does not exist.
This function uses a hash of the assembly's GUID when creating the , if it is available. If it is not available, it uses a hash
of the simple name of the assembly. Although the name is hashed to help guarantee uniqueness, it is still entirely possible that another application
may use that name with the same hashing algorithm to generate its name. Therefore, it is best to ensure that the
is defined in the AssemblyInfo of your application.
On POSIX systems, the exhibits kernel persistence, meaning instances will remain active beyond the lifespan of the
creating process. Named semaphores must be explicitly removed by invoking when they are no longer needed.
Kernel persistence necessitates careful design consideration regarding the responsibility for invoking .
Since the common use case for named semaphores is across multiple applications, it is advisable for the last exiting process to handle the
cleanup. In cases where an application may crash before calling , the semaphore persists in the system,
potentially leading to resource leakage. Implementations should include strategies to address and mitigate this risk.
The named semaphore exists, but the user does not have the minimum needed security access rights to use it.
Gets a uniquely named inter-process associated with the specified that identifies a source object
needing concurrency locking.
Identifying name of source object needing concurrency locking (e.g., a path and file name).
The maximum number of requests for the semaphore that can be granted concurrently.
The initial number of requests for the semaphore that can be granted concurrently, or -1 to default to .
Determines if semaphore should be marked as global; set value to false for local.
A uniquely named inter-process specific to ; is created if it does not exist.
This function uses a hash of the when creating the , not the actual - this way
restrictions on the length do not need to be a user concern. All processes needing an inter-process need
to use this same function to ensure access to the same .
The can be a string of any length (must not be empty, null or white space) and is not case-sensitive. All hashes of the
used to create the global are first converted to lower case.
On POSIX systems, the exhibits kernel persistence, meaning instances will remain active beyond the lifespan of the
creating process. Named semaphores must be explicitly removed by invoking when they are no longer needed.
Kernel persistence necessitates careful design consideration regarding the responsibility for invoking .
Since the common use case for named semaphores is across multiple applications, it is advisable for the last exiting process to handle the
cleanup. In cases where an application may crash before calling , the semaphore persists in the system,
potentially leading to resource leakage. Implementations should include strategies to address and mitigate this risk.
Argument cannot be empty, null or white space.
The named semaphore exists, but the user does not have the minimum needed security access rights to use it.
Represents an inter-process reader/writer lock using and
native locking mechanisms.
The uses a to synchronize access to an inter-process shared resource.
On POSIX systems, the exhibits kernel persistence, meaning instances will remain active beyond the lifespan of
the creating process. The named semaphore must be explicitly removed by invoking when the last
reader-writer lock instance is no longer needed. Kernel persistence necessitates careful design consideration regarding process
responsibility for invoking the method. Since the common use case for named semaphores is across
multiple applications, it is advisable for the last exiting process to handle the cleanup. In cases where an application may crash before
calling the method, the semaphore persists in the system, potentially leading to resource leakage.
Implementations should include strategies to address and mitigate this risk.
Default maximum concurrent locks allowed for .
Creates a new instance of the associated with the specified
that identifies a source object needing concurrency locking.
Identifying name of source object needing concurrency locking (e.g., a path and file name).
Determines if semaphore and mutex used by should be marked as global; set value to false for local.
Creates a new instance of the associated with the specified
that identifies a source object needing concurrency locking.
Identifying name of source object needing concurrency locking (e.g., a path and file name).
Maximum concurrent reader locks to allow.
Determines if semaphore and mutex used by should be marked as global; set value to false for local.
If more reader locks are requested than the , excess reader locks will simply
wait until a lock is available (i.e., one of the existing reads completes).
Releases the unmanaged resources before the object is reclaimed by .
Gets the maximum concurrent reader locks allowed.
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Tries to enter the lock in read mode.
Upon successful acquisition of a read lock, use the finally block of a try/finally statement to call .
One should be called for each or .
Tries to enter the lock in write mode.
Upon successful acquisition of a write lock, use the finally block of a try/finally statement to call .
One should be called for each or .
Exits read mode and returns the prior read lock count.
Upon successful acquisition of a read lock, use the finally block of a try/finally statement to call .
One should be called for each or .
Exits write mode.
Upon successful acquisition of a write lock, use the finally block of a try/finally statement to call .
One should be called for each or .
Tries to enter the lock in read mode, with an optional time-out.
The number of milliseconds to wait, or -1 () to wait indefinitely.
true if the calling thread entered read mode, otherwise, false.
Upon successful acquisition of a read lock, use the finally block of a try/finally statement to call .
One should be called for each or .
Note that this function may wait as long as 2 * since the function first waits for synchronous access
to the semaphore, then waits again on an available semaphore slot.
Tries to enter the lock in write mode, with an optional time-out.
The number of milliseconds to wait, or -1 () to wait indefinitely.
true if the calling thread entered write mode, otherwise, false.
Upon successful acquisition of a write lock, use the finally block of a try/finally statement to call .
One should be called for each or .
Note that this function may wait as long as 2 * since the function first waits for synchronous access
to the semaphore, then waits again on an available semaphore slot.
Releases inter-process resources used by the .
On POSIX systems, calling this method removes the named semaphore used by the reader-writer lock.
The semaphore name is removed immediately and is destroyed once all other processes that have the
semaphore open close it. Calling this method on Windows systems does nothing.
Represents a cross-platform, interprocess named semaphore, which limits the number of threads that can concurrently
access a resource or a pool of resources.
A is a synchronization object that can be utilized across multiple processes.
On POSIX systems, the exhibits kernel persistence, meaning instances will remain
active beyond the lifespan of the creating process. Named semaphores must be explicitly removed by invoking
when they are no longer needed. Kernel persistence necessitates careful design consideration
regarding the responsibility for invoking . Since the common use case for named semaphores is
across multiple applications, it is advisable for the last exiting process to handle the cleanup. In cases where
an application may crash before calling , the semaphore persists in the system, potentially
leading to resource leakage. Implementations should include strategies to address and mitigate this risk.
Initializes a new instance of the class, specifying the initial number of entries,
the maximum number of concurrent entries, and the name of a system semaphore object.
The initial number of requests for the semaphore that can be granted concurrently.
The maximum number of requests for the semaphore that can be granted concurrently.
The unique name identifying the semaphore. This name is case-sensitive. Use a backslash (\\) to specify a
namespace, but avoid it elsewhere in the name. On Unix-based systems, the name should conform to valid file
naming conventions, excluding slashes except for an optional namespace backslash. The name length is limited
to 250 characters after any optional namespace.
The may be prefixed with Global\ or Local\ to specify a namespace.
When the Global namespace is specified, the synchronization object may be shared with any processes on the system.
When the Local namespace is specified, which is also the default when no namespace is specified, the synchronization
object may be shared with processes in the same session. On Windows, a session is a login session, and services
typically run in a different non-interactive session. On Unix-like operating systems, each shell has its own session.
Session-local synchronization objects may be appropriate for synchronizing between processes with a parent/child
relationship where they all run in the same session.
Initializes a new instance of the class, specifying the initial number of entries,
the maximum number of concurrent entries, the name of a system semaphore object, and specifying a variable that
receives a value indicating whether a new system semaphore was created.
The initial number of requests for the semaphore that can be granted concurrently.
The maximum number of requests for the semaphore that can be granted concurrently.
The unique name identifying the semaphore. This name is case-sensitive. Use a backslash (\\) to specify a
namespace, but avoid it elsewhere in the name. On Unix-based systems, the name should conform to valid file
naming conventions, excluding slashes except for an optional namespace backslash. The name length is limited
to 250 characters after any optional namespace.
When method returns, contains true if the specified named system semaphore was created; otherwise,
false if the semaphore already existed.
The may be prefixed with Global\ or Local\ to specify a namespace.
When the Global namespace is specified, the synchronization object may be shared with any processes on the system.
When the Local namespace is specified, which is also the default when no namespace is specified, the synchronization
object may be shared with processes in the same session. On Windows, a session is a login session, and services
typically run in a different non-interactive session. On Unix-like operating systems, each shell has its own session.
Session-local synchronization objects may be appropriate for synchronizing between processes with a parent/child
relationship where they all run in the same session.
Gets or sets the native operating system handle.
Gets the name of the .
When overridden in a derived class, releases the unmanaged resources used by the ,
and optionally releases the managed resources.
true to release both managed and unmanaged resources; otherwise, false to release only
unmanaged resources.
Releases all resources held by the current .
Blocks the current thread until the current receives a signal.
true if the current instance receives a signal. If the current instance is never signaled,
never returns.
Blocks the current thread until the current instance receives a signal, using a
to specify the time interval.
A that represents the number of milliseconds to wait, or a
that represents -1 milliseconds to wait indefinitely.
true if the current instance receives a signal; otherwise, false.
Blocks the current thread until the current instance receives a signal, using a 32-bit signed integer to
specify the time interval in milliseconds.
The number of milliseconds to wait, or (-1) to wait indefinitely.
true if the current instance receives a signal; otherwise, false.
Blocks the current thread until the current instance receives a signal, using a
to specify the time interval and specifying whether to exit the synchronization domain before the wait.
A that represents the number of milliseconds to wait, or a
that represents -1 milliseconds to wait indefinitely.
true to exit the synchronization domain for the context before the wait (if in a synchronized context),
and reacquire it afterward; otherwise, false.
true if the current instance receives a signal; otherwise, false.
Blocks the current thread until the current receives a signal, using a
32-bit signed integer to specify the time interval and specifying whether to exit the synchronization
domain before the wait.
The number of milliseconds to wait, or (-1) to wait indefinitely.
true to exit the synchronization domain for the context before the wait (if in a synchronized context),
and reacquire it afterward; otherwise, false.
true if the current instance receives a signal; otherwise, false.
Exits the semaphore and returns the previous count.
The count on the semaphore before the method was called.
Exits the semaphore a specified number of times and returns the previous count.
The number of times to exit the semaphore.
The count on the semaphore before the method was called.
Removes a named semaphore.
On POSIX systems, calling this method removes the named semaphore referred to by .
The semaphore name is removed immediately and is destroyed once all other processes that have the semaphore
open close it. Calling this method on Windows systems does nothing.
Opens an existing named semaphore.
The unique name identifying the semaphore. This name is case-sensitive. Use a backslash (\\) to specify a
namespace, but avoid it elsewhere in the name. On Unix-based systems, the name should conform to valid file
naming conventions, excluding slashes except for an optional namespace backslash. The name length is limited
to 250 characters after any optional namespace.
An object that represents the opened named semaphore.
The may be prefixed with Global\ or Local\ to specify a namespace.
When the Global namespace is specified, the synchronization object may be shared with any processes on the system.
When the Local namespace is specified, which is also the default when no namespace is specified, the synchronization
object may be shared with processes in the same session. On Windows, a session is a login session, and services
typically run in a different non-interactive session. On Unix-like operating systems, each shell has its own session.
Session-local synchronization objects may be appropriate for synchronizing between processes with a parent/child
relationship where they all run in the same session.
Opens the specified named semaphore, if it already exists, and returns a value that indicates whether the
operation succeeded.
The unique name identifying the semaphore. This name is case-sensitive. Use a backslash (\\) to specify a
namespace, but avoid it elsewhere in the name. On Unix-based systems, the name should conform to valid file
naming conventions, excluding slashes except for an optional namespace backslash. The name length is limited
to 250 characters after any optional namespace.
When this method returns, contains a object that represents the named semaphore
if the call succeeded, or null if the call failed. This parameter is treated as uninitialized.
true if the named semaphore was opened successfully; otherwise, false. In some cases,
false may be returned for invalid names.
The may be prefixed with Global\ or Local\ to specify a namespace.
When the Global namespace is specified, the synchronization object may be shared with any processes on the system.
When the Local namespace is specified, which is also the default when no namespace is specified, the synchronization
object may be shared with processes in the same session. On Windows, a session is a login session, and services
typically run in a different non-interactive session. On Unix-like operating systems, each shell has its own session.
Session-local synchronization objects may be appropriate for synchronizing between processes with a parent/child
relationship where they all run in the same session.
Removes a named semaphore.
The unique name identifying the semaphore. This name is case-sensitive. Use a backslash (\\) to specify a
namespace, but avoid it elsewhere in the name. On Unix-based systems, the name should conform to valid file
naming conventions, excluding slashes except for an optional namespace backslash. The name length is limited
to 250 characters after any optional namespace.
On POSIX systems, calling this method removes the named semaphore referred to by .
The semaphore name is removed immediately and is destroyed once all other processes that have the semaphore
open close it. Calling this method on Windows systems does nothing.
Represents a short-running synchronized operation that cannot run while it is already
in progress. Async operations will execute on the thread-pool after the specified
in milliseconds.
By default, the action performed by the
is executed on the when running the operation asynchronously.
When the operation is set to pending, the action is executed in an asynchronous loop on
the thread pool until all pending operations have been completed. Since the action is
executed on the thread pool, it is best if it can be executed quickly, without
blocking the thread or putting it to sleep. If completion of the operation is
critical, such as when saving data to a file, this type of operation should not
be used since thread pool threads are background threads and will not prevent the
program from ending before the operation is complete.
Defines the default value for the property.
Creates a new instance of the class.
The action to be performed during this operation.
Creates a new instance of the class.
The cancellable action to be performed during this operation.
Cancellable synchronized operation is useful in cases where actions should be terminated
during dispose and/or shutdown operations.
Creates a new instance of the class.
The action to be performed during this operation.
The action to be performed if an exception is thrown from the action.
Creates a new instance of the class.
The cancellable action to be performed during this operation.
The action to be performed if an exception is thrown from the action.
Cancellable synchronized operation is useful in cases where actions should be terminated
during dispose and/or shutdown operations.
Gets or sets the amount of time to wait before execution, in milliseconds,
for any asynchronous calls. Zero value will execute immediately.
Non asynchronous calls will not be delayed.
Executes the action on another thread after the specified in milliseconds or marks
the operation as pending if the operation is already running. Method same as for
.
Defines synchronization mode for running any pending operation; must be false for
.
For , actions will always run on another thread so this method is
hidden from intellisense.
When the operation is marked as pending, it will run again after the operation that is currently running
has completed. This is useful if an update has invalidated the operation that is currently running and
will therefore need to be run again.
must be false for .
Attempts to execute the action on another thread after the specified in milliseconds.
Does nothing if the operation is already running. Method same as for
.
Defines synchronization mode for running any pending operation; must be false for
.
For , actions will always run on another thread so this method is
hidden from intellisense.
must be false for .
Executes the action on another thread after the specified in milliseconds or marks
the operation as pending if the operation is already running
When the operation is marked as pending, operation will run again after currently running operation has
completed. This is useful if an update has invalidated the operation that is currently running and will
therefore need to be run again.
Attempts to execute the action on another thread after the specified in milliseconds.
Does nothing if the operation is already running.
Executes the action on a separate thread after the specified .
Factory method to match the signature.
The action to be performed by the .
A new instance of with of 1000 milliseconds.
Factory method for creating synchronized operations.
The action to be synchronized by the operation.
The operation that synchronizes the given action.
Represents the available types of synchronized operations.
with IsBackground set to true
Represents an operation that cannot run while it is already in progress.
Gets flag indicating if the synchronized operation is currently executing its action.
Gets flag indicating if the synchronized operation has an additional operation that is pending
execution after the currently running action has completed.
Gets or sets to use for canceling actions.
Executes the action on current thread or marks the operation as pending if the operation is already running.
Defines synchronization mode for running any pending operation.
When the operation is marked as pending, operation will run again after currently running operation has
completed. This is useful if an update has invalidated the operation that is currently running and will
therefore need to be run again.
When is true, this method will not guarantee that control
will be returned to the thread that called it; if other threads continuously mark the operation as pending,
this thread will continue to run the operation indefinitely on the calling thread.
Attempts to execute the action on current thread. Does nothing if the operation is already running.
Defines synchronization mode for running any pending operation.
When is true, this method will not guarantee that control
will be returned to the thread that called it; if other threads continuously mark the operation as pending,
this thread will continue to run the operation indefinitely on the calling thread.
Executes the action on another thread or marks the operation as pending if the operation is already running.
When the operation is marked as pending, it will run again after the operation that is currently running
has completed. This is useful if an update has invalidated the operation that is currently running and
will therefore need to be run again.
Attempts to execute the action on another thread. Does nothing if the operation is already running.
Represents a long-running synchronized operation that cannot run while it is already in progress.
The action performed by the is executed on
its own dedicated thread when running the operation in the foreground asynchronously.
When running on its own thread, the action is executed in a tight loop until all
pending operations have been completed. This type of synchronized operation should
be preferred if operations may take a long time, block the thread, or put it to sleep.
It is also recommended to prefer this type of operation if the speed of the operation
is not critical or if completion of the operation is critical, such as when saving data
to a file.
Creates a new instance of the class.
The action to be performed during this operation.
Creates a new instance of the class.
The cancellable action to be performed during this operation.
Cancellable synchronized operation is useful in cases where actions should be terminated
during dispose and/or shutdown operations.
Creates a new instance of the class.
The action to be performed during this operation.
The action to be performed if an exception is thrown from the action.
Creates a new instance of the class.
The action to be performed during this operation.
The cancellable action to be performed if an exception is thrown from the action.
Cancellable synchronized operation is useful in cases where actions should be terminated
during dispose and/or shutdown operations.
Gets or sets whether the thread executing the action is a background thread.
This defaults to false, be aware that foreground thread will prevent shutdown
while task is running. If a task keeps getting marked as pending, application will not
shut down; consider a cancellable action for
instances that use a foreground thread.
Executes the action on a separate thread.
Factory method to match the signature.
The action to be performed by the .
A new instance of .
The namespace provides classes and interfaces for
synchronized operations, which are operations that cannot run while another is already in progress, e.g.,
and .
Represents a short-running synchronized operation that cannot run while it is already in progress.
By default, the action performed by the
is executed on the when running the operation asynchronously.
When the operation is set to pending, the action is executed in an asynchronous loop
on the thread pool until all pending operations have been completed. Since the action
is executed on the thread pool, it is best if it can be executed quickly, without
blocking the thread or putting it to sleep. If completion of the operation is
critical, such as when saving data to a file, this type of operation should not
be used since thread pool threads are background threads and will not prevent the
program from ending before the operation is complete.
Creates a new instance of the class.
The action to be performed during this operation.
Creates a new instance of the class.
The action to be performed during this operation.
The action to be performed if an exception is thrown from the action.
Executes the action in an asynchronous loop on
the thread pool, as long as the operation is pending.
Factory method to match the signature.
The action to be performed by the .
A new instance of .
Base class for operations that cannot run while they is already in progress.
This class handles the synchronization between the methods defined in the
interface. Implementers should only need to implement the method to provide a
mechanism for executing the action on a separate thread.
If subclass implementations get constructed without an exception handler, applications should attach to the static
event so that any unhandled exceptions can be exposed to a log.
Creates a new instance of the class.
The action to be performed during this operation.
Creates a new instance of the class.
The cancellable action to be performed during this operation.
Cancellable synchronized operation is useful in cases where actions should be terminated
during dispose and/or shutdown operations.
Creates a new instance of the class.
The action to be performed during this operation.
The action to be performed if an exception is thrown from the action.
Creates a new instance of the class.
The cancellable action to be performed during this operation.
The action to be performed if an exception is thrown from the action.
Cancellable synchronized operation is useful in cases where actions should be terminated
during dispose and/or shutdown operations.
Gets flag indicating if the synchronized operation is currently executing its action.
Gets flag indicating if the synchronized operation has an additional operation that is pending
execution after the currently running action has completed.
Gets or sets to use for cancelling actions.
Executes the action on current thread or marks the operation as pending if the operation is already running.
Defines synchronization mode for running any pending operation.
When the operation is marked as pending, operation will run again after currently running operation has
completed. This is useful if an update has invalidated the operation that is currently running and will
therefore need to be run again.
When is true, this method will not guarantee that control
will be returned to the thread that called it; if other threads continuously mark the operation as pending,
this thread will continue to run the operation indefinitely on the calling thread.
Attempts to execute the action on current thread. Does nothing if the operation is already running.
Defines synchronization mode for running any pending operation.
When is true, this method will not guarantee that control
will be returned to the thread that called it; if other threads continuously mark the operation as pending,
this thread will continue to run the operation indefinitely on the calling thread.
Executes the action on another thread or marks the operation as pending if the operation is already running.
When the operation is marked as pending, operation will run again after currently running operation has
completed. This is useful if an update has invalidated the operation that is currently running and will
therefore need to be run again.
Attempts to execute the action on another thread. Does nothing if the operation is already running.
Executes the action once on the current thread.
true if the action was pending and needs to run again; otherwise, false.
Executes the action on a separate thread.
Implementers should call on a separate thread and check the return value.
If it returns true, that means it needs to run again. The following is a sample implementation using
a regular dedicated thread:
protected override void ExecuteActionAsync()
{
Thread actionThread = new Thread(() =>
{
while (ExecuteAction())
{
}
});
actionThread.Start();
}
Processes an exception thrown by an operation.
to be processed.
Represents a task-based synchronized operation
that cannot run while it is already in progress.
The action performed by the is executed using
. Pending actions run when the task returned by the
asynchronous action is completed. This synchronized operation only supports the async
methods on the interface because the async action
cannot be executed synchronously.
The following example shows how to use to
implement a notifier that receives notification requests ad-hoc but sends notifications
no more than once every 15 seconds.
public ExampleClass() =>
SynchronizedOperation = new TaskSynchronizedOperation(NotifyAsync);
public void SendNotification() =>
SynchronizedOperation.RunOnceAsync();
private async Task NotifyAsync()
{
Notify();
await Task.Delay(15000);
}
Creates a new instance of the class.
The action to be performed during this operation.
Creates a new instance of the class.
The action to be performed during this operation.
Creates a new instance of the class.
The action to be performed during this operation.
The action to be performed if an exception is thrown from the action.
Creates a new instance of the class.
The action to be performed during this operation.
The action to be performed if an exception is thrown from the action.
Gets a value to indicate whether the synchronized
operation is currently executing its action.
Gets a value to indicate whether the synchronized operation
has an additional operation that is pending execution after
the currently running action has completed.
Gets or sets to use for canceling actions.
Executes the action on another thread or marks the
operation as pending if the operation is already running.
When the operation is marked as pending, it will run again after the
operation that is currently running has completed. This is useful if
an update has invalidated the operation that is currently running and
will therefore need to be run again.
Attempts to execute the action on another thread.
Does nothing if the operation is already running.
Time intervals enumeration used by method.
Baseline timestamp to the second (i.e., starting at zero milliseconds).
Baseline timestamp to the minute (i.e., starting at zero seconds and milliseconds).
Baseline timestamp to the hour (i.e., starting at zero minutes, seconds and milliseconds).
Baseline timestamp to the day (i.e., starting at zero hours, minutes, seconds and milliseconds).
Baseline timestamp to the month (i.e., starting at day one, zero hours, minutes, seconds and milliseconds).
Baseline timestamp to the year (i.e., starting at month one, day one, zero hours, minutes, seconds and milliseconds).
Provides a type converter to convert values to and from various other representations.
Since reports a type code of , the converter will convert
to and from long values as well as other types supported by .
Provides a JSON converter for values.
Represents an instant in time, or time period, as a 64-bit signed integer with a value that is expressed as the number
of 100-nanosecond intervals that have elapsed since 12:00:00 midnight, January 1, 0001.
can represent an "instant in time" and therefore can be used exactly like a .
The difference between and is that is essentially a long
integer (i.e., an ) which represents the number of ticks that have elapsed since 12:00:00 midnight,
January 1, 0001 with each tick having a resolution of 100-nanoseconds. You would use in places where
you needed to directly represent time in high-resolution, i.e., time with sub-second accuracy, using an object that will
act like a long integer but handle time conversions. can also represent a "time period" (e.g., the
number of ticks elapsed since a process started) and thus can also be used like a ; when used in
this manner the method can be used to convert the value
into a handy textual representation of elapsed years, days, hours, minutes and seconds or sub-seconds.
This class behaves just like an representing a time in ticks; it is implicitly castable to and from
an and therefore can be generally used "as" an Int64 directly. It is also implicitly castable to and
from a , a , an and a .
Number of 100-nanosecond ticks in one second.
Number of 100-nanosecond ticks in one millisecond.
Number of 100-nanosecond ticks in one microsecond.
Number of 100-nanosecond ticks in one minute.
Number of 100-nanosecond ticks in one hour.
Number of 100-nanosecond ticks in one day.
Time value stored in ticks.
Creates a new .
New time value in ticks.
Creates a new .
New time value as a .
Creates a new .
New time value as a .
Gets the value in equivalent number of days.
Value of in days.
If value represents an instant in time, returned value will represent the number of days
that have elapsed since 12:00:00 midnight, January 1, 0001.
Gets the value in equivalent number of hours.
Value of in hours.
If value represents an instant in time, returned value will represent the number of hours
that have elapsed since 12:00:00 midnight, January 1, 0001.
Gets the value in equivalent number of minutes.
Value of in minutes.
If value represents an instant in time, returned value will represent the number of minutes
that have elapsed since 12:00:00 midnight, January 1, 0001.
Gets the value in equivalent number of seconds.
Value of in seconds.
If value represents an instant in time, returned value will represent the number of seconds
that have elapsed since 12:00:00 midnight, January 1, 0001.
Gets the value in equivalent number of milliseconds.
Value of in milliseconds.
If value represents an instant in time, returned value will represent the number of milliseconds
that have elapsed since 12:00:00 midnight, January 1, 0001.
Gets the value in equivalent number of microseconds.
Value of in microseconds.
If value represents an instant in time, returned value will represent the number of microseconds
that have elapsed since 12:00:00 midnight, January 1, 0001.
Gets a new value truncated by removing fractions of the arguement.
New object.
If value represents the number of ticks in a second, the truncated value will represent Ticks rounded
down to the nearest whole second.
Determines if time, represented by value in UTC time, is valid by comparing it to
the system clock.
The allowed lag time, in seconds, before assuming time is too old to be valid.
The allowed lead time, in seconds, before assuming time is too advanced to be valid.
True, if UTC time represented by value, is within the specified range.
Time, represented by value, is considered valid if it exists within the specified
and range of system clock time in UTC. Note
that and must be greater than zero, but can be set
to sub-second intervals.
and must be greater than zero, but can be less than one.
Determines if time, represented by value in UTC time, is valid by comparing it to
the system clock.
The allowed lag time, in ticks, before assuming time is too old to be valid.
The allowed lead time, in ticks, before assuming time is too advanced to be valid.
True, if UTC time represented by value, is within the specified range.
Time, represented by value, is considered valid if it exists within the specified
and range of system clock time in UTC. Note
that and must be greater than zero.
and must be greater than zero.
Determines if time, represented by value in local time, is valid by comparing it to
the system clock.
The allowed lag time, in seconds, before assuming time is too old to be valid.
The allowed lead time, in seconds, before assuming time is too advanced to be valid.
True, if local time represented by value, is within the specified range.
Time, represented by value, is considered valid if it exists within the specified
and range of local system clock time. Note
that and must be greater than zero, but can be set
to sub-second intervals.
and must be greater than zero, but can be less than one.
Determines if time, represented by value in local time, is valid by comparing it to
the system clock.
The allowed lag time, in ticks, before assuming time is too old to be valid.
The allowed lead time, in ticks, before assuming time is too advanced to be valid.
True, if local time represented by value, is within the specified range.
Time, represented by value, is considered valid if it exists within the specified
and range of local system clock time. Note
that and must be greater than zero.
and must be greater than zero.
Determines if time, represented by value, is valid by comparing it to the specified
current time.
Specified current time (e.g., could be DateTime.Now.Ticks).
The allowed lag time, in seconds, before assuming time is too old to be valid.
The allowed lead time, in seconds, before assuming time is too advanced to be valid.
True, if time represented by value, is within the specified range.
Time, represented by value, is considered valid if it exists within the specified
and range of . Note
that and must be greater than zero, but can be set
to sub-second intervals.
and must be greater than zero, but can be less than one.
Determines if time, represented by value, is valid by comparing it to the specified
current time.
Specified current time (e.g., could be DateTime.Now.Ticks).
The allowed lag time, in ticks, before assuming time is too old to be valid.
The allowed lead time, in ticks, before assuming time is too advanced to be valid.
True, if time represented by value, is within the specified range.
Time, represented by value, is considered valid if it exists within the specified
and range of . Note
that and must be greater than zero.
and must be greater than zero.
Gets the distance, in 100-nanoseconds intervals, beyond the top of the second in the timestamp
represented by the .
Number of 100-nanoseconds intervals value is from the top of the second.
Creates a new value that represents a base-lined timestamp, in 100-nanoseconds
intervals, that begins at the beginning of the specified time interval.
to which timestamp should be base-lined.
A new value that represents a base-lined timestamp, in 100-nanoseconds intervals,
that begins at the specified .
Base-lining to the would return the
value starting at zero milliseconds.
Base-lining to the would return the
value starting at zero seconds and milliseconds.
Base-lining to the would return the
value starting at zero minutes, seconds and milliseconds.
Base-lining to the would return the
value starting at zero hours, minutes, seconds and milliseconds.
Base-lining to the would return the
value starting at day one, zero hours, minutes, seconds and milliseconds.
Base-lining to the would return the
value starting at month one, day one, zero hours, minutes, seconds and milliseconds.
Converts the value of the value to its equivalent string representation.
A string representation of the value.
Converts the value to its equivalent string representation, using
the specified format.
A format string.
The string representation of the value of this instance as specified by format.
Converts the value to its equivalent string representation, using
the specified culture-specific format information.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by provider.
Converts the value to its equivalent string representation, using
specified format and culture-specific format information.
A format specification.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by format and provider.
Converts the value into a textual representation of years, days, hours,
minutes and seconds.
Note that this ToElapsedTimeString overload will not display fractional seconds. To allow
display of fractional seconds, or completely remove second resolution from the textual
representation, use the overload instead.
The string representation of the value of this instance, consisting of the number of
years, days, hours, minutes and seconds represented by this value.
Converts the value into a textual representation of years, days, hours,
minutes and seconds with the specified number of fractional digits.
Number of fractional digits to display for seconds.
Minimum sub-second resolution to display. Defaults to .
Set to -1 to suppress seconds display, this will
force minimum resolution of time display to minutes.
The string representation of the value of this instance, consisting of the number of
years, days, hours, minutes and seconds represented by this value.
is not less than or equal to or
is not defined in array.
Converts the value into a textual representation of years, days, hours,
minutes and seconds with the specified number of fractional digits given string array of
time names.
Number of fractional digits to display for seconds.
Time names array to use during textual conversion.
Minimum sub-second resolution to display. Defaults to .
Set to -1 to suppress seconds display, this will
force minimum resolution of time display to minutes.
array needs one string entry for each of the following names:
" year", " years", " day", " days", " hour", " hours", " minute", " minutes", " second", " seconds", "less than ".
The string representation of the value of this instance, consisting of the number of
years, days, hours, minutes and seconds represented by this value.
is not less than or equal to or
is not defined in array.
Compares this instance to a specified object and returns an indication of their relative values.
An object to compare, or null.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
value is not an , , or .
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Compares this instance to a specified and returns an indication of their
relative values.
An to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Returns a value indicating whether this instance is equal to a specified object.
An object to compare, or null.
True if obj is an instance of or and equals the value of this instance;
otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
An value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns the hash code for this instance.
A 32-bit signed integer hash code.
Returns the for value type .
The enumerated constant, .
Compares the two values for equality.
left hand operand.
right hand operand.
value representing the result.
Compares the two values for inequality.
left hand operand.
right hand operand.
value representing the result.
Returns true if left value is less than right value.
left hand operand.
right hand operand.
value representing the result.
Returns true if left value is less or equal to than right value.
left hand operand.
right hand operand.
value representing the result.
Returns true if left value is greater than right value.
left hand operand.
right hand operand.
value representing the result.
Returns true if left value is greater than or equal to right value.
left hand operand.
right hand operand.
value representing the result.
Implicitly converts value, represented in ticks, to a .
value to convert.
value representing the result.
Implicitly converts value, represented as a , to a .
value to convert.
value representing the result.
Implicitly converts value, represented as a , to a .
value to convert.
value representing the result.
Implicitly converts value, represented as a , to a .
value to convert.
value representing the result.
Implicitly converts , represented in ticks, to an .
value to convert.
value representing the result.
Implicitly converts , represented in ticks, to a .
value to convert.
value representing the result.
Implicitly converts , represented in ticks, to a .
value to convert.
value representing the result.
Implicitly converts , represented in ticks, to an .
value to convert.
value representing the result.
Implicitly converts , represented in ticks, to a .
value to convert.
value representing the result.
Returns true if value is not zero.
value to evaluate.
value representing the result.
Returns true if value is equal to zero.
value to evaluate.
value representing the result.
Returns bitwise complement of value.
value to evaluate.
value representing the result.
Returns logical bitwise AND of values.
left hand operand.
right hand operand.
value representing the result.
Returns logical bitwise OR of values.
left hand operand.
right hand operand.
value representing the result.
Returns logical bitwise exclusive-OR of values.
left hand operand.
right hand operand.
value representing the result.
Returns value after right shifts of first value by the number of bits specified by second value.
value to shift.
number of bits to shift.
value representing the result.
Returns value after left shifts of first value by the number of bits specified by second value.
value to shift.
number of bits to shift.
value representing the result.
Returns computed remainder after dividing first value by the second.
Left hand operand.
Right hand operand.
value representing the result.
Returns computed sum of values.
Left hand operand.
Right hand operand.
value representing the result.
Returns computed difference of values.
Left hand operand.
Right hand operand.
value representing the result.
Returns computed product of values.
Left hand operand.
Right hand operand.
value representing the result.
Returns computed division of values.
Left hand operand.
Right hand operand.
value representing the result.
Returns result of first value raised to power of second value.
Left hand operand.
Right hand operand.
value representing the result.
Represents the largest possible value of a . This field is constant.
Represents the smallest possible value of a . This field is constant.
Gets a high-resolution number of seconds, including fractional seconds, that have
elapsed since 12:00:00 midnight, January 1, 0001.
Converts , in 100-nanosecond tick intervals, to seconds.
Number of ticks to convert to seconds.
Number seconds represented by specified in ticks.
If represents an instant in time, returned value will represent the number of seconds
that have elapsed since 12:00:00 midnight, January 1, 0001.
Converts , in 100-nanosecond tick intervals, to milliseconds.
Number of ticks to convert to milliseconds.
Number milliseconds represented by specified in ticks.
If represents an instant in time, returned value will represent the number of milliseconds
that have elapsed since 12:00:00 midnight, January 1, 0001.
Converts , in 100-nanosecond tick intervals, to microseconds.
Number of ticks to convert to microseconds.
Number microseconds represented by specified in ticks.
If represents an instant in time, returned value will represent the number of microseconds
that have elapsed since 12:00:00 midnight, January 1, 0001.
Creates a new from the specified in seconds.
New value in seconds.
New object from the specified in seconds.
Creates a new from the specified in milliseconds.
New value in milliseconds.
New object from the specified in milliseconds.
Creates a new from the specified in microseconds.
New value in microseconds.
New object from the specified in microseconds.
Converts the string representation of a number to its equivalent.
A string containing a number to convert.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number in a specified culture-specific format to its equivalent.
A string containing a number to convert.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style and culture-specific format to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number to its equivalent. A return value
indicates whether the conversion succeeded or failed.
A string containing a number to convert.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not of the correct format, or represents a number less than or greater than .
This parameter is passed uninitialized.
true if s was converted successfully; otherwise, false.
Converts the string representation of a number in a specified style and culture-specific format to its
equivalent. A return value indicates whether the conversion succeeded or failed.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not in a format compliant with style, or represents a number less than or
greater than . This parameter is passed uninitialized.
A object that supplies culture-specific formatting information about s.
true if s was converted successfully; otherwise, false.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
Gets a sub-second time distribution in for the specified .
Samples per second.
Array of sub-second time distribution in .
Gets a sub-second time distribution in milliseconds for the specified .
Samples per second.
Array of sub-second time distribution in milliseconds.
Gets a sub-second time distribution in microseconds for the specified .
Samples per second.
Array of sub-second time distribution in microseconds.
Returns a floor-aligned sub-second distribution timestamp for given .
Timestamp to align.
Samples per second to use for distribution.
Defines the time resolution to use when aligning to its proper distribution timestamp.
A floor-aligned sub-second distribution timestamp for given .
Time resolution value is typically a power of 10 based on the number of ticks per the desired resolution. The following table defines
common resolutions and their respective values:
Resolution
Time Resolution Value
-
Seconds
-
Milliseconds
-
Microseconds
-
Ticks
0
If source timestamps have variation, i.e., they are not aligned within common distributions, the
can be adjusted to include slack to accommodate the variance. When including slack in the time resolution, the value will depend
on the , for example: you could use 330,000 for 30 samples per second, 160,000 for 60 samples
per second, and 80,000 for 120 samples per second. Actual slack value may need to be more or less depending on the size of the
source timestamp variation.
Returns a floor-aligned millisecond distribution timestamp for given .
Timestamp to align.
Samples per second to use for distribution.
A floor-aligned millisecond distribution timestamp for given .
Returns a floor-aligned microsecond distribution timestamp for given .
Timestamp to align.
Samples per second to use for distribution.
A floor-aligned microsecond distribution timestamp for given .
Returns the nearest sub-second distribution timestamp for given .
Timestamp to align.
Samples per second to use for distribution.
The nearest sub-second distribution timestamp for given .
Returns the nearest distribution timestamp for given .
Timestamp to align.
Samples per second to use for distribution.
Starting Timestamp of the Distribution.
The nearest distribution timestamp for given .
Returns the distribution timestamp for given or if there is no TS within the specified Tolerance.
Timestamp to align.
Samples per second to use for distribution.
Tolerance of the TS in ticks.
Starting Timestamp of the Distribution.
The distribution timestamp for given or .
Contains extension methods for values.
Extends the TimeSpan Class
Converts the value into a textual representation of years, days, hours,
minutes and seconds with the specified number of fractional digits given string array of
time names.
The to process.
Number of fractional digits to display for seconds.
Time names array to use during textual conversion.
Minimum sub-second resolution to display. Defaults to .
Set to -1 to suppress seconds display, this will
force minimum resolution of time display to minutes.
array needs one string entry for each of the following names:
" year", " years", " day", " days", " hour", " hours", " minute", " minutes", " second", " seconds", "less than ".
DateTime g_start = DateTime.UtcNow;
DateTime EndTime = DateTime.UtcNow;
TimeSpan duration = EndTime.Subtract(g_start);
Console.WriteLine("Elapsed Time = " + duration.ToElapsedTimeString());
The string representation of the value of this instance, consisting of the number of
years, days, hours, minutes and seconds represented by this value.
is not less than or equal to or
is not defined in array.
Represents the base class for alternate time-tag implementations.
Default format for implementations.
Creates a new , given number base time (in ticks) and seconds since base time.
Ticks of time-tag base.
Number of seconds since base time.
Creates a new , given standard .NET .
Ticks of time-tag base.
Timestamp in used to create time-tag from.
Creates a new from serialization parameters.
The with populated with data.
The source for this deserialization.
Gets or sets number of seconds (including any fractional seconds) since base time.
Gets ticks representing the absolute minimum time of this time-tag implementation.
Returns standard .NET representation for time-tag.
A .
Returns basic textual representation for time-tag.
Format is "yyyy-MM-dd HH:mm:ss.fff" so that textual representation can be sorted in the
correct chronological order.
A value representing the time-tag.
Returns textual representation for time-tag in the specified .
Format of text output.
of textual representation for time-tag.
Returns textual representation for time-tag using the specified .
An that supplies culture-specific formatting information.
of textual representation for time-tag.
Returns textual representation for time-tag in the specified using
the specified .
Format of text output.
An that supplies culture-specific formatting information.
of textual representation for time-tag.
Compares the with another .
The to compare with the current .
A 32-bit signed integer that indicates the relative order of the objects being compared.
Compares the with a .
The to compare with the current .
A 32-bit signed integer that indicates the relative order of the objects being compared.
Compares the with the specified .
The to compare with the current .
A 32-bit signed integer that indicates the relative order of the objects being compared.
is not an or a .
Determines whether the specified is equal to the current .
The to compare with the current .
true if the specified is equal to the current ;
otherwise, false.
is not an .
Determines whether the specified is equal to the current .
The to compare with the current .
true if the specified is equal to the current ;
otherwise, false.
Determines whether the specified is equal to the current .
The to compare with the current .
true if the specified is equal to the current ;
otherwise, false.
Serves as a hash function for the current .
A hash code for the current .
Hash code based on number of seconds time-tag represents.
Populates a with the data needed to serialize the target object.
The to populate with data.
The destination for this serialization.
Returns true if is equal to .
Value 1 in the comparison.
Value 2 in the comparison.
true if is equal to ; otherwise false.
Returns true if is equal to .
Value 1 in the comparison.
Value 2 in the comparison.
true if is equal to ; otherwise false.
Returns true if is equal to .
Value 1 in the comparison.
Value 2 in the comparison.
true if is equal to ; otherwise false.
Returns true if is not equal to .
Value 1 in the comparison.
Value 2 in the comparison.
true if is not equal to ; otherwise false.
Returns true if is not equal to .
Value 1 in the comparison.
Value 2 in the comparison.
true if is not equal to ; otherwise false.
Returns true if is not equal to .
Value 1 in the comparison.
Value 2 in the comparison.
true if is not equal to ; otherwise false.
Returns true if is less than .
Value 1 in the comparison.
Value 2 in the comparison.
true if is less than ; otherwise false.
Returns true if is less than .
Value 1 in the comparison.
Value 2 in the comparison.
true if is less than ; otherwise false.
Returns true if is less than .
Value 1 in the comparison.
Value 2 in the comparison.
true if is less than ; otherwise false.
Returns true if is less than or equal to .
Value 1 in the comparison.
Value 2 in the comparison.
true if is less than or equal to ; otherwise false.
Returns true if is less than or equal to .
Value 1 in the comparison.
Value 2 in the comparison.
true if is less than or equal to ; otherwise false.
Returns true if is less than or equal to .
Value 1 in the comparison.
Value 2 in the comparison.
true if is less than or equal to ; otherwise false.
Returns true if is greater than .
Value 1 in the comparison.
Value 2 in the comparison.
true if is greater than ; otherwise false.
Returns true if is greater than .
Value 1 in the comparison.
Value 2 in the comparison.
true if is greater than ; otherwise false.
Returns true if is greater than .
Value 1 in the comparison.
Value 2 in the comparison.
true if is greater than ; otherwise false.
Returns true if is greater than or equal to .
Value 1 in the comparison.
Value 2 in the comparison.
true if is greater than or equal to ; otherwise false.
Returns true if is greater than or equal to .
Value 1 in the comparison.
Value 2 in the comparison.
true if is greater than or equal to ; otherwise false.
Returns true if is greater than or equal to .
Value 1 in the comparison.
Value 2 in the comparison.
true if is greater than or equal to ; otherwise false.
Contains extension methods for values.
Extensions to all objects.
Determines if the specified type is a native structure that represents a numeric value.
The being tested.
true if the specified type is a native structure that represents a numeric value.
For this method a boolean value is not considered numeric even though it can be thought of as a bit.
This expression returns true if the type is one of the following:
SByte, Byte, Int16, UInt16, Int32, UInt32, Int64, UInt64, Single, Double, Decimal
Gets the friendly class name of the provided type, trimming generic parameters.
Type to get friendly class name for.
Friendly class name of the provided type, or if is null.
Gets the root type in the inheritance hierarchy from which the specified inherits.
The whose root type is to be found.
The root type in the inheritance hierarchy from which the specified inherits.
Unless input is or , the returned type will never
be or , even though all types ultimately inherit from either one of them.
Gets a C#-compatible proper type name, resolving generic type names using reflection with no backticks (`), for the specified .
The whose name is to be resolved.
Flag that indicates if native C# type names should be used, when possible.
Flag that indicates if namespaces should be included in the type name.
A C#-compatible proper type name, resolving generic type names using reflection with no backticks (`), for the specified .
This method will return a C#-compatible proper type name, resolving generic type names using reflection, which creates a valid,
usable type name versus what returns. For example, will return something like:
System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]
with a backtick (`) to indicate a generic type and noisy assembly info. Even Type.Name returns List`1 with a backtick (`). For the
same type, this method would instead return: System.Collections.Generic.List<System.String> which is a valid, usable C# type name.
You can also set the parameter to false to remove namespaces from the type name, which yields:
List<String> for the same example.
Loads public types from assemblies in the application binaries directory that implement the specified
either through class inheritance or interface implementation.
The that must be implemented by the public types.
Public types that implement the specified .
Loads public types from assemblies in the application binaries directory that implement the specified
either through class inheritance or interface implementation.
The that must be implemented by the public types.
true to exclude public types that are abstract; otherwise false.
Public types that implement the specified .
Loads public types from assemblies in the specified that implement
the specified either through class inheritance or interface implementation.
The that must be implemented by the public types.
The directory containing the assemblies to be processed.
Public types that implement the specified .
Loads public types from assemblies in the specified that implement
the specified either through class inheritance or interface implementation.
The that must be implemented by the public types.
The directory containing the assemblies to be processed.
true to exclude public types that are abstract; otherwise false.
True to validate references of loaded assemblies before attempting to instantiate types; false otherwise.
Public types that implement the specified .
Represents the units available for an value.
Radian angle units.
Degree angle units.
Grad angle units, a.k.a., grade, gradian and gon.
ArcMinute angle units, a.k.a., minute of arc or MOA.
ArcSecond angle units, a.k.a., second of arc.
AngularMil angle units, a.k.a., mil.
Provides a type converter to convert values to and from various other representations.
Since reports a type code of , the converter will convert
to and from double values as well as other types supported by .
Represents an angle, in radians, as a double-precision floating-point number.
This class behaves just like a representing an angle in radians; it is implicitly
castable to and from a and therefore can be generally used "as" a double, but it
has the advantage of handling conversions to and from other angle representations, specifically
degrees, grads (a.k.a., grade, gradian and gon), arcminutes (a.k.a., minute of arc or MOA),
arcseconds (a.k.a., second of arc) and angular mil (a.k.a., mil).
This example converts degrees to grads:
public double GetGrads(double degrees)
{
return Angle.FromDegrees(degrees).ToGrads();
}
Creates a new .
New angle value in radians.
Gets the value in degrees.
Value of in degrees.
Gets the value in grads.
Value of in grads.
Gets the value in arcminutes.
Value of in arcminutes.
Gets the value in arcseconds.
Value of in arcseconds.
Gets the value in angular mil.
Value of in angular mil.
Converts the to the specified .
Target units.
converted to .
Compares this instance to a specified object and returns an indication of their relative values.
An object to compare, or null.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
value is not a or .
Compares this instance to a specified and returns an indication of their
relative values.
An to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Returns a value indicating whether this instance is equal to a specified object.
An object to compare, or null.
True if obj is an instance of or and equals the value of this instance;
otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
An value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns the hash code for this instance.
A 32-bit signed integer hash code.
Converts the numeric value of this instance to its equivalent string representation.
The string representation of the value of this instance, consisting of a minus sign if
the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeros.
Converts the numeric value of this instance to its equivalent string representation, using
the specified format.
A format string.
The string representation of the value of this instance as specified by format.
Converts the numeric value of this instance to its equivalent string representation using the
specified culture-specific format information.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by provider.
Converts the numeric value of this instance to its equivalent string representation using the
specified format and culture-specific format information.
A format specification.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by format and provider.
Converts the string representation of a number to its equivalent.
A string containing a number to convert.
An equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
An equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number in a specified culture-specific format to its equivalent.
A string containing a number to convert.
A that supplies culture-specific formatting information about s.
An equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style and culture-specific format to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A that supplies culture-specific formatting information about s.
An equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number to its equivalent. A return value
indicates whether the conversion succeeded or failed.
A string containing a number to convert.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not of the correct format, or represents a number less than or greater than .
This parameter is passed uninitialized.
true if s was converted successfully; otherwise, false.
Converts the string representation of a number in a specified style and culture-specific format to its
equivalent. A return value indicates whether the conversion succeeded or failed.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not in a format compliant with style, or represents a number less than or
greater than . This parameter is passed uninitialized.
A object that supplies culture-specific formatting information about s.
true if s was converted successfully; otherwise, false.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
Returns the for value type .
The enumerated constant, .
Compares the two values for equality.
An as the left hand operand.
An as the right hand operand.
A as the operation result.
Compares the two values for inequality.
An as the left hand operand.
An as the right hand operand.
A as the operation result.
Returns true if left value is less than right value.
An as the left hand operand.
An as the right hand operand.
A as the operation result.
Returns true if left value is less or equal to than right value.
An as the left hand operand.
An as the right hand operand.
A as the operation result.
Returns true if left value is greater than right value.
An as the left hand operand.
An as the right hand operand.
A as the operation result.
Returns true if left value is greater than or equal to right value.
An as the left hand operand.
An as the right hand operand.
A as the operation result.
Implicitly converts value, represented in radians, to an .
A value.
An object.
Implicitly converts , represented in radians, to a .
An object.
A value.
Returns computed remainder after dividing first value by the second.
An as the left hand operand.
An as the right hand operand.
An as the result.
Returns computed sum of values.
An as the left hand operand.
An as the right hand operand.
An as the result.
Returns computed difference of values.
An as the left hand operand.
An as the right hand operand.
An as the result.
Returns computed product of values.
An as the left hand operand.
An as the right hand operand.
An as the result.
Returns computed division of values.
An as the left hand operand.
An as the right hand operand.
An as the result.
Returns result of first value raised to power of second value.
An as the left hand operand.
An as the right hand operand.
A as the result.
Represents the largest possible value of an . This field is constant.
Represents the smallest possible value of an . This field is constant.
Creates a new value from the specified in degrees.
New value in degrees.
New object from the specified in degrees.
Creates a new value from the specified in grads.
New value in grads.
New object from the specified in grads.
Creates a new value from the specified in arcminutes.
New value in arcminutes.
New object from the specified in arcminutes.
Creates a new value from the specified in arcseconds.
New value in arcseconds.
New object from the specified in arcseconds.
Creates a new value from the specified in angular mil.
New value in angular mil.
New object from the specified in angular mil.
Converts the in the specified to a new in radians.
Source value.
Source value units.
New from the specified in .
Represents the units available for a value.
Coulomb charge units, i.e., ampere-seconds.
AmpereHour charge units.
Abcoulomb charge units, a.k.a., an electromagnetic unit.
Statcoulomb charge units, a.k.a., electrostatic unit or franklin.
Atomic charge units.
Faraday charge units.
Provides a type converter to convert values to and from various other representations.
Since reports a type code of , the converter will convert
to and from double values as well as other types supported by .
Represents an electric charge measurement, in coulombs (i.e., ampere-seconds), as a double-precision floating-point number.
This class behaves just like a representing a charge in coulombs; it is implicitly
castable to and from a and therefore can be generally used "as" a double, but it
has the advantage of handling conversions to and from other charge representations, specifically
ampere-hours, abcoulomb (a.k.a., an electromagnetic unit), statcoulomb (a.k.a., electrostatic unit or franklin), atomic unit of charge
and faraday. Metric conversions are handled simply by applying the needed conversion factor, for example:
Convert charge, in coulombs, to kilocoulombs:
public double GetKilocoulombs(Charge coulombs)
{
return coulombs / SI.Kilo;
}
Creates a new .
New charge value in coulombs.
Gets the value in ampere-hours.
Value of in ampere-hours.
Gets the value in abcoulombs.
Value of in abcoulombs.
Gets the value in statcoulombs.
Value of in statcoulombs.
Gets the value in atomic units of charge.
Value of in atomic units of charge.
Gets the value in faraday.
Value of in faraday.
Converts the to the specified .
Target units.
converted to .
Compares this instance to a specified object and returns an indication of their relative values.
An object to compare, or null.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
value is not a or .
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Returns a value indicating whether this instance is equal to a specified object.
An object to compare, or null.
True if obj is an instance of or and equals the value of this instance;
otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns the hash code for this instance.
A 32-bit signed integer hash code.
Converts the numeric value of this instance to its equivalent string representation.
The string representation of the value of this instance, consisting of a minus sign if
the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeros.
Converts the numeric value of this instance to its equivalent string representation, using
the specified format.
A format string.
The string representation of the value of this instance as specified by format.
Converts the numeric value of this instance to its equivalent string representation using the
specified culture-specific format information.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by provider.
Converts the numeric value of this instance to its equivalent string representation using the
specified format and culture-specific format information.
A format specification.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by format and provider.
Converts the string representation of a number to its equivalent.
A string containing a number to convert.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number in a specified culture-specific format to its equivalent.
A string containing a number to convert.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style and culture-specific format to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number to its equivalent. A return value
indicates whether the conversion succeeded or failed.
A string containing a number to convert.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not of the correct format, or represents a number less than or greater than .
This parameter is passed uninitialized.
true if s was converted successfully; otherwise, false.
Converts the string representation of a number in a specified style and culture-specific format to its
equivalent. A return value indicates whether the conversion succeeded or failed.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not in a format compliant with style, or represents a number less than or
greater than . This parameter is passed uninitialized.
A object that supplies culture-specific formatting information about s.
true if s was converted successfully; otherwise, false.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
Returns the for value type .
The enumerated constant, .
Compares the two values for equality.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Compares the two values for inequality.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is less than right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is less or equal to than right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is greater than right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is greater than or equal to right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Implicitly converts value, represented in coulombs, to a .
A value.
A value.
Implicitly converts , represented in coulombs, to a .
A value.
A value.
Returns computed remainder after dividing first value by the second.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed sum of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed difference of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed product of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed division of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns result of first value raised to charge of second value.
A object as the left hand operand.
A object as the right hand operand.
A as the result.
Represents the largest possible value of an . This field is constant.
Represents the smallest possible value of an . This field is constant.
Creates a new value from the specified in ampere-hours.
New value in ampere-hours.
New object from the specified in ampere-hours.
Creates a new value from the specified in abcoulombs.
New value in abcoulombs.
New object from the specified in abcoulombs.
Creates a new value from the specified in statcoulombs.
New value in statcoulombs.
New object from the specified in statcoulombs.
Creates a new value from the specified in atomic units of charge.
New value in atomic units of charge.
New object from the specified in atomic units of charge.
Creates a new value from the specified in faraday.
New value in faraday.
New object from the specified in faraday.
Converts the in the specified to a new in coulombs.
Source value.
Source value units.
New from the specified in .
Represents the units available for a value.
Ampere current units.
Abampere current units, a.k.a., an electromagnetic unit.
Statampere current units, a.k.a., esu per second.
Provides a type converter to convert values to and from various other representations.
Since reports a type code of , the converter will convert
to and from double values as well as other types supported by .
Represents an electric current measurement, in amperes, as a double-precision floating-point number.
This class behaves just like a representing a current in amperes; it is implicitly
castable to and from a and therefore can be generally used "as" a double, but it
has the advantage of handling conversions to and from other current representations, specifically
abampere (a.k.a., an electromagnetic unit) and statampere (a.k.a., esu per second). Metric conversions are handled
simply by applying the needed conversion factor, for example:
Convert current, in amperes, to kiloamperes:
public double GetKiloamperes(Current amperes)
{
return amperes / SI.Kilo;
}
Creates a new .
New current value in amperes.
Gets the value in abamperes.
Value of in abamperes.
Gets the value in statamperes.
Value of in statamperes.
Converts the to the specified .
Target units.
converted to .
Compares this instance to a specified object and returns an indication of their relative values.
An object to compare, or null.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
value is not a or .
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Returns a value indicating whether this instance is equal to a specified object.
An object to compare, or null.
True if obj is an instance of or and equals the value of this instance;
otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns the hash code for this instance.
A 32-bit signed integer hash code.
Converts the numeric value of this instance to its equivalent string representation.
The string representation of the value of this instance, consisting of a minus sign if
the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeros.
Converts the numeric value of this instance to its equivalent string representation, using
the specified format.
A format string.
The string representation of the value of this instance as specified by format.
Converts the numeric value of this instance to its equivalent string representation using the
specified culture-specific format information.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by provider.
Converts the numeric value of this instance to its equivalent string representation using the
specified format and culture-specific format information.
A format specification.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by format and provider.
Converts the string representation of a number to its equivalent.
A string containing a number to convert.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number in a specified culture-specific format to its equivalent.
A string containing a number to convert.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style and culture-specific format to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number to its equivalent. A return value
indicates whether the conversion succeeded or failed.
A string containing a number to convert.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not of the correct format, or represents a number less than or greater than .
This parameter is passed uninitialized.
true if s was converted successfully; otherwise, false.
Converts the string representation of a number in a specified style and culture-specific format to its
equivalent. A return value indicates whether the conversion succeeded or failed.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not in a format compliant with style, or represents a number less than or
greater than . This parameter is passed uninitialized.
A object that supplies culture-specific formatting information about s.
true if s was converted successfully; otherwise, false.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
Returns the for value type .
The enumerated constant, .
Compares the two values for equality.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Compares the two values for inequality.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is less than right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is less or equal to than right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is greater than right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is greater than or equal to right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Implicitly converts value, represented in amperes, to a .
A value.
A object as the result.
Implicitly converts , represented in amperes, to a .
A object.
A value as the result.
Returns computed remainder after dividing first value by the second.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed sum of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed difference of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed product of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed division of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns result of first value raised to current of second value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result of the operation.
Represents the largest possible value of an . This field is constant.
Represents the smallest possible value of an . This field is constant.
Creates a new value from the specified in abamperes.
New value in abamperes.
New object from the specified in abamperes.
Creates a new value from the specified in statamperes.
New value in statamperes.
New object from the specified in statamperes.
Converts the in the specified to a new in amperes.
Source value.
Source value units.
New from the specified in .
Represents the units available for an value.
Joule energy units, i.e., watt-seconds.
WattHour energy units.
BTU energy units.
Celsius heat energy units.
Liters atmosphere energy units.
Calorie energy units.
Horsepower-hour energy units.
Barrels of oil energy units.
Tons of coal energy units.
Provides a type converter to convert values to and from various other representations.
Since reports a type code of , the converter will convert
to and from double values as well as other types supported by .
Represents an energy measurement, in joules (i.e., watt-seconds), as a double-precision floating-point number.
This class behaves just like a representing an energy in joules; it is implicitly
castable to and from a and therefore can be generally used "as" a double, but it
has the advantage of handling conversions to and from other energy representations, specifically
watt-hours, BTU, Celsius heat unit, liter-atmosphere, calorie, horsepower-hour, barrel of oil and ton of coal.
Metric conversions are handled simply by applying the needed conversion factor, for example:
Convert energy in joules to megajoules:
public double GetMegajoules(Energy joules)
{
return joules / SI.Mega;
}
This example converts megajoules to kilowatt-hours:
public double GetKilowattHours(double megajoules)
{
return (new Energy(megajoules * SI.Mega)).ToWattHours() / SI.Kilo;
}
This example converts kilowatt-hours to megawatt-hours:
public double GetMegawattHours(double kilowattHours)
{
return (kilowattHours * SI.Kilo) / SI.Mega;
}
Creates a new .
New energy value in joules.
Gets the value in coulombs given the specified .
Source used to calculate value.
value in coulombs given the specified .
Gets the value in watt-hours.
Value of in watt-hours.
Gets the value in BTU (International Table).
Value of in BTU.
Gets the value in Celsius heat units (International Table).
Value of in Celsius heat units.
Gets the value in liters-atmosphere.
Value of in liters-atmosphere.
Gets the value in calories (International Table).
Value of in calories.
Gets the value in horsepower-hours.
Value of in horsepower-hours.
Gets the value in equivalent barrels of oil.
Value of in equivalent barrels of oil.
Gets the value in equivalent tons of coal.
Value of in equivalent tons of coal.
Converts the to the specified .
Target units.
converted to .
Compares this instance to a specified object and returns an indication of their relative values.
An object to compare, or null.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
value is not a or .
Compares this instance to a specified and returns an indication of their
relative values.
An to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Returns a value indicating whether this instance is equal to a specified object.
An object to compare, or null.
True if obj is an instance of or and equals the value of this instance;
otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
An value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns the hash code for this instance.
A 32-bit signed integer hash code.
Converts the numeric value of this instance to its equivalent string representation.
The string representation of the value of this instance, consisting of a minus sign if
the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeros.
Converts the numeric value of this instance to its equivalent string representation, using
the specified format.
A format string.
The string representation of the value of this instance as specified by format.
Converts the numeric value of this instance to its equivalent string representation using the
specified culture-specific format information.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by provider.
Converts the numeric value of this instance to its equivalent string representation using the
specified format and culture-specific format information.
A format specification.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by format and provider.
Converts the string representation of a number to its equivalent.
A string containing a number to convert.
An equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
An equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number in a specified culture-specific format to its equivalent.
A string containing a number to convert.
A that supplies culture-specific formatting information about s.
An equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style and culture-specific format to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A that supplies culture-specific formatting information about s.
An equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number to its equivalent. A return value
indicates whether the conversion succeeded or failed.
A string containing a number to convert.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not of the correct format, or represents a number less than or greater than .
This parameter is passed uninitialized.
true if s was converted successfully; otherwise, false.
Converts the string representation of a number in a specified style and culture-specific format to its
equivalent. A return value indicates whether the conversion succeeded or failed.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not in a format compliant with style, or represents a number less than or
greater than . This parameter is passed uninitialized.
A object that supplies culture-specific formatting information about s.
true if s was converted successfully; otherwise, false.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
Returns the for value type .
The enumerated constant, .
Compares the two values for equality.
An object as the left hand operand.
An object as the right hand operand.
A as the result of the operation.
Compares the two values for inequality.
An object as the left hand operand.
An object as the right hand operand.
A as the result of the operation.
Returns true if left value is less than right value.
An object as the left hand operand.
An object as the right hand operand.
A as the result of the operation.
Returns true if left value is less or equal to than right value.
An object as the left hand operand.
An object as the right hand operand.
A as the result of the operation.
Returns true if left value is greater than right value.
An object as the left hand operand.
An object as the right hand operand.
A as the result of the operation.
Returns true if left value is greater than or equal to right value.
An object as the left hand operand.
An object as the right hand operand.
A as the result of the operation.
Implicitly converts value, represented in joules, to an .
A value.
An object.
Implicitly converts , represented in joules, to a .
An object.
A value.
Returns computed remainder after dividing first value by the second.
An object as the left hand operand.
An object as the right hand operand.
An object as the result of the operation.
Returns computed sum of values.
An object as the left hand operand.
An object as the right hand operand.
An object as the result of the operation.
Returns computed difference of values.
An object as the left hand operand.
An object as the right hand operand.
An object as the result of the operation.
Returns computed product of values.
An object as the left hand operand.
An object as the right hand operand.
An object as the result of the operation.
Returns computed division of values.
An object as the left hand operand.
An object as the right hand operand.
An object as the result of the operation.
Returns result of first value raised to power of second value.
An object as the left hand operand.
An object as the right hand operand.
A value as the result of the operation.
Represents the largest possible value of an . This field is constant.
Represents the smallest possible value of an . This field is constant.
Creates a new value from the specified in watt-hours.
New value in watt-hours.
New object from the specified in watt-hours.
Creates a new value from the specified in BTU (International Table).
New value in BTU.
New object from the specified in BTU.
Creates a new value from the specified in Celsius heat units (International Table).
New value in Celsius heat units.
New object from the specified in Celsius heat units.
Creates a new value from the specified in liters-atmosphere.
New value in liters-atmosphere.
New object from the specified in liters-atmosphere.
Creates a new value from the specified in calories (International Table).
New value in calories.
New object from the specified in calories.
Creates a new value from the specified in horsepower-hours.
New value in horsepower-hours.
New object from the specified in horsepower-hours.
Creates a new value from the specified in equivalent barrels of oil.
New value in equivalent barrels of oil.
New object from the specified in equivalent barrels of oil.
Creates a new value from the specified in equivalent tons of coal.
New value in equivalent tons of coal.
New object from the specified in equivalent tons of coal.
Converts the in the specified to a new in joules.
Source value.
Source value units.
New from the specified in .
Represents the units available for a value.
Meter length units.
Foot length units.
Inch length units.
Mile length units.
Light-second length units.
U.S. survey foot length units.
U.S. survey mile length units.
Nautical mile length units.
Yard length units.
Provides a type converter to convert values to and from various other representations.
Since reports a type code of , the converter will convert
to and from double values as well as other types supported by .
Represents a length measurement, in meters, as a double-precision floating-point number.
This class behaves just like a representing a length in meters; it is implicitly
castable to and from a and therefore can be generally used "as" a double, but it
has the advantage of handling conversions to and from other length representations, specifically
inches, feet, yards, miles, U.S. survey feet, U.S. survey miles, light-seconds, and nautical miles.
Metric conversions are handled simply by applying the needed conversion factor, for example:
Convert length in meters to kilometers:
public double GetKilometers(Length meters)
{
return meters / SI.Kilo;
}
This example converts feet to inches:
public double GetFeet(double inches)
{
return Length.FromInches(inches).ToFeet();
}
Creates a new .
New length value in meters.
Gets the value in feet.
Value of in feet.
Gets the value in yards.
Value of in yards.
Gets the value in inches.
Value of in inches.
Gets the value in miles.
Value of in miles.
Gets the value in light-seconds.
Value of in light-seconds.
Gets the value in US survey feet.
Value of in US survey feet.
Gets the value in US survey miles.
Value of in US survey miles.
Gets the value in nautical miles.
Value of in nautical miles.
Converts the to the specified .
Target units.
converted to .
Compares this instance to a specified object and returns an indication of their relative values.
An object to compare, or null.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
value is not a or .
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Returns a value indicating whether this instance is equal to a specified object.
An object to compare, or null.
True if obj is an instance of or and equals the value of this instance;
otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns the hash code for this instance.
A 32-bit signed integer hash code.
Converts the numeric value of this instance to its equivalent string representation.
The string representation of the value of this instance, consisting of a minus sign if
the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeros.
Converts the numeric value of this instance to its equivalent string representation, using
the specified format.
A format string.
The string representation of the value of this instance as specified by format.
Converts the numeric value of this instance to its equivalent string representation using the
specified culture-specific format information.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by provider.
Converts the numeric value of this instance to its equivalent string representation using the
specified format and culture-specific format information.
A format specification.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by format and provider.
Converts the string representation of a number to its equivalent.
A string containing a number to convert.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number in a specified culture-specific format to its equivalent.
A string containing a number to convert.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style and culture-specific format to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number to its equivalent. A return value
indicates whether the conversion succeeded or failed.
A string containing a number to convert.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not of the correct format, or represents a number less than or greater than .
This parameter is passed uninitialized.
true if s was converted successfully; otherwise, false.
Converts the string representation of a number in a specified style and culture-specific format to its
equivalent. A return value indicates whether the conversion succeeded or failed.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not in a format compliant with style, or represents a number less than or
greater than . This parameter is passed uninitialized.
A object that supplies culture-specific formatting information about s.
true if s was converted successfully; otherwise, false.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
Returns the for value type .
The enumerated constant, .
Compares the two values for equality.
A object left hand operand.
A object right hand operand.
A value as the result of the operation.
Compares the two values for inequality.
A object left hand operand.
A object right hand operand.
A value as the result of the operation.
Returns true if left value is less than right value.
A object left hand operand.
A object right hand operand.
A value as the result of the operation.
Returns true if left value is less or equal to than right value.
A object left hand operand.
A object right hand operand.
A value as the result of the operation.
Returns true if left value is greater than right value.
A object left hand operand.
A object right hand operand.
A value as the result of the operation.
Returns true if left value is greater than or equal to right value.
A object left hand operand.
A object right hand operand.
A value as the result of the operation.
Implicitly converts value, represented in meters, to a .
A value.
A object.
Implicitly converts , represented in meters, to a .
A object.
A value.
Returns computed remainder after dividing first value by the second.
A object left hand operand.
A object right hand operand.
A object as the result.
Returns computed sum of values.
A object left hand operand.
A object right hand operand.
A object as the result.
Returns computed difference of values.
A object left hand operand.
A object right hand operand.
A object as the result.
Returns computed product of values.
A object left hand operand.
A object right hand operand.
A object as the result.
Returns computed division of values.
A object left hand operand.
A object right hand operand.
A object as the result.
Returns result of first value raised to power of second value.
A object left hand operand.
A object right hand operand.
A value as the result.
Represents the largest possible value of an . This field is constant.
Represents the smallest possible value of an . This field is constant.
Creates a new value from the specified in feet.
New value in feet.
New object from the specified in feet.
Creates a new value from the specified in yards.
New value in yards.
New object from the specified in yards.
Creates a new value from the specified in inches.
New value in inches.
New object from the specified in inches.
Creates a new value from the specified in miles.
New value in miles.
New object from the specified in miles.
Creates a new value from the specified in light-seconds.
New value in light-seconds.
New object from the specified in light-seconds.
Creates a new value from the specified in US survey feet.
New value in US survey feet.
New object from the specified in US survey feet.
Creates a new value from the specified in US survey miles.
New value in US survey miles.
New object from the specified in US survey miles.
Creates a new value from the specified in nautical miles.
New value in nautical miles.
New object from the specified in nautical miles.
Converts the in the specified to a new in meters.
Source value.
Source value units.
New from the specified in .
Represents the units available for a value.
Kilogram mass units.
Ounce mass units.
Pound mass units.
Metric pound mass units.
Ton mass units.
Metric ton mass units.
Long ton mass units.
Provides a type converter to convert values to and from various other representations.
Since reports a type code of , the converter will convert
to and from double values as well as other types supported by .
Represents a mass measurement, in kilograms, as a double-precision floating-point number.
This class behaves just like a representing a mass in kilograms; it is implicitly
castable to and from a and therefore can be generally used "as" a double, but it
has the advantage of handling conversions to and from other mass representations, specifically
ounces, pounds and tons. Metric conversions are handled simply by applying the needed
conversion factor, for example:
Convert mass, in kilograms, to grams:
public double GetGrams(Mass kilograms)
{
return kilograms * SI.Kilo;
}
This example converts tons to pounds:
public double GetPounds(double tons)
{
return Mass.FromTons(tons).ToPounds();
}
Creates a new .
New mass value in kilograms.
Gets the value in ounces (avoirdupois).
Value of in ounces.
Gets the value in pounds (avoirdupois).
Value of in pounds.
Gets the value in metric pounds.
Value of in metric pounds.
Gets the value in short tons.
Value of in short tons.
Gets the value in metric tons.
Value of in metric tons.
Gets the value in long tons.
Value of in long tons.
Converts the to the specified .
Target units.
converted to .
Compares this instance to a specified object and returns an indication of their relative values.
An object to compare, or null.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
value is not a or .
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Returns a value indicating whether this instance is equal to a specified object.
An object to compare, or null.
True if obj is an instance of or and equals the value of this instance;
otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns the hash code for this instance.
A 32-bit signed integer hash code.
Converts the numeric value of this instance to its equivalent string representation.
The string representation of the value of this instance, consisting of a minus sign if
the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeros.
Converts the numeric value of this instance to its equivalent string representation, using
the specified format.
A format string.
The string representation of the value of this instance as specified by format.
Converts the numeric value of this instance to its equivalent string representation using the
specified culture-specific format information.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by provider.
Converts the numeric value of this instance to its equivalent string representation using the
specified format and culture-specific format information.
A format specification.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by format and provider.
Converts the string representation of a number to its equivalent.
A string containing a number to convert.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number in a specified culture-specific format to its equivalent.
A string containing a number to convert.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style and culture-specific format to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number to its equivalent. A return value
indicates whether the conversion succeeded or failed.
A string containing a number to convert.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not of the correct format, or represents a number less than or greater than .
This parameter is passed uninitialized.
true if s was converted successfully; otherwise, false.
Converts the string representation of a number in a specified style and culture-specific format to its
equivalent. A return value indicates whether the conversion succeeded or failed.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not in a format compliant with style, or represents a number less than or
greater than . This parameter is passed uninitialized.
A object that supplies culture-specific formatting information about s.
true if s was converted successfully; otherwise, false.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
Returns the for value type .
The enumerated constant, .
Compares the two values for equality.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Compares the two values for inequality.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Returns true if left value is less than right value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Returns true if left value is less or equal to than right value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Returns true if left value is greater than right value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Returns true if left value is greater than or equal to right value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Implicitly converts value, represented in kilograms, to a .
A value.
A object.
Implicitly converts , represented in kilograms, to a .
A object.
A value.
Returns computed remainder after dividing first value by the second.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed sum of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed difference of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed product of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed division of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns result of first value raised to mass of second value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result of the operation.
Represents the largest possible value of an . This field is constant.
Represents the smallest possible value of an . This field is constant.
Creates a new value from the specified in ounces (avoirdupois).
New value in ounces.
New object from the specified in ounces.
Creates a new value from the specified in pounds (avoirdupois).
New value in pounds.
New object from the specified in pounds.
Creates a new value from the specified in metric pounds.
New value in metric pounds.
New object from the specified in metric pounds.
Creates a new value from the specified in short tons.
New value in short tons.
New object from the specified in short tons.
Creates a new value from the specified in metric tons.
New value in metric tons.
New object from the specified in metric tons.
Creates a new value from the specified in long tons.
New value in long tons.
New object from the specified in long tons.
Converts the in the specified to a new in kilograms.
Source value.
Source value units.
New from the specified in .
The namespace organizes all Gemstone library functionality
related to units useful for common unit and SI conversions. The root units namespace includes
common units classes, e.g., , , and , .
Represents the units available for a value.
Watt power units.
Horsepower units.
Metric horsepower units.
Boiler horsepower units.
BTU per second power units.
Calories per second power units.
Liters atmosphere per second power units.
Provides a type converter to convert values to and from various other representations.
Since reports a type code of , the converter will convert
to and from double values as well as other types supported by .
Represents a power measurement, in watts, as a double-precision floating-point number.
This class behaves just like a representing a power in watts; it is implicitly
castable to and from a and therefore can be generally used "as" a double, but it
has the advantage of handling conversions to and from other power representations, specifically
horsepower, metric horsepower, boiler horsepower, BTU per second, calorie per second, and liter-atmosphere
per second. Metric conversions are handled simply by applying the needed conversion factor,
for example:
Convert power in watts to megawatts:
public double GetMegawatts(Power watts)
{
return watts / SI.Mega;
}
This example converts megawatts to mechanical horsepower:
public double GetHorsepower(double megawatts)
{
return (new Power(megawatts * SI.Mega)).ToHorsepower();
}
Creates a new .
New power value in watts.
Gets the value in mechanical horsepower (Imperial).
Value of in mechanical horsepower.
Gets the value in metric horsepower.
Value of in metric horsepower.
Gets the value in boiler horsepower.
Value of in boiler horsepower.
Gets the value in BTU (International Table) per second.
Value of in BTU per second.
Gets the value in calories (International Table) per second.
Value of in calories per second.
Gets the value in liters-atmosphere per second.
Value of in liters-atmosphere per second.
Converts the to the specified .
Target units.
converted to .
Compares this instance to a specified object and returns an indication of their relative values.
An object to compare, or null.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
value is not a or .
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Returns a value indicating whether this instance is equal to a specified object.
An object to compare, or null.
True if obj is an instance of or and equals the value of this instance;
otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns the hash code for this instance.
A 32-bit signed integer hash code.
Converts the numeric value of this instance to its equivalent string representation.
The string representation of the value of this instance, consisting of a minus sign if
the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeros.
Converts the numeric value of this instance to its equivalent string representation, using
the specified format.
A format string.
The string representation of the value of this instance as specified by format.
Converts the numeric value of this instance to its equivalent string representation using the
specified culture-specific format information.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by provider.
Converts the numeric value of this instance to its equivalent string representation using the
specified format and culture-specific format information.
A format specification.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by format and provider.
Converts the string representation of a number to its equivalent.
A string containing a number to convert.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number in a specified culture-specific format to its equivalent.
A string containing a number to convert.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style and culture-specific format to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number to its equivalent. A return value
indicates whether the conversion succeeded or failed.
A string containing a number to convert.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not of the correct format, or represents a number less than or greater than .
This parameter is passed uninitialized.
true if s was converted successfully; otherwise, false.
Converts the string representation of a number in a specified style and culture-specific format to its
equivalent. A return value indicates whether the conversion succeeded or failed.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not in a format compliant with style, or represents a number less than or
greater than . This parameter is passed uninitialized.
A object that supplies culture-specific formatting information about s.
true if s was converted successfully; otherwise, false.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
Returns the for value type .
The enumerated constant, .
Compares the two values for equality.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Compares the two values for inequality.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is less than right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is less or equal to than right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is greater than right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is greater than or equal to right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Implicitly converts value, represented in watts, to a .
A value.
A object.
Implicitly converts , represented in watts, to a .
A object.
A value.
Returns computed remainder after dividing first value by the second.
A left hand operand.
A right hand operand.
A object as the result of the operation.
Returns computed sum of values.
A left hand operand.
A right hand operand.
A object as the result of the operation.
Returns computed difference of values.
A left hand operand.
A right hand operand.
A object as the result of the operation.
Returns computed product of values.
A left hand operand.
A right hand operand.
A object as the result of the operation.
Returns computed division of values.
A left hand operand.
A right hand operand.
A object as the result of the operation.
Returns result of first value raised to power of second value.
A left hand operand.
A right hand operand.
A value as the result of the operation.
Represents the largest possible value of an . This field is constant.
Represents the smallest possible value of an . This field is constant.
Creates a new value from the specified in mechanical horsepower (Imperial).
New value in mechanical horsepower.
New object from the specified in mechanical horsepower.
Creates a new value from the specified in metric horsepower.
New value in metric horsepower.
New object from the specified in metric horsepower.
Creates a new value from the specified in boiler horsepower.
New value in boiler horsepower.
New object from the specified in boiler horsepower.
Creates a new value from the specified in BTU (International Table) per second.
New value in BTU per second.
New object from the specified in BTU per second.
Creates a new value from the specified in calories (International Table) per second.
New value in calories per second.
New object from the specified in calories per second.
Creates a new value from the specified in liters-atmosphere per second.
New value in liters-atmosphere per second.
New object from the specified in liters-atmosphere per second.
Converts the in the specified to a new in watts.
Source value.
Source value units.
New from the specified in .
Defines constant factors for SI units of measure to handle metric conversions.
SI prefix Y, 10^24
SI prefix Z, 10^21
SI prefix E, 10^18
SI prefix P, 10^15
SI prefix T, 10^12
SI prefix G, 10^9
SI prefix M, 10^6
SI prefix k, 10^3
SI prefix h, 10^2
SI prefix da, 10^1
SI prefix d, 10^-1
SI prefix c, 10^-2
SI prefix m, 10^-3
SI prefix µ, 10^-6
SI prefix n, 10^-9
SI prefix p, 10^-12
SI prefix f, 10^-15
SI prefix a, 10^-18
SI prefix z, 10^-21
SI prefix y, 10^-24
Gets an array of all the defined unit factor SI names ordered from least () to greatest ().
Gets an array of all the defined unit factor SI prefix symbols ordered from least () to greatest ().
Gets an array of all the defined SI unit factors ordered from least () to greatest ().
Turns the given number of units into a textual representation with an appropriate unit scaling.
Total units to represent textually.
Name of unit display (e.g., you could use "m/h" for meters per hour).
Optional SI factor symbol or name array to use during textual conversion, defaults to .
Optional minimum SI factor. Defaults to .
Optional maximum SI factor. Defaults to .
The array needs one string entry for each defined SI item ordered from
least () to greatest (), see or
arrays for examples.
A representation of the number of units.
or is not defined in array.
Turns the given number of units into a textual representation with an appropriate unit scaling.
Total units to represent textually.
A numeric string format for scaled .
Name of unit display (e.g., you could use "m/h" for meters per hour).
Optional minimum SI factor. Defaults to .
Optional maximum SI factor. Defaults to .
array is used for displaying SI symbol prefix for .
A representation of the number of units.
or is not defined in array.
Turns the given number of units into a textual representation with an appropriate unit scaling.
Total units to represent textually.
Number of decimal places to display.
Name of unit display (e.g., you could use "m/h" for meters per hour).
Optional SI factor symbol or name array to use during textual conversion, defaults to .
Optional minimum SI factor. Defaults to .
Optional maximum SI factor. Defaults to .
The array needs one string entry for each defined SI item ordered from
least () to greatest (), see or
arrays for examples.
A representation of the number of units.
cannot be negative.
or is not defined in array.
Turns the given number of units into a textual representation with an appropriate unit scaling
given string array of factor names or symbols.
Total units to represent textually.
A numeric string format for scaled .
Name of unit display (e.g., you could use "m/h" for meters per hour).
SI factor symbol or name array to use during textual conversion.
Optional number of decimal places to display.
Optional minimum SI factor. Defaults to .
Optional maximum SI factor. Defaults to .
The array needs one string entry for each defined SI item ordered from
least () to greatest (), see or
arrays for examples.
A representation of the number of units.
or is not defined in array.
Defines constant factors based on 1024 for related binary SI units of measure used in computational measurements.
See NIST Reference for information on IEC standard names.
1 exa, binary (E) = 1,152,921,504,606,846,976
This is the common name.
1 exbi (Ei) = 1,152,921,504,606,846,976
This is the IEC standard name.
1 peta, binary (P) = 1,125,899,906,842,624
This is the common name.
1 pebi (Pi) = 1,125,899,906,842,624
This is the IEC standard name.
1 tera, binary (T) = 1,099,511,627,776
This is the common name.
1 tebi (Ti) = 1,099,511,627,776
This is the IEC standard name.
1 giga, binary (G) = 1,073,741,824
This is the common name.
1 gibi (Gi) = 1,073,741,824
This is the IEC standard name.
1 mega, binary (M) = 1,048,576
This is the common name.
1 mebi (Mi) = 1,048,576
This is the IEC standard name.
1 kilo, binary (K) = 1,024
This is the common name.
1 kibi (Ki) = 1,024
This is the IEC standard name.
Gets an array of all the defined common binary unit factor SI names ordered from least () to greatest ().
Gets an array of all the defined common binary unit factor SI prefix symbols ordered from least () to greatest ().
Gets an array of all the defined IEC binary unit factor SI names ordered from least () to greatest ().
Gets an array of all the defined IEC binary unit factor SI prefix symbols ordered from least () to greatest ().
Gets an array of all the defined binary SI unit factors ordered from least () to greatest ().
Turns the given number of units (e.g., bytes) into a textual representation with an appropriate unit scaling
and common named representation (e.g., KB, MB, GB, TB, etc.).
Total units to represent textually.
Name of unit display (e.g., you could use "B" for bytes).
Optional SI factor symbol or name array to use during textual conversion, defaults to .
Optional minimum SI factor. Defaults to .
Optional maximum SI factor. Defaults to .
The array needs one string entry for each defined SI item ordered from
least () to greatest (), see or
arrays for examples.
A representation of the number of units.
or is not defined in array.
Turns the given number of units (e.g., bytes) into a textual representation with an appropriate unit scaling
and common named representation (e.g., KB, MB, GB, TB, etc.).
Total units to represent textually.
A numeric string format for scaled .
Name of unit display (e.g., you could use "B" for bytes).
Optional minimum SI factor. Defaults to .
Optional maximum SI factor. Defaults to .
array is used for displaying SI symbol prefix for .
A representation of the number of units.
or is not defined in array.
Turns the given number of units (e.g., bytes) into a textual representation with an appropriate unit scaling
and common named representation (e.g., KB, MB, GB, TB, etc.).
Total units to represent textually.
Number of decimal places to display.
Name of unit display (e.g., you could use "B" for bytes).
Optional SI factor symbol or name array to use during textual conversion, defaults to .
Optional minimum SI factor. Defaults to .
Optional maximum SI factor. Defaults to .
The array needs one string entry for each defined SI item ordered from
least () to greatest (), see or
arrays for examples.
A representation of the number of units.
cannot be negative.
or is not defined in array.
Turns the given number of units (e.g., bytes) into a textual representation with an appropriate unit scaling
given string array of factor names or symbols.
Total units to represent textually.
A numeric string format for scaled .
Name of unit display (e.g., you could use "B" for bytes).
SI factor symbol or name array to use during textual conversion.
Optional number of decimal places to display.
Optional minimum SI factor. Defaults to .
Optional maximum SI factor. Defaults to .
The array needs one string entry for each defined SI item ordered from
least () to greatest (), see or
arrays for examples.
A representation of the number of units.
or is not defined in array.
Represents the units available for a value.
Meters per second speed units.
Miles per hour speed units.
Kilometers per hour speed units.
Feet per minute speed units.
Inches per second speed units.
Knot speed units, international.
Mach speed units.
As modeled by International Standard Atmosphere, dry air at mean sea level, standard temperature of 15 °C.
Provides a type converter to convert values to and from various other representations.
Since reports a type code of , the converter will convert
to and from double values as well as other types supported by .
Represents a speed measurement, in meters per second, as a double-precision floating-point number.
This class behaves just like a representing a speed in meters per second; it is implicitly
castable to and from a and therefore can be generally used "as" a double, but it
has the advantage of handling conversions to and from other speed representations, specifically
miles per hour, kilometers per hour, feet per minute, inches per second, knots and Mach.
This example converts mph to km/h:
public double GetKilometersPerHour(double milesPerHour)
{
return Speed.FromMilesPerHour(milesPerHour).ToKilometersPerHour();
}
Creates a new .
New speed value in meters per second.
Gets the value in miles per hour.
Value of in miles per hour.
Gets the value in kilometers per hour.
Value of in kilometers per hour.
Gets the value in feet per minute.
Value of in feet per minute.
Gets the value in inches per second.
Value of in inches per second.
Gets the value in knots (International).
Value of in knots.
Gets the value in Mach.
Value of in Mach.
Converts the to the specified .
Target units.
converted to .
Compares this instance to a specified object and returns an indication of their relative values.
An object to compare, or null.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
value is not a or .
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Returns a value indicating whether this instance is equal to a specified object.
An object to compare, or null.
True if obj is an instance of or and equals the value of this instance;
otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns the hash code for this instance.
A 32-bit signed integer hash code.
Converts the numeric value of this instance to its equivalent string representation.
The string representation of the value of this instance, consisting of a minus sign if
the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeros.
Converts the numeric value of this instance to its equivalent string representation, using
the specified format.
A format string.
The string representation of the value of this instance as specified by format.
Converts the numeric value of this instance to its equivalent string representation using the
specified culture-specific format information.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by provider.
Converts the numeric value of this instance to its equivalent string representation using the
specified format and culture-specific format information.
A format specification.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by format and provider.
Converts the string representation of a number to its equivalent.
A string containing a number to convert.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number in a specified culture-specific format to its equivalent.
A string containing a number to convert.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style and culture-specific format to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number to its equivalent. A return value
indicates whether the conversion succeeded or failed.
A string containing a number to convert.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter per second is null,
is not of the correct format, or represents a number less than or greater than .
This parameter per second is passed uninitialized.
true if s was converted successfully; otherwise, false.
Converts the string representation of a number in a specified style and culture-specific format to its
equivalent. A return value indicates whether the conversion succeeded or failed.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter per second is null,
is not in a format compliant with style, or represents a number less than or
greater than . This parameter per second is passed uninitialized.
A object that supplies culture-specific formatting information about s.
true if s was converted successfully; otherwise, false.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
Returns the for value type .
The enumerated constant, .
Compares the two values for equality.
A object as the left hand operand.
A object as the right hand operand.
A value as the result of the operation.
Compares the two values for inequality.
A object as the left hand operand.
A object as the right hand operand.
A value as the result of the operation.
Returns true if left value is less than right value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result of the operation.
Returns true if left value is less or equal to than right value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result of the operation.
Returns true if left value is greater than right value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result of the operation.
Returns true if left value is greater than or equal to right value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result of the operation.
Implicitly converts value, represented in meters per second, to a .
A value.
A object.
Implicitly converts , represented in meters per second, to a .
A object.
A value.
Returns computed remainder after dividing first value by the second.
A object as the left hand operand.
A object as the right hand operand.
A object as the result.
Returns computed sum of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result.
Returns computed difference of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result.
Returns computed product of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result.
Returns computed division of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result.
Returns result of first value raised to speed of second value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Represents the largest possible value of an . This field is constant.
Represents the smallest possible value of an . This field is constant.
Creates a new value from the specified in miles per hour.
New value in miles per hour.
New object from the specified in miles per hour.
Creates a new value from the specified in kilometers per hour.
New value in kilometers per hour.
New object from the specified in kilometers per hour.
Creates a new value from the specified in feet per minute.
New value in feet per minute.
New object from the specified in feet per minute.
Creates a new value from the specified in inches per second.
New value in inches per second.
New object from the specified in inches per second.
Creates a new value from the specified in knots (International).
New value in knots.
New object from the specified in knots.
Creates a new value from the specified in Mach.
New value in Mach.
New object from the specified in Mach.
Converts the in the specified to a new in meters per second.
Source value.
Source value units.
New from the specified in .
Represents the units available for a value.
Kelvin temperature units.
Celsius temperature units.
Fahrenheit temperature units.
Newton temperature units.
Rankine temperature units.
Delisle temperature units.
Réaumur temperature units.
Rømer temperature units.
Provides a type converter to convert values to and from various other representations.
Since reports a type code of , the converter will convert
to and from double values as well as other types supported by .
Represents a temperature, in Kelvin, as a double-precision floating-point number.
This class behaves just like a representing a temperature in Kelvin; it is implicitly
castable to and from a and therefore can be generally used "as" a double, but it
has the advantage of handling conversions to and from other temperature representations, specifically
Celsius, Fahrenheit, Newton, Rankine, Delisle, Réaumur and Rømer.
This example converts Celsius to Fahrenheit:
public double GetFahrenheit(double celsius)
{
return Temperature.FromCelsius(celsius).ToFahrenheit();
}
Creates a new .
New temperature value in Kelvin.
Gets the value in Celsius.
Value of in Celsius.
Gets the value in Fahrenheit.
Value of in Fahrenheit.
Gets the value in Newton.
Value of in Newton.
Gets the value in Rankine.
Value of in Rankine.
Gets the value in Delisle.
Value of in Delisle.
Gets the value in Réaumur.
Value of in Réaumur.
Gets the value in Rømer.
Value of in Rømer.
Converts the to the specified .
Target units.
converted to .
Compares this instance to a specified object and returns an indication of their relative values.
An object to compare, or null.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
value is not a or .
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Returns a value indicating whether this instance is equal to a specified object.
An object to compare, or null.
True if obj is an instance of or and equals the value of this instance;
otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns the hash code for this instance.
A 32-bit signed integer hash code.
Converts the numeric value of this instance to its equivalent string representation.
The string representation of the value of this instance, consisting of a minus sign if
the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeros.
Converts the numeric value of this instance to its equivalent string representation, using
the specified format.
A format string.
The string representation of the value of this instance as specified by format.
Converts the numeric value of this instance to its equivalent string representation using the
specified culture-specific format information.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by provider.
Converts the numeric value of this instance to its equivalent string representation using the
specified format and culture-specific format information.
A format specification.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by format and provider.
Converts the string representation of a number to its equivalent.
A string containing a number to convert.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number in a specified culture-specific format to its equivalent.
A string containing a number to convert.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style and culture-specific format to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number to its equivalent. A return value
indicates whether the conversion succeeded or failed.
A string containing a number to convert.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not of the correct format, or represents a number less than or greater than .
This parameter is passed uninitialized.
true if s was converted successfully; otherwise, false.
Converts the string representation of a number in a specified style and culture-specific format to its
equivalent. A return value indicates whether the conversion succeeded or failed.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not in a format compliant with style, or represents a number less than or
greater than . This parameter is passed uninitialized.
A object that supplies culture-specific formatting information about s.
true if s was converted successfully; otherwise, false.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
Returns the for value type .
The enumerated constant, .
Compares the two values for equality.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Compares the two values for inequality.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is less than right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is less or equal to than right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is greater than right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is greater than or equal to right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Implicitly converts value, represented in Kelvin, to a .
A value.
A object.
Implicitly converts , represented in Kelvin, to a .
A object.
A value.
Returns computed remainder after dividing first value by the second.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed sum of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed difference of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed product of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed division of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns result of first value raised to power of second value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result of the operation.
Represents the largest possible value of a . This field is constant.
Represents the smallest possible value of a . This field is constant.
Creates a new value from the specified in Celsius.
New value in Celsius.
New object from the specified in Celsius.
Creates a new value from the specified in Fahrenheit.
New value in Fahrenheit.
New object from the specified in Fahrenheit.
Creates a new value from the specified in Newton.
New value in Newton.
New object from the specified in Newton.
Creates a new value from the specified in Rankine.
New value in Rankine.
New object from the specified in Rankine.
Creates a new value from the specified in Delisle.
New value in Delisle.
New object from the specified in Delisle.
Creates a new value from the specified in Réaumur.
New value in Réaumur.
New object from the specified in Réaumur.
Creates a new value from the specified in Rømer.
New value in Rømer.
New object from the specified in Rømer.
Converts the in the specified to a new in Kelvin.
Source value.
Source value units.
New from the specified in .
Represents the units available for a value.
Second time units.
Minute time units.
Hour time units.
Day time units.
Week time units.
Tick time units, 100-nanosecond intervals since 1/1/0001.
Atomic time units.
Planck time units.
Ke time units, traditional Chinese unit of decimal time.
Provides a type converter to convert values to and from various other representations.
Since reports a type code of , the converter will convert
to and from double values as well as other types supported by .
Represents a time measurement, in seconds, as a double-precision floating-point number.
This class behaves just like a representing a time in seconds; it is implicitly
castable to and from a and therefore can be generally used "as" a double, but it
has the advantage of handling conversions to and from other time representations, specifically
minutes, hours, days, weeks, atomic units of time, Planck time and ke. Metric conversions are handled
simply by applying the needed conversion factor, for example:
Convert time in nanoseconds to seconds:
public Time GetSeconds(double nanoseconds)
{
return nanoseconds * SI.Nano;
}
Convert time in seconds to milliseconds:
public double GetMilliseconds(Time seconds)
{
return time / SI.Milli;
}
This example converts minutes to hours:
public double GetHours(double minutes)
{
return Time.FromMinutes(minutes).ToHours();
}
Note that the method will convert the value, in seconds,
into a textual representation of years, days, hours, minutes and seconds using the static function
.
Fractional number of seconds in one tick.
Number of seconds in one minute.
Number of seconds in one hour.
Number of seconds in one day.
Number of seconds in one week.
Creates a new .
New time value in seconds.
Creates a new .
New time value as a .
Gets the value in atomic units of time.
Value of in atomic units of time.
Gets the value in Planck time.
Value of in Planck time.
Gets the value in ke, the traditional Chinese unit of decimal time.
Value of in ke.
Gets the value in minutes.
Value of in minutes.
Gets the value in hours.
Value of in hours.
Gets the value in days.
Value of in days.
Gets the value in weeks.
Value of in weeks.
Converts the value, in seconds, to 100-nanosecond tick intervals.
A object.
Converts the to the specified .
Target units.
converted to .
When converting to , precision loss will
occur for values that are outside the range of -2^52 and 2^52.
Converts the value into a textual representation of years, days, hours,
minutes and seconds.
Note that this ToString overload will not display fractional seconds. To allow display of
fractional seconds, or completely remove second resolution from the textual representation,
use the overload instead.
The string representation of the value of this instance, consisting of the number of
years, days, hours, minutes and seconds represented by this value.
Converts the value into a textual representation of years, days, hours,
minutes and seconds with the specified number of fractional digits.
Number of fractional digits to display for seconds.
Minimum sub-second resolution to display. Defaults to .
Set second precision to -1 to suppress seconds display.
The string representation of the value of this instance, consisting of the number of
years, days, hours, minutes and seconds represented by this value.
is not less than or equal to or
is not defined in array.
Converts the value into a textual representation of years, days, hours,
minutes and seconds with the specified number of fractional digits given string array of
time names.
Number of fractional digits to display for seconds.
Time names array to use during textual conversion.
Minimum sub-second resolution to display. Defaults to .
Set second precision to -1 to suppress seconds display.
array needs one string entry for each of the following names:
" year", " years", " day", " days", " hour", " hours", " minute", " minutes", " second", " seconds", "less than ".
The string representation of the value of this instance, consisting of the number of
years, days, hours, minutes and seconds represented by this value.
is not less than or equal to or
is not defined in array.
Compares this instance to a specified object and returns an indication of their relative values.
An object to compare, or null.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
value is not a or .
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Compares this instance to a specified and returns an indication of their
relative values.
An to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Returns a value indicating whether this instance is equal to a specified object.
An object to compare, or null.
True if obj is an instance of or and equals the value of this instance;
otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
An value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns the hash code for this instance.
A 32-bit signed integer hash code.
Converts the numeric value of this instance to its equivalent string representation, using
the specified format.
Note that this ToString overload matches , use
to convert value into a textual
representation of years, days, hours, minutes and seconds.
A format string.
The string representation of the value of this instance as specified by format.
Converts the numeric value of this instance to its equivalent string representation using the
specified culture-specific format information.
Note that this ToString overload matches , use
to convert value into a textual
representation of years, days, hours, minutes and seconds.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by provider.
Converts the numeric value of this instance to its equivalent string representation using the
specified format and culture-specific format information.
Note that this ToString overload matches , use
to convert value into a textual representation
of years, days, hours, minutes and seconds.
A format specification.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by format and provider.
Converts the string representation of a number to its equivalent.
A string containing a number to convert.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number in a specified culture-specific format to its equivalent.
A string containing a number to convert.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style and culture-specific format to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number to its equivalent. A return value
indicates whether the conversion succeeded or failed.
A string containing a number to convert.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not of the correct format, or represents a number less than or greater than .
This parameter is passed uninitialized.
true if s was converted successfully; otherwise, false.
Converts the string representation of a number in a specified style and culture-specific format to its
equivalent. A return value indicates whether the conversion succeeded or failed.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not in a format compliant with style, or represents a number less than or
greater than . This parameter is passed uninitialized.
A object that supplies culture-specific formatting information about s.
true if s was converted successfully; otherwise, false.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
Returns the for value type .
The enumerated constant, .
Compares the two values for equality.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Compares the two values for inequality.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is less than right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is less or equal to than right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is greater than right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Returns true if left value is greater than or equal to right value.
A object as the left hand operand.
A object as the right hand operand.
A as the result of the operation.
Implicitly converts value, represented in seconds, to a .
A value.
A object.
Implicitly converts value, represented as a , to a .
A object.
A object.
Implicitly converts , represented in seconds, to a .
A object.
A value.
Implicitly converts , represented in seconds, to a .
A object.
A object.
Returns computed remainder after dividing first value by the second.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed sum of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed difference of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed product of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns computed division of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result of the operation.
Returns result of first value raised to power of second value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result of the operation.
Represents the largest possible value of a . This field is constant.
Represents the smallest possible value of a . This field is constant.
Standard time names used by method.
Creates a new value from the specified in atomic units of time.
New value in atomic units of time.
New object from the specified in atomic units of time.
Creates a new value from the specified in Planck time.
New value in Planck time.
New object from the specified in Planck time.
Creates a new value from the specified in ke,
the traditional Chinese unit of decimal time.
New value in ke.
New object from the specified in ke.
Creates a new value from the specified in minutes.
New value in minutes.
New object from the specified in minutes.
Creates a new value from the specified in hours.
New value in hours.
New object from the specified in hours.
Creates a new value from the specified in days.
New value in days.
New object from the specified in days.
Creates a new value from the specified in weeks.
New value in weeks.
New object from the specified in weeks.
Creates a new value from the specified in .
New value in Ticks.
New object from the specified in .
Converts the in the specified to a new in seconds.
Source value.
Source value units.
New from the specified in .
When converting from , precision loss will
occur for values that are outside the range of -2^52 and 2^52.
Returns the number of seconds in the specified month and year.
The year.
The month (a number ranging from 1 to 12).
The number of seconds, as a , in the month for the specified year.
Month is less than 1 or greater than 12. -or- year is less than 1 or greater than 9999.
Returns the number of seconds in the specified year.
The year.
The number of seconds in the specified year.
Year is less than 1 or greater than 9999.
Converts total into a textual representation of years, days, hours,
minutes and seconds with the specified number of fractional digits given string array of
time names.
Seconds to convert to elapsed time.
Number of fractional digits to display for seconds.
Time names array to use during textual conversion.
Minimum sub-second resolution to display. Defaults to .
Set to -1 to suppress seconds display, this will
force minimum resolution of time display to minutes.
array needs one string entry for each of the following names:
" year", " years", " day", " days", " hour", " hours", " minute", " minutes", " second", " seconds", "less than ".
The string representation of the value of this instance, consisting of the number of
years, days, hours, minutes and seconds represented by this value.
is not less than or equal to or
is not defined in array.
Represents the units available for a value.
Voltage units.
Abvoltage units.
Statvoltage units.
Provides a type converter to convert values to and from various other representations.
Since reports a type code of , the converter will convert
to and from double values as well as other types supported by .
Represents an electromotive force (i.e., voltage) measurement, in volts, as a double-precision floating-point number.
This class behaves just like a representing a voltage in volts; it is implicitly
castable to and from a and therefore can be generally used "as" a double, but it
has the advantage of handling conversions to and from other voltage representations, specifically
abvolt and statvolt. Metric conversions are handled simply by applying the needed
conversion factor, for example:
Convert volts to megavolts:
public double GetMegavolts(Voltage volts)
{
return volts / SI.Mega;
}
Creates a new .
New voltage value in volts.
Gets the value in abvolts.
Value of in abvolts.
Gets the value in statvolts.
Value of in statvolts.
Converts the to the specified .
Target units.
converted to .
Compares this instance to a specified object and returns an indication of their relative values.
An object to compare, or null.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
value is not a or .
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Returns a value indicating whether this instance is equal to a specified object.
An object to compare, or null.
True if obj is an instance of or and equals the value of this instance;
otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns the hash code for this instance.
A 32-bit signed integer hash code.
Converts the numeric value of this instance to its equivalent string representation.
The string representation of the value of this instance, consisting of a minus sign if
the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeros.
Converts the numeric value of this instance to its equivalent string representation, using
the specified format.
A format string.
The string representation of the value of this instance as specified by format.
Converts the numeric value of this instance to its equivalent string representation using the
specified culture-specific format information.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by provider.
Converts the numeric value of this instance to its equivalent string representation using the
specified format and culture-specific format information.
A format specification.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by format and provider.
Converts the string representation of a number to its equivalent.
A string containing a number to convert.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number in a specified culture-specific format to its equivalent.
A string containing a number to convert.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style and culture-specific format to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number to its equivalent. A return value
indicates whether the conversion succeeded or failed.
A string containing a number to convert.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not of the correct format, or represents a number less than or greater than .
This parameter is passed uninitialized.
true if s was converted successfully; otherwise, false.
Converts the string representation of a number in a specified style and culture-specific format to its
equivalent. A return value indicates whether the conversion succeeded or failed.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not in a format compliant with style, or represents a number less than or
greater than . This parameter is passed uninitialized.
A object that supplies culture-specific formatting information about s.
true if s was converted successfully; otherwise, false.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
Returns the for value type .
The enumerated constant, .
Compares the two values for equality.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Compares the two values for inequality.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Returns true if left value is less than right value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Returns true if left value is less or equal to than right value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Returns true if left value is greater than right value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Returns true if left value is greater than or equal to right value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Implicitly converts value, represented in volts, to a .
A value.
A object.
Implicitly converts , represented in volts, to a .
A object.
A value.
Returns computed remainder after dividing first value by the second.
A object as the left hand operand.
A object as the right hand operand.
A as the result.
Returns computed sum of values.
A object as the left hand operand.
A object as the right hand operand.
A as the result.
Returns computed difference of values.
A object as the left hand operand.
A object as the right hand operand.
A as the result.
Returns computed product of values.
A object as the left hand operand.
A object as the right hand operand.
A as the result.
Returns computed division of values.
A object as the left hand operand.
A object as the right hand operand.
A as the result.
Returns result of first value raised to voltage of second value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Represents the largest possible value of an . This field is constant.
Represents the smallest possible value of an . This field is constant.
Creates a new value from the specified in abvolts.
New value in abvolts.
New object from the specified in abvolts.
Creates a new value from the specified in statvolts.
New value in statvolts.
New object from the specified in statvolts.
Converts the in the specified to a new in volts.
Source value.
Source value units.
New from the specified in .
Represents the units available for a value.
Cubic meter volume units.
Liter volume units.
Teaspoon volume units.
Metric teaspoon volume units.
Tablespoon volume units.
Metric tablespoon volume units.
Cup volume units.
Metric cup volume units.
Fluid ounce volume units.
Pint volume units.
Quart volume units.
Gallon volume units.
Cubic inch volume units.
Cubic feet volume units.
Provides a type converter to convert values to and from various other representations.
Since reports a type code of , the converter will convert
to and from double values as well as other types supported by .
Represents a volume measurement, in cubic meters, as a double-precision floating-point number.
This class behaves just like a representing a volume in cubic meters; it is implicitly
castable to and from a and therefore can be generally used "as" a double, but it
has the advantage of handling conversions to and from other volume representations, specifically
liters, teaspoons, tablespoons, cubic inches, fluid ounces, cups, pints, quarts, gallons and cubic feet.
Metric conversions are handled simply by applying the needed conversion factor, for example:
Convert volume, in cubic meters, to cubic kilometers:
public double GetCubicKilometers(Volume cubicmeters)
{
return cubicmeters / SI.Kilo;
}
This example converts teaspoons to cups:
public double GetCups(double teaspoons)
{
return Volume.FromTeaspoons(teaspoons).ToCups();
}
This example converts liters to fluid ounces:
public double GetFluidOunces(double liters)
{
return Volume.FromLiters(liters).ToFluidOunces();
}
Creates a new .
New volume value in cubic meters.
Gets the value in liters.
Value of in liters.
Gets the value in US teaspoons.
Value of in US teaspoons.
Gets the value in metric teaspoons.
Value of in metric teaspoons.
Gets the value in US tablespoons.
Value of in US tablespoons.
Gets the value in metric tablespoons.
Value of in metric tablespoons.
Gets the value in US cups.
Value of in US cups.
Gets the value in metric cups.
Value of in metric cups.
Gets the value in US fluid ounces.
Value of in US fluid ounces.
Gets the value in US fluid pints.
Value of in US fluid pints.
Gets the value in US fluid quarts.
Value of in US fluid quarts.
Gets the value in US fluid gallons.
Value of in US fluid gallons.
Gets the value in cubic inches.
Value of in cubic inches.
Gets the value in cubic feet.
Value of in cubic feet.
Converts the to the specified .
Target units.
converted to .
Compares this instance to a specified object and returns an indication of their relative values.
An object to compare, or null.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
value is not a or .
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Compares this instance to a specified and returns an indication of their
relative values.
A to compare.
A signed number indicating the relative values of this instance and value. Returns less than zero
if this instance is less than value, zero if this instance is equal to value, or greater than zero
if this instance is greater than value.
Returns a value indicating whether this instance is equal to a specified object.
An object to compare, or null.
True if obj is an instance of or and equals the value of this instance;
otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns a value indicating whether this instance is equal to a specified value.
A value to compare to this instance.
True if obj has the same value as this instance; otherwise, False.
Returns the hash code for this instance.
A 32-bit signed integer hash code.
Converts the numeric value of this instance to its equivalent string representation.
The string representation of the value of this instance, consisting of a minus sign if
the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeros.
Converts the numeric value of this instance to its equivalent string representation, using
the specified format.
A format string.
The string representation of the value of this instance as specified by format.
Converts the numeric value of this instance to its equivalent string representation using the
specified culture-specific format information.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by provider.
Converts the numeric value of this instance to its equivalent string representation using the
specified format and culture-specific format information.
A format specification.
A that supplies culture-specific formatting information.
The string representation of the value of this instance as specified by format and provider.
Converts the string representation of a number to its equivalent.
A string containing a number to convert.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number in a specified culture-specific format to its equivalent.
A string containing a number to convert.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
s is null.
s represents a number less than or greater than .
s is not in the correct format.
Converts the string representation of a number in a specified style and culture-specific format to its equivalent.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
A that supplies culture-specific formatting information about s.
A equivalent to the number contained in s.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
s is null.
s represents a number less than or greater than .
s is not in a format compliant with style.
Converts the string representation of a number to its equivalent. A return value
indicates whether the conversion succeeded or failed.
A string containing a number to convert.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not of the correct format, or represents a number less than or greater than .
This parameter is passed uninitialized.
true if s was converted successfully; otherwise, false.
Converts the string representation of a number in a specified style and culture-specific format to its
equivalent. A return value indicates whether the conversion succeeded or failed.
A string containing a number to convert.
A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s.
When this method returns, contains the value equivalent to the number contained in s,
if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null,
is not in a format compliant with style, or represents a number less than or
greater than . This parameter is passed uninitialized.
A object that supplies culture-specific formatting information about s.
true if s was converted successfully; otherwise, false.
style is not a System.Globalization.NumberStyles value. -or- style is not a combination of
System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values.
Returns the for value type .
The enumerated constant, .
Compares the two values for equality.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Compares the two values for inequality.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Returns true if left value is less than right value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Returns true if left value is less or equal to than right value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Returns true if left value is greater than right value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Returns true if left value is greater than or equal to right value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Implicitly converts value, represented in cubic meters, to a .
A value.
A object.
Implicitly converts , represented in cubic meters, to a .
A object.
A value.
Returns computed remainder after dividing first value by the second.
A object as the left hand operand.
A object as the right hand operand.
A object as the result.
Returns computed sum of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result.
Returns computed difference of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result.
Returns computed product of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result.
Returns computed division of values.
A object as the left hand operand.
A object as the right hand operand.
A object as the result.
Returns result of first value raised to volume of second value.
A object as the left hand operand.
A object as the right hand operand.
A value as the result.
Represents the largest possible value of an . This field is constant.
Represents the smallest possible value of an . This field is constant.
Creates a new value from the specified in liters.
New value in liters.
New object from the specified in liters.
Creates a new value from the specified in US teaspoons.
New value in US teaspoons.
New object from the specified in US teaspoons.
Creates a new value from the specified in metric teaspoons.
New value in metric teaspoons.
New object from the specified in metric teaspoons.
Creates a new value from the specified in US tablespoons.
New value in US tablespoons.
New object from the specified in US tablespoons.
Creates a new value from the specified in metric tablespoons.
New value in metric tablespoons.
New object from the specified in metric tablespoons.
Creates a new value from the specified in US cups.
New value in US cups.
New object from the specified in US cups.
Creates a new value from the specified in metric cups.
New value in metric cups.
New object from the specified in metric cups.
Creates a new value from the specified in US fluid ounces.
New value in US fluid ounces.
New object from the specified in US fluid ounces.
Creates a new value from the specified in US fluid pints.
New value in US fluid pints.
New object from the specified in US fluid pints.
Creates a new value from the specified in US fluid quarts.
New value in US fluid quarts.
New object from the specified in US fluid quarts.
Creates a new value from the specified in US fluid gallons.
New value in US fluid gallons.
New object from the specified in US fluid gallons.
Creates a new value from the specified in cubic inches.
New value in cubic inches.
New object from the specified in cubic inches.
Creates a new value from the specified in cubic feet.
New value in cubic feet.
New object from the specified in cubic feet.
Converts the in the specified to a new in cubic meters.
Source value.
Source value units.
New from the specified in .
Represents a standard Unix time-tag.
Creates a new , given number of seconds since 1/1/1970.
Number of seconds since 1/1/1970.
Creates a new , given number of seconds since 1/1/1970.
Number of seconds since 1/1/1970.
Creates a new , given specified .
Timestamp in to create Unix time-tag from (minimum valid date is 1/1/1970).
This constructor will accept a parameter since is implicitly castable to a .
Creates a new from serialization parameters.
The with populated with data.
The source for this deserialization.
Number of ticks since 1/1/1970.
Unix dates are measured as the number of seconds since 1/1/1970.
Defines a few common United States time zones.
Gets the Atlantic time zone.
This time zone is used by the Commonwealth of Puerto Rico and the United States Virgin Islands.
Gets the Eastern time zone.
Gets the Central time zone.
Gets the Mountain time zone.
Gets the Pacific time zone.
Gets the Alaskan time zone.
Gets the Hawaiian time zone.
Gets the West Pacific time zone.
This time zone is used by Guam and the Commonwealth of the Northern Mariana Islands.
This is also known as the Chamorro time zone.
Gets the Samoa time zone.
This time zone is used by the American Samoa.
Defines functions related to 16-bit words, 32-bit double-words and 64-bit quad-words.
Makes an unsigned word (UInt16) from two bytes.
High byte.
Low byte.
An unsigned 16-bit word made from the two specified bytes.
Makes an unsigned double-word (UInt32) from two unsigned words (UInt16).
High word.
Low word.
An unsigned 32-bit double-word made from the two specified unsigned 16-bit words.
Makes an unsigned quad-word (UInt64) from two unsigned double-words (UInt32).
High double-word.
Low double-word.
An unsigned 64-bit quad-word made from the two specified unsigned 32-bit double-words.
Contains extension methods for 16-bit words, 32-bit double-words and 64-bit quad-words..
Defines extension functions related to 16-bit words, 32-bit double-words and 64-bit quad-words.
Aligns word length value to a 16-bit boundary.
Word value to align.
Word value aligned to next 16-bit boundary.
Aligns word length value to a 16-bit boundary.
Word value to align.
Word value aligned to next 16-bit boundary.
Aligns double-word length value to a 32-bit boundary.
Double-word value to align.
Double-word value aligned to next 32-bit boundary.
Aligns double-word length value to a 32-bit boundary.
Double-word value to align.
Double-word value aligned to next 32-bit boundary.
Aligns quad-word length value to a 64-bit boundary.
Quad-word value to align.
Quad-word value aligned to next 64-bit boundary.
Aligns quad-word length value to a 64-bit boundary.
Quad-word value to align.
Quad-word value aligned to next 64-bit boundary.
Returns the high-nibble (high 4-bits) from a byte.
Byte value.
The high-nibble of the specified byte value.
Returns the high-byte from an unsigned word (UInt16).
2-byte, 16-bit unsigned integer value.
The high-order byte of the specified 16-bit unsigned integer value.
On little-endian architectures (e.g., Intel platforms), this will be the byte value whose in-memory representation
is the same as the right-most, most-significant-byte of the integer value.
Returns the unsigned high-word (UInt16) from an unsigned double-word (UInt32).
4-byte, 32-bit unsigned integer value.
The unsigned high-order word of the specified 32-bit unsigned integer value.
On little-endian architectures (e.g., Intel platforms), this will be the word value
whose in-memory representation is the same as the right-most, most-significant-word
of the integer value.
Returns the unsigned high-double-word (UInt32) from an unsigned quad-word (UInt64).
8-byte, 64-bit unsigned integer value.
The high-order double-word of the specified 64-bit unsigned integer value.
On little-endian architectures (e.g., Intel platforms), this will be the word value
whose in-memory representation is the same as the right-most, most-significant-word
of the integer value.
Returns the low-nibble (low 4-bits) from a byte.
Byte value.
The low-nibble of the specified byte value.
Returns the low-byte from an unsigned word (UInt16).
2-byte, 16-bit unsigned integer value.
The low-order byte of the specified 16-bit unsigned integer value.
On little-endian architectures (e.g., Intel platforms), this will be the byte value
whose in-memory representation is the same as the left-most, least-significant-byte
of the integer value.
Returns the unsigned low-word (UInt16) from an unsigned double-word (UInt32).
4-byte, 32-bit unsigned integer value.
The unsigned low-order word of the specified 32-bit unsigned integer value.
On little-endian architectures (e.g., Intel platforms), this will be the word value
whose in-memory representation is the same as the left-most, least-significant-word
of the integer value.
Returns the unsigned low-double-word (UInt32) from an unsigned quad-word (UInt64).
8-byte, 64-bit unsigned integer value.
The low-order double-word of the specified 64-bit unsigned integer value.
On little-endian architectures (e.g., Intel platforms), this will be the word value
whose in-memory representation is the same as the left-most, least-significant-word
of the integer value.
Custom -derived type for the GenerateINIKeyValuePairRegex method.
Cached, thread-safe singleton instance.
Initializes the instance.
Provides a factory for creating instances to be used by methods on .
Creates an instance of a used by methods on .
Provides the runner that contains the custom logic implementing the specified regular expression.
Scan the starting from base.runtextstart for the next match.
The text being scanned by the regular expression.
Search starting from base.runtextpos for the next location a match could possibly start.
The text being scanned by the regular expression.
true if a possible match was found; false if no more matches are possible.
Determine whether at base.runtextpos is a match for the regular expression.
The text being scanned by the regular expression.
true if the regular expression matches at the current position; otherwise, false.
Custom -derived type for the GenerateTypeNameCleanerRegex method.
Cached, thread-safe singleton instance.
Initializes the instance.
Provides a factory for creating instances to be used by methods on .
Creates an instance of a used by methods on .
Provides the runner that contains the custom logic implementing the specified regular expression.
Scan the starting from base.runtextstart for the next match.
The text being scanned by the regular expression.
Search starting from base.runtextpos for the next location a match could possibly start.
The text being scanned by the regular expression.
true if a possible match was found; false if no more matches are possible.
Determine whether at base.runtextpos is a match for the regular expression.
The text being scanned by the regular expression.
true if the regular expression matches at the current position; otherwise, false.
Helper methods used by generated -derived implementations.
Default timeout value set in , or if none was set.
Whether is non-infinite.
Finds the next index of any character that matches a character in the set [;\s\w].
Determines whether the character is part of the [\w] set.
Supports searching for characters in or not in "\0\u0001\u0002\u0003\u0004\u0005\u0006\a\b\u000e\u000f\u0010\u0011\u0012\u0013\u0014\u0015\u0016\u0017\u0018\u0019\u001a\u001b\u001c\u001d\u001e\u001f!\"#$%&'()*+,-./:<=>?@[\\]^`{|}~\u007f".