System.Runtime.zh

Microsoft.Win32.SafeHandles.CriticalHandleMinusOneIsInvalid

Provides a base class for Win32 critical handle implementations in which the value of -1 indicates an invalid handle.

Microsoft.Win32.SafeHandles.CriticalHandleMinusOneIsInvalid.#ctor

Initializes a new instance of the Microsoft.Win32.SafeHandles.CriticalHandleMinusOneIsInvalid class.

Microsoft.Win32.SafeHandles.CriticalHandleMinusOneIsInvalid.IsInvalid

Gets a value that indicates whether the handle is invalid.

Returns

true if the handle is not valid; otherwise, false.

Microsoft.Win32.SafeHandles.CriticalHandleZeroOrMinusOneIsInvalid

Provides a base class for Win32 critical handle implementations in which the value of either 0 or -1 indicates an invalid handle.

Microsoft.Win32.SafeHandles.CriticalHandleZeroOrMinusOneIsInvalid.#ctor

Microsoft.Win32.SafeHandles.CriticalHandleZeroOrMinusOneIsInvalid.IsInvalid

Gets a value that indicates whether the handle is invalid.

Returns

true if the handle is not valid; otherwise, false.

Microsoft.Win32.SafeHandles.SafeFileHandle

Represents a wrapper class for a file handle.

Microsoft.Win32.SafeHandles.SafeFileHandle.#ctor

Creates a Microsoft.Win32.SafeHandles.SafeFileHandle around a file handle.

Microsoft.Win32.SafeHandles.SafeFileHandle.#ctor()

Initializes a new instance of the Microsoft.Win32.SafeHandles.SafeFileHandle class.

Parameters

NameDescriptionDefault
preexistingHandle An System.IntPtr object that represents the pre-existing handle to use.
ownsHandle true to reliably release the handle during the finalization phase; false to prevent reliable release (not recommended).

Microsoft.Win32.SafeHandles.SafeFileHandle.IsAsync

Gets a value that determines if the handle is asynchronous or not.

Returns

true if the handle is asynchronous; false otherwise.

Microsoft.Win32.SafeHandles.SafeFileHandle.IsInvalid

Gets a value that indicates whether the handle is invalid.

Returns

true if the handle is not valid; otherwise, false.

Microsoft.Win32.SafeHandles.SafeHandleMinusOneIsInvalid

Provides a base class for Win32 safe handle implementations in which the value of -1 indicates an invalid handle.

Microsoft.Win32.SafeHandles.SafeHandleMinusOneIsInvalid.#ctor()

Initializes a new instance of the Microsoft.Win32.SafeHandles.SafeHandleMinusOneIsInvalid class, specifying whether the handle is to be reliably released.

Parameters

NameDescriptionDefault
ownsHandle true to reliably release the handle during the finalization phase; false to prevent reliable release (not recommended).

Microsoft.Win32.SafeHandles.SafeHandleMinusOneIsInvalid.IsInvalid

Gets a value that indicates whether the handle is invalid.

Returns

true if the handle is not valid; otherwise, false.

Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid

Provides a base class for Win32 safe handle implementations in which the value of either 0 or -1 indicates an invalid handle.

Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid.#ctor()

Initializes a new instance of the Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid class, specifying whether the handle is to be reliably released.

Parameters

NameDescriptionDefault
ownsHandle true to reliably release the handle during the finalization phase; false to prevent reliable release (not recommended).

Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid.IsInvalid

Gets a value that indicates whether the handle is invalid.

Returns

true if the handle is not valid; otherwise, false.

Microsoft.Win32.SafeHandles.SafeWaitHandle

Represents a wrapper class for a wait handle.

Microsoft.Win32.SafeHandles.SafeWaitHandle.#ctor

Microsoft.Win32.SafeHandles.SafeWaitHandle.#ctor()

Initializes a new instance of the Microsoft.Win32.SafeHandles.SafeWaitHandle class.

Parameters

NameDescriptionDefault
existingHandle An System.IntPtr object that represents the pre-existing handle to use.
ownsHandle true to reliably release the handle during the finalization phase; false to prevent reliable release (not recommended).

System.AccessViolationException

The exception that is thrown when there is an attempt to read or write protected memory.

System.AccessViolationException.#ctor

Initializes a new instance of the System.AccessViolationException class with a system-supplied message that describes the error.

System.AccessViolationException.#ctor()

Initializes a new instance of the System.AccessViolationException class with serialized data.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.AccessViolationException.#ctor()

Initializes a new instance of the System.AccessViolationException class with a specified message that describes the error.

Parameters

NameDescriptionDefault
message The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture.

System.AccessViolationException.#ctor()

Initializes a new instance of the System.AccessViolationException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.Action

Encapsulates a method that has no parameters and does not return a value.

System.Action`1

Encapsulates a method that has a single parameter and does not return a value.

Parameters

NameDescriptionDefault
obj The parameter of the method that this delegate encapsulates.

System.Action`10

Encapsulates a method that has 10 parameters and does not return a value.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.
arg9 The ninth parameter of the method that this delegate encapsulates.
arg10 The tenth parameter of the method that this delegate encapsulates.

System.Action`11

Encapsulates a method that has 11 parameters and does not return a value.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.
arg9 The ninth parameter of the method that this delegate encapsulates.
arg10 The tenth parameter of the method that this delegate encapsulates.
arg11 The eleventh parameter of the method that this delegate encapsulates.

System.Action`12

Encapsulates a method that has 12 parameters and does not return a value.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.
arg9 The ninth parameter of the method that this delegate encapsulates.
arg10 The tenth parameter of the method that this delegate encapsulates.
arg11 The eleventh parameter of the method that this delegate encapsulates.
arg12 The twelfth parameter of the method that this delegate encapsulates.

System.Action`13

Encapsulates a method that has 13 parameters and does not return a value.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.
arg9 The ninth parameter of the method that this delegate encapsulates.
arg10 The tenth parameter of the method that this delegate encapsulates.
arg11 The eleventh parameter of the method that this delegate encapsulates.
arg12 The twelfth parameter of the method that this delegate encapsulates.
arg13 The thirteenth parameter of the method that this delegate encapsulates.

System.Action`14

Encapsulates a method that has 14 parameters and does not return a value.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.
arg9 The ninth parameter of the method that this delegate encapsulates.
arg10 The tenth parameter of the method that this delegate encapsulates.
arg11 The eleventh parameter of the method that this delegate encapsulates.
arg12 The twelfth parameter of the method that this delegate encapsulates.
arg13 The thirteenth parameter of the method that this delegate encapsulates.
arg14 The fourteenth parameter of the method that this delegate encapsulates.

System.Action`15

Encapsulates a method that has 15 parameters and does not return a value.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.
arg9 The ninth parameter of the method that this delegate encapsulates.
arg10 The tenth parameter of the method that this delegate encapsulates.
arg11 The eleventh parameter of the method that this delegate encapsulates.
arg12 The twelfth parameter of the method that this delegate encapsulates.
arg13 The thirteenth parameter of the method that this delegate encapsulates.
arg14 The fourteenth parameter of the method that this delegate encapsulates.
arg15 The fifteenth parameter of the method that this delegate encapsulates.

System.Action`16

Encapsulates a method that has 16 parameters and does not return a value.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.
arg9 The ninth parameter of the method that this delegate encapsulates.
arg10 The tenth parameter of the method that this delegate encapsulates.
arg11 The eleventh parameter of the method that this delegate encapsulates.
arg12 The twelfth parameter of the method that this delegate encapsulates.
arg13 The thirteenth parameter of the method that this delegate encapsulates.
arg14 The fourteenth parameter of the method that this delegate encapsulates.
arg15 The fifteenth parameter of the method that this delegate encapsulates.
arg16 The sixteenth parameter of the method that this delegate encapsulates.

System.Action`2

Encapsulates a method that has two parameters and does not return a value.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.

System.Action`3

Encapsulates a method that has three parameters and does not return a value.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.

System.Action`4

Encapsulates a method that has four parameters and does not return a value.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.

System.Action`5

Encapsulates a method that has five parameters and does not return a value.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.

System.Action`6

Encapsulates a method that has six parameters and does not return a value.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.

System.Action`7

Encapsulates a method that has seven parameters and does not return a value.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.

System.Action`8

Encapsulates a method that has eight parameters and does not return a value.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.

System.Action`9

Encapsulates a method that has nine parameters and does not return a value.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.
arg9 The ninth parameter of the method that this delegate encapsulates.

System.Activator

Contains methods to create types of objects locally or remotely, or obtain references to existing remote objects. This class cannot be inherited.

System.Activator.CreateInstance()

Creates an instance of the type whose name is specified, using the named assembly and parameterless constructor.

Parameters

NameDescriptionDefault
assemblyName The name of the assembly where the type named typeName is sought. If assemblyName is null, the executing assembly is searched.
typeName The fully qualified name of the type to create an instance of.

Returns

A handle that must be unwrapped to access the newly created instance.

System.Activator.CreateInstance()

Creates an instance of the type whose name is specified, using the named assembly and the constructor that best matches the specified parameters.

Parameters

NameDescriptionDefault
assemblyName The name of the assembly where the type named typeName is sought. If assemblyName is null, the executing assembly is searched.
typeName The fully qualified name of the type to create an instance of.
ignoreCase true to specify that the search for typeName is not case-sensitive; false to specify that the search is case-sensitive.
bindingAttr A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted.
binder An object that uses bindingAttr and args to seek and identify the typeName constructor. If binder is null, the default binder is used.
args An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the parameterless constructor) is invoked.
culture Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used.
activationAttributes An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object that specifies the URL that is required to activate a remote object. This parameter is related to client-activated objects. Client activation is a legacy technology that is retained for backward compatibility but is not recommended for new development. Distributed applications should instead use Windows Communication Foundation.

Returns

A handle that must be unwrapped to access the newly created instance.

System.Activator.CreateInstance()

Creates an instance of the type whose name is specified, using the named assembly and parameterless constructor.

Parameters

NameDescriptionDefault
assemblyName The name of the assembly where the type named typeName is sought. If assemblyName is null, the executing assembly is searched.
typeName The fully qualified name of the type to create an instance of.
activationAttributes An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object that specifies the URL that is required to activate a remote object. This parameter is related to client-activated objects. Client activation is a legacy technology that is retained for backward compatibility but is not recommended for new development. Distributed applications should instead use Windows Communication Foundation.

Returns

A handle that must be unwrapped to access the newly created instance.

System.Activator.CreateInstance()

Creates an instance of the specified type using that type's parameterless constructor.

Parameters

NameDescriptionDefault
type The type of object to create.

Returns

A reference to the newly created object.

System.Activator.CreateInstance()

Creates an instance of the specified type using that type's parameterless constructor.

Parameters

NameDescriptionDefault
type The type of object to create.
nonPublic true if a public or nonpublic parameterless constructor can match; false if only a public parameterless constructor can match.

Returns

A reference to the newly created object.

System.Activator.CreateInstance()

Creates an instance of the specified type using the constructor that best matches the specified parameters.

Parameters

NameDescriptionDefault
type The type of object to create.
args An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the parameterless constructor) is invoked.

Returns

A reference to the newly created object.

System.Activator.CreateInstance()

Creates an instance of the specified type using the constructor that best matches the specified parameters.

Parameters

NameDescriptionDefault
type The type of object to create.
args An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the parameterless constructor) is invoked.
activationAttributes An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object that specifies the URL that is required to activate a remote object. This parameter is related to client-activated objects. Client activation is a legacy technology that is retained for backward compatibility but is not recommended for new development. Distributed applications should instead use Windows Communication Foundation.

Returns

A reference to the newly created object.

System.Activator.CreateInstance()

Creates an instance of the specified type using the constructor that best matches the specified parameters.

Parameters

NameDescriptionDefault
type The type of object to create.
bindingAttr A combination of zero or more bit flags that affect the search for the type constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted.
binder An object that uses bindingAttr and args to seek and identify the type constructor. If binder is null, the default binder is used.
args An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the parameterless constructor) is invoked.
culture Culture-specific information that governs the coercion of args to the formal types declared for the type constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used.

Returns

A reference to the newly created object.

System.Activator.CreateInstance()

Creates an instance of the specified type using the constructor that best matches the specified parameters.

Parameters

NameDescriptionDefault
type The type of object to create.
bindingAttr A combination of zero or more bit flags that affect the search for the type constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted.
binder An object that uses bindingAttr and args to seek and identify the type constructor. If binder is null, the default binder is used.
args An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the parameterless constructor) is invoked.
culture Culture-specific information that governs the coercion of args to the formal types declared for the type constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used.
activationAttributes An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object that specifies the URL that is required to activate a remote object. This parameter is related to client-activated objects. Client activation is a legacy technology that is retained for backward compatibility but is not recommended for new development. Distributed applications should instead use Windows Communication Foundation.

Returns

A reference to the newly created object.

System.Activator.CreateInstance``1

Creates an instance of the type designated by the specified generic type parameter, using the parameterless constructor.

Returns

A reference to the newly created object.

System.Activator.CreateInstanceFrom()

Creates an instance of the type whose name is specified, using the named assembly file and parameterless constructor.

Parameters

NameDescriptionDefault
assemblyFile The name of a file that contains an assembly where the type named typeName is sought.
typeName The name of the type to create an instance of.

Returns

A handle that must be unwrapped to access the newly created instance.

System.Activator.CreateInstanceFrom()

Creates an instance of the type whose name is specified, using the named assembly file and the constructor that best matches the specified parameters.

Parameters

NameDescriptionDefault
assemblyFile The name of a file that contains an assembly where the type named typeName is sought.
typeName The name of the type to create an instance of.
ignoreCase true to specify that the search for typeName is not case-sensitive; false to specify that the search is case-sensitive.
bindingAttr A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted.
binder An object that uses bindingAttr and args to seek and identify the typeName constructor. If binder is null, the default binder is used.
args An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the parameterless constructor) is invoked.
culture Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used.
activationAttributes An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object that specifies the URL that is required to activate a remote object. This parameter is related to client-activated objects. Client activation is a legacy technology that is retained for backward compatibility but is not recommended for new development. Distributed applications should instead use Windows Communication Foundation.

Returns

A handle that must be unwrapped to access the newly created instance.

System.Activator.CreateInstanceFrom()

Creates an instance of the type whose name is specified, using the named assembly file and parameterless constructor.

Parameters

NameDescriptionDefault
assemblyFile The name of a file that contains an assembly where the type named typeName is sought.
typeName The name of the type to create an instance of.
activationAttributes An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object that specifies the URL that is required to activate a remote object. This parameter is related to client-activated objects. Client activation is a legacy technology that is retained for backward compatibility but is not recommended for new development. Distributed applications should instead use Windows Communication Foundation.

Returns

A handle that must be unwrapped to access the newly created instance.

System.AggregateException

Represents one or more errors that occur during application execution.

System.AggregateException.#ctor

Initializes a new instance of the System.AggregateException class with a system-supplied message that describes the error.

System.AggregateException.#ctor()

Initializes a new instance of the System.AggregateException class with references to the inner exceptions that are the cause of this exception.

Parameters

NameDescriptionDefault
innerExceptions The exceptions that are the cause of the current exception.

System.AggregateException.#ctor()

Initializes a new instance of the System.AggregateException class with references to the inner exceptions that are the cause of this exception.

Parameters

NameDescriptionDefault
innerExceptions The exceptions that are the cause of the current exception.

System.AggregateException.#ctor()

Initializes a new instance of the System.AggregateException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.AggregateException.#ctor()

Initializes a new instance of the System.AggregateException class with a specified message that describes the error.

Parameters

NameDescriptionDefault
message The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture.

System.AggregateException.#ctor()

Initializes a new instance of the System.AggregateException class with a specified error message and references to the inner exceptions that are the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerExceptions The exceptions that are the cause of the current exception.

System.AggregateException.#ctor()

Initializes a new instance of the System.AggregateException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.AggregateException.#ctor()

Initializes a new instance of the System.AggregateException class with a specified error message and references to the inner exceptions that are the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerExceptions The exceptions that are the cause of the current exception.

System.AggregateException.Flatten

Flattens an System.AggregateException instances into a single, new instance.

Returns

A new, flattened System.AggregateException.

System.AggregateException.GetBaseException

Returns the System.AggregateException that is the root cause of this exception.

Returns

The System.AggregateException that is the root cause of this exception.

System.AggregateException.GetObjectData()

Initializes a new instance of the System.AggregateException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.AggregateException.Handle()

Invokes a handler on each System.Exception contained by this System.AggregateException.

Parameters

NameDescriptionDefault
predicate The predicate to execute for each exception. The predicate accepts as an argument the System.Exception to be processed and returns a Boolean to indicate whether the exception was handled.

System.AggregateException.ToString

Creates and returns a string representation of the current System.AggregateException.

Returns

A string representation of the current exception.

System.AggregateException.InnerExceptions

Gets a read-only collection of the System.Exception instances that caused the current exception.

Returns

A read-only collection of the System.Exception instances that caused the current exception.

System.AggregateException.Message

Gets a message that describes the exception.

Returns

The message that describes the exception.

System.AppContext

Provides members for setting and retrieving data about an application's context.

System.AppContext.GetData()

Returns the value of the named data element assigned to the current application domain.

Parameters

NameDescriptionDefault
name The name of the data element.

Returns

The value of name, if name identifies a named value; otherwise, null.

System.AppContext.SetData()

Sets the value of the named data element assigned to the current application domain.

Parameters

NameDescriptionDefault
name The name of the data element
data The value of name

System.AppContext.SetSwitch()

Sets the value of a switch.

Parameters

NameDescriptionDefault
switchName The name of the switch.
isEnabled The value of the switch.

System.AppContext.TryGetSwitch()

Tries to get the value of a switch.

Parameters

NameDescriptionDefault
switchName The name of the switch.
isEnabled When this method returns, contains the value of switchName if switchName was found, or false if switchName was not found. This parameter is passed uninitialized.

Returns

true if switchName was set and the isEnabled argument contains the value of the switch; otherwise, false.

System.AppContext.BaseDirectory

Gets the file path of the base directory that the assembly resolver uses to probe for assemblies.

Returns

The file path of the base directory that the assembly resolver uses to probe for assemblies.

System.AppContext.TargetFrameworkName

Gets the name of the framework version targeted by the current application.

Returns

The name of the framework version targeted by the current application.

System.AppDomain

Represents an application domain, which is an isolated environment where applications execute. This class cannot be inherited.

System.AppDomain.AssemblyLoad

Occurs when an assembly is loaded.

System.AppDomain.AssemblyResolve

Occurs when the resolution of an assembly fails.

System.AppDomain.DomainUnload

Occurs when an System.AppDomain is about to be unloaded.

System.AppDomain.FirstChanceException

Occurs when an exception is thrown in managed code, before the runtime searches the call stack for an exception handler in the application domain.

System.AppDomain.ProcessExit

Occurs when the default application domain's parent process exits.

System.AppDomain.ReflectionOnlyAssemblyResolve

Occurs when the resolution of an assembly fails in the reflection-only context.

System.AppDomain.ResourceResolve

Occurs when the resolution of a resource fails because the resource is not a valid linked or embedded resource in the assembly.

System.AppDomain.TypeResolve

Occurs when the resolution of a type fails.

System.AppDomain.UnhandledException

Occurs when an exception is not caught.

System.AppDomain.AppendPrivatePath()

Appends the specified directory name to the private path list.

Parameters

NameDescriptionDefault
path The name of the directory to be appended to the private path.

System.AppDomain.ApplyPolicy()

Returns the assembly display name after policy has been applied.

Parameters

NameDescriptionDefault
assemblyName The assembly display name, in the form provided by the System.Reflection.Assembly.FullName property.

Returns

A string containing the assembly display name after policy has been applied.

System.AppDomain.ClearPrivatePath

Resets the path that specifies the location of private assemblies to the empty string ("").

System.AppDomain.ClearShadowCopyPath

Resets the list of directories containing shadow copied assemblies to the empty string ("").

System.AppDomain.CreateDomain()

Creates a new application domain with the specified name.

Parameters

NameDescriptionDefault
friendlyName The friendly name of the domain.

Returns

The newly created application domain.

System.AppDomain.CreateInstance()

Creates a new instance of the specified type defined in the specified assembly.

Parameters

NameDescriptionDefault
assemblyName The display name of the assembly. See System.Reflection.Assembly.FullName.
typeName The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property.

Returns

An object that is a wrapper for the new instance specified by typeName. The return value needs to be unwrapped to access the real object.

System.AppDomain.CreateInstance()

Creates a new instance of the specified type defined in the specified assembly. Parameters specify a binder, binding flags, constructor arguments, culture-specific information used to interpret arguments, and optional activation attributes.

Parameters

NameDescriptionDefault
assemblyName The display name of the assembly. See System.Reflection.Assembly.FullName.
typeName The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property.
ignoreCase A Boolean value specifying whether to perform a case-sensitive search or not.
bindingAttr A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted.
binder An object that enables the binding, coercion of argument types, invocation of members, and retrieval of System.Reflection.MemberInfo objects using reflection. If binder is null, the default binder is used.
args The arguments to pass to the constructor. This array of arguments must match in number, order, and type the parameters of the constructor to invoke. If the parameterless constructor is preferred, args must be an empty array or null.
culture Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used.
activationAttributes An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object that specifies the URL that is required to activate a remote object. This parameter is related to client-activated objects. Client activation is a legacy technology that is retained for backward compatibility but is not recommended for new development. Distributed applications should instead use Windows Communication Foundation.

Returns

An object that is a wrapper for the new instance specified by typeName. The return value needs to be unwrapped to access the real object.

System.AppDomain.CreateInstance()

Creates a new instance of the specified type defined in the specified assembly. A parameter specifies an array of activation attributes.

Parameters

NameDescriptionDefault
assemblyName The display name of the assembly. See System.Reflection.Assembly.FullName.
typeName The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property.
activationAttributes An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object that specifies the URL that is required to activate a remote object. This parameter is related to client-activated objects.Client activation is a legacy technology that is retained for backward compatibility but is not recommended for new development. Distributed applications should instead use Windows Communication Foundation.

Returns

An object that is a wrapper for the new instance specified by typeName. The return value needs to be unwrapped to access the real object.

System.AppDomain.CreateInstanceAndUnwrap()

Creates a new instance of the specified type. Parameters specify the assembly where the type is defined, and the name of the type.

Parameters

NameDescriptionDefault
assemblyName The display name of the assembly. See System.Reflection.Assembly.FullName.
typeName The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property.

Returns

An instance of the object specified by typeName.

System.AppDomain.CreateInstanceAndUnwrap()

Creates a new instance of the specified type defined in the specified assembly, specifying whether the case of the type name is ignored; the binding attributes and the binder that are used to select the type to be created; the arguments of the constructor; the culture; and the activation attributes.

Parameters

NameDescriptionDefault
assemblyName The display name of the assembly. See System.Reflection.Assembly.FullName.
typeName The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property.
ignoreCase A Boolean value specifying whether to perform a case-sensitive search or not.
bindingAttr A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted.
binder An object that enables the binding, coercion of argument types, invocation of members, and retrieval of System.Reflection.MemberInfo objects using reflection. If binder is null, the default binder is used.
args The arguments to pass to the constructor. This array of arguments must match in number, order, and type the parameters of the constructor to invoke. If the parameterless constructor is preferred, args must be an empty array or null.
culture A culture-specific object used to govern the coercion of types. If culture is null, the CultureInfo for the current thread is used.
activationAttributes An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. that specifies the URL that is required to activate a remote object. This parameter is related to client-activated objects. Client activation is a legacy technology that is retained for backward compatibility but is not recommended for new development. Distributed applications should instead use Windows Communication Foundation.

Returns

An instance of the object specified by typeName.

System.AppDomain.CreateInstanceAndUnwrap()

Creates a new instance of the specified type. Parameters specify the assembly where the type is defined, the name of the type, and an array of activation attributes.

Parameters

NameDescriptionDefault
assemblyName The display name of the assembly. See System.Reflection.Assembly.FullName.
typeName The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property.
activationAttributes An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object that specifies the URL that is required to activate a remote object. This parameter is related to client-activated objects.Client activation is a legacy technology that is retained for backward compatibility but is not recommended for new development. Distributed applications should instead use Windows Communication Foundation.

Returns

An instance of the object specified by typeName.

System.AppDomain.CreateInstanceFrom()

Creates a new instance of the specified type defined in the specified assembly file.

Parameters

NameDescriptionDefault
assemblyFile The name, including the path, of a file that contains an assembly that defines the requested type. The assembly is loaded using the System.Reflection.Assembly.LoadFrom() method.
typeName The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property.

Returns

An object that is a wrapper for the new instance, or null if typeName is not found. The return value needs to be unwrapped to access the real object.

System.AppDomain.CreateInstanceFrom()

Creates a new instance of the specified type defined in the specified assembly file.

Parameters

NameDescriptionDefault
assemblyFile The name, including the path, of a file that contains an assembly that defines the requested type. The assembly is loaded using the System.Reflection.Assembly.LoadFrom() method.
typeName The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property.
ignoreCase A Boolean value specifying whether to perform a case-sensitive search or not.
bindingAttr A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted.
binder An object that enables the binding, coercion of argument types, invocation of members, and retrieval of System.Reflection.MemberInfo objects through reflection. If binder is null, the default binder is used.
args The arguments to pass to the constructor. This array of arguments must match in number, order, and type the parameters of the constructor to invoke. If the parameterless constructor is preferred, args must be an empty array or null.
culture Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used.
activationAttributes An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object that specifies the URL that is required to activate a remote object. This parameter is related to client-activated objects. Client activation is a legacy technology that is retained for backward compatibility but is not recommended for new development. Distributed applications should instead use Windows Communication Foundation.

Returns

An object that is a wrapper for the new instance, or null if typeName is not found. The return value needs to be unwrapped to access the real object.

System.AppDomain.CreateInstanceFrom()

Creates a new instance of the specified type defined in the specified assembly file.

Parameters

NameDescriptionDefault
assemblyFile The name, including the path, of a file that contains an assembly that defines the requested type. The assembly is loaded using the System.Reflection.Assembly.LoadFrom() method.
typeName The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property.
activationAttributes An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object that specifies the URL that is required to activate a remote object. This parameter is related to client-activated objects.Client activation is a legacy technology that is retained for backward compatibility but is not recommended for new development. Distributed applications should instead use Windows Communication Foundation.

Returns

An object that is a wrapper for the new instance, or null if typeName is not found. The return value needs to be unwrapped to access the real object.

System.AppDomain.CreateInstanceFromAndUnwrap()

Creates a new instance of the specified type defined in the specified assembly file.

Parameters

NameDescriptionDefault
assemblyFile
typeName The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property.

Returns

The requested object, or null if typeName is not found.

System.AppDomain.CreateInstanceFromAndUnwrap()

Creates a new instance of the specified type defined in the specified assembly file, specifying whether the case of the type name is ignored; the binding attributes and the binder that are used to select the type to be created; the arguments of the constructor; the culture; and the activation attributes.

Parameters

NameDescriptionDefault
assemblyFile The file name and path of the assembly that defines the requested type.
typeName The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property.
ignoreCase A Boolean value specifying whether to perform a case-sensitive search or not.
bindingAttr A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted.
binder An object that enables the binding, coercion of argument types, invocation of members, and retrieval of System.Reflection.MemberInfo objects through reflection. If binder is null, the default binder is used.
args The arguments to pass to the constructor. This array of arguments must match in number, order, and type the parameters of the constructor to invoke. If the parameterless constructor is preferred, args must be an empty array or null.
culture Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used.
activationAttributes An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object that specifies the URL that is required to activate a remote object. This parameter is related to client-activated objects. Client activation is a legacy technology that is retained for backward compatibility but is not recommended for new development. Distributed applications should instead use Windows Communication Foundation.

Returns

The requested object, or null if typeName is not found.

System.AppDomain.CreateInstanceFromAndUnwrap()

Creates a new instance of the specified type defined in the specified assembly file.

Parameters

NameDescriptionDefault
assemblyFile
typeName The fully qualified name of the requested type, including the namespace but not the assembly (see the System.Type.FullName property).
activationAttributes An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object that specifies the URL that is required to activate a remote object. This parameter is related to client-activated objects.Client activation is a legacy technology that is retained for backward compatibility but is not recommended for new development. Distributed applications should instead use Windows Communication Foundation.

Returns

The requested object, or null if typeName is not found.

System.AppDomain.ExecuteAssembly()

Executes the assembly contained in the specified file.

Parameters

NameDescriptionDefault
assemblyFile The name of the file that contains the assembly to execute.

Returns

The value returned by the entry point of the assembly.

System.AppDomain.ExecuteAssembly()

Executes the assembly contained in the specified file, using the specified arguments.

Parameters

NameDescriptionDefault
assemblyFile The name of the file that contains the assembly to execute.
args The arguments to the entry point of the assembly.

Returns

The value that is returned by the entry point of the assembly.

System.AppDomain.ExecuteAssembly()

Executes the assembly contained in the specified file, using the specified arguments, hash value, and hash algorithm.

Parameters

NameDescriptionDefault
assemblyFile The name of the file that contains the assembly to execute.
args The arguments to the entry point of the assembly.
hashValue Represents the value of the computed hash code.
hashAlgorithm Represents the hash algorithm used by the assembly manifest.

Returns

The value that is returned by the entry point of the assembly.

System.AppDomain.ExecuteAssemblyByName()

Executes the assembly given an System.Reflection.AssemblyName, using the specified arguments.

Parameters

NameDescriptionDefault
assemblyName An System.Reflection.AssemblyName object representing the name of the assembly.
args Command-line arguments to pass when starting the process.

Returns

The value that is returned by the entry point of the assembly.

System.AppDomain.ExecuteAssemblyByName()

Executes an assembly given its display name.

Parameters

NameDescriptionDefault
assemblyName The display name of the assembly. See System.Reflection.Assembly.FullName.

Returns

The value returned by the entry point of the assembly.

System.AppDomain.ExecuteAssemblyByName()

Executes the assembly given its display name, using the specified arguments.

Parameters

NameDescriptionDefault
assemblyName The display name of the assembly. See System.Reflection.Assembly.FullName.
args Command-line arguments to pass when starting the process.

Returns

The value that is returned by the entry point of the assembly.

System.AppDomain.GetAssemblies

Gets the assemblies that have been loaded into the execution context of this application domain.

Returns

An array of assemblies in this application domain.

System.AppDomain.GetCurrentThreadId

Gets the current thread identifier.

Returns

A 32-bit signed integer that is the identifier of the current thread.

System.AppDomain.GetData()

Gets the value stored in the current application domain for the specified name.

Parameters

NameDescriptionDefault
name The name of a predefined application domain property, or the name of an application domain property you have defined.

Returns

The value of the name property, or null if the property does not exist.

System.AppDomain.IsCompatibilitySwitchSet()

Gets a nullable Boolean value that indicates whether any compatibility switches are set, and if so, whether the specified compatibility switch is set.

Parameters

NameDescriptionDefault
value The compatibility switch to test.

Returns

A null reference (Nothing in Visual Basic) if no compatibility switches are set; otherwise, a Boolean value that indicates whether the compatibility switch that is specified by value is set.

System.AppDomain.IsDefaultAppDomain

Returns a value that indicates whether the application domain is the default application domain for the process.

Returns

true if the current System.AppDomain object represents the default application domain for the process; otherwise, false.

System.AppDomain.IsFinalizingForUnload

Indicates whether this application domain is unloading, and the objects it contains are being finalized by the common language runtime.

Returns

true if this application domain is unloading and the common language runtime has started invoking finalizers; otherwise, false.

System.AppDomain.Load()

Loads the System.Reflection.Assembly with a common object file format (COFF) based image containing an emitted System.Reflection.Assembly.

Parameters

NameDescriptionDefault
rawAssembly An array of type byte that is a COFF-based image containing an emitted assembly.

Returns

The loaded assembly.

System.AppDomain.Load()

Loads the System.Reflection.Assembly with a common object file format (COFF) based image containing an emitted System.Reflection.Assembly. The raw bytes representing the symbols for the System.Reflection.Assembly are also loaded.

Parameters

NameDescriptionDefault
rawAssembly An array of type byte that is a COFF-based image containing an emitted assembly.
rawSymbolStore An array of type byte containing the raw bytes representing the symbols for the assembly.

Returns

The loaded assembly.

System.AppDomain.Load()

Parameters

NameDescriptionDefault
assemblyRef An object that describes the assembly to load.

Returns

The loaded assembly.

System.AppDomain.Load()

Loads an System.Reflection.Assembly given its display name.

Parameters

NameDescriptionDefault
assemblyString The display name of the assembly. See System.Reflection.Assembly.FullName.

Returns

The loaded assembly.

System.AppDomain.ReflectionOnlyGetAssemblies

Returns the assemblies that have been loaded into the reflection-only context of the application domain.

Returns

An array of System.Reflection.Assembly objects that represent the assemblies loaded into the reflection-only context of the application domain.

System.AppDomain.SetCachePath()

Establishes the specified directory path as the location where assemblies are shadow copied.

Parameters

NameDescriptionDefault
path The fully qualified path to the shadow copy location.

System.AppDomain.SetData()

Assigns the specified value to the specified application domain property.

Parameters

NameDescriptionDefault
name The name of a user-defined application domain property to create or change.
data The value of the property.

System.AppDomain.SetDynamicBase()

Establishes the specified directory path as the base directory for subdirectories where dynamically generated files are stored and accessed.

Parameters

NameDescriptionDefault
path The fully qualified path that is the base directory for subdirectories where dynamic assemblies are stored.

System.AppDomain.SetPrincipalPolicy()

Specifies how principal and identity objects should be attached to a thread if the thread attempts to bind to a principal while executing in this application domain.

Parameters

NameDescriptionDefault
policy One of the System.Security.Principal.PrincipalPolicy values that specifies the type of the principal object to attach to threads.

System.AppDomain.SetShadowCopyFiles

Turns on shadow copying.

System.AppDomain.SetShadowCopyPath()

Establishes the specified directory path as the location of assemblies to be shadow copied.

Parameters

NameDescriptionDefault
path A list of directory names, where each name is separated by a semicolon.

System.AppDomain.SetThreadPrincipal()

Sets the default principal object to be attached to threads if they attempt to bind to a principal while executing in this application domain.

Parameters

NameDescriptionDefault
principal The principal object to attach to threads.

System.AppDomain.ToString

Obtains a string representation that includes the friendly name of the application domain and any context policies.

Returns

A string formed by concatenating the literal string "Name:", the friendly name of the application domain, and either string representations of the context policies or the string "There are no context policies."

System.AppDomain.Unload()

Unloads the specified application domain.

Parameters

NameDescriptionDefault
domain An application domain to unload.

System.AppDomain.BaseDirectory

Gets the base directory that the assembly resolver uses to probe for assemblies.

Returns

The base directory that the assembly resolver uses to probe for assemblies.

System.AppDomain.CurrentDomain

Gets the current application domain for the current System.Threading.Thread.

Returns

The current application domain.

System.AppDomain.DynamicDirectory

Gets the directory that the assembly resolver uses to probe for dynamically created assemblies.

Returns

The directory that the assembly resolver uses to probe for dynamically created assemblies.

System.AppDomain.FriendlyName

Gets the friendly name of this application domain.

Returns

The friendly name of this application domain.

System.AppDomain.Id

Gets an integer that uniquely identifies the application domain within the process.

Returns

An integer that identifies the application domain.

System.AppDomain.IsFullyTrusted

Gets a value that indicates whether assemblies that are loaded into the current application domain execute with full trust.

Returns

true if assemblies that are loaded into the current application domain execute with full trust; otherwise, false.

System.AppDomain.IsHomogenous

Gets a value that indicates whether the current application domain has a set of permissions that is granted to all assemblies that are loaded into the application domain.

Returns

true if the current application domain has a homogenous set of permissions; otherwise, false.

System.AppDomain.MonitoringIsEnabled

Gets or sets a value that indicates whether CPU and memory monitoring of application domains is enabled for the current process. Once monitoring is enabled for a process, it cannot be disabled.

Returns

true if monitoring is enabled; otherwise false.

System.AppDomain.MonitoringSurvivedMemorySize

Gets the number of bytes that survived the last collection and that are known to be referenced by the current application domain.

Returns

The number of surviving bytes.

System.AppDomain.MonitoringSurvivedProcessMemorySize

Gets the total bytes that survived from the last collection for all application domains in the process.

Returns

The total number of surviving bytes for the process.

System.AppDomain.MonitoringTotalAllocatedMemorySize

Gets the total size, in bytes, of all memory allocations that have been made by the application domain since it was created, without subtracting memory that has been collected.

Returns

The total size of all memory allocations.

System.AppDomain.MonitoringTotalProcessorTime

Gets the total processor time that has been used by all threads while executing in the current application domain, since the process started.

Returns

Total processor time for the current application domain.

System.AppDomain.PermissionSet

Gets the permission set of a sandboxed application domain.

Returns

The permission set of the sandboxed application domain.

System.AppDomain.RelativeSearchPath

Gets the path under the base directory where the assembly resolver should probe for private assemblies.

Returns

The path under the base directory where the assembly resolver should probe for private assemblies.

System.AppDomain.SetupInformation

Gets the application domain configuration information for this instance.

Returns

The application domain initialization information.

System.AppDomain.ShadowCopyFiles

Gets an indication whether the application domain is configured to shadow copy files.

Returns

true if the application domain is configured to shadow copy files; otherwise, false.

System.AppDomainSetup

Represents assembly binding information that can be added to an instance of System.AppDomain.

System.AppDomainSetup.ApplicationBase

Gets the name of the directory containing the application.

Returns

The name of the application base directory.

System.AppDomainSetup.TargetFrameworkName

Gets (or, in .NET Framework, sets) a string that specifies the target framework in a format that can be parsed by the System.Runtime.Versioning.FrameworkName.#ctor() constructor.

Returns

The target framework of the executable that started the process.

System.AppDomainUnloadedException

The exception that is thrown when an attempt is made to access an unloaded application domain.

System.AppDomainUnloadedException.#ctor

Initializes a new instance of the System.AppDomainUnloadedException class.

System.AppDomainUnloadedException.#ctor()

Initializes a new instance of the System.AppDomainUnloadedException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.AppDomainUnloadedException.#ctor()

Initializes a new instance of the System.AppDomainUnloadedException class with a specified error message.

Parameters

NameDescriptionDefault
message The message that describes the error.

System.AppDomainUnloadedException.#ctor()

Initializes a new instance of the System.AppDomainUnloadedException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The message that describes the error.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.

System.ApplicationException

Serves as the base class for application-defined exceptions.

System.ApplicationException.#ctor

Initializes a new instance of the System.ApplicationException class.

System.ApplicationException.#ctor()

Initializes a new instance of the System.ApplicationException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.ApplicationException.#ctor()

Initializes a new instance of the System.ApplicationException class with a specified error message.

Parameters

NameDescriptionDefault
message A message that describes the error.

System.ApplicationException.#ctor()

Initializes a new instance of the System.ApplicationException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.

System.ApplicationId

Contains information used to uniquely identify a manifest-based application. This class cannot be inherited.

System.ApplicationId.#ctor()

Initializes a new instance of the System.ApplicationId class.

Parameters

NameDescriptionDefault
publicKeyToken The array of bytes representing the raw public key data.
name The name of the application.
version A System.Version object that specifies the version of the application.
processorArchitecture The processor architecture of the application.
culture The culture of the application.

System.ApplicationId.Copy

Creates and returns an identical copy of the current application identity.

Returns

An System.ApplicationId object that represents an exact copy of the original.

System.ApplicationId.Equals()

Determines whether the specified System.ApplicationId object is equivalent to the current System.ApplicationId.

Parameters

NameDescriptionDefault
o The System.ApplicationId object to compare to the current System.ApplicationId.

Returns

true if the specified System.ApplicationId object is equivalent to the current System.ApplicationId; otherwise, false.

System.ApplicationId.GetHashCode

Gets the hash code for the current application identity.

Returns

The hash code for the current application identity.

System.ApplicationId.ToString

Creates and returns a string representation of the application identity.

Returns

A string representation of the application identity.

System.ApplicationId.Culture

Gets a string representing the culture information for the application.

Returns

The culture information for the application.

System.ApplicationId.Name

Gets the name of the application.

Returns

The name of the application.

System.ApplicationId.ProcessorArchitecture

Gets the target processor architecture for the application.

Returns

The processor architecture of the application.

System.ApplicationId.PublicKeyToken

Gets the public key token for the application.

Returns

A byte array containing the public key token for the application.

System.ApplicationId.Version

Gets the version of the application.

Returns

A System.Version that specifies the version of the application.

System.ArgIterator

Represents a variable-length argument list; that is, the parameters of a function that takes a variable number of arguments.

System.ArgIterator.#ctor()

Initializes a new instance of the System.ArgIterator structure using the specified argument list.

Parameters

NameDescriptionDefault
arglist An argument list consisting of mandatory and optional arguments.

System.ArgIterator.#ctor()

Initializes a new instance of the System.ArgIterator structure using the specified argument list and a pointer to an item in the list.

Parameters

NameDescriptionDefault
arglist An argument list consisting of mandatory and optional arguments.
ptr A pointer to the argument in arglist to access first, or the first mandatory argument in arglist if ptr is null.

System.ArgIterator.End

Concludes processing of the variable-length argument list represented by this instance.

System.ArgIterator.Equals()

This method is not supported, and always throws System.NotSupportedException.

Parameters

NameDescriptionDefault
o An object to be compared to this instance.

Returns

This comparison is not supported. No value is returned.

System.ArgIterator.GetHashCode

Returns the hash code of this object.

Returns

A 32-bit signed integer hash code.

System.ArgIterator.GetNextArg

Returns the next argument in a variable-length argument list.

Returns

The next argument as a System.TypedReference object.

System.ArgIterator.GetNextArg()

Returns the next argument in a variable-length argument list that has a specified type.

Parameters

NameDescriptionDefault
rth A runtime type handle that identifies the type of the argument to retrieve.

Returns

The next argument as a System.TypedReference object.

System.ArgIterator.GetNextArgType

Returns the type of the next argument.

Returns

The type of the next argument.

System.ArgIterator.GetRemainingCount

Returns the number of arguments remaining in the argument list.

Returns

The number of remaining arguments.

System.ArgumentException

The exception that is thrown when one of the arguments provided to a method is not valid.

System.ArgumentException.#ctor

Initializes a new instance of the System.ArgumentException class.

System.ArgumentException.#ctor()

Initializes a new instance of the System.ArgumentException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.ArgumentException.#ctor()

Initializes a new instance of the System.ArgumentException class with a specified error message.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.

System.ArgumentException.#ctor()

Initializes a new instance of the System.ArgumentException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.

System.ArgumentException.#ctor()

Initializes a new instance of the System.ArgumentException class with a specified error message and the name of the parameter that causes this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
paramName The name of the parameter that caused the current exception.

System.ArgumentException.#ctor()

Initializes a new instance of the System.ArgumentException class with a specified error message, the parameter name, and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
paramName The name of the parameter that caused the current exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.

System.ArgumentException.GetObjectData()

Sets the System.Runtime.Serialization.SerializationInfo object with the parameter name and additional exception information.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.ArgumentException.ThrowIfNullOrEmpty()

Throws an exception if argument is null or empty.

Parameters

NameDescriptionDefault
argument The string argument to validate as non-null and non-empty.
paramName The name of the parameter with which argument corresponds.

System.ArgumentException.ThrowIfNullOrWhiteSpace()

Throws an exception if argument is null, empty, or consists only of white-space characters.

Parameters

NameDescriptionDefault
argument The string argument to validate.
paramName The name of the parameter with which argument corresponds.

System.ArgumentException.Message

Gets the error message and the parameter name, or only the error message if no parameter name is set.

Returns

A text string describing the details of the exception. The value of this property takes one of two forms: Condition Value The paramName is a null reference (Nothing in Visual Basic) or of zero length. The message string passed to the constructor. The paramName is not null reference (Nothing in Visual Basic) and it has a length greater than zero. The message string appended with the name of the invalid parameter.

System.ArgumentException.ParamName

Gets the name of the parameter that causes this exception.

Returns

The parameter name.

System.ArgumentNullException

The exception that is thrown when a null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

System.ArgumentNullException.#ctor

Initializes a new instance of the System.ArgumentNullException class.

System.ArgumentNullException.#ctor()

Initializes a new instance of the System.ArgumentNullException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context An object that describes the source or destination of the serialized data.

System.ArgumentNullException.#ctor()

Initializes a new instance of the System.ArgumentNullException class with the name of the parameter that causes this exception.

Parameters

NameDescriptionDefault
paramName The name of the parameter that caused the exception.

System.ArgumentNullException.#ctor()

Initializes a new instance of the System.ArgumentNullException class with a specified error message and the exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for this exception.
innerException The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.

System.ArgumentNullException.#ctor()

Initializes an instance of the System.ArgumentNullException class with a specified error message and the name of the parameter that causes this exception.

Parameters

NameDescriptionDefault
paramName The name of the parameter that caused the exception.
message A message that describes the error.

System.ArgumentNullException.ThrowIfNull()

Throws an System.ArgumentNullException if argument is null.

Parameters

NameDescriptionDefault
argument The reference type argument to validate as non-null.
paramName The name of the parameter with which argument corresponds. If you omit this parameter, the name of argument is used.

System.ArgumentNullException.ThrowIfNull()

Throws an System.ArgumentNullException if argument is null.

Parameters

NameDescriptionDefault
argument The pointer argument to validate as non-null.
paramName The name of the parameter with which argument corresponds.

System.ArgumentOutOfRangeException

The exception that is thrown when the value of an argument is outside the allowable range of values as defined by the invoked method.

System.ArgumentOutOfRangeException.#ctor

Initializes a new instance of the System.ArgumentOutOfRangeException class.

System.ArgumentOutOfRangeException.#ctor()

Initializes a new instance of the System.ArgumentOutOfRangeException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context An object that describes the source or destination of the serialized data.

System.ArgumentOutOfRangeException.#ctor()

Initializes a new instance of the System.ArgumentOutOfRangeException class with the name of the parameter that causes this exception.

Parameters

NameDescriptionDefault
paramName The name of the parameter that causes this exception.

System.ArgumentOutOfRangeException.#ctor()

Initializes a new instance of the System.ArgumentOutOfRangeException class with a specified error message and the exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for this exception.
innerException The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.

System.ArgumentOutOfRangeException.#ctor()

Initializes a new instance of the System.ArgumentOutOfRangeException class with the parameter name, the value of the argument, and a specified error message.

Parameters

NameDescriptionDefault
paramName The name of the parameter that caused the exception.
actualValue The value of the argument that causes this exception.
message The message that describes the error.

System.ArgumentOutOfRangeException.#ctor()

Initializes a new instance of the System.ArgumentOutOfRangeException class with the name of the parameter that causes this exception and a specified error message.

Parameters

NameDescriptionDefault
paramName The name of the parameter that caused the exception.
message The message that describes the error.

System.ArgumentOutOfRangeException.GetObjectData()

Sets the System.Runtime.Serialization.SerializationInfo object with the invalid argument value and additional exception information.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context An object that describes the source or destination of the serialized data.

System.ArgumentOutOfRangeException.ThrowIfEqual``1()

Throws an System.ArgumentOutOfRangeException if value is equal to other.

Parameters

NameDescriptionDefault
value The argument to validate as not equal to other.
other The value to compare with value.
paramName The name of the parameter with which value corresponds.

System.ArgumentOutOfRangeException.ThrowIfGreaterThan``1()

Throws an System.ArgumentOutOfRangeException if value is greater than other.

Parameters

NameDescriptionDefault
value The argument to validate as less than or equal to other.
other The value to compare with value.
paramName The name of the parameter with which value corresponds.

System.ArgumentOutOfRangeException.ThrowIfGreaterThanOrEqual``1()

Throws an System.ArgumentOutOfRangeException if value is greater than or equal to other.

Parameters

NameDescriptionDefault
value The argument to validate as less than other.
other The value to compare with value.
paramName The name of the parameter with which value corresponds.

System.ArgumentOutOfRangeException.ThrowIfLessThan``1()

Throws an System.ArgumentOutOfRangeException if value is less than other.

Parameters

NameDescriptionDefault
value The argument to validate as greater than or equal to other.
other The value to compare with value.
paramName The name of the parameter with which value corresponds.

System.ArgumentOutOfRangeException.ThrowIfLessThanOrEqual``1()

Throws an System.ArgumentOutOfRangeException if value is less than or equal to other.

Parameters

NameDescriptionDefault
value The argument to validate as greater than other.
other The value to compare with value.
paramName The name of the parameter with which value corresponds.

System.ArgumentOutOfRangeException.ThrowIfNegative``1()

Throws an System.ArgumentOutOfRangeException if value is negative.

Parameters

NameDescriptionDefault
value The argument to validate as non-negative.
paramName The name of the parameter with which value corresponds.

System.ArgumentOutOfRangeException.ThrowIfNegativeOrZero``1()

Throws an System.ArgumentOutOfRangeException if value is negative or zero.

Parameters

NameDescriptionDefault
value The argument to validate as non-zero or non-negative.
paramName The name of the parameter with which value corresponds.

System.ArgumentOutOfRangeException.ThrowIfNotEqual``1()

Throws an System.ArgumentOutOfRangeException if value is not equal to other.

Parameters

NameDescriptionDefault
value The argument to validate as equal to other.
other The value to compare with value.
paramName The name of the parameter with which value corresponds.

System.ArgumentOutOfRangeException.ThrowIfZero``1()

Throws an System.ArgumentOutOfRangeException if value is zero.

Parameters

NameDescriptionDefault
value The argument to validate as non-zero.
paramName The name of the parameter with which value corresponds.

System.ArgumentOutOfRangeException.ActualValue

Gets the argument value that causes this exception.

Returns

The value of the parameter that caused the current System.Exception.

System.ArgumentOutOfRangeException.Message

Gets the error message and the string representation of the invalid argument value, or only the error message if the argument value is null.

Returns

The text message for this exception. The value of this property takes one of two forms, as follows. Condition Value The actualValue is null. The message string passed to the constructor. The actualValue is not null. The message string appended with the string representation of the invalid argument value.

System.ArithmeticException

The exception that is thrown for errors in an arithmetic, casting, or conversion operation.

System.ArithmeticException.#ctor

Initializes a new instance of the System.ArithmeticException class.

System.ArithmeticException.#ctor()

Initializes a new instance of the System.ArithmeticException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.ArithmeticException.#ctor()

Initializes a new instance of the System.ArithmeticException class with a specified error message.

Parameters

NameDescriptionDefault
message A System.String that describes the error.

System.ArithmeticException.#ctor()

Initializes a new instance of the System.ArithmeticException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.

System.Array

Provides methods for creating, manipulating, searching, and sorting arrays, thereby serving as the base class for all arrays in the common language runtime.

System.Array.AsReadOnly``1()

Returns a read-only wrapper for the specified array.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based array to wrap in a read-only System.Collections.ObjectModel.ReadOnlyCollection`1 wrapper.

Returns

A read-only System.Collections.ObjectModel.ReadOnlyCollection`1 wrapper for the specified array.

System.Array.BinarySearch()

Searches a range of elements in a one-dimensional sorted array for a value, using the System.IComparable interface implemented by each element of the array and by the specified value.

Parameters

NameDescriptionDefault
array The sorted one-dimensional System.Array to search.
index The starting index of the range to search.
length The length of the range to search.
value The object to search for.

Returns

The index of the specified value in the specified array, if value is found; otherwise, a negative number. If value is not found and value is less than one or more elements in array, the negative number returned is the bitwise complement of the index of the first element that is larger than value. If value is not found and value is greater than all elements in array, the negative number returned is the bitwise complement of (the index of the last element plus 1). If this method is called with a non-sorted array, the return value can be incorrect and a negative number could be returned, even if value is present in array.

System.Array.BinarySearch()

Searches a range of elements in a one-dimensional sorted array for a value, using the specified System.Collections.IComparer interface.

Parameters

NameDescriptionDefault
array The sorted one-dimensional System.Array to search.
index The starting index of the range to search.
length The length of the range to search.
value The object to search for.
comparer The System.Collections.IComparer implementation to use when comparing elements. -or- null to use the System.IComparable implementation of each element.

Returns

The index of the specified value in the specified array, if value is found; otherwise, a negative number. If value is not found and value is less than one or more elements in array, the negative number returned is the bitwise complement of the index of the first element that is larger than value. If value is not found and value is greater than all elements in array, the negative number returned is the bitwise complement of (the index of the last element plus 1). If this method is called with a non-sorted array, the return value can be incorrect and a negative number could be returned, even if value is present in array.

System.Array.BinarySearch()

Searches an entire one-dimensional sorted array for a specific element, using the System.IComparable interface implemented by each element of the array and by the specified object.

Parameters

NameDescriptionDefault
array The sorted one-dimensional System.Array to search.
value The object to search for.

Returns

The index of the specified value in the specified array, if value is found; otherwise, a negative number. If value is not found and value is less than one or more elements in array, the negative number returned is the bitwise complement of the index of the first element that is larger than value. If value is not found and value is greater than all elements in array, the negative number returned is the bitwise complement of (the index of the last element plus 1). If this method is called with a non-sorted array, the return value can be incorrect and a negative number could be returned, even if value is present in array.

System.Array.BinarySearch()

Searches an entire one-dimensional sorted array for a value using the specified System.Collections.IComparer interface.

Parameters

NameDescriptionDefault
array The sorted one-dimensional System.Array to search.
value The object to search for.
comparer The System.Collections.IComparer implementation to use when comparing elements. -or- null to use the System.IComparable implementation of each element.

Returns

The index of the specified value in the specified array, if value is found; otherwise, a negative number. If value is not found and value is less than one or more elements in array, the negative number returned is the bitwise complement of the index of the first element that is larger than value. If value is not found and value is greater than all elements in array, the negative number returned is the bitwise complement of (the index of the last element plus 1). If this method is called with a non-sorted array, the return value can be incorrect and a negative number could be returned, even if value is present in array.

System.Array.BinarySearch``1()

Searches an entire one-dimensional sorted array for a specific element, using the System.IComparable`1 generic interface implemented by each element of the System.Array and by the specified object.

Parameters

NameDescriptionDefault
array The sorted one-dimensional, zero-based System.Array to search.
value The object to search for.

Returns

The index of the specified value in the specified array, if value is found; otherwise, a negative number. If value is not found and value is less than one or more elements in array, the negative number returned is the bitwise complement of the index of the first element that is larger than value. If value is not found and value is greater than all elements in array, the negative number returned is the bitwise complement of (the index of the last element plus 1). If this method is called with a non-sorted array, the return value can be incorrect and a negative number could be returned, even if value is present in array.

System.Array.BinarySearch``1()

Searches an entire one-dimensional sorted array for a value using the specified System.Collections.Generic.IComparer`1 generic interface.

Parameters

NameDescriptionDefault
array The sorted one-dimensional, zero-based System.Array to search.
value The object to search for.
comparer The System.Collections.Generic.IComparer`1 implementation to use when comparing elements. -or- null to use the System.IComparable`1 implementation of each element.

Returns

The index of the specified value in the specified array, if value is found; otherwise, a negative number. If value is not found and value is less than one or more elements in array, the negative number returned is the bitwise complement of the index of the first element that is larger than value. If value is not found and value is greater than all elements in array, the negative number returned is the bitwise complement of (the index of the last element plus 1). If this method is called with a non-sorted array, the return value can be incorrect and a negative number could be returned, even if value is present in array.

System.Array.BinarySearch``1()

Searches a range of elements in a one-dimensional sorted array for a value, using the System.IComparable`1 generic interface implemented by each element of the System.Array and by the specified value.

Parameters

NameDescriptionDefault
array The sorted one-dimensional, zero-based System.Array to search.
index The starting index of the range to search.
length The length of the range to search.
value The object to search for.

Returns

The index of the specified value in the specified array, if value is found; otherwise, a negative number. If value is not found and value is less than one or more elements in array, the negative number returned is the bitwise complement of the index of the first element that is larger than value. If value is not found and value is greater than all elements in array, the negative number returned is the bitwise complement of (the index of the last element plus 1). If this method is called with a non-sorted array, the return value can be incorrect and a negative number could be returned, even if value is present in array.

System.Array.BinarySearch``1()

Searches a range of elements in a one-dimensional sorted array for a value, using the specified System.Collections.Generic.IComparer`1 generic interface.

Parameters

NameDescriptionDefault
array The sorted one-dimensional, zero-based System.Array to search.
index The starting index of the range to search.
length The length of the range to search.
value The object to search for.
comparer The System.Collections.Generic.IComparer`1 implementation to use when comparing elements. -or- null to use the System.IComparable`1 implementation of each element.

Returns

The index of the specified value in the specified array, if value is found; otherwise, a negative number. If value is not found and value is less than one or more elements in array, the negative number returned is the bitwise complement of the index of the first element that is larger than value. If value is not found and value is greater than all elements in array, the negative number returned is the bitwise complement of (the index of the last element plus 1). If this method is called with a non-sorted array, the return value can be incorrect and a negative number could be returned, even if value is present in array.

System.Array.Clear()

Clears the contents of an array.

Parameters

NameDescriptionDefault
array The array to clear.

System.Array.Clear()

Sets a range of elements in an array to the default value of each element type.

Parameters

NameDescriptionDefault
array The array whose elements need to be cleared.
index The starting index of the range of elements to clear.
length The number of elements to clear.

System.Array.Clone

Creates a shallow copy of the System.Array.

Returns

A shallow copy of the System.Array.

System.Array.ConstrainedCopy()

Copies a range of elements from an System.Array starting at the specified source index and pastes them to another System.Array starting at the specified destination index. Guarantees that all changes are undone if the copy does not succeed completely.

Parameters

NameDescriptionDefault
sourceArray The System.Array that contains the data to copy.
sourceIndex A 32-bit integer that represents the index in the sourceArray at which copying begins.
destinationArray The System.Array that receives the data.
destinationIndex A 32-bit integer that represents the index in the destinationArray at which storing begins.
length A 32-bit integer that represents the number of elements to copy.

System.Array.ConvertAll``2()

Converts an array of one type to an array of another type.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to convert to a target type.
converter A System.Converter`2 that converts each element from one type to another type.

Returns

An array of the target type containing the converted elements from the source array.

System.Array.Copy()

Copies a range of elements from an System.Array starting at the first element and pastes them into another System.Array starting at the first element. The length is specified as a 32-bit integer.

Parameters

NameDescriptionDefault
sourceArray The System.Array that contains the data to copy.
destinationArray The System.Array that receives the data.
length A 32-bit integer that represents the number of elements to copy.

System.Array.Copy()

Copies a range of elements from an System.Array starting at the first element and pastes them into another System.Array starting at the first element. The length is specified as a 64-bit integer.

Parameters

NameDescriptionDefault
sourceArray The System.Array that contains the data to copy.
destinationArray The System.Array that receives the data.
length A 64-bit integer that represents the number of elements to copy. The integer must be between zero and Int32.MaxValue, inclusive.

System.Array.Copy()

Copies a range of elements from an System.Array starting at the specified source index and pastes them to another System.Array starting at the specified destination index. The length and the indexes are specified as 32-bit integers.

Parameters

NameDescriptionDefault
sourceArray The System.Array that contains the data to copy.
sourceIndex A 32-bit integer that represents the index in the sourceArray at which copying begins.
destinationArray The System.Array that receives the data.
destinationIndex A 32-bit integer that represents the index in the destinationArray at which storing begins.
length A 32-bit integer that represents the number of elements to copy.

System.Array.Copy()

Copies a range of elements from an System.Array starting at the specified source index and pastes them to another System.Array starting at the specified destination index. The length and the indexes are specified as 64-bit integers.

Parameters

NameDescriptionDefault
sourceArray The System.Array that contains the data to copy.
sourceIndex A 64-bit integer that represents the index in the sourceArray at which copying begins.
destinationArray The System.Array that receives the data.
destinationIndex A 64-bit integer that represents the index in the destinationArray at which storing begins.
length A 64-bit integer that represents the number of elements to copy. The integer must be between zero and Int32.MaxValue, inclusive.

System.Array.CopyTo()

Copies all the elements of the current one-dimensional array to the specified one-dimensional array starting at the specified destination array index. The index is specified as a 32-bit integer.

Parameters

NameDescriptionDefault
array The one-dimensional array that is the destination of the elements copied from the current array.
index A 32-bit integer that represents the index in array at which copying begins.

System.Array.CopyTo()

Copies all the elements of the current one-dimensional array to the specified one-dimensional array starting at the specified destination array index. The index is specified as a 64-bit integer.

Parameters

NameDescriptionDefault
array The one-dimensional array that is the destination of the elements copied from the current array.
index A 64-bit integer that represents the index in array at which copying begins.

System.Array.CreateInstance()

Creates a one-dimensional System.Array of the specified System.Type and length, with zero-based indexing.

Parameters

NameDescriptionDefault
elementType The System.Type of the System.Array to create.
length The size of the System.Array to create.

Returns

A new one-dimensional System.Array of the specified System.Type with the specified length, using zero-based indexing.

System.Array.CreateInstance()

Creates a two-dimensional System.Array of the specified System.Type and dimension lengths, with zero-based indexing.

Parameters

NameDescriptionDefault
elementType The System.Type of the System.Array to create.
length1 The size of the first dimension of the System.Array to create.
length2 The size of the second dimension of the System.Array to create.

Returns

A new two-dimensional System.Array of the specified System.Type with the specified length for each dimension, using zero-based indexing.

System.Array.CreateInstance()

Creates a three-dimensional System.Array of the specified System.Type and dimension lengths, with zero-based indexing.

Parameters

NameDescriptionDefault
elementType The System.Type of the System.Array to create.
length1 The size of the first dimension of the System.Array to create.
length2 The size of the second dimension of the System.Array to create.
length3 The size of the third dimension of the System.Array to create.

Returns

A new three-dimensional System.Array of the specified System.Type with the specified length for each dimension, using zero-based indexing.

System.Array.CreateInstance()

Creates a multidimensional System.Array of the specified System.Type and dimension lengths, with zero-based indexing. The dimension lengths are specified in an array of 32-bit integers.

Parameters

NameDescriptionDefault
elementType The System.Type of the System.Array to create.
lengths An array of 32-bit integers that represent the size of each dimension of the System.Array to create.

Returns

A new multidimensional System.Array of the specified System.Type with the specified length for each dimension, using zero-based indexing.

System.Array.CreateInstance()

Creates a multidimensional System.Array of the specified System.Type and dimension lengths, with the specified lower bounds.

Parameters

NameDescriptionDefault
elementType The System.Type of the System.Array to create.
lengths A one-dimensional array that contains the size of each dimension of the System.Array to create.
lowerBounds A one-dimensional array that contains the lower bound (starting index) of each dimension of the System.Array to create.

Returns

A new multidimensional System.Array of the specified System.Type with the specified length and lower bound for each dimension.

System.Array.CreateInstance()

Creates a multidimensional System.Array of the specified System.Type and dimension lengths, with zero-based indexing. The dimension lengths are specified in an array of 64-bit integers.

Parameters

NameDescriptionDefault
elementType The System.Type of the System.Array to create.
lengths An array of 64-bit integers that represent the size of each dimension of the System.Array to create. Each integer in the array must be between zero and Int32.MaxValue, inclusive.

Returns

A new multidimensional System.Array of the specified System.Type with the specified length for each dimension, using zero-based indexing.

System.Array.Empty``1

Returns an empty array.

Returns

An empty array.

System.Array.Exists``1()

Determines whether the specified array contains elements that match the conditions defined by the specified predicate.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to search.
match The System.Predicate`1 that defines the conditions of the elements to search for.

Returns

true if array contains one or more elements that match the conditions defined by the specified predicate; otherwise, false.

System.Array.Fill``1()

Assigns the given value of type to each element of the specified array.

Parameters

NameDescriptionDefault
array The array to be filled.
value The value to assign to each array element.

System.Array.Fill``1()

Assigns the given value of type to the elements of the specified array which are within the range of startIndex (inclusive) and the next count number of indices.

Parameters

NameDescriptionDefault
array The System.Array to be filled.
value The new value for the elements in the specified range.
startIndex A 32-bit integer that represents the index in the System.Array at which filling begins.
count The number of elements to copy.

System.Array.Find``1()

Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire System.Array.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based array to search.
match The predicate that defines the conditions of the element to search for.

Returns

The first element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T.

System.Array.FindAll``1()

Retrieves all the elements that match the conditions defined by the specified predicate.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to search.
match The System.Predicate`1 that defines the conditions of the elements to search for.

Returns

An System.Array containing all the elements that match the conditions defined by the specified predicate, if found; otherwise, an empty System.Array.

System.Array.FindIndex``1()

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the System.Array that starts at the specified index and contains the specified number of elements.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to search.
startIndex The zero-based starting index of the search.
count The number of elements in the section to search.
match The System.Predicate`1 that defines the conditions of the element to search for.

Returns

The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

System.Array.FindIndex``1()

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the System.Array that extends from the specified index to the last element.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to search.
startIndex The zero-based starting index of the search.
match The System.Predicate`1 that defines the conditions of the element to search for.

Returns

The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

System.Array.FindIndex``1()

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire System.Array.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to search.
match The System.Predicate`1 that defines the conditions of the element to search for.

Returns

The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

System.Array.FindLast``1()

Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire System.Array.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to search.
match The System.Predicate`1 that defines the conditions of the element to search for.

Returns

The last element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T.

System.Array.FindLastIndex``1()

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the System.Array that contains the specified number of elements and ends at the specified index.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to search.
startIndex The zero-based starting index of the backward search.
count The number of elements in the section to search.
match The System.Predicate`1 that defines the conditions of the element to search for.

Returns

The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

System.Array.FindLastIndex``1()

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the System.Array that extends from the first element to the specified index.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to search.
startIndex The zero-based starting index of the backward search.
match The System.Predicate`1 that defines the conditions of the element to search for.

Returns

The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

System.Array.FindLastIndex``1()

Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire System.Array.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to search.
match The System.Predicate`1 that defines the conditions of the element to search for.

Returns

The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

System.Array.ForEach``1()

Performs the specified action on each element of the specified array.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array on whose elements the action is to be performed.
action The System.Action`1 to perform on each element of array.

System.Array.GetEnumerator

Returns

System.Array.GetLength()

Gets a 32-bit integer that represents the number of elements in the specified dimension of the System.Array.

Parameters

NameDescriptionDefault
dimension A zero-based dimension of the System.Array whose length needs to be determined.

Returns

A 32-bit integer that represents the number of elements in the specified dimension.

System.Array.GetLongLength()

Gets a 64-bit integer that represents the number of elements in the specified dimension of the System.Array.

Parameters

NameDescriptionDefault
dimension A zero-based dimension of the System.Array whose length needs to be determined.

Returns

A 64-bit integer that represents the number of elements in the specified dimension.

System.Array.GetLowerBound()

Gets the index of the first element of the specified dimension in the array.

Parameters

NameDescriptionDefault
dimension A zero-based dimension of the array whose starting index needs to be determined.

Returns

The index of the first element of the specified dimension in the array.

System.Array.GetUpperBound()

Gets the index of the last element of the specified dimension in the array.

Parameters

NameDescriptionDefault
dimension A zero-based dimension of the array whose upper bound needs to be determined.

Returns

The index of the last element of the specified dimension in the array, or -1 if the specified dimension is empty.

System.Array.GetValue()

Gets the value at the specified position in the one-dimensional System.Array. The index is specified as a 32-bit integer.

Parameters

NameDescriptionDefault
index A 32-bit integer that represents the position of the System.Array element to get.

Returns

The value at the specified position in the one-dimensional System.Array.

System.Array.GetValue()

Gets the value at the specified position in the two-dimensional System.Array. The indexes are specified as 32-bit integers.

Parameters

NameDescriptionDefault
index1 A 32-bit integer that represents the first-dimension index of the System.Array element to get.
index2 A 32-bit integer that represents the second-dimension index of the System.Array element to get.

Returns

The value at the specified position in the two-dimensional System.Array.

System.Array.GetValue()

Gets the value at the specified position in the three-dimensional System.Array. The indexes are specified as 32-bit integers.

Parameters

NameDescriptionDefault
index1 A 32-bit integer that represents the first-dimension index of the System.Array element to get.
index2 A 32-bit integer that represents the second-dimension index of the System.Array element to get.
index3 A 32-bit integer that represents the third-dimension index of the System.Array element to get.

Returns

The value at the specified position in the three-dimensional System.Array.

System.Array.GetValue()

Gets the value at the specified position in the multidimensional System.Array. The indexes are specified as an array of 32-bit integers.

Parameters

NameDescriptionDefault
indices A one-dimensional array of 32-bit integers that represent the indexes specifying the position of the System.Array element to get.

Returns

The value at the specified position in the multidimensional System.Array.

System.Array.GetValue()

Gets the value at the specified position in the one-dimensional System.Array. The index is specified as a 64-bit integer.

Parameters

NameDescriptionDefault
index A 64-bit integer that represents the position of the System.Array element to get.

Returns

The value at the specified position in the one-dimensional System.Array.

System.Array.GetValue()

Gets the value at the specified position in the two-dimensional System.Array. The indexes are specified as 64-bit integers.

Parameters

NameDescriptionDefault
index1 A 64-bit integer that represents the first-dimension index of the System.Array element to get.
index2 A 64-bit integer that represents the second-dimension index of the System.Array element to get.

Returns

The value at the specified position in the two-dimensional System.Array.

System.Array.GetValue()

Gets the value at the specified position in the three-dimensional System.Array. The indexes are specified as 64-bit integers.

Parameters

NameDescriptionDefault
index1 A 64-bit integer that represents the first-dimension index of the System.Array element to get.
index2 A 64-bit integer that represents the second-dimension index of the System.Array element to get.
index3 A 64-bit integer that represents the third-dimension index of the System.Array element to get.

Returns

The value at the specified position in the three-dimensional System.Array.

System.Array.GetValue()

Gets the value at the specified position in the multidimensional System.Array. The indexes are specified as an array of 64-bit integers.

Parameters

NameDescriptionDefault
indices A one-dimensional array of 64-bit integers that represent the indexes specifying the position of the System.Array element to get.

Returns

The value at the specified position in the multidimensional System.Array.

System.Array.IndexOf()

Searches for the specified object and returns the index of its first occurrence in a one-dimensional array.

Parameters

NameDescriptionDefault
array The one-dimensional array to search.
value The object to locate in array.

Returns

The index of the first occurrence of value in array, if found; otherwise, the lower bound of the array minus 1.

System.Array.IndexOf()

Searches for the specified object in a range of elements of a one-dimensional array, and returns the index of its first occurrence. The range extends from a specified index to the end of the array.

Parameters

NameDescriptionDefault
array The one-dimensional array to search.
value The object to locate in array.
startIndex The starting index of the search. 0 (zero) is valid in an empty array.

Returns

The index of the first occurrence of value, if it's found, within the range of elements in array that extends from startIndex to the last element; otherwise, the lower bound of the array minus 1.

System.Array.IndexOf()

Searches for the specified object in a range of elements of a one-dimensional array, and returns the index of ifs first occurrence. The range extends from a specified index for a specified number of elements.

Parameters

NameDescriptionDefault
array The one-dimensional array to search.
value The object to locate in array.
startIndex The starting index of the search. 0 (zero) is valid in an empty array.
count The number of elements to search.

Returns

The index of the first occurrence of value, if it's found in the array from index startIndex to startIndex + count - 1; otherwise, the lower bound of the array minus 1.

System.Array.IndexOf``1()

Searches for the specified object and returns the index of its first occurrence in a one-dimensional array.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based array to search.
value The object to locate in array.

Returns

The zero-based index of the first occurrence of value in the entire array, if found; otherwise, -1.

System.Array.IndexOf``1()

Searches for the specified object in a range of elements of a one dimensional array, and returns the index of its first occurrence. The range extends from a specified index to the end of the array.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based array to search.
value The object to locate in array.
startIndex The zero-based starting index of the search. 0 (zero) is valid in an empty array.

Returns

The zero-based index of the first occurrence of value within the range of elements in array that extends from startIndex to the last element, if found; otherwise, -1.

System.Array.IndexOf``1()

Searches for the specified object in a range of elements of a one-dimensional array, and returns the index of its first occurrence. The range extends from a specified index for a specified number of elements.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based array to search.
value The object to locate in array.
startIndex The zero-based starting index of the search. 0 (zero) is valid in an empty array.
count The number of elements in the section to search.

Returns

The zero-based index of the first occurrence of value within the range of elements in array that starts at startIndex and contains the number of elements specified in count, if found; otherwise, -1.

System.Array.Initialize

Initializes every element of the value-type System.Array by calling the parameterless constructor of the value type.

System.Array.LastIndexOf()

Searches for the specified object and returns the index of the last occurrence within the entire one-dimensional System.Array.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array to search.
value The object to locate in array.

Returns

The index of the last occurrence of value within the entire array, if found; otherwise, the lower bound of the array minus 1.

System.Array.LastIndexOf()

Searches for the specified object and returns the index of the last occurrence within the range of elements in the one-dimensional System.Array that extends from the first element to the specified index.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array to search.
value The object to locate in array.
startIndex The starting index of the backward search.

Returns

The index of the last occurrence of value within the range of elements in array that extends from the first element to startIndex, if found; otherwise, the lower bound of the array minus 1.

System.Array.LastIndexOf()

Searches for the specified object and returns the index of the last occurrence within the range of elements in the one-dimensional System.Array that contains the specified number of elements and ends at the specified index.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array to search.
value The object to locate in array.
startIndex The starting index of the backward search.
count The number of elements in the section to search.

Returns

The index of the last occurrence of value within the range of elements in array that contains the number of elements specified in count and ends at startIndex, if found; otherwise, the lower bound of the array minus 1.

System.Array.LastIndexOf``1()

Searches for the specified object and returns the index of the last occurrence within the entire System.Array.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to search.
value The object to locate in array.

Returns

The zero-based index of the last occurrence of value within the entire array, if found; otherwise, -1.

System.Array.LastIndexOf``1()

Searches for the specified object and returns the index of the last occurrence within the range of elements in the System.Array that extends from the first element to the specified index.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to search.
value The object to locate in array.
startIndex The zero-based starting index of the backward search.

Returns

The zero-based index of the last occurrence of value within the range of elements in array that extends from the first element to startIndex, if found; otherwise, -1.

System.Array.LastIndexOf``1()

Searches for the specified object and returns the index of the last occurrence within the range of elements in the System.Array that contains the specified number of elements and ends at the specified index.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to search.
value The object to locate in array.
startIndex The zero-based starting index of the backward search.
count The number of elements in the section to search.

Returns

The zero-based index of the last occurrence of value within the range of elements in array that contains the number of elements specified in count and ends at startIndex, if found; otherwise, -1.

System.Array.Resize``1()

Changes the number of elements of a one-dimensional array to the specified new size.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based array to resize, or null to create a new array with the specified size.
newSize The size of the new array.

System.Array.Reverse()

Reverses the sequence of the elements in the entire one-dimensional System.Array.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array to reverse.

System.Array.Reverse()

Reverses the sequence of a subset of the elements in the one-dimensional System.Array.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array to reverse.
index The starting index of the section to reverse.
length The number of elements in the section to reverse.

System.Array.Reverse``1()

Reverses the sequence of the elements in the one-dimensional generic array.

Parameters

NameDescriptionDefault
array The one-dimensional array of elements to reverse.

System.Array.Reverse``1()

Reverses the sequence of a subset of the elements in the one-dimensional generic array.

Parameters

NameDescriptionDefault
array The one-dimensional array of elements to reverse.
index The starting index of the section to reverse.
length The number of elements in the section to reverse.

System.Array.SetValue()

Sets a value to the element at the specified position in the one-dimensional System.Array. The index is specified as a 32-bit integer.

Parameters

NameDescriptionDefault
value The new value for the specified element.
index A 32-bit integer that represents the position of the System.Array element to set.

System.Array.SetValue()

Sets a value to the element at the specified position in the two-dimensional System.Array. The indexes are specified as 32-bit integers.

Parameters

NameDescriptionDefault
value The new value for the specified element.
index1 A 32-bit integer that represents the first-dimension index of the System.Array element to set.
index2 A 32-bit integer that represents the second-dimension index of the System.Array element to set.

System.Array.SetValue()

Sets a value to the element at the specified position in the three-dimensional System.Array. The indexes are specified as 32-bit integers.

Parameters

NameDescriptionDefault
value The new value for the specified element.
index1 A 32-bit integer that represents the first-dimension index of the System.Array element to set.
index2 A 32-bit integer that represents the second-dimension index of the System.Array element to set.
index3 A 32-bit integer that represents the third-dimension index of the System.Array element to set.

System.Array.SetValue()

Sets a value to the element at the specified position in the multidimensional System.Array. The indexes are specified as an array of 32-bit integers.

Parameters

NameDescriptionDefault
value The new value for the specified element.
indices A one-dimensional array of 32-bit integers that represent the indexes specifying the position of the element to set.

System.Array.SetValue()

Sets a value to the element at the specified position in the one-dimensional System.Array. The index is specified as a 64-bit integer.

Parameters

NameDescriptionDefault
value The new value for the specified element.
index A 64-bit integer that represents the position of the System.Array element to set.

System.Array.SetValue()

Sets a value to the element at the specified position in the two-dimensional System.Array. The indexes are specified as 64-bit integers.

Parameters

NameDescriptionDefault
value The new value for the specified element.
index1 A 64-bit integer that represents the first-dimension index of the System.Array element to set.
index2 A 64-bit integer that represents the second-dimension index of the System.Array element to set.

System.Array.SetValue()

Sets a value to the element at the specified position in the three-dimensional System.Array. The indexes are specified as 64-bit integers.

Parameters

NameDescriptionDefault
value The new value for the specified element.
index1 A 64-bit integer that represents the first-dimension index of the System.Array element to set.
index2 A 64-bit integer that represents the second-dimension index of the System.Array element to set.
index3 A 64-bit integer that represents the third-dimension index of the System.Array element to set.

System.Array.SetValue()

Sets a value to the element at the specified position in the multidimensional System.Array. The indexes are specified as an array of 64-bit integers.

Parameters

NameDescriptionDefault
value The new value for the specified element.
indices A one-dimensional array of 64-bit integers that represent the indexes specifying the position of the element to set.

System.Array.Sort()

Sorts the elements in an entire one-dimensional System.Array using the System.IComparable implementation of each element of the System.Array.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array to sort.

System.Array.Sort()

Sorts a pair of one-dimensional System.Array objects (one contains the keys and the other contains the corresponding items) based on the keys in the first System.Array using the System.IComparable implementation of each key.

Parameters

NameDescriptionDefault
keys The one-dimensional System.Array that contains the keys to sort.
items The one-dimensional System.Array that contains the items that correspond to each of the keys in the keysSystem.Array. -or- null to sort only the keysSystem.Array.

System.Array.Sort()

Sorts a pair of one-dimensional System.Array objects (one contains the keys and the other contains the corresponding items) based on the keys in the first System.Array using the specified System.Collections.IComparer.

Parameters

NameDescriptionDefault
keys The one-dimensional System.Array that contains the keys to sort.
items The one-dimensional System.Array that contains the items that correspond to each of the keys in the keysSystem.Array. -or- null to sort only the keysSystem.Array.
comparer The System.Collections.IComparer implementation to use when comparing elements. -or- null to use the System.IComparable implementation of each element.

System.Array.Sort()

Sorts a range of elements in a pair of one-dimensional System.Array objects (one contains the keys and the other contains the corresponding items) based on the keys in the first System.Array using the System.IComparable implementation of each key.

Parameters

NameDescriptionDefault
keys The one-dimensional System.Array that contains the keys to sort.
items The one-dimensional System.Array that contains the items that correspond to each of the keys in the keysSystem.Array. -or- null to sort only the keysSystem.Array.
index The starting index of the range to sort.
length The number of elements in the range to sort.

System.Array.Sort()

Sorts a range of elements in a pair of one-dimensional System.Array objects (one contains the keys and the other contains the corresponding items) based on the keys in the first System.Array using the specified System.Collections.IComparer.

Parameters

NameDescriptionDefault
keys The one-dimensional System.Array that contains the keys to sort.
items The one-dimensional System.Array that contains the items that correspond to each of the keys in the keysSystem.Array. -or- null to sort only the keysSystem.Array.
index The starting index of the range to sort.
length The number of elements in the range to sort.
comparer The System.Collections.IComparer implementation to use when comparing elements. -or- null to use the System.IComparable implementation of each element.

System.Array.Sort()

Sorts the elements in a one-dimensional System.Array using the specified System.Collections.IComparer.

Parameters

NameDescriptionDefault
array The one-dimensional array to sort.
comparer The implementation to use when comparing elements. -or- null to use the System.IComparable implementation of each element.

System.Array.Sort()

Sorts the elements in a range of elements in a one-dimensional System.Array using the System.IComparable implementation of each element of the System.Array.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array to sort.
index The starting index of the range to sort.
length The number of elements in the range to sort.

System.Array.Sort()

Sorts the elements in a range of elements in a one-dimensional System.Array using the specified System.Collections.IComparer.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array to sort.
index The starting index of the range to sort.
length The number of elements in the range to sort.
comparer The System.Collections.IComparer implementation to use when comparing elements. -or- null to use the System.IComparable implementation of each element.

System.Array.Sort``1()

Sorts the elements in an entire System.Array using the System.IComparable`1 generic interface implementation of each element of the System.Array.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to sort.

System.Array.Sort``1()

Sorts the elements in an System.Array using the specified System.Collections.Generic.IComparer`1 generic interface.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-base System.Array to sort.
comparer The System.Collections.Generic.IComparer`1 generic interface implementation to use when comparing elements, or null to use the System.IComparable`1 generic interface implementation of each element.

System.Array.Sort``1()

Sorts the elements in an System.Array using the specified System.Comparison`1.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to sort.
comparison The System.Comparison`1 to use when comparing elements.

System.Array.Sort``1()

Sorts the elements in a range of elements in an System.Array using the System.IComparable`1 generic interface implementation of each element of the System.Array.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to sort.
index The starting index of the range to sort.
length The number of elements in the range to sort.

System.Array.Sort``1()

Sorts the elements in a range of elements in an System.Array using the specified System.Collections.Generic.IComparer`1 generic interface.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to sort.
index The starting index of the range to sort.
length The number of elements in the range to sort.
comparer The System.Collections.Generic.IComparer`1 generic interface implementation to use when comparing elements, or null to use the System.IComparable`1 generic interface implementation of each element.

System.Array.Sort``2()

Sorts a pair of System.Array objects (one contains the keys and the other contains the corresponding items) based on the keys in the first System.Array using the System.IComparable`1 generic interface implementation of each key.

Parameters

NameDescriptionDefault
keys The one-dimensional, zero-based System.Array that contains the keys to sort.
items The one-dimensional, zero-based System.Array that contains the items that correspond to the keys in keys, or null to sort only keys.

System.Array.Sort``2()

Sorts a pair of System.Array objects (one contains the keys and the other contains the corresponding items) based on the keys in the first System.Array using the specified System.Collections.Generic.IComparer`1 generic interface.

Parameters

NameDescriptionDefault
keys The one-dimensional, zero-based System.Array that contains the keys to sort.
items The one-dimensional, zero-based System.Array that contains the items that correspond to the keys in keys, or null to sort only keys.
comparer The System.Collections.Generic.IComparer`1 generic interface implementation to use when comparing elements, or null to use the System.IComparable`1 generic interface implementation of each element.

System.Array.Sort``2()

Sorts a range of elements in a pair of System.Array objects (one contains the keys and the other contains the corresponding items) based on the keys in the first System.Array using the System.IComparable`1 generic interface implementation of each key.

Parameters

NameDescriptionDefault
keys The one-dimensional, zero-based System.Array that contains the keys to sort.
items The one-dimensional, zero-based System.Array that contains the items that correspond to the keys in keys, or null to sort only keys.
index The starting index of the range to sort.
length The number of elements in the range to sort.

System.Array.Sort``2()

Sorts a range of elements in a pair of System.Array objects (one contains the keys and the other contains the corresponding items) based on the keys in the first System.Array using the specified System.Collections.Generic.IComparer`1 generic interface.

Parameters

NameDescriptionDefault
keys The one-dimensional, zero-based System.Array that contains the keys to sort.
items The one-dimensional, zero-based System.Array that contains the items that correspond to the keys in keys, or null to sort only keys.
index The starting index of the range to sort.
length The number of elements in the range to sort.
comparer The System.Collections.Generic.IComparer`1 generic interface implementation to use when comparing elements, or null to use the System.IComparable`1 generic interface implementation of each element.

System.Array.System#Collections#IList#Add()

Calling this method always throws a System.NotSupportedException exception.

Parameters

NameDescriptionDefault
value The object to be added to the System.Collections.IList.

Returns

Adding a value to an array is not supported. No value is returned.

System.Array.System#Collections#IList#Clear

Removes all items from the System.Collections.IList.

System.Array.System#Collections#IList#Contains()

Determines whether an element is in the System.Collections.IList.

Parameters

NameDescriptionDefault
value The object to locate in the current list. The element to locate can be null for reference types.

Returns

true if value is found in the System.Collections.IList; otherwise, false.

System.Array.System#Collections#IList#IndexOf()

Determines the index of a specific item in the System.Collections.IList.

Parameters

NameDescriptionDefault
value The object to locate in the current list.

Returns

The index of value if found in the list; otherwise, -1.

System.Array.System#Collections#IList#Insert()

Inserts an item to the System.Collections.IList at the specified index.

Parameters

NameDescriptionDefault
index The index at which value should be inserted.
value The object to insert.

System.Array.System#Collections#IList#Remove()

Removes the first occurrence of a specific object from the System.Collections.IList.

Parameters

NameDescriptionDefault
value The object to remove from the System.Collections.IList.

System.Array.System#Collections#IList#RemoveAt()

Removes the System.Collections.IList item at the specified index.

Parameters

NameDescriptionDefault
index The index of the element to remove.

System.Array.System#Collections#IStructuralComparable#CompareTo()

Determines whether the current collection object precedes, occurs in the same position as, or follows another object in the sort order.

Parameters

NameDescriptionDefault
other The object to compare with the current instance.
comparer An object that compares the current object and other.

Returns

An integer that indicates the relationship of the current collection object to other, as shown in the following table. Return value Description -1 The current instance precedes other. 0 The current instance and other are equal. 1 The current instance follows other.

System.Array.System#Collections#IStructuralEquatable#Equals()

Determines whether an object is equal to the current instance.

Parameters

NameDescriptionDefault
other The object to compare with the current instance.
comparer An object that determines whether the current instance and other are equal.

Returns

true if the two objects are equal; otherwise, false.

System.Array.System#Collections#IStructuralEquatable#GetHashCode()

Returns a hash code for the current instance.

Parameters

NameDescriptionDefault
comparer An object that computes the hash code of the current object.

Returns

The hash code for the current instance.

System.Array.TrueForAll``1()

Determines whether every element in the array matches the conditions defined by the specified predicate.

Parameters

NameDescriptionDefault
array The one-dimensional, zero-based System.Array to check against the conditions.
match The predicate that defines the conditions to check against the elements.

Returns

true if every element in array matches the conditions defined by the specified predicate; otherwise, false. If there are no elements in the array, the return value is true.

System.Array.IsFixedSize

Gets a value indicating whether the System.Array has a fixed size.

Returns

This property is always true for all arrays.

System.Array.IsReadOnly

Gets a value indicating whether the System.Array is read-only.

Returns

This property is always false for all arrays.

System.Array.IsSynchronized

Gets a value indicating whether access to the System.Array is synchronized (thread safe).

Returns

This property is always false for all arrays.

System.Array.Length

Gets the total number of elements in all the dimensions of the System.Array.

Returns

The total number of elements in all the dimensions of the System.Array; zero if there are no elements in the array.

System.Array.LongLength

Gets a 64-bit integer that represents the total number of elements in all the dimensions of the System.Array.

Returns

A 64-bit integer that represents the total number of elements in all the dimensions of the System.Array.

System.Array.MaxLength

Gets the maximum number of elements that may be contained in an array.

Returns

The maximum count of elements allowed in any array.

System.Array.Rank

Gets the rank (number of dimensions) of the System.Array. For example, a one-dimensional array returns 1, a two-dimensional array returns 2, and so on.

Returns

The rank (number of dimensions) of the System.Array.

System.Array.SyncRoot

Gets an object that can be used to synchronize access to the System.Array.

Returns

An object that can be used to synchronize access to the System.Array.

System.Array.System#Collections#ICollection#Count

Gets the number of elements contained in the System.Array.

Returns

The number of elements contained in the collection.

System.Array.System#Collections#IList#Item()

Gets or sets the element at the specified index.

Parameters

NameDescriptionDefault
index The index of the element to get or set.

Returns

The element at the specified index.

System.ArraySegment`1

Delimits a section of a one-dimensional array.

System.ArraySegment`1.#ctor()

Initializes a new instance of the System.ArraySegment`1 structure that delimits all the elements in the specified array.

Parameters

NameDescriptionDefault
array The array to wrap.

System.ArraySegment`1.#ctor()

Initializes a new instance of the System.ArraySegment`1 structure that delimits the specified range of the elements in the specified array.

Parameters

NameDescriptionDefault
array The array containing the range of elements to delimit.
offset The zero-based index of the first element in the range.
count The number of elements in the range.

System.ArraySegment`1.CopyTo()

Copies the contents of this instance into the specified destination array of the same type .

Parameters

NameDescriptionDefault
destination The array of type T into which the contents of this instance will be copied.

System.ArraySegment`1.CopyTo()

Copies the contents of this instance into the specified destination array of the same type , starting at the specified destination index.

Parameters

NameDescriptionDefault
destination The array of type T into which the contents of this instance will be copied.
destinationIndex The index in destination at which storing begins.

System.ArraySegment`1.CopyTo()

Copies the contents of this instance into the specified destination array segment of the same type .

Parameters

NameDescriptionDefault
destination The array segment into which the contents of this instance will be copied.

System.ArraySegment`1.Equals()

Determines whether the specified System.ArraySegment`1 structure is equal to the current instance.

Parameters

NameDescriptionDefault
obj The structure to compare with the current instance.

Returns

true if the specified System.ArraySegment`1 structure is equal to the current instance; otherwise, false.

System.ArraySegment`1.Equals()

Determines whether the specified object is equal to the current instance.

Parameters

NameDescriptionDefault
obj The object to be compared with the current instance.

Returns

true if the specified object is a System.ArraySegment`1 structure and is equal to the current instance; otherwise, false.

System.ArraySegment`1.GetEnumerator

Returns an enumerator that can be used to iterate through the array segment.

Returns

An enumerator that can be used to iterate through the array segment.

System.ArraySegment`1.GetHashCode

Returns the hash code for the current instance.

Returns

A 32-bit signed integer hash code.

System.ArraySegment`1.op_Equality()

Indicates whether two System.ArraySegment`1 structures are equal.

Parameters

NameDescriptionDefault
a The structure on the left side of the equality operator.
b The structure on the right side of the equality operator.

Returns

true if a is equal to b; otherwise, false.

System.ArraySegment`1.op_Implicit()

Defines an implicit conversion of an array of type to an array segment of type .

Parameters

NameDescriptionDefault
array The array to convert.

Returns

An array segment representation of the array.

System.ArraySegment`1.op_Inequality()

Indicates whether two System.ArraySegment`1 structures are unequal.

Parameters

NameDescriptionDefault
a The structure on the left side of the inequality operator.
b The structure on the right side of the inequality operator.

Returns

true if a is not equal to b; otherwise, false.

System.ArraySegment`1.Slice()

Forms a slice out of the current array segment starting at the specified index.

Parameters

NameDescriptionDefault
index The index at which to begin the slice.

Returns

An array segment that consists of all elements of the current array segment from index to the end of the array segment.

System.ArraySegment`1.Slice()

Forms a slice of the specified length out of the current array segment starting at the specified index.

Parameters

NameDescriptionDefault
index The index at which to begin the slice.
count The desired length of the slice.

Returns

An array segment of count elements starting at index.

System.ArraySegment`1.System#Collections#Generic#ICollection{T}#Add()

Throws a System.NotSupportedException exception in all cases.

Parameters

NameDescriptionDefault
item The object to add to the array segment.

System.ArraySegment`1.System#Collections#Generic#ICollection{T}#Clear

Throws a System.NotSupportedException exception in all cases.

System.ArraySegment`1.System#Collections#Generic#ICollection{T}#Contains()

Determines whether the array segment contains a specific value.

Parameters

NameDescriptionDefault
item The object to locate in the array segment.

Returns

true if item is found in the array segment; otherwise, false.

System.ArraySegment`1.System#Collections#Generic#ICollection{T}#Remove()

Throws a System.NotSupportedException exception in all cases.

Parameters

NameDescriptionDefault
item The object to remove from the array segment.

Returns

Always throws an exception.

System.ArraySegment`1.System#Collections#Generic#IEnumerable{T}#GetEnumerator

Returns an enumerator that iterates through the array segment.

Returns

An enumerator that can be used to iterate through the array segment.

System.ArraySegment`1.System#Collections#Generic#IList{T}#IndexOf()

Determines the index of a specific item in the array segment.

Parameters

NameDescriptionDefault
item The object to locate in the array segment.

Returns

The index of item if found in the list; otherwise, -1.

System.ArraySegment`1.System#Collections#Generic#IList{T}#Insert()

Throws a System.NotSupportedException exception in all cases.

Parameters

NameDescriptionDefault
index The zero-based index at which item should be inserted.
item The object to insert into the array segment.

System.ArraySegment`1.System#Collections#Generic#IList{T}#RemoveAt()

Throws a System.NotSupportedException exception in all cases.

Parameters

NameDescriptionDefault
index The zero-based index of the item to remove.

System.ArraySegment`1.System#Collections#IEnumerable#GetEnumerator

Returns an enumerator that iterates through an array segment.

Returns

An enumerator that can be used to iterate through the array segment.

System.ArraySegment`1.ToArray

Copies the contents of this array segment into a new array.

Returns

An array containing the data in the current array segment.

System.ArraySegment`1.Array

Gets the original array containing the range of elements that the array segment delimits.

Returns

The original array that was passed to the constructor, and that contains the range delimited by the System.ArraySegment`1.

System.ArraySegment`1.Count

Gets the number of elements in the range delimited by the array segment.

Returns

The number of elements in the range delimited by the System.ArraySegment`1.

System.ArraySegment`1.Empty

Represents the empty array segment. This field is read-only.

Returns

An array segment of type containing zero elements.

System.ArraySegment`1.Item()

Gets or sets the element at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index of the element to get or set.

Returns

The element at the specified index.

System.ArraySegment`1.Offset

Gets the position of the first element in the range delimited by the array segment, relative to the start of the original array.

Returns

The position of the first element in the range delimited by the System.ArraySegment`1, relative to the start of the original array.

System.ArraySegment`1.System#Collections#Generic#ICollection{T}#IsReadOnly

Gets a value that indicates whether the array segment is read-only.

Returns

true if the array segment is read-only; otherwise, false.

System.ArraySegment`1.System#Collections#Generic#IList{T}#Item()

Gets or sets the element at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index of the element to get or set.

Returns

The element at the specified index.

System.ArraySegment`1.System#Collections#Generic#IReadOnlyList{T}#Item()

Gets the element at the specified index of the array segment.

Parameters

NameDescriptionDefault
index The zero-based index of the element to get.

Returns

The element at the specified index.

System.ArraySegment`1.Enumerator

Provides an enumerator for the elements of an System.ArraySegment`1.

System.ArraySegment`1.Enumerator.Dispose

Releases all resources used by this enumerator instance.

System.ArraySegment`1.Enumerator.MoveNext

Advances the enumerator to the next element of the System.ArraySegment`1.

Returns

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the array segment.

System.ArraySegment`1.Enumerator.System#Collections#IEnumerator#Reset

Sets the enumerator to its initial position, which is before the first element in the array segment.

System.ArraySegment`1.Enumerator.Current

Gets a reference to the item at the current position of the enumerator.

Returns

The element of the System.ArraySegment`1 at the current position of the enumerator.

System.ArraySegment`1.Enumerator.System#Collections#IEnumerator#Current

Gets the element at the current position of the enumerator.

Returns

The element in the array segment at the current position of the enumerator.

System.ArrayTypeMismatchException

The exception that is thrown when an attempt is made to store an element of the wrong type within an array.

System.ArrayTypeMismatchException.#ctor

Initializes a new instance of the System.ArrayTypeMismatchException class.

System.ArrayTypeMismatchException.#ctor()

Initializes a new instance of the System.ArrayTypeMismatchException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.ArrayTypeMismatchException.#ctor()

Initializes a new instance of the System.ArrayTypeMismatchException class with a specified error message.

Parameters

NameDescriptionDefault
message A System.String that describes the error.

System.ArrayTypeMismatchException.#ctor()

Initializes a new instance of the System.ArrayTypeMismatchException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.

System.AssemblyLoadEventArgs

Provides data for the System.AppDomain.AssemblyLoad event.

System.AssemblyLoadEventArgs.#ctor()

Initializes a new instance of the System.AssemblyLoadEventArgs class using the specified System.Reflection.Assembly.

Parameters

NameDescriptionDefault
loadedAssembly An instance that represents the currently loaded assembly.

System.AssemblyLoadEventArgs.LoadedAssembly

Gets an System.Reflection.Assembly that represents the currently loaded assembly.

Returns

An instance of System.Reflection.Assembly that represents the currently loaded assembly.

System.AssemblyLoadEventHandler

Represents the method that handles the System.AppDomain.AssemblyLoad event of an System.AppDomain.

Parameters

NameDescriptionDefault
sender The source of the event.
args An System.AssemblyLoadEventArgs that contains the event data.

System.AsyncCallback

References a method to be called when a corresponding asynchronous operation completes.

Parameters

NameDescriptionDefault
ar The result of the asynchronous operation.

System.Attribute

Represents the base class for custom attributes.

System.Attribute.#ctor

Initializes a new instance of the System.Attribute class.

System.Attribute.Equals()

Returns a value that indicates whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An System.Object to compare with this instance or null.

Returns

true if obj and this instance are of the same type and have identical field values; otherwise, false.

System.Attribute.GetCustomAttribute()

Retrieves a custom attribute applied to a specified assembly. Parameters specify the assembly and the type of the custom attribute to search for.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.Assembly class that describes a reusable collection of modules.
attributeType The type, or a base type, of the custom attribute to search for.

Returns

A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute.

System.Attribute.GetCustomAttribute()

Retrieves a custom attribute applied to an assembly. Parameters specify the assembly, the type of the custom attribute to search for, and an ignored search option.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.Assembly class that describes a reusable collection of modules.
attributeType The type, or a base type, of the custom attribute to search for.
inherit This parameter is ignored, and does not affect the operation of this method.

Returns

A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute.

System.Attribute.GetCustomAttribute()

Retrieves a custom attribute applied to a member of a type. Parameters specify the member, and the type of the custom attribute to search for.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.MemberInfo class that describes a constructor, event, field, method, or property member of a class.
attributeType The type, or a base type, of the custom attribute to search for.

Returns

A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute.

System.Attribute.GetCustomAttribute()

Retrieves a custom attribute applied to a member of a type. Parameters specify the member, the type of the custom attribute to search for, and whether to search ancestors of the member.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.MemberInfo class that describes a constructor, event, field, method, or property member of a class.
attributeType The type, or a base type, of the custom attribute to search for.
inherit If true, specifies to also search the ancestors of element for custom attributes.

Returns

A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute.

System.Attribute.GetCustomAttribute()

Retrieves a custom attribute applied to a module. Parameters specify the module, and the type of the custom attribute to search for.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.Module class that describes a portable executable file.
attributeType The type, or a base type, of the custom attribute to search for.

Returns

A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute.

System.Attribute.GetCustomAttribute()

Retrieves a custom attribute applied to a module. Parameters specify the module, the type of the custom attribute to search for, and an ignored search option.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.Module class that describes a portable executable file.
attributeType The type, or a base type, of the custom attribute to search for.
inherit This parameter is ignored, and does not affect the operation of this method.

Returns

A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute.

System.Attribute.GetCustomAttribute()

Retrieves a custom attribute applied to a method parameter. Parameters specify the method parameter, and the type of the custom attribute to search for.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.ParameterInfo class that describes a parameter of a member of a class.
attributeType The type, or a base type, of the custom attribute to search for.

Returns

A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute.

System.Attribute.GetCustomAttribute()

Retrieves a custom attribute applied to a method parameter. Parameters specify the method parameter, the type of the custom attribute to search for, and whether to search ancestors of the method parameter.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.ParameterInfo class that describes a parameter of a member of a class.
attributeType The type, or a base type, of the custom attribute to search for.
inherit If true, specifies to also search the ancestors of element for custom attributes.

Returns

A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute.

System.Attribute.GetCustomAttributes()

Retrieves an array of the custom attributes applied to an assembly. A parameter specifies the assembly.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.Assembly class that describes a reusable collection of modules.

Returns

An System.Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist.

System.Attribute.GetCustomAttributes()

Retrieves an array of the custom attributes applied to an assembly. Parameters specify the assembly, and an ignored search option.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.Assembly class that describes a reusable collection of modules.
inherit This parameter is ignored, and does not affect the operation of this method.

Returns

An System.Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist.

System.Attribute.GetCustomAttributes()

Retrieves an array of the custom attributes applied to an assembly. Parameters specify the assembly, and the type of the custom attribute to search for.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.Assembly class that describes a reusable collection of modules.
attributeType The type, or a base type, of the custom attribute to search for.

Returns

An System.Attribute array that contains the custom attributes of type attributeType applied to element, or an empty array if no such custom attributes exist.

System.Attribute.GetCustomAttributes()

Retrieves an array of the custom attributes applied to an assembly. Parameters specify the assembly, the type of the custom attribute to search for, and an ignored search option.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.Assembly class that describes a reusable collection of modules.
attributeType The type, or a base type, of the custom attribute to search for.
inherit This parameter is ignored, and does not affect the operation of this method.

Returns

An System.Attribute array that contains the custom attributes of type attributeType applied to element, or an empty array if no such custom attributes exist.

System.Attribute.GetCustomAttributes()

Retrieves an array of the custom attributes applied to a member of a type. A parameter specifies the member.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.MemberInfo class that describes a constructor, event, field, method, or property member of a class.

Returns

An System.Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist.

System.Attribute.GetCustomAttributes()

Retrieves an array of the custom attributes applied to a member of a type. Parameters specify the member, the type of the custom attribute to search for, and whether to search ancestors of the member.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.MemberInfo class that describes a constructor, event, field, method, or property member of a class.
inherit If true, specifies to also search the ancestors of element for custom attributes.

Returns

An System.Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist.

System.Attribute.GetCustomAttributes()

Retrieves an array of the custom attributes applied to a member of a type. Parameters specify the member, and the type of the custom attribute to search for.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.MemberInfo class that describes a constructor, event, field, method, or property member of a class.
attributeType

Returns

An System.Attribute array that contains the custom attributes of type type applied to element, or an empty array if no such custom attributes exist.

System.Attribute.GetCustomAttributes()

Retrieves an array of the custom attributes applied to a member of a type. Parameters specify the member, the type of the custom attribute to search for, and whether to search ancestors of the member.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.MemberInfo class that describes a constructor, event, field, method, or property member of a class.
attributeType
inherit If true, specifies to also search the ancestors of element for custom attributes.

Returns

An System.Attribute array that contains the custom attributes of type type applied to element, or an empty array if no such custom attributes exist.

System.Attribute.GetCustomAttributes()

Retrieves an array of the custom attributes applied to a module. A parameter specifies the module.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.Module class that describes a portable executable file.

Returns

An System.Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist.

System.Attribute.GetCustomAttributes()

Retrieves an array of the custom attributes applied to a module. Parameters specify the module, and an ignored search option.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.Module class that describes a portable executable file.
inherit This parameter is ignored, and does not affect the operation of this method.

Returns

An System.Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist.

System.Attribute.GetCustomAttributes()

Retrieves an array of the custom attributes applied to a module. Parameters specify the module, and the type of the custom attribute to search for.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.Module class that describes a portable executable file.
attributeType The type, or a base type, of the custom attribute to search for.

Returns

An System.Attribute array that contains the custom attributes of type attributeType applied to element, or an empty array if no such custom attributes exist.

System.Attribute.GetCustomAttributes()

Retrieves an array of the custom attributes applied to a module. Parameters specify the module, the type of the custom attribute to search for, and an ignored search option.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.Module class that describes a portable executable file.
attributeType The type, or a base type, of the custom attribute to search for.
inherit This parameter is ignored, and does not affect the operation of this method.

Returns

An System.Attribute array that contains the custom attributes of type attributeType applied to element, or an empty array if no such custom attributes exist.

System.Attribute.GetCustomAttributes()

Retrieves an array of the custom attributes applied to a method parameter. A parameter specifies the method parameter.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.ParameterInfo class that describes a parameter of a member of a class.

Returns

An System.Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist.

System.Attribute.GetCustomAttributes()

Retrieves an array of the custom attributes applied to a method parameter. Parameters specify the method parameter, and whether to search ancestors of the method parameter.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.ParameterInfo class that describes a parameter of a member of a class.
inherit If true, specifies to also search the ancestors of element for custom attributes.

Returns

An System.Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist.

System.Attribute.GetCustomAttributes()

Retrieves an array of the custom attributes applied to a method parameter. Parameters specify the method parameter, and the type of the custom attribute to search for.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.ParameterInfo class that describes a parameter of a member of a class.
attributeType The type, or a base type, of the custom attribute to search for.

Returns

An System.Attribute array that contains the custom attributes of type attributeType applied to element, or an empty array if no such custom attributes exist.

System.Attribute.GetCustomAttributes()

Retrieves an array of the custom attributes applied to a method parameter. Parameters specify the method parameter, the type of the custom attribute to search for, and whether to search ancestors of the method parameter.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.ParameterInfo class that describes a parameter of a member of a class.
attributeType The type, or a base type, of the custom attribute to search for.
inherit If true, specifies to also search the ancestors of element for custom attributes.

Returns

An System.Attribute array that contains the custom attributes of type attributeType applied to element, or an empty array if no such custom attributes exist.

System.Attribute.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Attribute.IsDefaultAttribute

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

Returns

true if this instance is the default attribute for the class; otherwise, false.

System.Attribute.IsDefined()

Determines whether any custom attributes are applied to an assembly. Parameters specify the assembly, and the type of the custom attribute to search for.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.Assembly class that describes a reusable collection of modules.
attributeType The type, or a base type, of the custom attribute to search for.

Returns

true if a custom attribute of type attributeType is applied to element; otherwise, false.

System.Attribute.IsDefined()

Determines whether any custom attributes are applied to an assembly. Parameters specify the assembly, the type of the custom attribute to search for, and an ignored search option.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.Assembly class that describes a reusable collection of modules.
attributeType The type, or a base type, of the custom attribute to search for.
inherit This parameter is ignored, and does not affect the operation of this method.

Returns

true if a custom attribute of type attributeType is applied to element; otherwise, false.

System.Attribute.IsDefined()

Determines whether any custom attributes are applied to a member of a type. Parameters specify the member, and the type of the custom attribute to search for.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.MemberInfo class that describes a constructor, event, field, method, type, or property member of a class.
attributeType The type, or a base type, of the custom attribute to search for.

Returns

true if a custom attribute of type attributeType is applied to element; otherwise, false.

System.Attribute.IsDefined()

Determines whether any custom attributes are applied to a member of a type. Parameters specify the member, the type of the custom attribute to search for, and whether to search ancestors of the member.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.MemberInfo class that describes a constructor, event, field, method, type, or property member of a class.
attributeType The type, or a base type, of the custom attribute to search for.
inherit If true, specifies to also search the ancestors of element for custom attributes.

Returns

true if a custom attribute of type attributeType is applied to element; otherwise, false.

System.Attribute.IsDefined()

Determines whether any custom attributes of a specified type are applied to a module. Parameters specify the module, and the type of the custom attribute to search for.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.Module class that describes a portable executable file.
attributeType The type, or a base type, of the custom attribute to search for.

Returns

true if a custom attribute of type attributeType is applied to element; otherwise, false.

System.Attribute.IsDefined()

Determines whether any custom attributes are applied to a module. Parameters specify the module, the type of the custom attribute to search for, and an ignored search option.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.Module class that describes a portable executable file.
attributeType The type, or a base type, of the custom attribute to search for.
inherit This parameter is ignored, and does not affect the operation of this method.

Returns

true if a custom attribute of type attributeType is applied to element; otherwise, false.

System.Attribute.IsDefined()

Determines whether any custom attributes are applied to a method parameter. Parameters specify the method parameter, and the type of the custom attribute to search for.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.ParameterInfo class that describes a parameter of a member of a class.
attributeType The type, or a base type, of the custom attribute to search for.

Returns

true if a custom attribute of type attributeType is applied to element; otherwise, false.

System.Attribute.IsDefined()

Determines whether any custom attributes are applied to a method parameter. Parameters specify the method parameter, the type of the custom attribute to search for, and whether to search ancestors of the method parameter.

Parameters

NameDescriptionDefault
element An object derived from the System.Reflection.ParameterInfo class that describes a parameter of a member of a class.
attributeType The type, or a base type, of the custom attribute to search for.
inherit If true, specifies to also search the ancestors of element for custom attributes.

Returns

true if a custom attribute of type attributeType is applied to element; otherwise, false.

System.Attribute.Match()

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

Parameters

NameDescriptionDefault
obj An System.Object to compare with this instance of System.Attribute.

Returns

true if this instance equals obj; otherwise, false.

System.Attribute.TypeId

When implemented in a derived class, gets a unique identifier for this System.Attribute.

Returns

An System.Object that is a unique identifier for the attribute.

System.AttributeTargets

Specifies the application elements on which it is valid to apply an attribute.

System.AttributeTargets.All

Attribute can be applied to any application element.

System.AttributeTargets.Assembly

Attribute can be applied to an assembly.

System.AttributeTargets.Class

Attribute can be applied to a class.

System.AttributeTargets.Constructor

Attribute can be applied to a constructor.

System.AttributeTargets.Delegate

Attribute can be applied to a delegate.

System.AttributeTargets.Enum

Attribute can be applied to an enumeration.

System.AttributeTargets.Event

Attribute can be applied to an event.

System.AttributeTargets.Field

Attribute can be applied to a field.

System.AttributeTargets.GenericParameter

Attribute can be applied to a generic parameter. Currently, this attribute can be applied only in C#, Microsoft intermediate language (MSIL), and emitted code.

System.AttributeTargets.Interface

Attribute can be applied to an interface.

System.AttributeTargets.Method

Attribute can be applied to a method.

System.AttributeTargets.Module

Attribute can be applied to a module. Module refers to a portable executable file (.dll or.exe) and not a Visual Basic standard module.

System.AttributeTargets.Parameter

Attribute can be applied to a parameter.

System.AttributeTargets.Property

Attribute can be applied to a property.

System.AttributeTargets.ReturnValue

Attribute can be applied to a return value.

System.AttributeTargets.Struct

Attribute can be applied to a structure; that is, a value type.

System.AttributeUsageAttribute

Specifies the usage of another attribute class. This class cannot be inherited.

System.AttributeUsageAttribute.#ctor()

Initializes a new instance of the System.AttributeUsageAttribute class with the specified list of System.AttributeTargets, the System.AttributeUsageAttribute.AllowMultiple value, and the System.AttributeUsageAttribute.Inherited value.

Parameters

NameDescriptionDefault
validOn The set of values combined using a bitwise OR operation to indicate which program elements are valid.

System.AttributeUsageAttribute.AllowMultiple

Gets or sets a Boolean value indicating whether more than one instance of the indicated attribute can be specified for a single program element.

Returns

true if more than one instance is allowed to be specified; otherwise, false. The default is false.

System.AttributeUsageAttribute.Inherited

Gets or sets a System.Boolean value that determines whether the indicated attribute is inherited by derived classes and overriding members.

Returns

true if the attribute can be inherited by derived classes and overriding members; otherwise, false. The default is true.

System.AttributeUsageAttribute.ValidOn

Gets a set of values identifying which program elements that the indicated attribute can be applied to.

Returns

One or several System.AttributeTargets values. The default is All.

System.BadImageFormatException

The exception that is thrown when the file image of a dynamic link library (DLL) or an executable program is invalid.

System.BadImageFormatException.#ctor

Initializes a new instance of the System.BadImageFormatException class.

System.BadImageFormatException.#ctor()

Initializes a new instance of the System.BadImageFormatException class with serialized data.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.BadImageFormatException.#ctor()

Initializes a new instance of the System.BadImageFormatException class with a specified error message.

Parameters

NameDescriptionDefault
message The message that describes the error.

System.BadImageFormatException.#ctor()

Initializes a new instance of the System.BadImageFormatException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
inner The exception that is the cause of the current exception. If the inner parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.

System.BadImageFormatException.#ctor()

Initializes a new instance of the System.BadImageFormatException class with a specified error message and file name.

Parameters

NameDescriptionDefault
message A message that describes the error.
fileName The full name of the file with the invalid image.

System.BadImageFormatException.#ctor()

Initializes a new instance of the System.BadImageFormatException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
fileName The full name of the file with the invalid image.
inner The exception that is the cause of the current exception. If the inner parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.BadImageFormatException.GetObjectData()

Sets the System.Runtime.Serialization.SerializationInfo object with the file name, assembly cache log, and additional exception information.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.BadImageFormatException.ToString

Returns the fully qualified name of this exception and possibly the error message, the name of the inner exception, and the stack trace.

Returns

A string containing the fully qualified name of this exception and possibly the error message, the name of the inner exception, and the stack trace.

System.BadImageFormatException.FileName

Gets the name of the file that causes this exception.

Returns

The name of the file with the invalid image, or a null reference if no file name was passed to the constructor for the current instance.

System.BadImageFormatException.FusionLog

Gets the log file that describes why an assembly load failed.

Returns

A String containing errors reported by the assembly cache.

System.BadImageFormatException.Message

Gets the error message and the name of the file that caused this exception.

Returns

A string containing the error message and the name of the file that caused this exception.

System.Base64FormattingOptions

Specifies whether relevant System.Convert.ToBase64CharArray and System.Convert.ToBase64String methods insert line breaks in their output.

System.Base64FormattingOptions.InsertLineBreaks

Inserts line breaks after every 76 characters in the string representation.

System.Base64FormattingOptions.None

Does not insert line breaks after every 76 characters in the string representation.

System.BitConverter

Converts base data types to an array of bytes, and an array of bytes to base data types.

System.BitConverter.IsLittleEndian

Indicates the byte order ("endianness") in which data is stored in this computer architecture.

System.BitConverter.DoubleToInt64Bits()

Converts the specified double-precision floating point number to a 64-bit signed integer.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

A 64-bit signed integer whose value is equivalent to value.

System.BitConverter.DoubleToUInt64Bits()

Converts the specified double-precision floating point number to a 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

A 64-bit unsigned integer whose bits are identical to value.

System.BitConverter.GetBytes()

Returns the specified Boolean value as a byte array.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

A byte array with length 1.

System.BitConverter.GetBytes()

Returns the specified Unicode character value as an array of bytes.

Parameters

NameDescriptionDefault
value The character to convert.

Returns

An array of bytes with length 2.

System.BitConverter.GetBytes()

Returns the specified double-precision floating-point value as an array of bytes.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

An array of bytes with length 8.

System.BitConverter.GetBytes()

Returns the specified half-precision floating-point value as an array of bytes.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

An array of bytes with length 2.

System.BitConverter.GetBytes()

Returns the specified 16-bit signed integer value as an array of bytes.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

An array of bytes with length 2.

System.BitConverter.GetBytes()

Returns the specified 32-bit signed integer value as an array of bytes.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

An array of bytes with length 4.

System.BitConverter.GetBytes()

Returns the specified 64-bit signed integer value as an array of bytes.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

An array of bytes with length 8.

System.BitConverter.GetBytes()

Returns the specified single-precision floating point value as an array of bytes.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

An array of bytes with length 4.

System.BitConverter.GetBytes()

Returns the specified 16-bit unsigned integer value as an array of bytes.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

An array of bytes with length 2.

System.BitConverter.GetBytes()

Returns the specified 32-bit unsigned integer value as an array of bytes.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

An array of bytes with length 4.

System.BitConverter.GetBytes()

Returns the specified 64-bit unsigned integer value as an array of bytes.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

An array of bytes with length 8.

System.BitConverter.HalfToInt16Bits()

Converts a half-precision floating-point value into a 16-bit integer.

Parameters

NameDescriptionDefault
value The half-precision floating-point value to convert.

Returns

An integer representing the converted half-precision floating-point value.

System.BitConverter.HalfToUInt16Bits()

Converts the specified half-precision floating point number to a 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

A 16-bit unsigned integer whose bits are identical to value.

System.BitConverter.Int16BitsToHalf()

Reinterprets the specified 16-bit signed integer value as a half-precision floating-point value.

Parameters

NameDescriptionDefault
value The 16-bit signed integer value to convert.

Returns

A half-precision floating-point value that represents the converted integer.

System.BitConverter.Int32BitsToSingle()

Reinterprets the specified 32-bit integer as a single-precision floating-point value.

Parameters

NameDescriptionDefault
value The integer to convert.

Returns

A single-precision floating-point value that represents the converted integer.

System.BitConverter.Int64BitsToDouble()

Reinterprets the specified 64-bit signed integer to a double-precision floating point number.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

A double-precision floating point number whose value is equivalent to value.

System.BitConverter.SingleToInt32Bits()

Converts a single-precision floating-point value into an integer.

Parameters

NameDescriptionDefault
value The single-precision floating-point value to convert.

Returns

An integer representing the converted single-precision floating-point value.

System.BitConverter.SingleToUInt32Bits()

Converts the specified single-precision floating point number to a 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

A 32-bit unsigned integer whose bits are identical to value.

System.BitConverter.ToBoolean()

Returns a Boolean value converted from the byte at a specified position in a byte array.

Parameters

NameDescriptionDefault
value A byte array.
startIndex The index of the byte within value to convert.

Returns

true if the byte at startIndex in value is nonzero; otherwise, false.

System.BitConverter.ToBoolean()

Converts a read-only byte span to a Boolean value.

Parameters

NameDescriptionDefault
value A read-only span containing the bytes to convert.

Returns

A Boolean representing the converted bytes.

System.BitConverter.ToChar()

Returns a Unicode character converted from two bytes at a specified position in a byte array.

Parameters

NameDescriptionDefault
value An array that includes the two bytes to convert.
startIndex The starting position within value.

Returns

The character formed by two bytes beginning at startIndex.

System.BitConverter.ToChar()

Converts a read-only byte span into a character.

Parameters

NameDescriptionDefault
value A read-only span containing the bytes to convert.

Returns

A character representing the converted bytes.

System.BitConverter.ToDouble()

Returns a double-precision floating point number converted from eight bytes at a specified position in a byte array.

Parameters

NameDescriptionDefault
value An array of bytes that includes the eight bytes to convert.
startIndex The starting position within value.

Returns

A double-precision floating point number formed by eight bytes beginning at startIndex.

System.BitConverter.ToDouble()

Converts a read-only byte span into a double-precision floating-point value.

Parameters

NameDescriptionDefault
value A read-only span containing the bytes to convert.

Returns

A double-precision floating-point value that represents the converted bytes.

System.BitConverter.ToHalf()

Returns a laft-precision floating point number converted from two bytes at a specified position in a byte array.

Parameters

NameDescriptionDefault
value An array of bytes that includes the two bytes to convert.
startIndex The starting position within value.

Returns

A half-precision floating point number formed by two bytes beginning at startIndex.

System.BitConverter.ToHalf()

Converts a read-only byte span into a half-precision floating-point value.

Parameters

NameDescriptionDefault
value A read-only span containing the bytes to convert.

Returns

A half-precision floating-point value that represents the converted bytes.

System.BitConverter.ToInt16()

Returns a 16-bit signed integer converted from two bytes at a specified position in a byte array.

Parameters

NameDescriptionDefault
value An array of bytes that includes the two bytes to convert.
startIndex The starting position within value.

Returns

A 16-bit signed integer formed by two bytes beginning at startIndex.

System.BitConverter.ToInt16()

Converts a read-only byte span into a 16-bit signed integer.

Parameters

NameDescriptionDefault
value A read-only span containing the bytes to convert.

Returns

A 16-bit signed integer representing the converted bytes.

System.BitConverter.ToInt32()

Returns a 32-bit signed integer converted from four bytes at a specified position in a byte array.

Parameters

NameDescriptionDefault
value An array of bytes that includes the four bytes to convert.
startIndex The starting position within value.

Returns

A 32-bit signed integer formed by four bytes beginning at startIndex.

System.BitConverter.ToInt32()

Converts a read-only byte span into a 32-bit signed integer.

Parameters

NameDescriptionDefault
value A read-only span containing the bytes to convert.

Returns

A 32-bit signed integer representing the converted bytes.

System.BitConverter.ToInt64()

Returns a 64-bit signed integer converted from eight bytes at a specified position in a byte array.

Parameters

NameDescriptionDefault
value An array of bytes that includes the eight bytes to convert.
startIndex The starting position within value.

Returns

A 64-bit signed integer formed by eight bytes beginning at startIndex.

System.BitConverter.ToInt64()

Converts a read-only byte span into a 64-bit signed integer.

Parameters

NameDescriptionDefault
value A read-only span containing the bytes to convert.

Returns

A 64-bit signed integer representing the converted bytes.

System.BitConverter.ToSingle()

Returns a single-precision floating point number converted from four bytes at a specified position in a byte array.

Parameters

NameDescriptionDefault
value An array of bytes.
startIndex The starting position within value.

Returns

A single-precision floating point number formed by four bytes beginning at startIndex.

System.BitConverter.ToSingle()

Converts a read-only byte span into a single-precision floating-point value.

Parameters

NameDescriptionDefault
value A read-only span containing the bytes to convert.

Returns

A single-precision floating-point value representing the converted bytes.

System.BitConverter.ToString()

Converts the numeric value of each element of a specified array of bytes to its equivalent hexadecimal string representation.

Parameters

NameDescriptionDefault
value An array of bytes.

Returns

A string of hexadecimal pairs separated by hyphens, where each pair represents the corresponding element in value; for example, "7F-2C-4A-00".

System.BitConverter.ToString()

Converts the numeric value of each element of a specified subarray of bytes to its equivalent hexadecimal string representation.

Parameters

NameDescriptionDefault
value An array of bytes.
startIndex The starting position within value.

Returns

A string of hexadecimal pairs separated by hyphens, where each pair represents the corresponding element in a subarray of value; for example, "7F-2C-4A-00".

System.BitConverter.ToString()

Converts the numeric value of each element of a specified subarray of bytes to its equivalent hexadecimal string representation.

Parameters

NameDescriptionDefault
value An array of bytes that includes the bytes to convert.
startIndex The starting position within value.
length The number of array elements in value to convert.

Returns

A string of hexadecimal pairs separated by hyphens, where each pair represents the corresponding element in a subarray of value; for example, "7F-2C-4A-00".

System.BitConverter.ToUInt16()

Returns a 16-bit unsigned integer converted from two bytes at a specified position in a byte array.

Parameters

NameDescriptionDefault
value The array of bytes that includes the two bytes to convert.
startIndex The starting position within value.

Returns

A 16-bit unsigned integer formed by two bytes beginning at startIndex.

System.BitConverter.ToUInt16()

Converts a read-only byte-span into a 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value A read-only span containing the bytes to convert.

Returns

An 16-bit unsigned integer representing the converted bytes.

System.BitConverter.ToUInt32()

Returns a 32-bit unsigned integer converted from four bytes at a specified position in a byte array.

Parameters

NameDescriptionDefault
value An array of bytes.
startIndex The starting position within value.

Returns

A 32-bit unsigned integer formed by four bytes beginning at startIndex.

System.BitConverter.ToUInt32()

Converts a read-only byte span into a 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value A read-only span containing the bytes to convert.

Returns

A 32-bit unsigned integer representing the converted bytes.

System.BitConverter.ToUInt64()

Returns a 64-bit unsigned integer converted from eight bytes at a specified position in a byte array.

Parameters

NameDescriptionDefault
value An array of bytes that includes the eight bytes to convert.
startIndex The starting position within value.

Returns

A 64-bit unsigned integer formed by the eight bytes beginning at startIndex.

System.BitConverter.ToUInt64()

Converts bytes into an unsigned long.

Parameters

NameDescriptionDefault
value A read-only span containing the bytes to convert.

Returns

A 64-bit unsigned integer representing the converted bytes.

System.BitConverter.TryWriteBytes()

Converts a Boolean into a span of bytes.

Parameters

NameDescriptionDefault
destination When this method returns, the bytes representing the converted Boolean.
value The Boolean to convert.

Returns

true if the conversion was successful; false otherwise.

System.BitConverter.TryWriteBytes()

Converts a character into a span of bytes.

Parameters

NameDescriptionDefault
destination When this method returns, the bytes representing the converted character.
value The character to convert.

Returns

true if the conversion was successful; false otherwise.

System.BitConverter.TryWriteBytes()

Converts a double-precision floating-point value into a span of bytes.

Parameters

NameDescriptionDefault
destination When this method returns, the bytes representing the converted double-precision floating-point value.
value The double-precision floating-point value to convert.

Returns

true if the conversion was successful; false otherwise.

System.BitConverter.TryWriteBytes()

Converts a half-precision floating-point value into a span of bytes.

Parameters

NameDescriptionDefault
destination When this method returns, the bytes representing the converted half-precision floating-point value.
value The half-precision floating-point value to convert.

Returns

true if the conversion was successful; false otherwise.

System.BitConverter.TryWriteBytes()

Converts a 16-bit signed integer into a span of bytes.

Parameters

NameDescriptionDefault
destination When this method returns, the bytes representing the converted 16-bit signed integer.
value The 16-bit signed integer to convert.

Returns

true if the conversion was successful; false otherwise.

System.BitConverter.TryWriteBytes()

Converts a 32-bit signed integer into a span of bytes.

Parameters

NameDescriptionDefault
destination When this method returns, the bytes representing the converted 32-bit signed integer.
value The 32-bit signed integer to convert.

Returns

true if the conversion was successful; false otherwise.

System.BitConverter.TryWriteBytes()

Converts a 64-bit signed integer into a span of bytes.

Parameters

NameDescriptionDefault
destination When this method returns, the bytes representing the converted 64-bit signed integer.
value The 64-bit signed integer to convert.

Returns

true if the conversion was successful; false otherwise.

System.BitConverter.TryWriteBytes()

Converts a single-precision floating-point value into a span of bytes.

Parameters

NameDescriptionDefault
destination When this method returns, the bytes representing the converted single-precision floating-point value.
value The single-precision floating-point value to convert.

Returns

true if the conversion was successful; false otherwise.

System.BitConverter.TryWriteBytes()

Converts an unsigned 16-bit integer into a span of bytes.

Parameters

NameDescriptionDefault
destination When this method returns, the bytes representing the converted unsigned 16-bit integer.
value The unsigned 16-bit integer to convert.

Returns

true if the conversion was successful; false otherwise.

System.BitConverter.TryWriteBytes()

Converts a 32-bit unsigned integer into a span of bytes.

Parameters

NameDescriptionDefault
destination When this method returns, the bytes representing the converted unsigned 32-bit integer.
value The unsigned 32-bit integer to convert.

Returns

true if the conversion was successful; false otherwise.

System.BitConverter.TryWriteBytes()

Converts an unsigned 64-bit integer into a span of bytes.

Parameters

NameDescriptionDefault
destination When this method returns, the bytes representing the converted unsigned 64-bit integer.
value The unsigned 64-bit integer to convert.

Returns

true if the conversion was successful; false otherwise.

System.BitConverter.UInt16BitsToHalf()

Converts the specified 16-bit unsigned integer to a half-precision floating point number.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

A half-precision floating point number whose bits are identical to value.

System.BitConverter.UInt32BitsToSingle()

Converts the specified 32-bit unsigned integer to a single-precision floating point number.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

A single-precision floating point number whose bits are identical to value.

System.BitConverter.UInt64BitsToDouble()

Converts the specified 64-bit unsigned integer to a double-precision floating point number.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

A double-precision floating point number whose bits are identical to value.

System.Boolean

Represents a Boolean (true or false) value.

System.Boolean.FalseString

Represents the Boolean value false as a string. This field is read-only.

System.Boolean.TrueString

Represents the Boolean value true as a string. This field is read-only.

System.Boolean.CompareTo()

Compares this instance to a specified System.Boolean object and returns an integer that indicates their relationship to one another.

Parameters

NameDescriptionDefault
value A System.Boolean object to compare to this instance.

Returns

A signed integer that indicates the relative values of this instance and value. Return Value Condition Less than zero This instance is false and value is true. Zero This instance and value are equal (either both are true or both are false). Greater than zero This instance is true and value is false.

System.Boolean.CompareTo()

Compares this instance to a specified object and returns an integer that indicates their relationship to one another.

Parameters

NameDescriptionDefault
obj An object to compare to this instance, or null.

Returns

A signed integer that indicates the relative order of this instance and obj. Return Value Condition Less than zero This instance is false and obj is true. Zero This instance and obj are equal (either both are true or both are false). Greater than zero This instance is true and obj is false. -or- obj is null.

System.Boolean.Equals()

Returns a value indicating whether this instance is equal to a specified System.Boolean object.

Parameters

NameDescriptionDefault
obj A System.Boolean value to compare to this instance.

Returns

true if obj has the same value as this instance; otherwise, false.

System.Boolean.Equals()

Returns a value indicating whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare to this instance.

Returns

true if obj is a System.Boolean and has the same value as this instance; otherwise, false.

System.Boolean.GetHashCode

Returns the hash code for this instance.

Returns

A hash code for the current System.Boolean.

System.Boolean.GetTypeCode

Returns the type code for the System.Boolean value type.

Returns

The enumerated constant System.TypeCode.Boolean.

System.Boolean.Parse()

Converts the specified span representation of a logical value to its System.Boolean equivalent.

Parameters

NameDescriptionDefault
value A span containing the characters representing the value to convert.

Returns

true if value is equivalent to System.Boolean.TrueString; false if value is equivalent to System.Boolean.FalseString.

System.Boolean.Parse()

Converts the specified string representation of a logical value to its System.Boolean equivalent.

Parameters

NameDescriptionDefault
value A string containing the value to convert.

Returns

true if value is equivalent to System.Boolean.TrueString; false if value is equivalent to System.Boolean.FalseString.

System.Boolean.System#IConvertible#ToBoolean()

For a description of this member, see System.IConvertible.ToBoolean().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

true or false.

System.Boolean.System#IConvertible#ToByte()

For a description of this member, see System.IConvertible.ToByte().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

1 if the value of this instance is true; otherwise, 0.

System.Boolean.System#IConvertible#ToChar()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

This conversion is not supported. No value is returned.

System.Boolean.System#IConvertible#ToDateTime()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

This conversion is not supported. No value is returned.

System.Boolean.System#IConvertible#ToDecimal()

For a description of this member, see System.IConvertible.ToDecimal().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

1 if this instance is true; otherwise, 0.

System.Boolean.System#IConvertible#ToDouble()

For a description of this member, see System.IConvertible.ToDouble().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

1 if this instance is true; otherwise, 0.

System.Boolean.System#IConvertible#ToInt16()

For a description of this member, see System.IConvertible.ToInt16().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

1 if this instance is true; otherwise, 0.

System.Boolean.System#IConvertible#ToInt32()

For a description of this member, see System.IConvertible.ToInt32().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

1 if this instance is true; otherwise, 0.

System.Boolean.System#IConvertible#ToInt64()

For a description of this member, see System.IConvertible.ToInt64().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

1 if this instance is true; otherwise, 0.

System.Boolean.System#IConvertible#ToSByte()

For a description of this member, see System.IConvertible.ToSByte().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

1 if this instance is true; otherwise, 0.

System.Boolean.System#IConvertible#ToSingle()

For a description of this member, see System.IConvertible.ToSingle().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

1 if this instance is true; otherwise, 0.

System.Boolean.System#IConvertible#ToType()

For a description of this member, see System.IConvertible.ToType().

Parameters

NameDescriptionDefault
type The desired type.
provider An System.IFormatProvider implementation that supplies culture-specific information about the format of the returned value.

Returns

An object of the specified type, with a value that is equivalent to the value of this Boolean object.

System.Boolean.System#IConvertible#ToUInt16()

For a description of this member, see System.IConvertible.ToUInt16().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

1 if this instance is true; otherwise, 0.

System.Boolean.System#IConvertible#ToUInt32()

For a description of this member, see System.IConvertible.ToUInt32().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

1 if this instance is true; otherwise, 0.

System.Boolean.System#IConvertible#ToUInt64()

For a description of this member, see System.IConvertible.ToUInt64().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

1 if this instance is true; otherwise, 0.

System.Boolean.System#IParsable{System#Boolean}#Parse()

Parses a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about s.

Returns

The result of parsing s.

System.Boolean.System#IParsable{System#Boolean}#TryParse()

Parameters

NameDescriptionDefault
s
provider
result

System.Boolean.System#ISpanParsable{System#Boolean}#Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about s.

Returns

The result of parsing s.

System.Boolean.System#ISpanParsable{System#Boolean}#TryParse()

Parameters

NameDescriptionDefault
s
provider
result

System.Boolean.ToString

Converts the value of this instance to its equivalent string representation (either "True" or "False").

Returns

"True" (the value of the System.Boolean.TrueString property) if the value of this instance is true, or "False" (the value of the System.Boolean.FalseString property) if the value of this instance is false.

System.Boolean.ToString()

Converts the value of this instance to its equivalent string representation (either "True" or "False").

Parameters

NameDescriptionDefault
provider (Reserved) An System.IFormatProvider object.

Returns

System.Boolean.TrueString if the value of this instance is true, or System.Boolean.FalseString if the value of this instance is false.

System.Boolean.TryFormat()

Tries to format the value of the current boolean instance into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span in which to write this instance's value formatted as a span of characters.
charsWritten When this method returns, contains the number of characters that were written in destination.

Returns

true if the formatting was successful; otherwise, false.

System.Boolean.TryParse()

Tries to convert the specified span representation of a logical value to its System.Boolean equivalent.

Parameters

NameDescriptionDefault
value A span containing the characters representing the value to convert.
result When this method returns, if the conversion succeeded, contains true if value is equal to System.Boolean.TrueString or false if value is equal to System.Boolean.FalseString. If the conversion failed, contains false. The conversion fails if value is null or is not equal to the value of either the System.Boolean.TrueString or System.Boolean.FalseString field.

Returns

true if value was converted successfully; otherwise, false.

System.Boolean.TryParse()

Tries to convert the specified string representation of a logical value to its System.Boolean equivalent.

Parameters

NameDescriptionDefault
value A string containing the value to convert.
result When this method returns, if the conversion succeeded, contains true if value is equal to System.Boolean.TrueString or false if value is equal to System.Boolean.FalseString. If the conversion failed, contains false. The conversion fails if value is null or is not equal to the value of either the System.Boolean.TrueString or System.Boolean.FalseString field.

Returns

true if value was converted successfully; otherwise, false.

System.Buffer

Manipulates arrays of primitive types.

System.Buffer.BlockCopy()

Copies a specified number of bytes from a source array starting at a particular offset to a destination array starting at a particular offset.

Parameters

NameDescriptionDefault
src The source buffer.
srcOffset The zero-based byte offset into src.
dst The destination buffer.
dstOffset The zero-based byte offset into dst.
count The number of bytes to copy.

System.Buffer.ByteLength()

Returns the number of bytes in the specified array.

Parameters

NameDescriptionDefault
array An array.

Returns

The number of bytes in the array.

System.Buffer.GetByte()

Retrieves the byte at the specified location in the specified array.

Parameters

NameDescriptionDefault
array An array.
index A location in the array.

Returns

The byte at the specified location in the array.

System.Buffer.MemoryCopy()

Copies a number of bytes specified as a long integer value from one address in memory to another. This API is not CLS-compliant.

Parameters

NameDescriptionDefault
source The address of the bytes to copy.
destination The target address.
destinationSizeInBytes The number of bytes available in the destination memory block.
sourceBytesToCopy The number of bytes to copy.

System.Buffer.MemoryCopy()

Copies a number of bytes specified as an unsigned long integer value from one address in memory to another. This API is not CLS-compliant.

Parameters

NameDescriptionDefault
source The address of the bytes to copy.
destination The target address.
destinationSizeInBytes The number of bytes available in the destination memory block.
sourceBytesToCopy The number of bytes to copy.

System.Buffer.SetByte()

Assigns a specified value to a byte at a particular location in a specified array.

Parameters

NameDescriptionDefault
array An array.
index A location in the array.
value A value to assign.

System.Buffers.ArrayPool`1

Provides a resource pool that enables reusing instances of type T[].

System.Buffers.ArrayPool`1.#ctor

Initializes a new instance of the System.Buffers.ArrayPool`1 class.

System.Buffers.ArrayPool`1.Create

Creates a new instance of the System.Buffers.ArrayPool`1 class.

Returns

A new instance of the System.Buffers.ArrayPool`1 class.

System.Buffers.ArrayPool`1.Create()

Creates a new instance of the System.Buffers.ArrayPool`1 class using the specified configuration.

Parameters

NameDescriptionDefault
maxArrayLength The maximum length of an array instance that may be stored in the pool.
maxArraysPerBucket The maximum number of array instances that may be stored in each bucket in the pool. The pool groups arrays of similar lengths into buckets for faster access.

Returns

A new instance of the System.Buffers.ArrayPool`1 class with the specified configuration.

System.Buffers.ArrayPool`1.Rent()

Retrieves a buffer that is at least the requested length.

Parameters

NameDescriptionDefault
minimumLength The minimum length of the array.

Returns

An array of type T that is at least minimumLength in length.

System.Buffers.ArrayPool`1.Return()

Returns an array to the pool that was previously obtained using the System.Buffers.ArrayPool`1.Rent() method on the same System.Buffers.ArrayPool`1 instance.

Parameters

NameDescriptionDefault
array A buffer to return to the pool that was previously obtained using the System.Buffers.ArrayPool`1.Rent() method.
clearArray Indicates whether the contents of the buffer should be cleared before reuse. If clearArray is set to true, and if the pool will store the buffer to enable subsequent reuse, the System.Buffers.ArrayPool`1.Return() method will clear the array of its contents so that a subsequent caller using the System.Buffers.ArrayPool`1.Rent() method will not see the content of the previous caller. If clearArray is set to false or if the pool will release the buffer, the array's contents are left unchanged.

System.Buffers.ArrayPool`1.Shared

Gets a shared System.Buffers.ArrayPool`1 instance.

Returns

A shared System.Buffers.ArrayPool`1 instance.

System.Buffers.IMemoryOwner`1

Identifies the owner of a block of memory who is responsible for disposing of the underlying memory appropriately.

System.Buffers.IMemoryOwner`1.Memory

Gets the memory belonging to this owner.

Returns

The memory belonging to this owner.

System.Buffers.IPinnable

Provides a mechanism for pinning and unpinning objects to prevent the garbage collector from moving them.

System.Buffers.IPinnable.Pin()

Pins a block of memory.

Parameters

NameDescriptionDefault
elementIndex The offset to the element within the memory buffer to which the returned System.Buffers.MemoryHandle points.

Returns

A handle to the block of memory.

System.Buffers.IPinnable.Unpin

Frees a block of pinned memory.

System.Buffers.MemoryHandle

Provides a memory handle for a block of memory.

System.Buffers.MemoryHandle.#ctor()

Creates a new memory handle for the block of memory.

Parameters

NameDescriptionDefault
pointer A pointer to memory.
handle A handle used to pin array buffers.
pinnable A reference to a manually managed object, or default if there is no memory manager.

System.Buffers.MemoryHandle.Dispose

Frees the pinned handle and releases the System.Buffers.IPinnable instance.

System.Buffers.MemoryHandle.Pointer

Returns a pointer to the memory block.

Returns

A pointer to the memory block.

System.Buffers.MemoryManager`1

An abstract base class that is used to replace the implementation of System.Memory`1.

System.Buffers.MemoryManager`1.#ctor

Initializes a new instance of the System.Buffers.MemoryManager`1 class.

System.Buffers.MemoryManager`1.CreateMemory()

Returns a memory buffer consisting of a specified number of elements from the memory managed by the current memory manager.

Parameters

NameDescriptionDefault
length The number of elements in the memory buffer, starting at offset 0.

Returns

A memory buffer.

System.Buffers.MemoryManager`1.CreateMemory()

Returns a memory buffer consisting of a specified number of elements starting at a specified offset from the memory managed by the current memory manager.

Parameters

NameDescriptionDefault
start The offset to the element at which the returned memory buffer starts.
length The number of elements to include in the returned memory buffer.

Returns

A memory buffer that consists of length elements starting at offset start.

System.Buffers.MemoryManager`1.Dispose()

Releases all resources used by the current memory manager.

Parameters

NameDescriptionDefault
disposing true to release both managed and unmanaged resources; false to release only unmanaged resources.

System.Buffers.MemoryManager`1.GetSpan

Returns a memory span that wraps the underlying memory buffer.

Returns

A memory span that wraps the underlying memory buffer.

System.Buffers.MemoryManager`1.Pin()

Returns a handle to the memory that has been pinned and whose address can be taken.

Parameters

NameDescriptionDefault
elementIndex The offset to the element in the memory buffer at which the returned System.Buffers.MemoryHandle points.

Returns

A handle to the memory that has been pinned.

System.Buffers.MemoryManager`1.System#IDisposable#Dispose

Releases all resources used by the memory manager.

System.Buffers.MemoryManager`1.TryGetArray()

Returns an array segment.

Parameters

NameDescriptionDefault
segment The array segment to write to.

Returns

true if the method succeeded in retrieving the array segment; otherwise, false.

System.Buffers.MemoryManager`1.Unpin

Unpins pinned memory so that the garbage collector is free to move it.

System.Buffers.MemoryManager`1.Memory

Gets the memory block handled by this System.Buffers.MemoryManager`1.

Returns

The memory block handled by this System.Buffers.MemoryManager`1.

System.Buffers.OperationStatus

Defines the values that can be returned from span-based operations that support processing of input contained in multiple discontiguous buffers.

System.Buffers.OperationStatus.DestinationTooSmall

The input is partially processed, up to what could fit into the destination buffer. The caller can enlarge the destination buffer, slice the buffers appropriately, and retry.

System.Buffers.OperationStatus.Done

The entire input buffer has been processed and the operation is complete.

System.Buffers.OperationStatus.InvalidData

The input contained invalid bytes which could not be processed. If the input is partially processed, the destination contains the partial result. This guarantees that no additional data appended to the input will make the invalid sequence valid.

System.Buffers.OperationStatus.NeedMoreData

The input is partially processed, up to the last valid chunk of the input that could be consumed. The caller can stitch the remaining unprocessed input with more data, slice the buffers appropriately, and retry.

System.Buffers.ReadOnlySpanAction`2

Encapsulates a method that receives a read-only span of objects of type and a state object of type .

Parameters

NameDescriptionDefault
span A read-only span of objects of type .
arg A state object of type .

System.Buffers.SearchValues

Provides a set of initialization methods for instances of the System.Buffers.SearchValues`1 class.

System.Buffers.SearchValues.Create()

Creates an optimized representation of values used for efficient searching.

Parameters

NameDescriptionDefault
values The set of values.

Returns

The optimized representation of values used for efficient searching.

System.Buffers.SearchValues.Create()

Creates an optimized representation of values used for efficient searching.

Parameters

NameDescriptionDefault
values The set of values.

Returns

The optimized representation of values used for efficient searching.

System.Buffers.SearchValues`1

Provides an immutable, read-only set of values optimized for efficient searching. Instances are created by System.Buffers.SearchValues.Create() or System.Buffers.SearchValues.Create().

System.Buffers.SearchValues`1.Contains()

Searches for the specified value.

Parameters

NameDescriptionDefault
value The value to search for.

Returns

true if value was found; otherwise, false.

System.Buffers.SpanAction`2

Encapsulates a method that receives a span of objects of type and a state object of type .

Parameters

NameDescriptionDefault
span A span of objects of type .
arg A state object of type .

System.Buffers.Text.Base64

Converts between binary data and UTF-8 encoded text that is represented in base 64.

System.Buffers.Text.Base64.DecodeFromUtf8()

Decodes the span of UTF-8 encoded text represented as base 64 into binary data. If the input is not a multiple of 4, it will decode as much as it can, to the closest multiple of 4.

Parameters

NameDescriptionDefault
utf8 The input span that contains UTF-8 encoded text in base 64 that needs to be decoded.
bytes The output span that contains the result of the operation, that is, the decoded binary data.
bytesConsumed When this method returns, contains the number of input bytes consumed during the operation. This can be used to slice the input for subsequent calls, if necessary.
bytesWritten When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary.
isFinalBlock true (default) to indicate that the input span contains the entire data to decode. false to indicate that the input span contains partial data with more data to follow.

Returns

One of the enumeration values that indicates the status of the decoding operation.

System.Buffers.Text.Base64.DecodeFromUtf8InPlace()

Decodes the span of UTF-8 encoded text in base 64 (in-place) into binary data. The decoded binary output is smaller than the text data contained in the input (the operation deflates the data). If the input is not a multiple of 4, the method will not decode any data.

Parameters

NameDescriptionDefault
buffer The input span that contains the base-64 text data that needs to be decoded.
bytesWritten When this method returns, contains the number of bytes written into the buffer.

Returns

One of the enumeration values that indicates the status of the decoding operation.

System.Buffers.Text.Base64.EncodeToUtf8()

Encodes the span of binary data into UTF-8 encoded text represented as base 64.

Parameters

NameDescriptionDefault
bytes The input span that contains binary data that needs to be encoded.
utf8 The output span that contains the result of the operation, that is, the UTF-8 encoded text in base 64.
bytesConsumed When this method returns, contains the number of input bytes consumed during the operation. This can be used to slice the input for subsequent calls, if necessary.
bytesWritten When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary.
isFinalBlock true (the default) to indicate that the input span contains the entire data to encode. false to indicate that the input span contains partial data with more data to follow.

Returns

One of the enumeration values that indicates the status of the encoding operation.

System.Buffers.Text.Base64.EncodeToUtf8InPlace()

Encodes the span of binary data (in-place) into UTF-8 encoded text represented as base 64. The encoded text output is larger than the binary data contained in the input (the operation inflates the data).

Parameters

NameDescriptionDefault
buffer The input span that contains binary data that needs to be encoded. Because the method performs an in-place conversion, it needs to be large enough to store the result of the operation.
dataLength The number of bytes of binary data contained within the buffer that needs to be encoded. This value must be smaller than the buffer length.
bytesWritten When this method returns, contains the number of bytes written into the buffer.

Returns

One of the enumeration values that indicates the status of the encoding operation.

System.Buffers.Text.Base64.GetMaxDecodedFromUtf8Length()

Returns the maximum length (in bytes) of the result if you were to decode base-64 encoded text within a byte span with the specified length.

Parameters

NameDescriptionDefault
length The size of the byte span.

Returns

The maximum length (in bytes) of the result.

System.Buffers.Text.Base64.GetMaxEncodedToUtf8Length()

Returns the maximum length (in bytes) of the result if you were to encode binary data within a byte span with the specified length.

Parameters

NameDescriptionDefault
length The size of the byte span.

Returns

The maximum length (in bytes) of the result.

System.Buffers.Text.Base64.IsValid()

Validates that the specified span of UTF-8 text is comprised of valid base-64 encoded data.

Parameters

NameDescriptionDefault
base64TextUtf8 A span of UTF-8 text to validate.

Returns

true if base64TextUtf8 contains a valid, decodable sequence of base-64 encoded data; otherwise, false.

System.Buffers.Text.Base64.IsValid()

Validates that the specified span of UTF-8 text is comprised of valid base-64 encoded data.

Parameters

NameDescriptionDefault
base64TextUtf8 A span of UTF-8 text to validate.
decodedLength If the method returns true, the number of decoded bytes that will result from decoding the input UTF-8 text.

Returns

true if base64TextUtf8 contains a valid, decodable sequence of base-64 encoded data; otherwise, false.

System.Buffers.Text.Base64.IsValid()

Validates that the specified span of text is comprised of valid base-64 encoded data.

Parameters

NameDescriptionDefault
base64Text A span of text to validate.

Returns

true if base64Text contains a valid, decodable sequence of base-64 encoded data; otherwise, false.

System.Buffers.Text.Base64.IsValid()

Validates that the specified span of text is comprised of valid base-64 encoded data.

Parameters

NameDescriptionDefault
base64Text A span of text to validate.
decodedLength If the method returns true, the number of decoded bytes that will result from decoding the input text.

Returns

true if base64Text contains a valid, decodable sequence of base-64 encoded data; otherwise, false.

System.Byte

Represents an 8-bit unsigned integer.

System.Byte.MaxValue

Represents the largest possible value of a System.Byte. This field is constant.

System.Byte.MinValue

Represents the smallest possible value of a System.Byte. This field is constant.

System.Byte.Clamp()

Clamps a value to an inclusive minimum and maximum value.

Parameters

NameDescriptionDefault
value The value to clamp.
min The inclusive minimum to which
value
should clamp.
max The inclusive maximum to which
value
should clamp.

Returns

The result of clamping
value
to the inclusive range of
min
and
max
.

System.Byte.CompareTo()

Compares this instance to a specified 8-bit unsigned integer and returns an indication of their relative values.

Parameters

NameDescriptionDefault
value An 8-bit unsigned integer to compare.

Returns

A signed integer that indicates the relative order of this instance and value. Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value.

System.Byte.CompareTo()

Compares this instance to a specified object and returns an indication of their relative values.

Parameters

NameDescriptionDefault
value An object to compare, or null.

Returns

A signed integer that indicates the relative order of this instance and value. Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value, or value is null.

System.Byte.CreateChecked``1()

Creates an instance of the current type from a value, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
.

System.Byte.CreateSaturating``1()

Creates an instance of the current type from a value, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, saturating if
value
falls outside the representable range of
TSelf
.

System.Byte.CreateTruncating``1()

Creates an instance of the current type from a value, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, truncating if
value
falls outside the representable range of
TSelf
.

System.Byte.DivRem()

Computes the quotient and remainder of two values.

Parameters

NameDescriptionDefault
left The value which
right
divides.
right The value which divides
left
.

Returns

The quotient and remainder of
left
divided-by
right
.

System.Byte.Equals()

Returns a value indicating whether this instance and a specified System.Byte object represent the same value.

Parameters

NameDescriptionDefault
obj An object to compare to this instance.

Returns

true if obj is equal to this instance; otherwise, false.

System.Byte.Equals()

Returns a value indicating whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance, or null.

Returns

true if obj is an instance of System.Byte and equals the value of this instance; otherwise, false.

System.Byte.GetHashCode

Returns the hash code for this instance.

Returns

A hash code for the current System.Byte.

System.Byte.GetTypeCode

Returns the System.TypeCode for value type System.Byte.

Returns

The enumerated constant, System.TypeCode.Byte.

System.Byte.IsEvenInteger()

Determines if a value represents an even integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an even integer; otherwise,
false
.

System.Byte.IsOddInteger()

Determines if a value represents an odd integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an odd integer; otherwise,
false
.

System.Byte.IsPow2()

Determines if a value is a power of two.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is a power of two; otherwise,
false
.

System.Byte.LeadingZeroCount()

Computes the number of leading zeros in a value.

Parameters

NameDescriptionDefault
value The value whose leading zeroes are to be counted.

Returns

The number of leading zeros in
value
.

System.Byte.Log2()

Computes the log2 of a value.

Parameters

NameDescriptionDefault
value The value whose log2 is to be computed.

Returns

The log2 of
value
.

System.Byte.Max()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Byte.Min()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Byte.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.Byte.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.Byte.Parse()

Converts the span representation of a number in a specified style and culture-specific format to its System.Byte equivalent.

Parameters

NameDescriptionDefault
s A span containing the characters representing the value to convert.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider An object that supplies culture-specific information about the format of s. If provider is null, the thread current culture is used.

Returns

A byte value that is equivalent to the number contained in s.

System.Byte.Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.

Returns

The result of parsing
s
.

System.Byte.Parse()

Converts the string representation of a number to its System.Byte equivalent.

Parameters

NameDescriptionDefault
s A string that contains a number to convert. The string is interpreted using the System.Globalization.NumberStyles.Integer style.

Returns

A byte value that is equivalent to the number contained in s.

System.Byte.Parse()

Converts the string representation of a number in a specified style to its System.Byte equivalent.

Parameters

NameDescriptionDefault
s A string that contains a number to convert. The string is interpreted using the style specified by style.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.

Returns

A byte value that is equivalent to the number contained in s.

System.Byte.Parse()

Converts the string representation of a number in a specified style and culture-specific format to its System.Byte equivalent.

Parameters

NameDescriptionDefault
s A string that contains a number to convert. The string is interpreted using the style specified by style.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider An object that supplies culture-specific information about the format of s. If provider is null, the thread current culture is used.

Returns

A byte value that is equivalent to the number contained in s.

System.Byte.Parse()

Converts the string representation of a number in a specified culture-specific format to its System.Byte equivalent.

Parameters

NameDescriptionDefault
s A string that contains a number to convert. The string is interpreted using the System.Globalization.NumberStyles.Integer style.
provider An object that supplies culture-specific parsing information about s. If provider is null, the thread current culture is used.

Returns

A byte value that is equivalent to the number contained in s.

System.Byte.PopCount()

Computes the number of bits that are set in a value.

Parameters

NameDescriptionDefault
value The value whose set bits are to be counted.

Returns

The number of set bits in
value
.

System.Byte.RotateLeft()

Rotates a value left by a given amount.

Parameters

NameDescriptionDefault
value The value which is rotated left by
rotateAmount
.
rotateAmount The amount by which
value
is rotated left.

Returns

The result of rotating
value
left by
rotateAmount
.

System.Byte.RotateRight()

Rotates a value right by a given amount.

Parameters

NameDescriptionDefault
value The value which is rotated right by
rotateAmount
.
rotateAmount The amount by which
value
is rotated right.

Returns

The result of rotating
value
right by
rotateAmount
.

System.Byte.Sign()

Computes the sign of a value.

Parameters

NameDescriptionDefault
value The value whose sign is to be computed.

Returns

A positive value if
value
is positive, if
value
is zero, and a negative value if
value
is negative.

System.Byte.System#IConvertible#ToBoolean()

For a description of this member, see System.IConvertible.ToBoolean().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

true if the value of the current instance is not zero; otherwise, false.

System.Byte.System#IConvertible#ToByte()

For a description of this member, see System.IConvertible.ToByte().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, unchanged.

System.Byte.System#IConvertible#ToChar()

For a description of this member, see System.IConvertible.ToChar().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Char.

System.Byte.System#IConvertible#ToDateTime()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

This conversion is not supported. No value is returned.

System.Byte.System#IConvertible#ToDecimal()

For a description of this member, see System.IConvertible.ToDecimal().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Decimal.

System.Byte.System#IConvertible#ToDouble()

For a description of this member, see System.IConvertible.ToDouble().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Double.

System.Byte.System#IConvertible#ToInt16()

For a description of this member, see System.IConvertible.ToInt16().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.Int16.

System.Byte.System#IConvertible#ToInt32()

For a description of this member, see System.IConvertible.ToInt32().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.Int32.

System.Byte.System#IConvertible#ToInt64()

For a description of this member, see System.IConvertible.ToInt64().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.Int64.

System.Byte.System#IConvertible#ToSByte()

For a description of this member, see System.IConvertible.ToSByte().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.SByte.

System.Byte.System#IConvertible#ToSingle()

For a description of this member, see System.IConvertible.ToSingle().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Single.

System.Byte.System#IConvertible#ToType()

For a description of this member, see System.IConvertible.ToType().

Parameters

NameDescriptionDefault
type The type to which to convert this System.Byte value.
provider An System.IFormatProvider implementation that supplies information about the format of the returned value.

Returns

The value of the current instance, converted to type.

System.Byte.System#IConvertible#ToUInt16()

For a description of this member, see System.IConvertible.ToUInt16().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt16.

System.Byte.System#IConvertible#ToUInt32()

For a description of this member, see System.IConvertible.ToUInt32().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt32.

System.Byte.System#IConvertible#ToUInt64()

For a description of this member, see System.IConvertible.ToUInt64().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt64.

System.Byte.System#Numerics#IAdditionOperators{System#Byte@System#Byte@System#Byte}#op_Addition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which right is added.
right The value that's added to left.

Returns

The sum of left and right.

System.Byte.System#Numerics#IAdditionOperators{System#Byte@System#Byte@System#Byte}#op_CheckedAddition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which right is added.
right The value that's added to left.

Returns

The sum of left and right.

System.Byte.System#Numerics#IBinaryInteger<System#Byte>#GetByteCount

Gets the number of bytes that will be written as part of .

Returns

The number of bytes that will be written as part of .

System.Byte.System#Numerics#IBinaryInteger<System#Byte>#GetShortestBitLength

Gets the length, in bits, of the shortest two's complement representation of the current value.

Returns

The length, in bits, of the shortest two's complement representation of the current value.

System.Byte.System#Numerics#IBinaryInteger{System#Byte}#TryReadBigEndian()

Parameters

NameDescriptionDefault
source
isUnsigned
value

System.Byte.System#Numerics#IBinaryInteger{System#Byte}#TryReadLittleEndian()

Parameters

NameDescriptionDefault
source
isUnsigned
value

System.Byte.System#Numerics#IBinaryInteger<System#Byte>#TryWriteBigEndian()

Tries to write the current value, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the value was succesfully written to
destination
; otherwise,
false
.

System.Byte.System#Numerics#IBinaryInteger<System#Byte>#TryWriteLittleEndian()

Tries to write the current value, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the value was succesfully written to
destination
; otherwise,
false
.

System.Byte.System#Numerics#IBitwiseOperators{System#Byte@System#Byte@System#Byte}#op_BitwiseAnd()

Computes the bitwise-and of two values.

Parameters

NameDescriptionDefault
left The value to and with right.
right The value to and with left.

Returns

The bitwise-and of left and right.

System.Byte.System#Numerics#IBitwiseOperators{System#Byte@System#Byte@System#Byte}#op_BitwiseOr()

Computes the bitwise-or of two values.

Parameters

NameDescriptionDefault
left The value to or with right.
right The value to or with left.

Returns

The bitwise-or of left and right.

System.Byte.System#Numerics#IBitwiseOperators{System#Byte@System#Byte@System#Byte}#op_ExclusiveOr()

Computes the exclusive-or of two values.

Parameters

NameDescriptionDefault
left The value to xor with right.
right The value to xor with left.

Returns

The exclusive-or of left and right.

System.Byte.System#Numerics#IBitwiseOperators{System#Byte@System#Byte@System#Byte}#op_OnesComplement()

Computes the ones-complement representation of a given value.

Parameters

NameDescriptionDefault
value The value for which to compute the ones-complement.

Returns

The ones-complement of value.

System.Byte.System#Numerics#IComparisonOperators{System#Byte@System#Byte@System#Boolean}#op_GreaterThan()

Compares two values to determine which is greater.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is greater than right; otherwise, false.

System.Byte.System#Numerics#IComparisonOperators{System#Byte@System#Byte@System#Boolean}#op_GreaterThanOrEqual()

Compares two values to determine which is greater or equal.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is greater than or equal to right; otherwise, false.

System.Byte.System#Numerics#IComparisonOperators{System#Byte@System#Byte@System#Boolean}#op_LessThan()

Compares two values to determine which is less.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is less than right; otherwise, false.

System.Byte.System#Numerics#IComparisonOperators{System#Byte@System#Byte@System#Boolean}#op_LessThanOrEqual()

Compares two values to determine which is less or equal.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is less than or equal to right; otherwise, false.

System.Byte.System#Numerics#IDecrementOperators{System#Byte}#op_CheckedDecrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing value.

System.Byte.System#Numerics#IDecrementOperators{System#Byte}#op_Decrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing value.

System.Byte.System#Numerics#IDivisionOperators{System#Byte@System#Byte@System#Byte}#op_Division()

Divides one value by another to compute their quotient.

Parameters

NameDescriptionDefault
left The value that right divides.
right The value that divides left.

Returns

The quotient of left divided by right.

System.Byte.System#Numerics#IEqualityOperators{System#Byte@System#Byte@System#Boolean}#op_Equality()

Compares two values to determine equality.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is equal to right; otherwise, false.

System.Byte.System#Numerics#IEqualityOperators{System#Byte@System#Byte@System#Boolean}#op_Inequality()

Compares two values to determine inequality.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is not equal to right; otherwise, false.

System.Byte.System#Numerics#IIncrementOperators{System#Byte}#op_CheckedIncrement()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing value.

System.Byte.System#Numerics#IIncrementOperators{System#Byte}#op_Increment()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing value.

System.Byte.System#Numerics#IModulusOperators{System#Byte@System#Byte@System#Byte}#op_Modulus()

Divides two values together to compute their modulus or remainder.

Parameters

NameDescriptionDefault
left The value that right divides.
right The value that divides left.

Returns

The modulus or remainder of left divided by right.

System.Byte.System#Numerics#IMultiplyOperators{System#Byte@System#Byte@System#Byte}#op_CheckedMultiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value that right multiplies.
right The value that multiplies left.

Returns

The product of left multiplied by right.

System.Byte.System#Numerics#IMultiplyOperators{System#Byte@System#Byte@System#Byte}#op_Multiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value that right multiplies.
right The value that multiplies left.

Returns

The product of left multiplied by right.

System.Byte.System#Numerics#INumber{System#Byte}#CopySign()

Copies the sign of a value to the sign of another value.

Parameters

NameDescriptionDefault
value The value whose magnitude is used in the result.
sign The value whose sign is used in the result.

Returns

A value with the magnitude of value and the sign of sign.

System.Byte.System#Numerics#INumber{System#Byte}#MaxNumber()

Compares two values to compute which is greater and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Byte.System#Numerics#INumber{System#Byte}#MinNumber()

Compares two values to compute which is lesser and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Byte.System#Numerics#INumberBase{System#Byte}#Abs()

Computes the absolute of a value.

Parameters

NameDescriptionDefault
value The value for which to get its absolute.

Returns

The absolute of value.

System.Byte.System#Numerics#INumberBase{System#Byte}#IsCanonical()

Determines if a value is in its canonical representation.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is in its canonical representation; otherwise, false.

System.Byte.System#Numerics#INumberBase{System#Byte}#IsComplexNumber()

Determines if a value represents a complex number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a complex number; otherwise, false.

System.Byte.System#Numerics#INumberBase{System#Byte}#IsFinite()

Determines if a value is finite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is finite; otherwise, false.

System.Byte.System#Numerics#INumberBase{System#Byte}#IsImaginaryNumber()

Determines if a value represents a pure imaginary number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a pure imaginary number; otherwise, false.

System.Byte.System#Numerics#INumberBase{System#Byte}#IsInfinity()

Determines if a value is infinite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is infinite; otherwise, false.

System.Byte.System#Numerics#INumberBase{System#Byte}#IsInteger()

Determines if a value represents an integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is an integer; otherwise, false.

System.Byte.System#Numerics#INumberBase{System#Byte}#IsNaN()

Determines if a value is NaN.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is NaN; otherwise, false.

System.Byte.System#Numerics#INumberBase{System#Byte}#IsNegative()

Determines if a value is negative.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is negative; otherwise, false.

System.Byte.System#Numerics#INumberBase{System#Byte}#IsNegativeInfinity()

Determines if a value is negative infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is negative infinity; otherwise, false.

System.Byte.System#Numerics#INumberBase{System#Byte}#IsNormal()

Determines if a value is normal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is normal; otherwise, false.

System.Byte.System#Numerics#INumberBase{System#Byte}#IsPositive()

Determines if a value is positive.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is positive; otherwise, false.

System.Byte.System#Numerics#INumberBase{System#Byte}#IsPositiveInfinity()

Determines if a value is positive infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is positive infinity; otherwise, false.

System.Byte.System#Numerics#INumberBase{System#Byte}#IsRealNumber()

Determines if a value represents a real number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a real number; otherwise, false.

System.Byte.System#Numerics#INumberBase{System#Byte}#IsSubnormal()

Determines if a value is subnormal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is subnormal; otherwise, false.

System.Byte.System#Numerics#INumberBase{System#Byte}#IsZero()

Determines if a value is zero.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is zero; otherwise, false.

System.Byte.System#Numerics#INumberBase{System#Byte}#MaxMagnitude()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Byte.System#Numerics#INumberBase{System#Byte}#MaxMagnitudeNumber()

Compares two values to compute which has the greater magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Byte.System#Numerics#INumberBase{System#Byte}#MinMagnitude()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Byte.System#Numerics#INumberBase{System#Byte}#MinMagnitudeNumber()

Compares two values to compute which has the lesser magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Byte.System#Numerics#INumberBase{System#Byte}#TryConvertFromChecked``1()

Parameters

NameDescriptionDefault
value
result

System.Byte.System#Numerics#INumberBase{System#Byte}#TryConvertFromSaturating``1()

Parameters

NameDescriptionDefault
value
result

System.Byte.System#Numerics#INumberBase{System#Byte}#TryConvertFromTruncating``1()

Parameters

NameDescriptionDefault
value
result

System.Byte.System#Numerics#INumberBase{System#Byte}#TryConvertToChecked``1()

Tries to convert an instance of the the current type to another type, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Byte.System#Numerics#INumberBase{System#Byte}#TryConvertToSaturating``1()

Tries to convert an instance of the the current type to another type, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Byte.System#Numerics#INumberBase{System#Byte}#TryConvertToTruncating``1()

Tries to convert an instance of the the current type to another type, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Byte.System#Numerics#IShiftOperators{System#Byte@System#Int32@System#Byte}#op_LeftShift()

Shifts a value left by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted left by shiftAmount.
shiftAmount The amount by which value is shifted left.

Returns

The result of shifting value left by shiftAmount.

System.Byte.System#Numerics#IShiftOperators{System#Byte@System#Int32@System#Byte}#op_RightShift()

Shifts a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted right by shiftAmount.
shiftAmount The amount by which value is shifted right.

Returns

The result of shifting value right by shiftAmount.

System.Byte.System#Numerics#IShiftOperators{System#Byte@System#Int32@System#Byte}#op_UnsignedRightShift()

Shifts a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted right by shiftAmount.
shiftAmount The amount by which value is shifted right.

Returns

The result of shifting value right by shiftAmount.

System.Byte.System#Numerics#ISubtractionOperators{System#Byte@System#Byte@System#Byte}#op_CheckedSubtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which right is subtracted.
right The value that's subtracted from left.

Returns

The value of right subtracted from left.

System.Byte.System#Numerics#ISubtractionOperators{System#Byte@System#Byte@System#Byte}#op_Subtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which right is subtracted.
right The value that's subtracted from left.

Returns

The value of right subtracted from left.

System.Byte.System#Numerics#IUnaryNegationOperators{System#Byte@System#Byte}#op_CheckedUnaryNegation()

Computes the checked unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of value.

System.Byte.System#Numerics#IUnaryNegationOperators{System#Byte@System#Byte}#op_UnaryNegation()

Computes the unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of value.

System.Byte.System#Numerics#IUnaryPlusOperators{System#Byte@System#Byte}#op_UnaryPlus()

Computes the unary plus of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary plus.

Returns

The unary plus of value.

System.Byte.ToString

Converts the value of the current System.Byte object to its equivalent string representation.

Returns

The string representation of the value of this object, which consists of a sequence of digits that range from 0 to 9 with no leading zeroes.

System.Byte.ToString()

Converts the numeric value of the current System.Byte object to its equivalent string representation using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

The string representation of the value of this object in the format specified by the provider parameter.

System.Byte.ToString()

Converts the value of the current System.Byte object to its equivalent string representation using the specified format.

Parameters

NameDescriptionDefault
format A numeric format string.

Returns

The string representation of the current System.Byte object, formatted as specified by the format parameter.

System.Byte.ToString()

Converts the value of the current System.Byte object to its equivalent string representation using the specified format and culture-specific formatting information.

Parameters

NameDescriptionDefault
format A standard or custom numeric format string.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of the current System.Byte object, formatted as specified by the format and provider parameters.

System.Byte.TrailingZeroCount()

Computes the number of trailing zeros in a value.

Parameters

NameDescriptionDefault
value The value whose trailing zeroes are to be counted.

Returns

The number of trailing zeros in
value
.

System.Byte.TryFormat()

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

Parameters

NameDescriptionDefault
utf8Destination The span in which to write this instance's value formatted as a span of bytes.
bytesWritten When this method returns, contains the number of bytes that were written in
utf8Destination
.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for
utf8Destination
.
provider An optional object that supplies culture-specific formatting information for
utf8Destination
.

Returns

true
if the formatting was successful; otherwise,
false
.

System.Byte.TryFormat()

Tries to format the value of the current 8-bit unsigned integer instance into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span in which to write this instance's value formatted as a span of characters.
charsWritten When this method returns, the number of characters that were written in destination.
format A span containing the charactes that represent a standard or custom format string that defines the acceptable format for destination.
provider An optional object that supplies culture-specific formatting information for destination.

Returns

true if the formatting was successful; otherwise, false.

System.Byte.TryParse()

Tries to convert a UTF-8 character span containing the string representation of a number to its 8-bit unsigned integer equivalent.

Parameters

NameDescriptionDefault
utf8Text A span containing the UTF-8 characters representing the number to convert.
result When this method returns, contains the 8-bit unsigned integer value equivalent to the number contained in utf8Text if the conversion succeeded, or zero if the conversion failed. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if utf8Text was converted successfully; otherwise, false.

System.Byte.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.Byte.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.Byte.TryParse()

Tries to convert the span representation of a number to its System.Byte equivalent, and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A span containing the characters representing the number to convert.
result When this method returns, contains the System.Byte value equivalent to the number contained in s if the conversion succeeded, or zero if the conversion failed. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Byte.TryParse()

Converts the span representation of a number in a specified style and culture-specific format to its System.Byte equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A span containing the characters representing the number to convert. The span is interpreted using the System.Globalization.NumberStyles.Integer style.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider An object that supplies culture-specific formatting information about s. If provider is null, the thread current culture is used.
result When this method returns, contains the 8-bit unsigned integer 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 or System.String.Empty, is not of the correct format, or represents a number less than Byte.MinValue or greater than Byte.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Byte.TryParse()

Tries to parse a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
, or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Byte.TryParse()

Tries to convert the string representation of a number to its System.Byte equivalent, and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A string that contains a number to convert.
result When this method returns, contains the System.Byte value equivalent to the number contained in s if the conversion succeeded, or zero if the conversion failed. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Byte.TryParse()

Converts the string representation of a number in a specified style and culture-specific format to its System.Byte equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A string containing a number to convert. The string is interpreted using the style specified by style.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider An object that supplies culture-specific formatting information about s. If provider is null, the thread current culture is used.
result When this method returns, contains the 8-bit unsigned integer 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 or System.String.Empty, is not of the correct format, or represents a number less than Byte.MinValue or greater than Byte.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Byte.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Byte.System#Numerics#IAdditiveIdentity{System#Byte@System#Byte}#AdditiveIdentity

Gets the additive identity of the current type.

System.Byte.System#Numerics#IBinaryNumber{System#Byte}#AllBitsSet

Gets an instance of the binary type in which all bits are set.

System.Byte.System#Numerics#IMinMaxValue{System#Byte}#MaxValue

Gets the maximum value of the current type.

System.Byte.System#Numerics#IMinMaxValue{System#Byte}#MinValue

Gets the minimum value of the current type.

System.Byte.System#Numerics#IMultiplicativeIdentity{System#Byte@System#Byte}#MultiplicativeIdentity

Gets the multiplicative identity of the current type.

System.Byte.System#Numerics#INumberBase{System#Byte}#One

Gets the value 1 for the type.

System.Byte.System#Numerics#INumberBase{System#Byte}#Radix

Gets the radix, or base, for the type.

System.Byte.System#Numerics#INumberBase{System#Byte}#Zero

Gets the value 0 for the type.

System.CannotUnloadAppDomainException

The exception that is thrown when an attempt to unload an application domain fails.

System.CannotUnloadAppDomainException.#ctor

Initializes a new instance of the System.CannotUnloadAppDomainException class.

System.CannotUnloadAppDomainException.#ctor()

Initializes a new instance of the System.CannotUnloadAppDomainException class from serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.CannotUnloadAppDomainException.#ctor()

Initializes a new instance of the System.CannotUnloadAppDomainException class with a specified error message.

Parameters

NameDescriptionDefault
message A System.String that describes the error.

System.CannotUnloadAppDomainException.#ctor()

Initializes a new instance of the System.CannotUnloadAppDomainException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.Char

Represents a character as a UTF-16 code unit.

System.Char.MaxValue

Represents the largest possible value of a System.Char. This field is constant.

System.Char.MinValue

Represents the smallest possible value of a System.Char. This field is constant.

System.Char.CompareTo()

Compares this instance to a specified System.Char object and indicates whether this instance precedes, follows, or appears in the same position in the sort order as the specified System.Char object.

Parameters

NameDescriptionDefault
value A System.Char object to compare.

Returns

A signed number indicating the position of this instance in the sort order in relation to the value parameter. Return Value Description Less than zero This instance precedes value. Zero This instance has the same position in the sort order as value. Greater than zero This instance follows value.

System.Char.CompareTo()

Compares this instance to a specified object and indicates whether this instance precedes, follows, or appears in the same position in the sort order as the specified System.Object.

Parameters

NameDescriptionDefault
value An object to compare this instance to, or null.

Returns

A signed number indicating the position of this instance in the sort order in relation to the value parameter. Return Value Description Less than zero This instance precedes value. Zero This instance has the same position in the sort order as value. Greater than zero This instance follows value. -or- value is null.

System.Char.ConvertFromUtf32()

Converts the specified Unicode code point into a UTF-16 encoded string.

Parameters

NameDescriptionDefault
utf32 A 21-bit Unicode code point.

Returns

A string consisting of one System.Char object or a surrogate pair of System.Char objects equivalent to the code point specified by the utf32 parameter.

System.Char.ConvertToUtf32()

Converts the value of a UTF-16 encoded surrogate pair into a Unicode code point.

Parameters

NameDescriptionDefault
highSurrogate A high surrogate code unit (that is, a code unit ranging from U+D800 through U+DBFF).
lowSurrogate A low surrogate code unit (that is, a code unit ranging from U+DC00 through U+DFFF).

Returns

The 21-bit Unicode code point represented by the highSurrogate and lowSurrogate parameters.

System.Char.ConvertToUtf32()

Converts the value of a UTF-16 encoded character or surrogate pair at a specified position in a string into a Unicode code point.

Parameters

NameDescriptionDefault
s A string that contains a character or surrogate pair.
index The index position of the character or surrogate pair in s.

Returns

The 21-bit Unicode code point represented by the character or surrogate pair at the position in the s parameter specified by the index parameter.

System.Char.Equals()

Returns a value that indicates whether this instance is equal to the specified System.Char object.

Parameters

NameDescriptionDefault
obj An object to compare to this instance.

Returns

true if the obj parameter equals the value of this instance; otherwise, false.

System.Char.Equals()

Returns a value that indicates whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance or null.

Returns

true if obj is an instance of System.Char and equals the value of this instance; otherwise, false.

System.Char.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Char.GetNumericValue()

Converts the specified numeric Unicode character to a double-precision floating point number.

Parameters

NameDescriptionDefault
c The Unicode character to convert.

Returns

The numeric value of c if that character represents a number; otherwise, -1.0.

System.Char.GetNumericValue()

Converts the numeric Unicode character at the specified position in a specified string to a double-precision floating point number.

Parameters

NameDescriptionDefault
s A System.String.
index The character position in s.

Returns

The numeric value of the character at position index in s if that character represents a number; otherwise, -1.

System.Char.GetTypeCode

Returns the System.TypeCode for value type System.Char.

Returns

The enumerated constant, System.TypeCode.Char.

System.Char.GetUnicodeCategory()

Categorizes a specified Unicode character into a group identified by one of the System.Globalization.UnicodeCategory values.

Parameters

NameDescriptionDefault
c The Unicode character to categorize.

Returns

A System.Globalization.UnicodeCategory value that identifies the group that contains c.

System.Char.GetUnicodeCategory()

Categorizes the character at the specified position in a specified string into a group identified by one of the System.Globalization.UnicodeCategory values.

Parameters

NameDescriptionDefault
s A System.String.
index The character position in s.

Returns

A System.Globalization.UnicodeCategory enumerated constant that identifies the group that contains the character at position index in s.

System.Char.IsAscii()

Returns true if c is an ASCII character ([ U+0000..U+007F ]).

Parameters

NameDescriptionDefault
c The character to analyze.

Returns

true if c is an ASCII character; false otherwise.

System.Char.IsAsciiDigit()

Indicates whether a character is categorized as an ASCII digit.

Parameters

NameDescriptionDefault
c The character to evaluate.

Returns

true if c is an ASCII digit; otherwise, false.

System.Char.IsAsciiHexDigit()

Indicates whether a character is categorized as an ASCII hexademical digit.

Parameters

NameDescriptionDefault
c The character to evaluate.

Returns

true if c is a hexademical digit; otherwise, false.

System.Char.IsAsciiHexDigitLower()

Indicates whether a character is categorized as an ASCII lower-case hexademical digit.

Parameters

NameDescriptionDefault
c The character to evaluate.

Returns

true if c is a lower-case hexademical digit; otherwise, false.

System.Char.IsAsciiHexDigitUpper()

Indicates whether a character is categorized as an ASCII upper-case hexademical digit.

Parameters

NameDescriptionDefault
c The character to evaluate.

Returns

true if c is a hexademical digit; otherwise, false.

System.Char.IsAsciiLetter()

Indicates whether a character is categorized as an ASCII letter.

Parameters

NameDescriptionDefault
c The character to evaluate.

Returns

true if c is an ASCII letter; otherwise, false.

System.Char.IsAsciiLetterLower()

Indicates whether a character is categorized as a lowercase ASCII letter.

Parameters

NameDescriptionDefault
c The character to evaluate.

Returns

true if c is a lowercase ASCII letter; otherwise, false.

System.Char.IsAsciiLetterOrDigit()

Indicates whether a character is categorized as an ASCII letter or digit.

Parameters

NameDescriptionDefault
c The character to evaluate.

Returns

true if c is an ASCII letter or digit; otherwise, false.

System.Char.IsAsciiLetterUpper()

Indicates whether a character is categorized as an uppercase ASCII letter.

Parameters

NameDescriptionDefault
c The character to evaluate.

Returns

true if c is a lowercase ASCII letter; otherwise, false.

System.Char.IsBetween()

Indicates whether a character is within the specified inclusive range.

Parameters

NameDescriptionDefault
c The character to evaluate.
minInclusive The lower bound, inclusive.
maxInclusive The upper bound, inclusive.

Returns

true if c is within the specified range; otherwise, false.

System.Char.IsControl()

Indicates whether the specified Unicode character is categorized as a control character.

Parameters

NameDescriptionDefault
c The Unicode character to evaluate.

Returns

true if c is a control character; otherwise, false.

System.Char.IsControl()

Indicates whether the character at the specified position in a specified string is categorized as a control character.

Parameters

NameDescriptionDefault
s A string.
index The position of the character to evaluate in s.

Returns

true if the character at position index in s is a control character; otherwise, false.

System.Char.IsDigit()

Indicates whether the specified Unicode character is categorized as a decimal digit.

Parameters

NameDescriptionDefault
c The Unicode character to evaluate.

Returns

true if c is a decimal digit; otherwise, false.

System.Char.IsDigit()

Indicates whether the character at the specified position in a specified string is categorized as a decimal digit.

Parameters

NameDescriptionDefault
s A string.
index The position of the character to evaluate in s.

Returns

true if the character at position index in s is a decimal digit; otherwise, false.

System.Char.IsHighSurrogate()

Indicates whether the specified System.Char object is a high surrogate.

Parameters

NameDescriptionDefault
c The Unicode character to evaluate.

Returns

true if the numeric value of the c parameter ranges from U+D800 through U+DBFF; otherwise, false.

System.Char.IsHighSurrogate()

Indicates whether the System.Char object at the specified position in a string is a high surrogate.

Parameters

NameDescriptionDefault
s A string.
index The position of the character to evaluate in s.

Returns

true if the numeric value of the specified character in the s parameter ranges from U+D800 through U+DBFF; otherwise, false.

System.Char.IsLetter()

Indicates whether the specified Unicode character is categorized as a Unicode letter.

Parameters

NameDescriptionDefault
c The Unicode character to evaluate.

Returns

true if c is a letter; otherwise, false.

System.Char.IsLetter()

Indicates whether the character at the specified position in a specified string is categorized as a Unicode letter.

Parameters

NameDescriptionDefault
s A string.
index The position of the character to evaluate in s.

Returns

true if the character at position index in s is a letter; otherwise, false.

System.Char.IsLetterOrDigit()

Indicates whether the specified Unicode character is categorized as a letter or a decimal digit.

Parameters

NameDescriptionDefault
c The Unicode character to evaluate.

Returns

true if c is a letter or a decimal digit; otherwise, false.

System.Char.IsLetterOrDigit()

Indicates whether the character at the specified position in a specified string is categorized as a letter or a decimal digit.

Parameters

NameDescriptionDefault
s A string.
index The position of the character to evaluate in s.

Returns

true if the character at position index in s is a letter or a decimal digit; otherwise, false.

System.Char.IsLower()

Indicates whether the specified Unicode character is categorized as a lowercase letter.

Parameters

NameDescriptionDefault
c The Unicode character to evaluate.

Returns

true if c is a lowercase letter; otherwise, false.

System.Char.IsLower()

Indicates whether the character at the specified position in a specified string is categorized as a lowercase letter.

Parameters

NameDescriptionDefault
s A string.
index The position of the character to evaluate in s.

Returns

true if the character at position index in s is a lowercase letter; otherwise, false.

System.Char.IsLowSurrogate()

Indicates whether the specified System.Char object is a low surrogate.

Parameters

NameDescriptionDefault
c The character to evaluate.

Returns

true if the numeric value of the c parameter ranges from U+DC00 through U+DFFF; otherwise, false.

System.Char.IsLowSurrogate()

Indicates whether the System.Char object at the specified position in a string is a low surrogate.

Parameters

NameDescriptionDefault
s A string.
index The position of the character to evaluate in s.

Returns

true if the numeric value of the specified character in the s parameter ranges from U+DC00 through U+DFFF; otherwise, false.

System.Char.IsNumber()

Indicates whether the specified Unicode character is categorized as a number.

Parameters

NameDescriptionDefault
c The Unicode character to evaluate.

Returns

true if c is a number; otherwise, false.

System.Char.IsNumber()

Indicates whether the character at the specified position in a specified string is categorized as a number.

Parameters

NameDescriptionDefault
s A string.
index The position of the character to evaluate in s.

Returns

true if the character at position index in s is a number; otherwise, false.

System.Char.IsPunctuation()

Indicates whether the specified Unicode character is categorized as a punctuation mark.

Parameters

NameDescriptionDefault
c The Unicode character to evaluate.

Returns

true if c is a punctuation mark; otherwise, false.

System.Char.IsPunctuation()

Indicates whether the character at the specified position in a specified string is categorized as a punctuation mark.

Parameters

NameDescriptionDefault
s A string.
index The position of the character to evaluate in s.

Returns

true if the character at position index in s is a punctuation mark; otherwise, false.

System.Char.IsSeparator()

Indicates whether the specified Unicode character is categorized as a separator character.

Parameters

NameDescriptionDefault
c The Unicode character to evaluate.

Returns

true if c is a separator character; otherwise, false.

System.Char.IsSeparator()

Indicates whether the character at the specified position in a specified string is categorized as a separator character.

Parameters

NameDescriptionDefault
s A string.
index The position of the character to evaluate in s.

Returns

true if the character at position index in s is a separator character; otherwise, false.

System.Char.IsSurrogate()

Indicates whether the specified character has a surrogate code unit.

Parameters

NameDescriptionDefault
c The Unicode character to evaluate.

Returns

true if c is either a high surrogate or a low surrogate; otherwise, false.

System.Char.IsSurrogate()

Indicates whether the character at the specified position in a specified string has a surrogate code unit.

Parameters

NameDescriptionDefault
s A string.
index The position of the character to evaluate in s.

Returns

true if the character at position index in s is a either a high surrogate or a low surrogate; otherwise, false.

System.Char.IsSurrogatePair()

Indicates whether the two specified System.Char objects form a surrogate pair.

Parameters

NameDescriptionDefault
highSurrogate The character to evaluate as the high surrogate of a surrogate pair.
lowSurrogate The character to evaluate as the low surrogate of a surrogate pair.

Returns

true if the numeric value of the highSurrogate parameter ranges from U+D800 through U+DBFF, and the numeric value of the lowSurrogate parameter ranges from U+DC00 through U+DFFF; otherwise, false.

System.Char.IsSurrogatePair()

Indicates whether two adjacent System.Char objects at a specified position in a string form a surrogate pair.

Parameters

NameDescriptionDefault
s A string.
index The starting position of the pair of characters to evaluate within s.

Returns

true if the s parameter includes adjacent characters at positions index and index + 1, and the numeric value of the character at position index ranges from U+D800 through U+DBFF, and the numeric value of the character at position index+1 ranges from U+DC00 through U+DFFF; otherwise, false.

System.Char.IsSymbol()

Indicates whether the specified Unicode character is categorized as a symbol character.

Parameters

NameDescriptionDefault
c The Unicode character to evaluate.

Returns

true if c is a symbol character; otherwise, false.

System.Char.IsSymbol()

Indicates whether the character at the specified position in a specified string is categorized as a symbol character.

Parameters

NameDescriptionDefault
s A string.
index The position of the character to evaluate in s.

Returns

true if the character at position index in s is a symbol character; otherwise, false.

System.Char.IsUpper()

Indicates whether the specified Unicode character is categorized as an uppercase letter.

Parameters

NameDescriptionDefault
c The Unicode character to evaluate.

Returns

true if c is an uppercase letter; otherwise, false.

System.Char.IsUpper()

Indicates whether the character at the specified position in a specified string is categorized as an uppercase letter.

Parameters

NameDescriptionDefault
s A string.
index The position of the character to evaluate in s.

Returns

true if the character at position index in s is an uppercase letter; otherwise, false.

System.Char.IsWhiteSpace()

Indicates whether the specified Unicode character is categorized as white space.

Parameters

NameDescriptionDefault
c The Unicode character to evaluate.

Returns

true if c is white space; otherwise, false.

System.Char.IsWhiteSpace()

Indicates whether the character at the specified position in a specified string is categorized as white space.

Parameters

NameDescriptionDefault
s A string.
index The position of the character to evaluate in s.

Returns

true if the character at position index in s is white space; otherwise, false.

System.Char.Parse()

Converts the value of the specified string to its equivalent Unicode character.

Parameters

NameDescriptionDefault
s A string that contains a single character, or null.

Returns

A Unicode character equivalent to the sole character in s.

System.Char.System#IConvertible#ToBoolean()

Note This conversion is not supported. Attempting to do so throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

This conversion is not supported. No value is returned.

System.Char.System#IConvertible#ToByte()

For a description of this member, see System.IConvertible.ToByte().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The converted value of the current System.Char object.

System.Char.System#IConvertible#ToChar()

For a description of this member, see System.IConvertible.ToChar().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current System.Char object unchanged.

System.Char.System#IConvertible#ToDateTime()

Note This conversion is not supported. Attempting to do so throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

No value is returned.

System.Char.System#IConvertible#ToDecimal()

Note This conversion is not supported. Attempting to do so throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

No value is returned.

System.Char.System#IConvertible#ToDouble()

Note This conversion is not supported. Attempting to do so throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

No value is returned.

System.Char.System#IConvertible#ToInt16()

For a description of this member, see System.IConvertible.ToInt16().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The converted value of the current System.Char object.

System.Char.System#IConvertible#ToInt32()

For a description of this member, see System.IConvertible.ToInt32().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The converted value of the current System.Char object.

System.Char.System#IConvertible#ToInt64()

For a description of this member, see System.IConvertible.ToInt64().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The converted value of the current System.Char object.

System.Char.System#IConvertible#ToSByte()

For a description of this member, see System.IConvertible.ToSByte().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The converted value of the current System.Char object.

System.Char.System#IConvertible#ToSingle()

Note This conversion is not supported. Attempting to do so throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

No value is returned.

System.Char.System#IConvertible#ToType()

For a description of this member, see System.IConvertible.ToType().

Parameters

NameDescriptionDefault
type A System.Type object.
provider An System.IFormatProvider object.

Returns

An object of the specified type.

System.Char.System#IConvertible#ToUInt16()

For a description of this member, see System.IConvertible.ToUInt16().

Parameters

NameDescriptionDefault
provider An System.IFormatProvider object. (Specify null because the provider parameter is ignored.)

Returns

The converted value of the current System.Char object.

System.Char.System#IConvertible#ToUInt32()

For a description of this member, see System.IConvertible.ToUInt32().

Parameters

NameDescriptionDefault
provider An System.IFormatProvider object. (Specify null because the provider parameter is ignored.)

Returns

The converted value of the current System.Char object.

System.Char.System#IConvertible#ToUInt64()

For a description of this member, see System.IConvertible.ToUInt64().

Parameters

NameDescriptionDefault
provider An System.IFormatProvider object. (Specify null because the provider parameter is ignored.)

Returns

The converted value of the current System.Char object.

System.Char.System#IFormattable#ToString()

Formats the value of the current instance using the specified format.

Parameters

NameDescriptionDefault
format The format to use. -or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the System.IFormattable implementation.
formatProvider The provider to use to format the value. -or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Returns

The value of the current instance in the specified format.

System.Char.System#IParsable{System#Char}#Parse()

Parses a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about s.

Returns

The result of parsing s.

System.Char.System#IParsable{System#Char}#TryParse()

Parameters

NameDescriptionDefault
s
provider
result

System.Char.System#ISpanFormattable#TryFormat()

Tries to format the value of the current instance into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span in which to write this instance's value formatted as a span of characters.
charsWritten When this method returns, the number of characters that were written in destination.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for destination.
provider An optional object that supplies culture-specific formatting information for destination.

Returns

true if the formatting was successful; otherwise, false.

System.Char.System#ISpanParsable{System#Char}#Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about s.

Returns

The result of parsing s.

System.Char.System#ISpanParsable{System#Char}#TryParse()

Parameters

NameDescriptionDefault
s
provider
result

System.Char.System#IUtf8SpanFormattable#TryFormat()

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

Parameters

NameDescriptionDefault
utf8Destination The span in which to write this instance's value formatted as a span of bytes.
bytesWritten When this method returns, contains the number of bytes that were written in
utf8Destination
.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for
utf8Destination
.
provider An optional object that supplies culture-specific formatting information for
utf8Destination
.

Returns

true
if the formatting was successful; otherwise,
false
.

System.Char.System#Numerics#IAdditionOperators{System#Char@System#Char@System#Char}#op_Addition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which right is added.
right The value that's added to left.

Returns

The sum of left and right.

System.Char.System#Numerics#IAdditionOperators{System#Char@System#Char@System#Char}#op_CheckedAddition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which right is added.
right The value that's added to left.

Returns

The sum of left and right.

System.Char.System#Numerics#IBinaryInteger<System#Char>#GetByteCount

Gets the number of bytes that will be written as part of .

Returns

The number of bytes that will be written as part of .

System.Char.System#Numerics#IBinaryInteger<System#Char>#GetShortestBitLength

Gets the length, in bits, of the shortest two's complement representation of the current value.

Returns

The length, in bits, of the shortest two's complement representation of the current value.

System.Char.System#Numerics#IBinaryInteger{System#Char}#LeadingZeroCount()

Computes the number of leading zero bits in a value.

Parameters

NameDescriptionDefault
value The value whose leading zero bits are to be counted.

Returns

The number of leading zero bits in value.

System.Char.System#Numerics#IBinaryInteger{System#Char}#PopCount()

Computes the number of bits that are set in a value.

Parameters

NameDescriptionDefault
value The value whose set bits are to be counted.

Returns

The number of set bits in value.

System.Char.System#Numerics#IBinaryInteger{System#Char}#RotateLeft()

Rotates a value left by a given amount.

Parameters

NameDescriptionDefault
value The value that's rotated left by rotateAmount.
rotateAmount The amount by which value is rotated left.

Returns

The result of rotating value left by rotateAmount.

System.Char.System#Numerics#IBinaryInteger{System#Char}#RotateRight()

Rotates a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that's rotated right by rotateAmount.
rotateAmount The amount by which value is rotated right.

Returns

The result of rotating value right by rotateAmount.

System.Char.System#Numerics#IBinaryInteger{System#Char}#TrailingZeroCount()

Computes the number of trailing zero bits in a value.

Parameters

NameDescriptionDefault
value The value whose trailing zero bits are to be counted.

Returns

The number of trailing zero bits in value.

System.Char.System#Numerics#IBinaryInteger{System#Char}#TryReadBigEndian()

Parameters

NameDescriptionDefault
source
isUnsigned
value

System.Char.System#Numerics#IBinaryInteger{System#Char}#TryReadLittleEndian()

Parameters

NameDescriptionDefault
source
isUnsigned
value

System.Char.System#Numerics#IBinaryInteger<System#Char>#TryWriteBigEndian()

Tries to write the current value, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the value was succesfully written to
destination
; otherwise,
false
.

System.Char.System#Numerics#IBinaryInteger<System#Char>#TryWriteLittleEndian()

Tries to write the current value, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the value was succesfully written to
destination
; otherwise,
false
.

System.Char.System#Numerics#IBinaryNumber{System#Char}#IsPow2()

Determines if a value is a power of two.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a power of two; otherwise, false.

System.Char.System#Numerics#IBinaryNumber{System#Char}#Log2()

Computes the log2 of a value.

Parameters

NameDescriptionDefault
value The value whose log2 is to be computed.

Returns

The log2 of value.

System.Char.System#Numerics#IBitwiseOperators{System#Char@System#Char@System#Char}#op_BitwiseAnd()

Computes the bitwise-and of two values.

Parameters

NameDescriptionDefault
left The value to and with right.
right The value to and with left.

Returns

The bitwise-and of left and right.

System.Char.System#Numerics#IBitwiseOperators{System#Char@System#Char@System#Char}#op_BitwiseOr()

Computes the bitwise-or of two values.

Parameters

NameDescriptionDefault
left The value to or with right.
right The value to or with left.

Returns

The bitwise-or of left and right.

System.Char.System#Numerics#IBitwiseOperators{System#Char@System#Char@System#Char}#op_ExclusiveOr()

Computes the exclusive-or of two values.

Parameters

NameDescriptionDefault
left The value to xor with right.
right The value to xor with left.

Returns

The exclusive-or of left and right.

System.Char.System#Numerics#IBitwiseOperators{System#Char@System#Char@System#Char}#op_OnesComplement()

Computes the ones-complement representation of a given value.

Parameters

NameDescriptionDefault
value The value for which to compute the ones-complement.

Returns

The ones-complement of value.

System.Char.System#Numerics#IComparisonOperators{System#Char@System#Char@System#Boolean}#op_GreaterThan()

Compares two values to determine which is greater.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is greater than right; otherwise, false.

System.Char.System#Numerics#IComparisonOperators{System#Char@System#Char@System#Boolean}#op_GreaterThanOrEqual()

Compares two values to determine which is greater or equal.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is greater than or equal to right; otherwise, false.

System.Char.System#Numerics#IComparisonOperators{System#Char@System#Char@System#Boolean}#op_LessThan()

Compares two values to determine which is less.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is less than right; otherwise, false.

System.Char.System#Numerics#IComparisonOperators{System#Char@System#Char@System#Boolean}#op_LessThanOrEqual()

Compares two values to determine which is less or equal.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is less than or equal to right; otherwise, false.

System.Char.System#Numerics#IDecrementOperators{System#Char}#op_CheckedDecrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing value.

System.Char.System#Numerics#IDecrementOperators{System#Char}#op_Decrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing value.

System.Char.System#Numerics#IDivisionOperators{System#Char@System#Char@System#Char}#op_Division()

Divides one value by another to compute their quotient.

Parameters

NameDescriptionDefault
left The value that right divides.
right The value that divides left.

Returns

The quotient of left divided by right.

System.Char.System#Numerics#IEqualityOperators{System#Char@System#Char@System#Boolean}#op_Equality()

Compares two values to determine equality.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is equal to right; otherwise, false.

System.Char.System#Numerics#IEqualityOperators{System#Char@System#Char@System#Boolean}#op_Inequality()

Compares two values to determine inequality.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is not equal to right; otherwise, false.

System.Char.System#Numerics#IIncrementOperators{System#Char}#op_CheckedIncrement()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing value.

System.Char.System#Numerics#IIncrementOperators{System#Char}#op_Increment()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing value.

System.Char.System#Numerics#IModulusOperators{System#Char@System#Char@System#Char}#op_Modulus()

Divides two values together to compute their modulus or remainder.

Parameters

NameDescriptionDefault
left The value that right divides.
right The value that divides left.

Returns

The modulus or remainder of left divided by right.

System.Char.System#Numerics#IMultiplyOperators{System#Char@System#Char@System#Char}#op_CheckedMultiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value that right multiplies.
right The value that multiplies left.

Returns

The product of left multiplied by right.

System.Char.System#Numerics#IMultiplyOperators{System#Char@System#Char@System#Char}#op_Multiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value that right multiplies.
right The value that multiplies left.

Returns

The product of left multiplied by right.

System.Char.System#Numerics#INumberBase{System#Char}#Abs()

Computes the absolute of a value.

Parameters

NameDescriptionDefault
value The value for which to get its absolute.

Returns

The absolute of value.

System.Char.System#Numerics#INumberBase{System#Char}#IsCanonical()

Determines if a value is in its canonical representation.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is in its canonical representation; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#IsComplexNumber()

Determines if a value represents a complex number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a complex number; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#IsEvenInteger()

Determines if a value represents an even integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is an even integer; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#IsFinite()

Determines if a value is finite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is finite; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#IsImaginaryNumber()

Determines if a value represents a pure imaginary number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a pure imaginary number; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#IsInfinity()

Determines if a value is infinite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is infinite; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#IsInteger()

Determines if a value represents an integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is an integer; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#IsNaN()

Determines if a value is NaN.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is NaN; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#IsNegative()

Determines if a value is negative.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is negative; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#IsNegativeInfinity()

Determines if a value is negative infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is negative infinity; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#IsNormal()

Determines if a value is normal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is normal; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#IsOddInteger()

Determines if a value represents an odd integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is an odd integer; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#IsPositive()

Determines if a value is positive.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is positive; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#IsPositiveInfinity()

Determines if a value is positive infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is positive infinity; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#IsRealNumber()

Determines if a value represents a real number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a real number; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#IsSubnormal()

Determines if a value is subnormal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is subnormal; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#IsZero()

Determines if a value is zero.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is zero; otherwise, false.

System.Char.System#Numerics#INumberBase{System#Char}#MaxMagnitude()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Char.System#Numerics#INumberBase{System#Char}#MaxMagnitudeNumber()

Compares two values to compute which has the greater magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Char.System#Numerics#INumberBase{System#Char}#MinMagnitude()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Char.System#Numerics#INumberBase{System#Char}#MinMagnitudeNumber()

Compares two values to compute which has the lesser magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Char.System#Numerics#INumberBase{System#Char}#Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
style A bitwise combination of number styles that can be present in s.
provider An object that provides culture-specific formatting information about s.

Returns

The result of parsing s.

System.Char.System#Numerics#INumberBase{System#Char}#Parse()

Parses a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
style A bitwise combination of number styles that can be present in s.
provider An object that provides culture-specific formatting information about s.

Returns

The result of parsing s.

System.Char.System#Numerics#INumberBase{System#Char}#TryConvertFromChecked``1()

Parameters

NameDescriptionDefault
value
result

System.Char.System#Numerics#INumberBase{System#Char}#TryConvertFromSaturating``1()

Parameters

NameDescriptionDefault
value
result

System.Char.System#Numerics#INumberBase{System#Char}#TryConvertFromTruncating``1()

Parameters

NameDescriptionDefault
value
result

System.Char.System#Numerics#INumberBase{System#Char}#TryConvertToChecked``1()

Tries to convert an instance of the the current type to another type, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Char.System#Numerics#INumberBase{System#Char}#TryConvertToSaturating``1()

Tries to convert an instance of the the current type to another type, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Char.System#Numerics#INumberBase{System#Char}#TryConvertToTruncating``1()

Tries to convert an instance of the the current type to another type, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Char.System#Numerics#INumberBase{System#Char}#TryParse()

Parameters

NameDescriptionDefault
s
style
provider
result

System.Char.System#Numerics#INumberBase{System#Char}#TryParse()

Parameters

NameDescriptionDefault
s
style
provider
result

System.Char.System#Numerics#IShiftOperators{System#Char@System#Int32@System#Char}#op_LeftShift()

Shifts a value left by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted left by shiftAmount.
shiftAmount The amount by which value is shifted left.

Returns

The result of shifting value left by shiftAmount.

System.Char.System#Numerics#IShiftOperators{System#Char@System#Int32@System#Char}#op_RightShift()

Shifts a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted right by shiftAmount.
shiftAmount The amount by which value is shifted right.

Returns

The result of shifting value right by shiftAmount.

System.Char.System#Numerics#IShiftOperators{System#Char@System#Int32@System#Char}#op_UnsignedRightShift()

Shifts a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted right by shiftAmount.
shiftAmount The amount by which value is shifted right.

Returns

The result of shifting value right by shiftAmount.

System.Char.System#Numerics#ISubtractionOperators{System#Char@System#Char@System#Char}#op_CheckedSubtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which right is subtracted.
right The value that's subtracted from left.

Returns

The value of right subtracted from left.

System.Char.System#Numerics#ISubtractionOperators{System#Char@System#Char@System#Char}#op_Subtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which right is subtracted.
right The value that's subtracted from left.

Returns

The value of right subtracted from left.

System.Char.System#Numerics#IUnaryNegationOperators{System#Char@System#Char}#op_CheckedUnaryNegation()

Computes the checked unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of value.

System.Char.System#Numerics#IUnaryNegationOperators{System#Char@System#Char}#op_UnaryNegation()

Computes the unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of value.

System.Char.System#Numerics#IUnaryPlusOperators{System#Char@System#Char}#op_UnaryPlus()

Computes the unary plus of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary plus.

Returns

The unary plus of value.

System.Char.ToLower()

Converts the value of a Unicode character to its lowercase equivalent.

Parameters

NameDescriptionDefault
c The Unicode character to convert.

Returns

The lowercase equivalent of c, or the unchanged value of c, if c is already lowercase or not alphabetic.

System.Char.ToLower()

Converts the value of a specified Unicode character to its lowercase equivalent using specified culture-specific formatting information.

Parameters

NameDescriptionDefault
c The Unicode character to convert.
culture An object that supplies culture-specific casing rules.

Returns

The lowercase equivalent of c, modified according to culture, or the unchanged value of c, if c is already lowercase or not alphabetic.

System.Char.ToLowerInvariant()

Converts the value of a Unicode character to its lowercase equivalent using the casing rules of the invariant culture.

Parameters

NameDescriptionDefault
c The Unicode character to convert.

Returns

The lowercase equivalent of the c parameter, or the unchanged value of c, if c is already lowercase or not alphabetic.

System.Char.ToString

Converts the value of this instance to its equivalent string representation.

Returns

The string representation of the value of this instance.

System.Char.ToString()

Converts the specified Unicode character to its equivalent string representation.

Parameters

NameDescriptionDefault
c The Unicode character to convert.

Returns

The string representation of the value of c.

System.Char.ToString()

Converts the value of this instance to its equivalent string representation using the specified culture-specific format information.

Parameters

NameDescriptionDefault
provider (Reserved) An object that supplies culture-specific formatting information.

Returns

The string representation of the value of this instance as specified by provider.

System.Char.ToUpper()

Converts the value of a Unicode character to its uppercase equivalent.

Parameters

NameDescriptionDefault
c The Unicode character to convert.

Returns

The uppercase equivalent of c, or the unchanged value of c if c is already uppercase, has no uppercase equivalent, or is not alphabetic.

System.Char.ToUpper()

Converts the value of a specified Unicode character to its uppercase equivalent using specified culture-specific formatting information.

Parameters

NameDescriptionDefault
c The Unicode character to convert.
culture An object that supplies culture-specific casing rules.

Returns

The uppercase equivalent of c, modified according to culture, or the unchanged value of c if c is already uppercase, has no uppercase equivalent, or is not alphabetic.

System.Char.ToUpperInvariant()

Converts the value of a Unicode character to its uppercase equivalent using the casing rules of the invariant culture.

Parameters

NameDescriptionDefault
c The Unicode character to convert.

Returns

The uppercase equivalent of the c parameter, or the unchanged value of c, if c is already uppercase or not alphabetic.

System.Char.TryParse()

Converts the value of the specified string to its equivalent Unicode character. A return code indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A string that contains a single character, or null.
result When this method returns, contains a Unicode character equivalent to the sole character in s, if the conversion succeeded, or an undefined value if the conversion failed. The conversion fails if the s parameter is null or the length of s is not 1. This parameter is passed uninitialized.

Returns

true if the s parameter was converted successfully; otherwise, false.

System.Char.System#Numerics#IAdditiveIdentity{System#Char@System#Char}#AdditiveIdentity

Gets the additive identity of the current type.

System.Char.System#Numerics#IBinaryNumber{System#Char}#AllBitsSet

Gets an instance of the binary type in which all bits are set.

System.Char.System#Numerics#IMinMaxValue{System#Char}#MaxValue

Gets the maximum value of the current type.

System.Char.System#Numerics#IMinMaxValue{System#Char}#MinValue

Gets the minimum value of the current type.

System.Char.System#Numerics#IMultiplicativeIdentity{System#Char@System#Char}#MultiplicativeIdentity

Gets the multiplicative identity of the current type.

System.Char.System#Numerics#INumberBase{System#Char}#One

Gets the value 1 for the type.

System.Char.System#Numerics#INumberBase{System#Char}#Radix

Gets the radix, or base, for the type.

System.Char.System#Numerics#INumberBase{System#Char}#Zero

Gets the value 0 for the type.

System.CharEnumerator

Supports iterating over a System.String object and reading its individual characters. This class cannot be inherited.

System.CharEnumerator.Clone

Creates a copy of the current System.CharEnumerator object.

Returns

An System.Object that is a copy of the current System.CharEnumerator object.

System.CharEnumerator.Dispose

Releases all resources used by the current instance of the System.CharEnumerator class.

System.CharEnumerator.MoveNext

Increments the internal index of the current System.CharEnumerator object to the next character of the enumerated string.

Returns

true if the index is successfully incremented and within the enumerated string; otherwise, false.

System.CharEnumerator.Reset

Initializes the index to a position logically before the first character of the enumerated string.

System.CharEnumerator.Current

Gets the currently referenced character in the string enumerated by this System.CharEnumerator object.

Returns

The Unicode character currently referenced by this System.CharEnumerator object.

System.CharEnumerator.System#Collections#IEnumerator#Current

Gets the currently referenced character in the string enumerated by this System.CharEnumerator object. For a description of this member, see System.Collections.IEnumerator.Current.

Returns

The boxed Unicode character currently referenced by this System.CharEnumerator object.

System.CLSCompliantAttribute

Indicates whether a program element is compliant with the Common Language Specification (CLS). This class cannot be inherited.

System.CLSCompliantAttribute.#ctor()

Initializes an instance of the System.CLSCompliantAttribute class with a Boolean value indicating whether the indicated program element is CLS-compliant.

Parameters

NameDescriptionDefault
isCompliant true if CLS-compliant; otherwise, false.

System.CLSCompliantAttribute.IsCompliant

Gets the Boolean value indicating whether the indicated program element is CLS-compliant.

Returns

true if the program element is CLS-compliant; otherwise, false.

System.CodeDom.Compiler.GeneratedCodeAttribute

Identifies code generated by a tool. This class cannot be inherited.

System.CodeDom.Compiler.GeneratedCodeAttribute.#ctor()

Initializes a new instance of the System.CodeDom.Compiler.GeneratedCodeAttribute class specifying the name and version of the tool that generated the code.

Parameters

NameDescriptionDefault
tool The name of the tool that generated the code.
version The version of the tool that generated the code.

System.CodeDom.Compiler.GeneratedCodeAttribute.Tool

Gets the name of the tool that generated the code.

Returns

The name of the tool that generated to code.

System.CodeDom.Compiler.GeneratedCodeAttribute.Version

Gets the version of the tool that generated the code.

Returns

The version of the tool that generated the code.

System.CodeDom.Compiler.IndentedTextWriter

Provides a text writer that can indent new lines by a tab string token.

System.CodeDom.Compiler.IndentedTextWriter.DefaultTabString

Specifies the default tab string. This field is constant.

System.CodeDom.Compiler.IndentedTextWriter.#ctor()

Initializes a new instance of the System.CodeDom.Compiler.IndentedTextWriter class using the specified text writer and default tab string.

Parameters

NameDescriptionDefault
writer The System.IO.TextWriter to use for output.

System.CodeDom.Compiler.IndentedTextWriter.#ctor()

Initializes a new instance of the System.CodeDom.Compiler.IndentedTextWriter class using the specified text writer and tab string.

Parameters

NameDescriptionDefault
writer The System.IO.TextWriter to use for output.
tabString The tab string to use for indentation.

System.CodeDom.Compiler.IndentedTextWriter.Close

Closes the document being written to.

System.CodeDom.Compiler.IndentedTextWriter.DisposeAsync

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

Returns

A representing the asynchronous dispose operation.

System.CodeDom.Compiler.IndentedTextWriter.Flush

Flushes the stream.

System.CodeDom.Compiler.IndentedTextWriter.FlushAsync

Clears all buffers for this asynchronously and causes any buffered data to be written to the underlying device.

Returns

A representing the asynchronous flush operation.

System.CodeDom.Compiler.IndentedTextWriter.FlushAsync()

Clears all buffers for this System.CodeDom.Compiler.IndentedTextWriter asynchronously and causes any buffered data to be written to the underlying device.

Parameters

NameDescriptionDefault
cancellationToken The System.Threading.CancellationToken to monitor for cancellation requests.

Returns

A System.Threading.Tasks.Task representing the asynchronous flush operation.

System.CodeDom.Compiler.IndentedTextWriter.OutputTabs

Outputs the tab string once for each level of indentation according to the System.CodeDom.Compiler.IndentedTextWriter.Indent property.

System.CodeDom.Compiler.IndentedTextWriter.OutputTabsAsync

Asynchronously outputs tabs to the underlying System.IO.TextWriter based on the current System.CodeDom.Compiler.IndentedTextWriter.Indent.

Returns

A System.Threading.Tasks.Task representing the asynchronous operation.

System.CodeDom.Compiler.IndentedTextWriter.Write()

Writes the text representation of a Boolean value to the text stream.

Parameters

NameDescriptionDefault
value The Boolean value to write.

System.CodeDom.Compiler.IndentedTextWriter.Write()

Writes a character to the text stream.

Parameters

NameDescriptionDefault
value The character to write.

System.CodeDom.Compiler.IndentedTextWriter.Write()

Writes a character array to the text stream.

Parameters

NameDescriptionDefault
buffer The character array to write.

System.CodeDom.Compiler.IndentedTextWriter.Write()

Writes a subarray of characters to the text stream.

Parameters

NameDescriptionDefault
buffer The character array to write data from.
index Starting index in the buffer.
count The number of characters to write.

System.CodeDom.Compiler.IndentedTextWriter.Write()

Writes the text representation of a Double to the text stream.

Parameters

NameDescriptionDefault
value The double to write.

System.CodeDom.Compiler.IndentedTextWriter.Write()

Writes the text representation of an integer to the text stream.

Parameters

NameDescriptionDefault
value The integer to write.

System.CodeDom.Compiler.IndentedTextWriter.Write()

Writes the text representation of an 8-byte integer to the text stream.

Parameters

NameDescriptionDefault
value The 8-byte integer to write.

System.CodeDom.Compiler.IndentedTextWriter.Write()

Writes the text representation of an object to the text stream.

Parameters

NameDescriptionDefault
value The object to write.

System.CodeDom.Compiler.IndentedTextWriter.Write()

Writes the text representation of a Single to the text stream.

Parameters

NameDescriptionDefault
value The single to write.

System.CodeDom.Compiler.IndentedTextWriter.Write()

Writes the specified string to the text stream.

Parameters

NameDescriptionDefault
s The string to write.

System.CodeDom.Compiler.IndentedTextWriter.Write()

Writes out a formatted string, using the same semantics as specified.

Parameters

NameDescriptionDefault
format The formatting string.
arg0 The object to write into the formatted string.

System.CodeDom.Compiler.IndentedTextWriter.Write()

Writes out a formatted string, using the same semantics as specified.

Parameters

NameDescriptionDefault
format The formatting string to use.
arg0 The first object to write into the formatted string.
arg1 The second object to write into the formatted string.

System.CodeDom.Compiler.IndentedTextWriter.Write()

Writes out a formatted string, using the same semantics as specified.

Parameters

NameDescriptionDefault
format The formatting string to use.
arg The argument array to output.

System.CodeDom.Compiler.IndentedTextWriter.WriteAsync()

Asynchronously writes the specified System.Char to the underlying System.IO.TextWriter, inserting tabs at the start of every line.

Parameters

NameDescriptionDefault
value The System.Char to write.

Returns

A System.Threading.Tasks.Task representing the asynchronous operation.

System.CodeDom.Compiler.IndentedTextWriter.WriteAsync()

Asynchronously writes the specified number of System.Chars from the specified buffer to the underlying System.IO.TextWriter, starting at the specified index, and outputting tabs at the start of every new line.

Parameters

NameDescriptionDefault
buffer The array to write from.
index Index in the array to stort writing at.
count The number of characters to write.

Returns

A System.Threading.Tasks.Task representing the asynchronous operation.

System.CodeDom.Compiler.IndentedTextWriter.WriteAsync()

Asynchronously writes the specified characters to the underlying System.IO.TextWriter, inserting tabs at the start of every line.

Parameters

NameDescriptionDefault
buffer The characters to write.
cancellationToken Token for canceling the operation.

Returns

A System.Threading.Tasks.Task representing the asynchronous operation.

System.CodeDom.Compiler.IndentedTextWriter.WriteAsync()

Asynchronously writes the specified string to the underlying System.IO.TextWriter, inserting tabs at the start of every line.

Parameters

NameDescriptionDefault
value The string to write.

Returns

A System.Threading.Tasks.Task representing the asynchronous operation.

System.CodeDom.Compiler.IndentedTextWriter.WriteAsync()

Asynchronously writes the contents of the specified System.Text.StringBuilder to the underlying System.IO.TextWriter, inserting tabs at the start of every line.

Parameters

NameDescriptionDefault
value The text to write.
cancellationToken Token for canceling the operation.

Returns

A System.Threading.Tasks.Task representing the asynchronous operation.

System.CodeDom.Compiler.IndentedTextWriter.WriteLine

Writes a line terminator.

System.CodeDom.Compiler.IndentedTextWriter.WriteLine()

Writes the text representation of a Boolean, followed by a line terminator, to the text stream.

Parameters

NameDescriptionDefault
value The Boolean to write.

System.CodeDom.Compiler.IndentedTextWriter.WriteLine()

Writes a character, followed by a line terminator, to the text stream.

Parameters

NameDescriptionDefault
value The character to write.

System.CodeDom.Compiler.IndentedTextWriter.WriteLine()

Writes a character array, followed by a line terminator, to the text stream.

Parameters

NameDescriptionDefault
buffer The character array to write.

System.CodeDom.Compiler.IndentedTextWriter.WriteLine()

Writes a subarray of characters, followed by a line terminator, to the text stream.

Parameters

NameDescriptionDefault
buffer The character array to write data from.
index Starting index in the buffer.
count The number of characters to write.

System.CodeDom.Compiler.IndentedTextWriter.WriteLine()

Writes the text representation of a Double, followed by a line terminator, to the text stream.

Parameters

NameDescriptionDefault
value The double to write.

System.CodeDom.Compiler.IndentedTextWriter.WriteLine()

Writes the text representation of an integer, followed by a line terminator, to the text stream.

Parameters

NameDescriptionDefault
value The integer to write.

System.CodeDom.Compiler.IndentedTextWriter.WriteLine()

Writes the text representation of an 8-byte integer, followed by a line terminator, to the text stream.

Parameters

NameDescriptionDefault
value The 8-byte integer to write.

System.CodeDom.Compiler.IndentedTextWriter.WriteLine()

Writes the text representation of an object, followed by a line terminator, to the text stream.

Parameters

NameDescriptionDefault
value The object to write.

System.CodeDom.Compiler.IndentedTextWriter.WriteLine()

Writes the text representation of a Single, followed by a line terminator, to the text stream.

Parameters

NameDescriptionDefault
value The single to write.

System.CodeDom.Compiler.IndentedTextWriter.WriteLine()

Writes the specified string, followed by a line terminator, to the text stream.

Parameters

NameDescriptionDefault
s The string to write.

System.CodeDom.Compiler.IndentedTextWriter.WriteLine()

Writes out a formatted string, followed by a line terminator, using the same semantics as specified.

Parameters

NameDescriptionDefault
format The formatting string.
arg0 The object to write into the formatted string.

System.CodeDom.Compiler.IndentedTextWriter.WriteLine()

Writes out a formatted string, followed by a line terminator, using the same semantics as specified.

Parameters

NameDescriptionDefault
format The formatting string to use.
arg0 The first object to write into the formatted string.
arg1 The second object to write into the formatted string.

System.CodeDom.Compiler.IndentedTextWriter.WriteLine()

Writes out a formatted string, followed by a line terminator, using the same semantics as specified.

Parameters

NameDescriptionDefault
format The formatting string to use.
arg The argument array to output.

System.CodeDom.Compiler.IndentedTextWriter.WriteLine()

Writes the text representation of a UInt32, followed by a line terminator, to the text stream.

Parameters

NameDescriptionDefault
value A UInt32 to output.

System.CodeDom.Compiler.IndentedTextWriter.WriteLineAsync

Asynchronously writes the line terminator to the underlying .

Returns

A representing the asynchronous line writing operation.

System.CodeDom.Compiler.IndentedTextWriter.WriteLineAsync()

Asynchronously writes the specified System.Char to the underlying System.IO.TextWriter followed by a line terminator, inserting tabs at the start of every line.

Parameters

NameDescriptionDefault
value The character to write.

Returns

A System.Threading.Tasks.Task representing the asynchronous operation.

System.CodeDom.Compiler.IndentedTextWriter.WriteLineAsync()

Asynchronously writes the specified number of characters from the specified buffer followed by a line terminator, to the underlying System.IO.TextWriter, starting at the specified index within the buffer, inserting tabs at the start of every line.

Parameters

NameDescriptionDefault
buffer The buffer containing characters to write.
index The index within the buffer to start writing at.
count The number of characters to write.

Returns

A System.Threading.Tasks.Task representing the asynchronous operation.

System.CodeDom.Compiler.IndentedTextWriter.WriteLineAsync()

Asynchronously writes the specified characters followed by a line terminator to the underlying System.IO.TextWriter, inserting tabs at the start of every line.

Parameters

NameDescriptionDefault
buffer The characters to write.
cancellationToken Token for canceling the operation.

Returns

A System.Threading.Tasks.Task representing the asynchronous operation.

System.CodeDom.Compiler.IndentedTextWriter.WriteLineAsync()

Asynchronously writes the specified string followed by a line terminator to the underlying System.IO.TextWriter, inserting tabs at the start of every line.

Parameters

NameDescriptionDefault
value The string to write.

Returns

A System.Threading.Tasks.Task representing the asynchronous operation.

System.CodeDom.Compiler.IndentedTextWriter.WriteLineAsync()

Asynchronously writes the contents of the specified System.Text.StringBuilder followed by a line terminator to the underlying System.IO.TextWriter, inserting tabs at the start of every line.

Parameters

NameDescriptionDefault
value The text to write.
cancellationToken Token for canceling the operation.

Returns

A System.Threading.Tasks.Task representing the asynchronous operation.

System.CodeDom.Compiler.IndentedTextWriter.WriteLineNoTabs()

Writes the specified string to a line without tabs.

Parameters

NameDescriptionDefault
s The string to write.

System.CodeDom.Compiler.IndentedTextWriter.WriteLineNoTabsAsync()

Asynchronously writes the specified string to the underlying System.IO.TextWriter without inserting tabs.

Parameters

NameDescriptionDefault
s The string to write.

Returns

A System.Threading.Tasks.Task representing the asynchronous operation.

System.CodeDom.Compiler.IndentedTextWriter.Encoding

Gets the encoding for the text writer to use.

Returns

An System.Text.Encoding that indicates the encoding for the text writer to use.

System.CodeDom.Compiler.IndentedTextWriter.Indent

Gets or sets the number of spaces to indent.

Returns

The number of spaces to indent.

System.CodeDom.Compiler.IndentedTextWriter.InnerWriter

Gets the System.IO.TextWriter to use.

Returns

The System.IO.TextWriter to use.

System.CodeDom.Compiler.IndentedTextWriter.NewLine

Gets or sets the new line character to use.

Returns

The new line character to use.

System.Collections.ArrayList

Implements the System.Collections.IList interface using an array whose size is dynamically increased as required.

System.Collections.ArrayList.#ctor

Initializes a new instance of the System.Collections.ArrayList class that is empty and has the default initial capacity.

System.Collections.ArrayList.#ctor()

Initializes a new instance of the System.Collections.ArrayList class that contains elements copied from the specified collection and that has the same initial capacity as the number of elements copied.

Parameters

NameDescriptionDefault
c The System.Collections.ICollection whose elements are copied to the new list.

System.Collections.ArrayList.#ctor()

Initializes a new instance of the System.Collections.ArrayList class that is empty and has the specified initial capacity.

Parameters

NameDescriptionDefault
capacity The number of elements that the new list can initially store.

System.Collections.ArrayList.Adapter()

Creates an System.Collections.ArrayList wrapper for a specific System.Collections.IList.

Parameters

NameDescriptionDefault
list The System.Collections.IList to wrap.

Returns

System.Collections.ArrayList.Add()

Adds an object to the end of the System.Collections.ArrayList.

Parameters

NameDescriptionDefault
value The System.Object to be added to the end of the System.Collections.ArrayList. The value can be null.

Returns

The System.Collections.ArrayList index at which the value has been added.

System.Collections.ArrayList.AddRange()

Adds the elements of an System.Collections.ICollection to the end of the System.Collections.ArrayList.

Parameters

NameDescriptionDefault
c The System.Collections.ICollection whose elements should be added to the end of the System.Collections.ArrayList. The collection itself cannot be null, but it can contain elements that are null.

System.Collections.ArrayList.BinarySearch()

Searches a range of elements in the sorted System.Collections.ArrayList for an element using the specified comparer and returns the zero-based index of the element.

Parameters

NameDescriptionDefault
index The zero-based starting index of the range to search.
count The length of the range to search.
value The System.Object to locate. The value can be null.
comparer The System.Collections.IComparer implementation to use when comparing elements. -or- null to use the default comparer that is the System.IComparable implementation of each element.

Returns

The zero-based index of value in the sorted System.Collections.ArrayList, if value is found; otherwise, a negative number, which is the bitwise complement of the index of the next element that is larger than value or, if there is no larger element, the bitwise complement of System.Collections.ArrayList.Count.

System.Collections.ArrayList.BinarySearch()

Searches the entire sorted System.Collections.ArrayList for an element using the default comparer and returns the zero-based index of the element.

Parameters

NameDescriptionDefault
value The System.Object to locate. The value can be null.

Returns

The zero-based index of value in the sorted System.Collections.ArrayList, if value is found; otherwise, a negative number, which is the bitwise complement of the index of the next element that is larger than value or, if there is no larger element, the bitwise complement of System.Collections.ArrayList.Count.

System.Collections.ArrayList.BinarySearch()

Searches the entire sorted System.Collections.ArrayList for an element using the specified comparer and returns the zero-based index of the element.

Parameters

NameDescriptionDefault
value The System.Object to locate. The value can be null.
comparer The System.Collections.IComparer implementation to use when comparing elements. -or- null to use the default comparer that is the System.IComparable implementation of each element.

Returns

The zero-based index of value in the sorted System.Collections.ArrayList, if value is found; otherwise, a negative number, which is the bitwise complement of the index of the next element that is larger than value or, if there is no larger element, the bitwise complement of System.Collections.ArrayList.Count.

System.Collections.ArrayList.Clear

Removes all elements from the System.Collections.ArrayList.

System.Collections.ArrayList.Clone

Creates a shallow copy of the System.Collections.ArrayList.

Returns

A shallow copy of the System.Collections.ArrayList.

System.Collections.ArrayList.Contains()

Determines whether an element is in the System.Collections.ArrayList.

Parameters

NameDescriptionDefault
item The System.Object to locate in the System.Collections.ArrayList. The value can be null.

Returns

true if item is found in the System.Collections.ArrayList; otherwise, false.

System.Collections.ArrayList.CopyTo()

Copies the entire System.Collections.ArrayList to a compatible one-dimensional System.Array, starting at the beginning of the target array.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ArrayList. The System.Array must have zero-based indexing.

System.Collections.ArrayList.CopyTo()

Copies the entire System.Collections.ArrayList to a compatible one-dimensional System.Array, starting at the specified index of the target array.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ArrayList. The System.Array must have zero-based indexing.
arrayIndex The zero-based index in array at which copying begins.

System.Collections.ArrayList.CopyTo()

Copies a range of elements from the System.Collections.ArrayList to a compatible one-dimensional System.Array, starting at the specified index of the target array.

Parameters

NameDescriptionDefault
index The zero-based index in the source System.Collections.ArrayList at which copying begins.
array The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ArrayList. The System.Array must have zero-based indexing.
arrayIndex The zero-based index in array at which copying begins.
count The number of elements to copy.

System.Collections.ArrayList.FixedSize()

Returns an System.Collections.ArrayList wrapper with a fixed size.

Parameters

NameDescriptionDefault
list The System.Collections.ArrayList to wrap.

Returns

An System.Collections.ArrayList wrapper with a fixed size.

System.Collections.ArrayList.FixedSize()

Returns an System.Collections.IList wrapper with a fixed size.

Parameters

NameDescriptionDefault
list The System.Collections.IList to wrap.

Returns

An System.Collections.IList wrapper with a fixed size.

System.Collections.ArrayList.GetEnumerator

Returns an enumerator for the entire System.Collections.ArrayList.

Returns

System.Collections.ArrayList.GetEnumerator()

Returns an enumerator for a range of elements in the System.Collections.ArrayList.

Parameters

NameDescriptionDefault
index The zero-based starting index of the System.Collections.ArrayList section that the enumerator should refer to.
count The number of elements in the System.Collections.ArrayList section that the enumerator should refer to.

Returns

An System.Collections.IEnumerator for the specified range of elements in the System.Collections.ArrayList.

System.Collections.ArrayList.GetRange()

Returns an System.Collections.ArrayList which represents a subset of the elements in the source System.Collections.ArrayList.

Parameters

NameDescriptionDefault
index The zero-based System.Collections.ArrayList index at which the range starts.
count The number of elements in the range.

Returns

An System.Collections.ArrayList which represents a subset of the elements in the source System.Collections.ArrayList.

System.Collections.ArrayList.IndexOf()

Searches for the specified System.Object and returns the zero-based index of the first occurrence within the entire System.Collections.ArrayList.

Parameters

NameDescriptionDefault
value The System.Object to locate in the System.Collections.ArrayList. The value can be null.

Returns

The zero-based index of the first occurrence of value within the entire System.Collections.ArrayList, if found; otherwise, -1.

System.Collections.ArrayList.IndexOf()

Searches for the specified System.Object and returns the zero-based index of the first occurrence within the range of elements in the System.Collections.ArrayList that extends from the specified index to the last element.

Parameters

NameDescriptionDefault
value The System.Object to locate in the System.Collections.ArrayList. The value can be null.
startIndex The zero-based starting index of the search. 0 (zero) is valid in an empty list.

Returns

The zero-based index of the first occurrence of value within the range of elements in the System.Collections.ArrayList that extends from startIndex to the last element, if found; otherwise, -1.

System.Collections.ArrayList.IndexOf()

Searches for the specified System.Object and returns the zero-based index of the first occurrence within the range of elements in the System.Collections.ArrayList that starts at the specified index and contains the specified number of elements.

Parameters

NameDescriptionDefault
value The System.Object to locate in the System.Collections.ArrayList. The value can be null.
startIndex The zero-based starting index of the search. 0 (zero) is valid in an empty list.
count The number of elements in the section to search.

Returns

The zero-based index of the first occurrence of value within the range of elements in the System.Collections.ArrayList that starts at startIndex and contains count number of elements, if found; otherwise, -1.

System.Collections.ArrayList.Insert()

Inserts an element into the System.Collections.ArrayList at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index at which value should be inserted.
value The System.Object to insert. The value can be null.

System.Collections.ArrayList.InsertRange()

Inserts the elements of a collection into the System.Collections.ArrayList at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index at which the new elements should be inserted.
c The System.Collections.ICollection whose elements should be inserted into the System.Collections.ArrayList. The collection itself cannot be null, but it can contain elements that are null.

System.Collections.ArrayList.LastIndexOf()

Searches for the specified System.Object and returns the zero-based index of the last occurrence within the entire System.Collections.ArrayList.

Parameters

NameDescriptionDefault
value The System.Object to locate in the System.Collections.ArrayList. The value can be null.

Returns

The zero-based index of the last occurrence of value within the entire the System.Collections.ArrayList, if found; otherwise, -1.

System.Collections.ArrayList.LastIndexOf()

Searches for the specified System.Object and returns the zero-based index of the last occurrence within the range of elements in the System.Collections.ArrayList that extends from the first element to the specified index.

Parameters

NameDescriptionDefault
value The System.Object to locate in the System.Collections.ArrayList. The value can be null.
startIndex The zero-based starting index of the backward search.

Returns

The zero-based index of the last occurrence of value within the range of elements in the System.Collections.ArrayList that extends from the first element to startIndex, if found; otherwise, -1.

System.Collections.ArrayList.LastIndexOf()

Searches for the specified System.Object and returns the zero-based index of the last occurrence within the range of elements in the System.Collections.ArrayList that contains the specified number of elements and ends at the specified index.

Parameters

NameDescriptionDefault
value The System.Object to locate in the System.Collections.ArrayList. The value can be null.
startIndex The zero-based starting index of the backward search.
count The number of elements in the section to search.

Returns

The zero-based index of the last occurrence of value within the range of elements in the System.Collections.ArrayList that contains count number of elements and ends at startIndex, if found; otherwise, -1.

System.Collections.ArrayList.ReadOnly()

Returns a read-only System.Collections.ArrayList wrapper.

Parameters

NameDescriptionDefault
list The System.Collections.ArrayList to wrap.

Returns

A read-only System.Collections.ArrayList wrapper around list.

System.Collections.ArrayList.ReadOnly()

Returns a read-only System.Collections.IList wrapper.

Parameters

NameDescriptionDefault
list The System.Collections.IList to wrap.

Returns

A read-only System.Collections.IList wrapper around list.

System.Collections.ArrayList.Remove()

Removes the first occurrence of a specific object from the System.Collections.ArrayList.

Parameters

NameDescriptionDefault
obj The System.Object to remove from the System.Collections.ArrayList. The value can be null.

System.Collections.ArrayList.RemoveAt()

Removes the element at the specified index of the System.Collections.ArrayList.

Parameters

NameDescriptionDefault
index The zero-based index of the element to remove.

System.Collections.ArrayList.RemoveRange()

Removes a range of elements from the System.Collections.ArrayList.

Parameters

NameDescriptionDefault
index The zero-based starting index of the range of elements to remove.
count The number of elements to remove.

System.Collections.ArrayList.Repeat()

Returns an System.Collections.ArrayList whose elements are copies of the specified value.

Parameters

NameDescriptionDefault
value The System.Object to copy multiple times in the new System.Collections.ArrayList. The value can be null.
count The number of times value should be copied.

Returns

An System.Collections.ArrayList with count number of elements, all of which are copies of value.

System.Collections.ArrayList.Reverse

Reverses the order of the elements in the entire System.Collections.ArrayList.

System.Collections.ArrayList.Reverse()

Reverses the order of the elements in the specified range.

Parameters

NameDescriptionDefault
index The zero-based starting index of the range to reverse.
count The number of elements in the range to reverse.

System.Collections.ArrayList.SetRange()

Copies the elements of a collection over a range of elements in the System.Collections.ArrayList.

Parameters

NameDescriptionDefault
index The zero-based System.Collections.ArrayList index at which to start copying the elements of c.
c The System.Collections.ICollection whose elements to copy to the System.Collections.ArrayList. The collection itself cannot be null, but it can contain elements that are null.

System.Collections.ArrayList.Sort

Sorts the elements in the entire System.Collections.ArrayList.

System.Collections.ArrayList.Sort()

Sorts the elements in the entire System.Collections.ArrayList using the specified comparer.

Parameters

NameDescriptionDefault
comparer The System.Collections.IComparer implementation to use when comparing elements. -or- A null reference (Nothing in Visual Basic) to use the System.IComparable implementation of each element.

System.Collections.ArrayList.Sort()

Sorts the elements in a range of elements in System.Collections.ArrayList using the specified comparer.

Parameters

NameDescriptionDefault
index The zero-based starting index of the range to sort.
count The length of the range to sort.
comparer The System.Collections.IComparer implementation to use when comparing elements. -or- A null reference (Nothing in Visual Basic) to use the System.IComparable implementation of each element.

System.Collections.ArrayList.Synchronized()

Returns an System.Collections.ArrayList wrapper that is synchronized (thread safe).

Parameters

NameDescriptionDefault
list The System.Collections.ArrayList to synchronize.

Returns

An System.Collections.ArrayList wrapper that is synchronized (thread safe).

System.Collections.ArrayList.Synchronized()

Returns an System.Collections.IList wrapper that is synchronized (thread safe).

Parameters

NameDescriptionDefault
list The System.Collections.IList to synchronize.

Returns

An System.Collections.IList wrapper that is synchronized (thread safe).

System.Collections.ArrayList.ToArray

Copies the elements of the System.Collections.ArrayList to a new System.Object array.

Returns

An System.Object array containing copies of the elements of the System.Collections.ArrayList.

System.Collections.ArrayList.ToArray()

Copies the elements of the System.Collections.ArrayList to a new array of the specified element type.

Parameters

NameDescriptionDefault
type The element System.Type of the destination array to create and copy elements to.

Returns

An array of the specified element type containing copies of the elements of the System.Collections.ArrayList.

System.Collections.ArrayList.TrimToSize

Sets the capacity to the actual number of elements in the System.Collections.ArrayList.

System.Collections.ArrayList.Capacity

Gets or sets the number of elements that the System.Collections.ArrayList can contain.

Returns

The number of elements that the System.Collections.ArrayList can contain.

System.Collections.ArrayList.Count

Gets the number of elements actually contained in the System.Collections.ArrayList.

Returns

The number of elements actually contained in the System.Collections.ArrayList.

System.Collections.ArrayList.IsFixedSize

Gets a value indicating whether the System.Collections.ArrayList has a fixed size.

Returns

true if the System.Collections.ArrayList has a fixed size; otherwise, false. The default is false.

System.Collections.ArrayList.IsReadOnly

Gets a value indicating whether the System.Collections.ArrayList is read-only.

Returns

true if the System.Collections.ArrayList is read-only; otherwise, false. The default is false.

System.Collections.ArrayList.IsSynchronized

Gets a value indicating whether access to the System.Collections.ArrayList is synchronized (thread safe).

Returns

true if access to the System.Collections.ArrayList is synchronized (thread safe); otherwise, false. The default is false.

System.Collections.ArrayList.Item()

Gets or sets the element at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index of the element to get or set.

Returns

The element at the specified index.

System.Collections.ArrayList.SyncRoot

Gets an object that can be used to synchronize access to the System.Collections.ArrayList.

Returns

An object that can be used to synchronize access to the System.Collections.ArrayList.

System.Collections.Comparer

Compares two objects for equivalence, where string comparisons are case-sensitive.

System.Collections.Comparer.Default

Represents an instance of System.Collections.Comparer that is associated with the System.Threading.Thread.CurrentCulture of the current thread. This field is read-only.

System.Collections.Comparer.DefaultInvariant

Represents an instance of System.Collections.Comparer that is associated with System.Globalization.CultureInfo.InvariantCulture. This field is read-only.

System.Collections.Comparer.#ctor()

Initializes a new instance of the System.Collections.Comparer class using the specified System.Globalization.CultureInfo.

Parameters

NameDescriptionDefault
culture The System.Globalization.CultureInfo to use for the new System.Collections.Comparer.

System.Collections.Comparer.Compare()

Performs a case-sensitive comparison of two objects of the same type and returns a value indicating whether one is less than, equal to, or greater than the other.

Parameters

NameDescriptionDefault
a The first object to compare.
b The second object to compare.

Returns

A signed integer that indicates the relative values of a and b, as shown in the following table. Value Meaning Less than zeroa is less than b. Zeroa equals b. Greater than zeroa is greater than b.

System.Collections.Comparer.GetObjectData()

Populates a System.Runtime.Serialization.SerializationInfo object with the data required for serialization.

Parameters

NameDescriptionDefault
info The object to populate with data.
context The context information about the source or destination of the serialization.

System.Collections.DictionaryEntry

Defines a dictionary key/value pair that can be set or retrieved.

System.Collections.DictionaryEntry.#ctor()

Initializes an instance of the System.Collections.DictionaryEntry type with the specified key and value.

Parameters

NameDescriptionDefault
key The object defined in each key/value pair.
value The definition associated with key.

System.Collections.DictionaryEntry.Deconstruct()

Deconstructs the current System.Collections.DictionaryEntry.

Parameters

NameDescriptionDefault
key The key of the current System.Collections.DictionaryEntry.
value The value of the current System.Collections.DictionaryEntry.

System.Collections.DictionaryEntry.Key

Gets or sets the key in the key/value pair.

Returns

The key in the key/value pair.

System.Collections.DictionaryEntry.Value

Gets or sets the value in the key/value pair.

Returns

The value in the key/value pair.

System.Collections.Generic.IAsyncEnumerable`1

Exposes an enumerator that provides asynchronous iteration over values of a specified type.

System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator()

Returns an enumerator that iterates asynchronously through the collection.

Parameters

NameDescriptionDefault
cancellationToken A System.Threading.CancellationToken that may be used to cancel the asynchronous iteration.

Returns

An enumerator that can be used to iterate asynchronously through the collection.

System.Collections.Generic.IAsyncEnumerator`1

Supports a simple asynchronous iteration over a generic collection.

System.Collections.Generic.IAsyncEnumerator`1.MoveNextAsync

Advances the enumerator asynchronously to the next element of the collection.

Returns

A System.Threading.Tasks.ValueTask`1 that will complete with a result of true if the enumerator was successfully advanced to the next element, or false if the enumerator has passed the end of the collection.

System.Collections.Generic.IAsyncEnumerator`1.Current

Gets the element in the collection at the current position of the enumerator.

Returns

The element in the collection at the current position of the enumerator.

System.Collections.Generic.ICollection`1

Defines methods to manipulate generic collections.

System.Collections.Generic.ICollection`1.Add()

Parameters

NameDescriptionDefault
item The object to add to the System.Collections.Generic.ICollection`1.

System.Collections.Generic.ICollection`1.Clear

Removes all items from the System.Collections.Generic.ICollection`1.

System.Collections.Generic.ICollection`1.Contains()

Determines whether the System.Collections.Generic.ICollection`1 contains a specific value.

Parameters

NameDescriptionDefault
item The object to locate in the System.Collections.Generic.ICollection`1.

Returns

true if item is found in the System.Collections.Generic.ICollection`1; otherwise, false.

System.Collections.Generic.ICollection`1.CopyTo()

Copies the elements of the System.Collections.Generic.ICollection`1 to an System.Array, starting at a particular System.Array index.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Generic.ICollection`1. The System.Array must have zero-based indexing.
arrayIndex The zero-based index in array at which copying begins.

System.Collections.Generic.ICollection`1.Remove()

Removes the first occurrence of a specific object from the System.Collections.Generic.ICollection`1.

Parameters

NameDescriptionDefault
item The object to remove from the System.Collections.Generic.ICollection`1.

Returns

true if item was successfully removed from the System.Collections.Generic.ICollection`1; otherwise, false. This method also returns false if item is not found in the original System.Collections.Generic.ICollection`1.

System.Collections.Generic.ICollection`1.Count

Gets the number of elements contained in the System.Collections.Generic.ICollection`1.

Returns

The number of elements contained in the System.Collections.Generic.ICollection`1.

System.Collections.Generic.ICollection`1.IsReadOnly

Gets a value indicating whether the System.Collections.Generic.ICollection`1 is read-only.

Returns

true if the System.Collections.Generic.ICollection`1 is read-only; otherwise, false.

System.Collections.Generic.IComparer`1

Defines a method that a type implements to compare two objects.

System.Collections.Generic.IComparer`1.Compare()

Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other.

Parameters

NameDescriptionDefault
x The first object to compare.
y The second object to compare.

Returns

A signed integer that indicates the relative values of x and y, as shown in the following table. Value Meaning Less than zerox is less than y. Zerox equals y. Greater than zerox is greater than y.

System.Collections.Generic.IDictionary`2

Represents a generic collection of key/value pairs.

System.Collections.Generic.IDictionary`2.Add()

Adds an element with the provided key and value to the System.Collections.Generic.IDictionary`2.

Parameters

NameDescriptionDefault
key The object to use as the key of the element to add.
value The object to use as the value of the element to add.

System.Collections.Generic.IDictionary`2.ContainsKey()

Determines whether the System.Collections.Generic.IDictionary`2 contains an element with the specified key.

Parameters

NameDescriptionDefault
key The key to locate in the System.Collections.Generic.IDictionary`2.

Returns

true if the System.Collections.Generic.IDictionary`2 contains an element with the key; otherwise, false.

System.Collections.Generic.IDictionary`2.Remove()

Removes the element with the specified key from the System.Collections.Generic.IDictionary`2.

Parameters

NameDescriptionDefault
key The key of the element to remove.

Returns

true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original System.Collections.Generic.IDictionary`2.

System.Collections.Generic.IDictionary`2.TryGetValue()

Gets the value associated with the specified key.

Parameters

NameDescriptionDefault
key The key whose value to get.
value When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.

Returns

true if the object that implements System.Collections.Generic.IDictionary`2 contains an element with the specified key; otherwise, false.

System.Collections.Generic.IDictionary`2.Item()

Gets or sets the element with the specified key.

Parameters

NameDescriptionDefault
key The key of the element to get or set.

Returns

The element with the specified key.

System.Collections.Generic.IDictionary`2.Keys

Returns

An System.Collections.Generic.ICollection`1 containing the keys of the object that implements System.Collections.Generic.IDictionary`2.

System.Collections.Generic.IDictionary`2.Values

Returns

An System.Collections.Generic.ICollection`1 containing the values in the object that implements System.Collections.Generic.IDictionary`2.

System.Collections.Generic.IEnumerable`1

Exposes the enumerator, which supports a simple iteration over a collection of a specified type.

System.Collections.Generic.IEnumerable`1.GetEnumerator

Returns an enumerator that iterates through the collection.

Returns

An enumerator that can be used to iterate through the collection.

System.Collections.Generic.IEnumerator`1

Supports a simple iteration over a generic collection.

System.Collections.Generic.IEnumerator`1.Current

Gets the element in the collection at the current position of the enumerator.

Returns

The element in the collection at the current position of the enumerator.

System.Collections.Generic.IEqualityComparer`1

Defines methods to support the comparison of objects for equality.

System.Collections.Generic.IEqualityComparer`1.Equals()

Determines whether the specified objects are equal.

Parameters

NameDescriptionDefault
x The first object of type T to compare.
y The second object of type T to compare.

Returns

true if the specified objects are equal; otherwise, false.

System.Collections.Generic.IEqualityComparer`1.GetHashCode()

Returns a hash code for the specified object.

Parameters

NameDescriptionDefault
obj The System.Object for which a hash code is to be returned.

Returns

A hash code for the specified object.

System.Collections.Generic.IList`1

Represents a collection of objects that can be individually accessed by index.

System.Collections.Generic.IList`1.IndexOf()

Determines the index of a specific item in the System.Collections.Generic.IList`1.

Parameters

NameDescriptionDefault
item The object to locate in the System.Collections.Generic.IList`1.

Returns

The index of item if found in the list; otherwise, -1.

System.Collections.Generic.IList`1.Insert()

Inserts an item to the System.Collections.Generic.IList`1 at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index at which item should be inserted.
item The object to insert into the System.Collections.Generic.IList`1.

System.Collections.Generic.IList`1.RemoveAt()

Removes the System.Collections.Generic.IList`1 item at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index of the item to remove.

System.Collections.Generic.IList`1.Item()

Gets or sets the element at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index of the element to get or set.

Returns

The element at the specified index.

System.Collections.Generic.IReadOnlyCollection`1

Represents a strongly-typed, read-only collection of elements.

System.Collections.Generic.IReadOnlyCollection`1.Count

Gets the number of elements in the collection.

Returns

The number of elements in the collection.

System.Collections.Generic.IReadOnlyDictionary`2

Represents a generic read-only collection of key/value pairs.

System.Collections.Generic.IReadOnlyDictionary`2.ContainsKey()

Determines whether the read-only dictionary contains an element that has the specified key.

Parameters

NameDescriptionDefault
key The key to locate.

Returns

true if the read-only dictionary contains an element that has the specified key; otherwise, false.

System.Collections.Generic.IReadOnlyDictionary`2.TryGetValue()

Gets the value that is associated with the specified key.

Parameters

NameDescriptionDefault
key The key to locate.
value When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.

Returns

true if the object that implements the System.Collections.Generic.IReadOnlyDictionary`2 interface contains an element that has the specified key; otherwise, false.

System.Collections.Generic.IReadOnlyDictionary`2.Item()

Gets the element that has the specified key in the read-only dictionary.

Parameters

NameDescriptionDefault
key The key to locate.

Returns

The element that has the specified key in the read-only dictionary.

System.Collections.Generic.IReadOnlyDictionary`2.Keys

Gets an enumerable collection that contains the keys in the read-only dictionary.

Returns

An enumerable collection that contains the keys in the read-only dictionary.

System.Collections.Generic.IReadOnlyDictionary`2.Values

Gets an enumerable collection that contains the values in the read-only dictionary.

Returns

An enumerable collection that contains the values in the read-only dictionary.

System.Collections.Generic.IReadOnlyList`1

Represents a read-only collection of elements that can be accessed by index.

System.Collections.Generic.IReadOnlyList`1.Item()

Gets the element at the specified index in the read-only list.

Parameters

NameDescriptionDefault
index The zero-based index of the element to get.

Returns

The element at the specified index in the read-only list.

System.Collections.Generic.IReadOnlySet`1

Provides a readonly abstraction of a set.

System.Collections.Generic.IReadOnlySet`1.Contains()

Determines if the set contains a specific item.

Parameters

NameDescriptionDefault
item The item to check if the set contains.

Returns

true if found; otherwise false.

System.Collections.Generic.IReadOnlySet`1.IsProperSubsetOf()

Determines whether the current set is a proper (strict) subset of a specified collection.

Parameters

NameDescriptionDefault
other The collection to compare to the current set.

Returns

true if the current set is a proper subset of other; otherwise false.

System.Collections.Generic.IReadOnlySet`1.IsProperSupersetOf()

Determines whether the current set is a proper (strict) superset of a specified collection.

Parameters

NameDescriptionDefault
other The collection to compare to the current set.

Returns

true if the collection is a proper superset of other; otherwise false.

System.Collections.Generic.IReadOnlySet`1.IsSubsetOf()

Determine whether the current set is a subset of a specified collection.

Parameters

NameDescriptionDefault
other The collection to compare to the current set.

Returns

true if the current set is a subset of other; otherwise false.

System.Collections.Generic.IReadOnlySet`1.IsSupersetOf()

Determine whether the current set is a super set of a specified collection.

Parameters

NameDescriptionDefault
other The collection to compare to the current set.

Returns

true if the current set is a subset of other; otherwise false.

System.Collections.Generic.IReadOnlySet`1.Overlaps()

Determines whether the current set overlaps with the specified collection.

Parameters

NameDescriptionDefault
other The collection to compare to the current set.

Returns

trueif the current set and other share at least one common element; otherwise, false.

System.Collections.Generic.IReadOnlySet`1.SetEquals()

Determines whether the current set and the specified collection contain the same elements.

Parameters

NameDescriptionDefault
other The collection to compare to the current set.

Returns

true if the current set is equal to other; otherwise, false.

System.Collections.Generic.ISet`1

Provides the base interface for the abstraction of sets.

System.Collections.Generic.ISet`1.Add()

Adds an element to the current set and returns a value to indicate if the element was successfully added.

Parameters

NameDescriptionDefault
item The element to add to the set.

Returns

true if the element is added to the set; false if the element is already in the set.

System.Collections.Generic.ISet`1.ExceptWith()

Removes all elements in the specified collection from the current set.

Parameters

NameDescriptionDefault
other The collection of items to remove from the set.

System.Collections.Generic.ISet`1.IntersectWith()

Modifies the current set so that it contains only elements that are also in a specified collection.

Parameters

NameDescriptionDefault
other The collection to compare to the current set.

System.Collections.Generic.ISet`1.IsProperSubsetOf()

Determines whether the current set is a proper (strict) subset of a specified collection.

Parameters

NameDescriptionDefault
other The collection to compare to the current set.

Returns

true if the current set is a proper subset of other; otherwise, false.

System.Collections.Generic.ISet`1.IsProperSupersetOf()

Determines whether the current set is a proper (strict) superset of a specified collection.

Parameters

NameDescriptionDefault
other The collection to compare to the current set.

Returns

true if the current set is a proper superset of other; otherwise, false.

System.Collections.Generic.ISet`1.IsSubsetOf()

Determines whether a set is a subset of a specified collection.

Parameters

NameDescriptionDefault
other The collection to compare to the current set.

Returns

true if the current set is a subset of other; otherwise, false.

System.Collections.Generic.ISet`1.IsSupersetOf()

Determines whether the current set is a superset of a specified collection.

Parameters

NameDescriptionDefault
other The collection to compare to the current set.

Returns

true if the current set is a superset of other; otherwise, false.

System.Collections.Generic.ISet`1.Overlaps()

Determines whether the current set overlaps with the specified collection.

Parameters

NameDescriptionDefault
other The collection to compare to the current set.

Returns

true if the current set and other share at least one common element; otherwise, false.

System.Collections.Generic.ISet`1.SetEquals()

Determines whether the current set and the specified collection contain the same elements.

Parameters

NameDescriptionDefault
other The collection to compare to the current set.

Returns

true if the current set is equal to other; otherwise, false.

System.Collections.Generic.ISet`1.SymmetricExceptWith()

Modifies the current set so that it contains only elements that are present either in the current set or in the specified collection, but not both.

Parameters

NameDescriptionDefault
other The collection to compare to the current set.

System.Collections.Generic.ISet`1.UnionWith()

Modifies the current set so that it contains all elements that are present in the current set, in the specified collection, or in both.

Parameters

NameDescriptionDefault
other The collection to compare to the current set.

System.Collections.Generic.KeyNotFoundException

The exception that is thrown when the key specified for accessing an element in a collection does not match any key in the collection.

System.Collections.Generic.KeyNotFoundException.#ctor

Initializes a new instance of the System.Collections.Generic.KeyNotFoundException class using default property values.

System.Collections.Generic.KeyNotFoundException.#ctor()

Initializes a new instance of the System.Collections.Generic.KeyNotFoundException class with serialized data.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.Collections.Generic.KeyNotFoundException.#ctor()

Initializes a new instance of the System.Collections.Generic.KeyNotFoundException class with the specified error message.

Parameters

NameDescriptionDefault
message The message that describes the error.

System.Collections.Generic.KeyNotFoundException.#ctor()

Initializes a new instance of the System.Collections.Generic.KeyNotFoundException class with the specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.Collections.Generic.KeyValuePair

Creates instances of the System.Collections.Generic.KeyValuePair`2 struct.

System.Collections.Generic.KeyValuePair.Create``2()

Creates a new key/value pair instance using provided values.

Parameters

NameDescriptionDefault
key The key of the new System.Collections.Generic.KeyValuePair`2 to be created.
value The value of the new System.Collections.Generic.KeyValuePair`2 to be created.

Returns

A key/value pair containing the provided arguments as values.

System.Collections.Generic.KeyValuePair`2

Defines a key/value pair that can be set or retrieved.

System.Collections.Generic.KeyValuePair`2.#ctor()

Initializes a new instance of the System.Collections.Generic.KeyValuePair`2 structure with the specified key and value.

Parameters

NameDescriptionDefault
key The object defined in each key/value pair.
value The definition associated with key.

System.Collections.Generic.KeyValuePair`2.Deconstruct()

Deconstructs the current System.Collections.Generic.KeyValuePair`2.

Parameters

NameDescriptionDefault
key The key of the current System.Collections.Generic.KeyValuePair`2.
value The value of the current System.Collections.Generic.KeyValuePair`2.

System.Collections.Generic.KeyValuePair`2.ToString

Returns a string representation of the System.Collections.Generic.KeyValuePair`2, using the string representations of the key and value.

Returns

A string representation of the System.Collections.Generic.KeyValuePair`2, which includes the string representations of the key and value.

System.Collections.Generic.KeyValuePair`2.Key

Gets the key in the key/value pair.

Returns

A that is the key of the System.Collections.Generic.KeyValuePair`2.

System.Collections.Generic.KeyValuePair`2.Value

Gets the value in the key/value pair.

Returns

A that is the value of the System.Collections.Generic.KeyValuePair`2.

System.Collections.Hashtable

Represents a collection of key/value pairs that are organized based on the hash code of the key.

System.Collections.Hashtable.#ctor

Initializes a new, empty instance of the System.Collections.Hashtable class using the default initial capacity, load factor, hash code provider, and comparer.

System.Collections.Hashtable.#ctor()

Initializes a new instance of the System.Collections.Hashtable class by copying the elements from the specified dictionary to the new System.Collections.Hashtable object. The new System.Collections.Hashtable object has an initial capacity equal to the number of elements copied, and uses the default load factor, hash code provider, and comparer.

Parameters

NameDescriptionDefault
d The System.Collections.IDictionary object to copy to a new System.Collections.Hashtable object.

System.Collections.Hashtable.#ctor()

Initializes a new instance of the System.Collections.Hashtable class by copying the elements from the specified dictionary to a new System.Collections.Hashtable object. The new System.Collections.Hashtable object has an initial capacity equal to the number of elements copied, and uses the default load factor and the specified System.Collections.IEqualityComparer object.

Parameters

NameDescriptionDefault
d The System.Collections.IDictionary object to copy to a new System.Collections.Hashtable object.
equalityComparer The System.Collections.IEqualityComparer object that defines the hash code provider and the comparer to use with the System.Collections.Hashtable. -or- null to use the default hash code provider and the default comparer. The default hash code provider is each key's implementation of System.Object.GetHashCode and the default comparer is each key's implementation of System.Object.Equals().

System.Collections.Hashtable.#ctor()

Initializes a new instance of the System.Collections.Hashtable class by copying the elements from the specified dictionary to the new System.Collections.Hashtable object. The new System.Collections.Hashtable object has an initial capacity equal to the number of elements copied, and uses the default load factor, and the specified hash code provider and comparer. This API is obsolete. For an alternative, see System.Collections.Hashtable.#ctor().

Parameters

NameDescriptionDefault
d The System.Collections.IDictionary object to copy to a new System.Collections.Hashtable object.
hcp The System.Collections.IHashCodeProvider object that supplies the hash codes for all keys in the System.Collections.Hashtable. -or- null to use the default hash code provider, which is each key's implementation of System.Object.GetHashCode.
comparer The System.Collections.IComparer object to use to determine whether two keys are equal. -or- null to use the default comparer, which is each key's implementation of System.Object.Equals().

System.Collections.Hashtable.#ctor()

Initializes a new instance of the System.Collections.Hashtable class by copying the elements from the specified dictionary to the new System.Collections.Hashtable object. The new System.Collections.Hashtable object has an initial capacity equal to the number of elements copied, and uses the specified load factor, and the default hash code provider and comparer.

Parameters

NameDescriptionDefault
d The System.Collections.IDictionary object to copy to a new System.Collections.Hashtable object.
loadFactor A number in the range from 0.1 through 1.0 that is multiplied by the default value which provides the best performance. The result is the maximum ratio of elements to buckets.

System.Collections.Hashtable.#ctor()

Initializes a new instance of the System.Collections.Hashtable class by copying the elements from the specified dictionary to the new System.Collections.Hashtable object. The new System.Collections.Hashtable object has an initial capacity equal to the number of elements copied, and uses the specified load factor and System.Collections.IEqualityComparer object.

Parameters

NameDescriptionDefault
d The System.Collections.IDictionary object to copy to a new System.Collections.Hashtable object.
loadFactor A number in the range from 0.1 through 1.0 that is multiplied by the default value which provides the best performance. The result is the maximum ratio of elements to buckets.
equalityComparer The System.Collections.IEqualityComparer object that defines the hash code provider and the comparer to use with the System.Collections.Hashtable. -or- null to use the default hash code provider and the default comparer. The default hash code provider is each key's implementation of System.Object.GetHashCode and the default comparer is each key's implementation of System.Object.Equals().

System.Collections.Hashtable.#ctor()

Initializes a new instance of the System.Collections.Hashtable class by copying the elements from the specified dictionary to the new System.Collections.Hashtable object. The new System.Collections.Hashtable object has an initial capacity equal to the number of elements copied, and uses the specified load factor, hash code provider, and comparer.

Parameters

NameDescriptionDefault
d The System.Collections.IDictionary object to copy to a new System.Collections.Hashtable object.
loadFactor A number in the range from 0.1 through 1.0 that is multiplied by the default value which provides the best performance. The result is the maximum ratio of elements to buckets.
hcp The System.Collections.IHashCodeProvider object that supplies the hash codes for all keys in the System.Collections.Hashtable. -or- null to use the default hash code provider, which is each key's implementation of System.Object.GetHashCode.
comparer The System.Collections.IComparer object to use to determine whether two keys are equal. -or- null to use the default comparer, which is each key's implementation of System.Object.Equals().

System.Collections.Hashtable.#ctor()

Initializes a new, empty instance of the System.Collections.Hashtable class using the default initial capacity and load factor, and the specified System.Collections.IEqualityComparer object.

Parameters

NameDescriptionDefault
equalityComparer The System.Collections.IEqualityComparer object that defines the hash code provider and the comparer to use with the System.Collections.Hashtable object. -or- null to use the default hash code provider and the default comparer. The default hash code provider is each key's implementation of System.Object.GetHashCode and the default comparer is each key's implementation of System.Object.Equals().

System.Collections.Hashtable.#ctor()

Initializes a new, empty instance of the System.Collections.Hashtable class using the default initial capacity and load factor, and the specified hash code provider and comparer.

Parameters

NameDescriptionDefault
hcp The System.Collections.IHashCodeProvider object that supplies the hash codes for all keys in the System.Collections.Hashtable object. -or- null to use the default hash code provider, which is each key's implementation of System.Object.GetHashCode.
comparer The System.Collections.IComparer object to use to determine whether two keys are equal. -or- null to use the default comparer, which is each key's implementation of System.Object.Equals().

System.Collections.Hashtable.#ctor()

Initializes a new, empty instance of the System.Collections.Hashtable class using the specified initial capacity, and the default load factor, hash code provider, and comparer.

Parameters

NameDescriptionDefault
capacity The approximate number of elements that the System.Collections.Hashtable object can initially contain.

System.Collections.Hashtable.#ctor()

Initializes a new, empty instance of the System.Collections.Hashtable class using the specified initial capacity and System.Collections.IEqualityComparer, and the default load factor.

Parameters

NameDescriptionDefault
capacity The approximate number of elements that the System.Collections.Hashtable object can initially contain.
equalityComparer The System.Collections.IEqualityComparer object that defines the hash code provider and the comparer to use with the System.Collections.Hashtable. -or- null to use the default hash code provider and the default comparer. The default hash code provider is each key's implementation of System.Object.GetHashCode and the default comparer is each key's implementation of System.Object.Equals().

System.Collections.Hashtable.#ctor()

Initializes a new, empty instance of the System.Collections.Hashtable class using the specified initial capacity, hash code provider, comparer, and the default load factor.

Parameters

NameDescriptionDefault
capacity The approximate number of elements that the System.Collections.Hashtable object can initially contain.
hcp The System.Collections.IHashCodeProvider object that supplies the hash codes for all keys in the System.Collections.Hashtable. -or- null to use the default hash code provider, which is each key's implementation of System.Object.GetHashCode.
comparer The System.Collections.IComparer object to use to determine whether two keys are equal. -or- null to use the default comparer, which is each key's implementation of System.Object.Equals().

System.Collections.Hashtable.#ctor()

Initializes a new, empty instance of the System.Collections.Hashtable class using the specified initial capacity and load factor, and the default hash code provider and comparer.

Parameters

NameDescriptionDefault
capacity The approximate number of elements that the System.Collections.Hashtable object can initially contain.
loadFactor A number in the range from 0.1 through 1.0 that is multiplied by the default value which provides the best performance. The result is the maximum ratio of elements to buckets.

System.Collections.Hashtable.#ctor()

Initializes a new, empty instance of the System.Collections.Hashtable class using the specified initial capacity, load factor, and System.Collections.IEqualityComparer object.

Parameters

NameDescriptionDefault
capacity The approximate number of elements that the System.Collections.Hashtable object can initially contain.
loadFactor A number in the range from 0.1 through 1.0 that is multiplied by the default value which provides the best performance. The result is the maximum ratio of elements to buckets.
equalityComparer The System.Collections.IEqualityComparer object that defines the hash code provider and the comparer to use with the System.Collections.Hashtable. -or- null to use the default hash code provider and the default comparer. The default hash code provider is each key's implementation of System.Object.GetHashCode and the default comparer is each key's implementation of System.Object.Equals().

System.Collections.Hashtable.#ctor()

Initializes a new, empty instance of the System.Collections.Hashtable class using the specified initial capacity, load factor, hash code provider, and comparer.

Parameters

NameDescriptionDefault
capacity The approximate number of elements that the System.Collections.Hashtable object can initially contain.
loadFactor A number in the range from 0.1 through 1.0 that is multiplied by the default value which provides the best performance. The result is the maximum ratio of elements to buckets.
hcp The System.Collections.IHashCodeProvider object that supplies the hash codes for all keys in the System.Collections.Hashtable. -or- null to use the default hash code provider, which is each key's implementation of System.Object.GetHashCode.
comparer The System.Collections.IComparer object to use to determine whether two keys are equal. -or- null to use the default comparer, which is each key's implementation of System.Object.Equals().

System.Collections.Hashtable.#ctor()

Initializes a new, empty instance of the System.Collections.Hashtable class that is serializable using the specified System.Runtime.Serialization.SerializationInfo and System.Runtime.Serialization.StreamingContext objects.

Parameters

NameDescriptionDefault
info A System.Runtime.Serialization.SerializationInfo object containing the information required to serialize the System.Collections.Hashtable object.
context A System.Runtime.Serialization.StreamingContext object containing the source and destination of the serialized stream associated with the System.Collections.Hashtable.

System.Collections.Hashtable.Add()

Adds an element with the specified key and value into the System.Collections.Hashtable.

Parameters

NameDescriptionDefault
key The key of the element to add.
value The value of the element to add. The value can be null.

System.Collections.Hashtable.Clear

Removes all elements from the System.Collections.Hashtable.

System.Collections.Hashtable.Clone

Creates a shallow copy of the System.Collections.Hashtable.

Returns

A shallow copy of the System.Collections.Hashtable.

System.Collections.Hashtable.Contains()

Determines whether the System.Collections.Hashtable contains a specific key.

Parameters

NameDescriptionDefault
key The key to locate in the System.Collections.Hashtable.

Returns

true if the System.Collections.Hashtable contains an element with the specified key; otherwise, false.

System.Collections.Hashtable.ContainsKey()

Determines whether the System.Collections.Hashtable contains a specific key.

Parameters

NameDescriptionDefault
key The key to locate in the System.Collections.Hashtable.

Returns

true if the System.Collections.Hashtable contains an element with the specified key; otherwise, false.

System.Collections.Hashtable.ContainsValue()

Determines whether the System.Collections.Hashtable contains a specific value.

Parameters

NameDescriptionDefault
value The value to locate in the System.Collections.Hashtable. The value can be null.

Returns

true if the System.Collections.Hashtable contains an element with the specified value; otherwise, false.

System.Collections.Hashtable.CopyTo()

Copies the System.Collections.Hashtable elements to a one-dimensional System.Array instance at the specified index.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array that is the destination of the System.Collections.DictionaryEntry objects copied from System.Collections.Hashtable. The System.Array must have zero-based indexing.
arrayIndex The zero-based index in array at which copying begins.

System.Collections.Hashtable.GetEnumerator

Returns

System.Collections.Hashtable.GetHash()

Returns the hash code for the specified key.

Parameters

NameDescriptionDefault
key The System.Object for which a hash code is to be returned.

Returns

The hash code for key.

System.Collections.Hashtable.GetObjectData()

Implements the System.Runtime.Serialization.ISerializable interface and returns the data needed to serialize the System.Collections.Hashtable.

Parameters

NameDescriptionDefault
info A System.Runtime.Serialization.SerializationInfo object containing the information required to serialize the System.Collections.Hashtable.
context A System.Runtime.Serialization.StreamingContext object containing the source and destination of the serialized stream associated with the System.Collections.Hashtable.

System.Collections.Hashtable.KeyEquals()

Compares a specific System.Object with a specific key in the System.Collections.Hashtable.

Parameters

NameDescriptionDefault
item The System.Object to compare with key.
key The key in the System.Collections.Hashtable to compare with item.

Returns

true if item and key are equal; otherwise, false.

System.Collections.Hashtable.OnDeserialization()

Implements the System.Runtime.Serialization.ISerializable interface and raises the deserialization event when the deserialization is complete.

Parameters

NameDescriptionDefault
sender The source of the deserialization event.

System.Collections.Hashtable.Remove()

Removes the element with the specified key from the System.Collections.Hashtable.

Parameters

NameDescriptionDefault
key The key of the element to remove.

System.Collections.Hashtable.Synchronized()

Returns a synchronized (thread-safe) wrapper for the System.Collections.Hashtable.

Parameters

NameDescriptionDefault
table The System.Collections.Hashtable to synchronize.

Returns

A synchronized (thread-safe) wrapper for the System.Collections.Hashtable.

System.Collections.Hashtable.System#Collections#IEnumerable#GetEnumerator

Returns an enumerator that iterates through a collection.

Returns

An System.Collections.IEnumerator that can be used to iterate through the collection.

System.Collections.Hashtable.comparer

Returns

System.Collections.Hashtable.Count

Gets the number of key/value pairs contained in the System.Collections.Hashtable.

Returns

The number of key/value pairs contained in the System.Collections.Hashtable.

System.Collections.Hashtable.EqualityComparer

Returns

System.Collections.Hashtable.hcp

Gets or sets the object that can dispense hash codes.

Returns

The object that can dispense hash codes.

System.Collections.Hashtable.IsFixedSize

Gets a value indicating whether the System.Collections.Hashtable has a fixed size.

Returns

true if the System.Collections.Hashtable has a fixed size; otherwise, false. The default is false.

System.Collections.Hashtable.IsReadOnly

Gets a value indicating whether the System.Collections.Hashtable is read-only.

Returns

true if the System.Collections.Hashtable is read-only; otherwise, false. The default is false.

System.Collections.Hashtable.IsSynchronized

Gets a value indicating whether access to the System.Collections.Hashtable is synchronized (thread safe).

Returns

true if access to the System.Collections.Hashtable is synchronized (thread safe); otherwise, false. The default is false.

System.Collections.Hashtable.Item()

Gets or sets the value associated with the specified key.

Parameters

NameDescriptionDefault
key The key whose value to get or set.

Returns

The value associated with the specified key. If the specified key is not found, attempting to get it returns null, and attempting to set it creates a new element using the specified key.

System.Collections.Hashtable.Keys

Gets an System.Collections.ICollection containing the keys in the System.Collections.Hashtable.

Returns

System.Collections.Hashtable.SyncRoot

Gets an object that can be used to synchronize access to the System.Collections.Hashtable.

Returns

An object that can be used to synchronize access to the System.Collections.Hashtable.

System.Collections.Hashtable.Values

Gets an System.Collections.ICollection containing the values in the System.Collections.Hashtable.

Returns

System.Collections.ICollection

Defines size, enumerators, and synchronization methods for all nongeneric collections.

System.Collections.ICollection.CopyTo()

Copies the elements of the System.Collections.ICollection to an System.Array, starting at a particular System.Array index.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ICollection. The System.Array must have zero-based indexing.
index The zero-based index in array at which copying begins.

System.Collections.ICollection.Count

Gets the number of elements contained in the System.Collections.ICollection.

Returns

The number of elements contained in the System.Collections.ICollection.

System.Collections.ICollection.IsSynchronized

Gets a value indicating whether access to the System.Collections.ICollection is synchronized (thread safe).

Returns

true if access to the System.Collections.ICollection is synchronized (thread safe); otherwise, false.

System.Collections.ICollection.SyncRoot

Gets an object that can be used to synchronize access to the System.Collections.ICollection.

Returns

An object that can be used to synchronize access to the System.Collections.ICollection.

System.Collections.IComparer

Exposes a method that compares two objects.

System.Collections.IComparer.Compare()

Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other.

Parameters

NameDescriptionDefault
x The first object to compare.
y The second object to compare.

Returns

A signed integer that indicates the relative values of x and y:
- If less than 0, x is less than y.
- If 0, x equals y.
- If greater than 0, x is greater than y.

System.Collections.IDictionary

Represents a nongeneric collection of key/value pairs.

System.Collections.IDictionary.Add()

Adds an element with the provided key and value to the System.Collections.IDictionary object.

Parameters

NameDescriptionDefault
key The System.Object to use as the key of the element to add.
value The System.Object to use as the value of the element to add.

System.Collections.IDictionary.Clear

Removes all elements from the System.Collections.IDictionary object.

System.Collections.IDictionary.Contains()

Determines whether the System.Collections.IDictionary object contains an element with the specified key.

Parameters

NameDescriptionDefault
key The key to locate in the System.Collections.IDictionary object.

Returns

true if the System.Collections.IDictionary contains an element with the key; otherwise, false.

System.Collections.IDictionary.GetEnumerator

Returns

System.Collections.IDictionary.Remove()

Removes the element with the specified key from the System.Collections.IDictionary object.

Parameters

NameDescriptionDefault
key The key of the element to remove.

System.Collections.IDictionary.IsFixedSize

Gets a value indicating whether the System.Collections.IDictionary object has a fixed size.

Returns

true if the System.Collections.IDictionary object has a fixed size; otherwise, false.

System.Collections.IDictionary.IsReadOnly

Gets a value indicating whether the System.Collections.IDictionary object is read-only.

Returns

true if the System.Collections.IDictionary object is read-only; otherwise, false.

System.Collections.IDictionary.Item()

Gets or sets the element with the specified key.

Parameters

NameDescriptionDefault
key The key of the element to get or set.

Returns

The element with the specified key, or null if the key does not exist.

System.Collections.IDictionary.Keys

Gets an System.Collections.ICollection object containing the keys of the System.Collections.IDictionary object.

Returns

An System.Collections.ICollection object containing the keys of the System.Collections.IDictionary object.

System.Collections.IDictionary.Values

Gets an System.Collections.ICollection object containing the values in the System.Collections.IDictionary object.

Returns

An System.Collections.ICollection object containing the values in the System.Collections.IDictionary object.

System.Collections.IDictionaryEnumerator

Enumerates the elements of a nongeneric dictionary.

System.Collections.IDictionaryEnumerator.Entry

Gets both the key and the value of the current dictionary entry.

Returns

A System.Collections.DictionaryEntry containing both the key and the value of the current dictionary entry.

System.Collections.IDictionaryEnumerator.Key

Gets the key of the current dictionary entry.

Returns

The key of the current element of the enumeration.

System.Collections.IDictionaryEnumerator.Value

Gets the value of the current dictionary entry.

Returns

The value of the current element of the enumeration.

System.Collections.IEnumerable

Exposes an enumerator, which supports a simple iteration over a non-generic collection.

System.Collections.IEnumerable.GetEnumerator

Returns an enumerator that iterates through a collection.

Returns

An System.Collections.IEnumerator object that can be used to iterate through the collection.

System.Collections.IEnumerator

Supports a simple iteration over a non-generic collection.

System.Collections.IEnumerator.MoveNext

Advances the enumerator to the next element of the collection.

Returns

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

System.Collections.IEnumerator.Reset

Sets the enumerator to its initial position, which is before the first element in the collection.

System.Collections.IEnumerator.Current

Gets the element in the collection at the current position of the enumerator.

Returns

The element in the collection at the current position of the enumerator.

System.Collections.IEqualityComparer

Defines methods to support the comparison of objects for equality.

System.Collections.IEqualityComparer.Equals()

Determines whether the specified objects are equal.

Parameters

NameDescriptionDefault
x The first object to compare.
y The second object to compare.

Returns

true if the specified objects are equal; otherwise, false.

System.Collections.IEqualityComparer.GetHashCode()

Returns a hash code for the specified object.

Parameters

NameDescriptionDefault
obj The System.Object for which a hash code is to be returned.

Returns

A hash code for the specified object.

System.Collections.IHashCodeProvider

Supplies a hash code for an object, using a custom hash function.

System.Collections.IHashCodeProvider.GetHashCode()

Returns a hash code for the specified object.

Parameters

NameDescriptionDefault
obj The System.Object for which a hash code is to be returned.

Returns

A hash code for the specified object.

System.Collections.IList

Represents a non-generic collection of objects that can be individually accessed by index.

System.Collections.IList.Add()

Adds an item to the System.Collections.IList.

Parameters

NameDescriptionDefault
value The object to add to the System.Collections.IList.

Returns

The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection.

System.Collections.IList.Clear

Removes all items from the System.Collections.IList.

System.Collections.IList.Contains()

Determines whether the System.Collections.IList contains a specific value.

Parameters

NameDescriptionDefault
value The object to locate in the System.Collections.IList.

Returns

true if the System.Object is found in the System.Collections.IList; otherwise, false.

System.Collections.IList.IndexOf()

Determines the index of a specific item in the System.Collections.IList.

Parameters

NameDescriptionDefault
value The object to locate in the System.Collections.IList.

Returns

The index of value if found in the list; otherwise, -1.

System.Collections.IList.Insert()

Inserts an item to the System.Collections.IList at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index at which value should be inserted.
value The object to insert into the System.Collections.IList.

System.Collections.IList.Remove()

Removes the first occurrence of a specific object from the System.Collections.IList.

Parameters

NameDescriptionDefault
value The object to remove from the System.Collections.IList.

System.Collections.IList.RemoveAt()

Removes the System.Collections.IList item at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index of the item to remove.

System.Collections.IList.IsFixedSize

Gets a value indicating whether the System.Collections.IList has a fixed size.

Returns

true if the System.Collections.IList has a fixed size; otherwise, false.

System.Collections.IList.IsReadOnly

Gets a value indicating whether the System.Collections.IList is read-only.

Returns

true if the System.Collections.IList is read-only; otherwise, false.

System.Collections.IList.Item()

Gets or sets the element at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index of the element to get or set.

Returns

The element at the specified index.

System.Collections.IStructuralComparable

Supports the structural comparison of collection objects.

System.Collections.IStructuralComparable.CompareTo()

Determines whether the current collection object precedes, occurs in the same position as, or follows another object in the sort order.

Parameters

NameDescriptionDefault
other The object to compare with the current instance.
comparer An object that compares members of the current collection object with the corresponding members of other.

Returns

A signed integer that indicates the relationship of the current collection object to other in the sort order:
- If less than 0, the current instance precedes other.
- If 0, the current instance and other are equal.
- If greater than 0, the current instance follows other. Return value Description -1 The current instance precedes other. 0 The current instance and other are equal. 1 The current instance follows other.

System.Collections.IStructuralEquatable

Defines methods to support the comparison of objects for structural equality.

System.Collections.IStructuralEquatable.Equals()

Determines whether an object is structurally equal to the current instance.

Parameters

NameDescriptionDefault
other The object to compare with the current instance.
comparer An object that determines whether the current instance and other are equal.

Returns

true if the two objects are equal; otherwise, false.

System.Collections.IStructuralEquatable.GetHashCode()

Returns a hash code for the current instance.

Parameters

NameDescriptionDefault
comparer An object that computes the hash code of the current object.

Returns

The hash code for the current instance.

System.Collections.ObjectModel.Collection`1

Provides the base class for a generic collection.

System.Collections.ObjectModel.Collection`1.#ctor

Initializes a new instance of the System.Collections.ObjectModel.Collection`1 class that is empty.

System.Collections.ObjectModel.Collection`1.#ctor()

Initializes a new instance of the System.Collections.ObjectModel.Collection`1 class as a wrapper for the specified list.

Parameters

NameDescriptionDefault
list The list that is wrapped by the new collection.

System.Collections.ObjectModel.Collection`1.Add()

Adds an object to the end of the System.Collections.ObjectModel.Collection`1.

Parameters

NameDescriptionDefault
item The object to be added to the end of the System.Collections.ObjectModel.Collection`1. The value can be null for reference types.

System.Collections.ObjectModel.Collection`1.Clear

Removes all elements from the System.Collections.ObjectModel.Collection`1.

System.Collections.ObjectModel.Collection`1.ClearItems

Removes all elements from the System.Collections.ObjectModel.Collection`1.

System.Collections.ObjectModel.Collection`1.Contains()

Determines whether an element is in the System.Collections.ObjectModel.Collection`1.

Parameters

NameDescriptionDefault
item The object to locate in the System.Collections.ObjectModel.Collection`1. The value can be null for reference types.

Returns

true if item is found in the System.Collections.ObjectModel.Collection`1; otherwise, false.

System.Collections.ObjectModel.Collection`1.CopyTo()

Copies the entire System.Collections.ObjectModel.Collection`1 to a compatible one-dimensional System.Array, starting at the specified index of the target array.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ObjectModel.Collection`1. The System.Array must have zero-based indexing.
index The zero-based index in array at which copying begins.

System.Collections.ObjectModel.Collection`1.GetEnumerator

Returns an enumerator that iterates through the System.Collections.ObjectModel.Collection`1.

Returns

System.Collections.ObjectModel.Collection`1.IndexOf()

Searches for the specified object and returns the zero-based index of the first occurrence within the entire System.Collections.ObjectModel.Collection`1.

Parameters

NameDescriptionDefault
item The object to locate in the System.Collections.ObjectModel.Collection`1. The value can be null for reference types.

Returns

The zero-based index of the first occurrence of item within the entire System.Collections.ObjectModel.Collection`1, if found; otherwise, -1.

System.Collections.ObjectModel.Collection`1.Insert()

Inserts an element into the System.Collections.ObjectModel.Collection`1 at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index at which item should be inserted.
item The object to insert. The value can be null for reference types.

System.Collections.ObjectModel.Collection`1.InsertItem()

Inserts an element into the System.Collections.ObjectModel.Collection`1 at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index at which item should be inserted.
item The object to insert. The value can be null for reference types.

System.Collections.ObjectModel.Collection`1.Remove()

Removes the first occurrence of a specific object from the System.Collections.ObjectModel.Collection`1.

Parameters

NameDescriptionDefault
item The object to remove from the System.Collections.ObjectModel.Collection`1. The value can be null for reference types.

Returns

true if item is successfully removed; otherwise, false. This method also returns false if item was not found in the original System.Collections.ObjectModel.Collection`1.

System.Collections.ObjectModel.Collection`1.RemoveAt()

Removes the element at the specified index of the System.Collections.ObjectModel.Collection`1.

Parameters

NameDescriptionDefault
index The zero-based index of the element to remove.

System.Collections.ObjectModel.Collection`1.RemoveItem()

Removes the element at the specified index of the System.Collections.ObjectModel.Collection`1.

Parameters

NameDescriptionDefault
index The zero-based index of the element to remove.

System.Collections.ObjectModel.Collection`1.SetItem()

Replaces the element at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index of the element to replace.
item The new value for the element at the specified index. The value can be null for reference types.

System.Collections.ObjectModel.Collection`1.System#Collections#ICollection#CopyTo()

Copies the elements of the System.Collections.ICollection to an System.Array, starting at a particular System.Array index.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ICollection. The System.Array must have zero-based indexing.
index The zero-based index in array at which copying begins.

System.Collections.ObjectModel.Collection`1.System#Collections#IEnumerable#GetEnumerator

Returns an enumerator that iterates through a collection.

Returns

An System.Collections.IEnumerator that can be used to iterate through the collection.

System.Collections.ObjectModel.Collection`1.System#Collections#IList#Add()

Adds an item to the System.Collections.IList.

Parameters

NameDescriptionDefault
value The System.Object to add to the System.Collections.IList.

Returns

The position into which the new element was inserted.

System.Collections.ObjectModel.Collection`1.System#Collections#IList#Contains()

Determines whether the System.Collections.IList contains a specific value.

Parameters

NameDescriptionDefault
value The System.Object to locate in the System.Collections.IList.

Returns

true if the System.Object is found in the System.Collections.IList; otherwise, false.

System.Collections.ObjectModel.Collection`1.System#Collections#IList#IndexOf()

Determines the index of a specific item in the System.Collections.IList.

Parameters

NameDescriptionDefault
value The System.Object to locate in the System.Collections.IList.

Returns

The index of value if found in the list; otherwise, -1.

System.Collections.ObjectModel.Collection`1.System#Collections#IList#Insert()

Inserts an item into the System.Collections.IList at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index at which value should be inserted.
value The System.Object to insert into the System.Collections.IList.

System.Collections.ObjectModel.Collection`1.System#Collections#IList#Remove()

Removes the first occurrence of a specific object from the System.Collections.IList.

Parameters

NameDescriptionDefault
value The System.Object to remove from the System.Collections.IList.

System.Collections.ObjectModel.Collection`1.Count

Gets the number of elements actually contained in the System.Collections.ObjectModel.Collection`1.

Returns

The number of elements actually contained in the System.Collections.ObjectModel.Collection`1.

System.Collections.ObjectModel.Collection`1.Item()

Gets or sets the element at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index of the element to get or set.

Returns

The element at the specified index.

System.Collections.ObjectModel.Collection`1.Items

Returns

System.Collections.ObjectModel.Collection`1.System#Collections#Generic#ICollection{T}#IsReadOnly

Gets a value indicating whether the System.Collections.Generic.ICollection`1 is read-only.

Returns

true if the System.Collections.Generic.ICollection`1 is read-only; otherwise, false. In the default implementation of System.Collections.ObjectModel.Collection`1, this property always returns false.

System.Collections.ObjectModel.Collection`1.System#Collections#ICollection#IsSynchronized

Gets a value indicating whether access to the System.Collections.ICollection is synchronized (thread safe).

Returns

true if access to the System.Collections.ICollection is synchronized (thread safe); otherwise, false. In the default implementation of System.Collections.ObjectModel.Collection`1, this property always returns false.

System.Collections.ObjectModel.Collection`1.System#Collections#ICollection#SyncRoot

Gets an object that can be used to synchronize access to the System.Collections.ICollection.

Returns

An object that can be used to synchronize access to the System.Collections.ICollection. In the default implementation of System.Collections.ObjectModel.Collection`1, this property always returns the current instance.

System.Collections.ObjectModel.Collection`1.System#Collections#IList#IsFixedSize

Gets a value indicating whether the System.Collections.IList has a fixed size.

Returns

true if the System.Collections.IList has a fixed size; otherwise, false. In the default implementation of System.Collections.ObjectModel.Collection`1, this property always returns false.

System.Collections.ObjectModel.Collection`1.System#Collections#IList#IsReadOnly

Gets a value indicating whether the System.Collections.IList is read-only.

Returns

true if the System.Collections.IList is read-only; otherwise, false. In the default implementation of System.Collections.ObjectModel.Collection`1, this property always returns false.

System.Collections.ObjectModel.Collection`1.System#Collections#IList#Item()

Gets or sets the element at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index of the element to get or set.

Returns

The element at the specified index.

System.Collections.ObjectModel.ReadOnlyCollection`1

Provides the base class for a generic read-only collection.

System.Collections.ObjectModel.ReadOnlyCollection`1.#ctor()

Initializes a new instance of the System.Collections.ObjectModel.ReadOnlyCollection`1 class that is a read-only wrapper around the specified list.

Parameters

NameDescriptionDefault
list The list to wrap.

System.Collections.ObjectModel.ReadOnlyCollection`1.Contains()

Determines whether an element is in the System.Collections.ObjectModel.ReadOnlyCollection`1.

Parameters

NameDescriptionDefault
value The object to locate in the System.Collections.ObjectModel.ReadOnlyCollection`1. The value can be null for reference types.

Returns

true if value is found in the System.Collections.ObjectModel.ReadOnlyCollection`1; otherwise, false.

System.Collections.ObjectModel.ReadOnlyCollection`1.CopyTo()

Copies the entire System.Collections.ObjectModel.ReadOnlyCollection`1 to a compatible one-dimensional System.Array, starting at the specified index of the target array.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ObjectModel.ReadOnlyCollection`1. The System.Array must have zero-based indexing.
index The zero-based index in array at which copying begins.

System.Collections.ObjectModel.ReadOnlyCollection`1.GetEnumerator

Returns an enumerator that iterates through the System.Collections.ObjectModel.ReadOnlyCollection`1.

Returns

System.Collections.ObjectModel.ReadOnlyCollection`1.IndexOf()

Searches for the specified object and returns the zero-based index of the first occurrence within the entire System.Collections.ObjectModel.ReadOnlyCollection`1.

Parameters

NameDescriptionDefault
value The object to locate in the System.Collections.Generic.List`1. The value can be null for reference types.

Returns

The zero-based index of the first occurrence of item within the entire System.Collections.ObjectModel.ReadOnlyCollection`1, if found; otherwise, -1.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#Generic#ICollection{T}#Add()

Adds an item to the System.Collections.Generic.ICollection`1. This implementation always throws System.NotSupportedException.

Parameters

NameDescriptionDefault
value The object to add to the System.Collections.Generic.ICollection`1.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#Generic#ICollection{T}#Clear

Removes all items from the System.Collections.Generic.ICollection`1. This implementation always throws System.NotSupportedException.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#Generic#ICollection{T}#Remove()

Removes the first occurrence of a specific object from the System.Collections.Generic.ICollection`1. This implementation always throws System.NotSupportedException.

Parameters

NameDescriptionDefault
value The object to remove from the System.Collections.Generic.ICollection`1.

Returns

true if value was successfully removed from the System.Collections.Generic.ICollection`1; otherwise, false.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#Generic#IList{T}#Insert()

Inserts an item to the System.Collections.Generic.IList`1 at the specified index. This implementation always throws System.NotSupportedException.

Parameters

NameDescriptionDefault
index The zero-based index at which value should be inserted.
value The object to insert into the System.Collections.Generic.IList`1.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#Generic#IList{T}#RemoveAt()

Removes the System.Collections.Generic.IList`1 item at the specified index. This implementation always throws System.NotSupportedException.

Parameters

NameDescriptionDefault
index The zero-based index of the item to remove.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#ICollection#CopyTo()

Copies the elements of the System.Collections.ICollection to an System.Array, starting at a particular System.Array index.

Parameters

NameDescriptionDefault
array The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ICollection. The System.Array must have zero-based indexing.
index The zero-based index in array at which copying begins.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#IEnumerable#GetEnumerator

Returns an enumerator that iterates through a collection.

Returns

An System.Collections.IEnumerator that can be used to iterate through the collection.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#IList#Add()

Adds an item to the System.Collections.IList. This implementation always throws System.NotSupportedException.

Parameters

NameDescriptionDefault
value The System.Object to add to the System.Collections.IList.

Returns

The position into which the new element was inserted.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#IList#Clear

Removes all items from the System.Collections.IList. This implementation always throws System.NotSupportedException.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#IList#Contains()

Determines whether the System.Collections.IList contains a specific value.

Parameters

NameDescriptionDefault
value The System.Object to locate in the System.Collections.IList.

Returns

true if the System.Object is found in the System.Collections.IList; otherwise, false.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#IList#IndexOf()

Determines the index of a specific item in the System.Collections.IList.

Parameters

NameDescriptionDefault
value The System.Object to locate in the System.Collections.IList.

Returns

The index of value if found in the list; otherwise, -1.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#IList#Insert()

Inserts an item to the System.Collections.IList at the specified index. This implementation always throws System.NotSupportedException.

Parameters

NameDescriptionDefault
index The zero-based index at which value should be inserted.
value The System.Object to insert into the System.Collections.IList.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#IList#Remove()

Removes the first occurrence of a specific object from the System.Collections.IList. This implementation always throws System.NotSupportedException.

Parameters

NameDescriptionDefault
value The System.Object to remove from the System.Collections.IList.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#IList#RemoveAt()

Removes the System.Collections.IList item at the specified index. This implementation always throws System.NotSupportedException.

Parameters

NameDescriptionDefault
index The zero-based index of the item to remove.

System.Collections.ObjectModel.ReadOnlyCollection`1.Count

Gets the number of elements contained in the System.Collections.ObjectModel.ReadOnlyCollection`1 instance.

Returns

The number of elements contained in the System.Collections.ObjectModel.ReadOnlyCollection`1 instance.

System.Collections.ObjectModel.ReadOnlyCollection`1.Empty

Returns

System.Collections.ObjectModel.ReadOnlyCollection`1.Item()

Gets the element at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index of the element to get.

Returns

The element at the specified index.

System.Collections.ObjectModel.ReadOnlyCollection`1.Items

Returns

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#Generic#ICollection{T}#IsReadOnly

Gets a value indicating whether the System.Collections.Generic.ICollection`1 is read-only.

Returns

true if the System.Collections.Generic.ICollection`1 is read-only; otherwise, false. In the default implementation of System.Collections.ObjectModel.ReadOnlyCollection`1, this property always returns true.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#Generic#IList{T}#Item()

Gets the element at the specified index. An System.NotSupportedException occurs if you try to set the item at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index of the element to get.

Returns

The element at the specified index.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#ICollection#IsSynchronized

Gets a value indicating whether access to the System.Collections.ICollection is synchronized (thread safe).

Returns

true if access to the System.Collections.ICollection is synchronized (thread safe); otherwise, false. In the default implementation of System.Collections.ObjectModel.ReadOnlyCollection`1, this property always returns false.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#ICollection#SyncRoot

Gets an object that can be used to synchronize access to the System.Collections.ICollection.

Returns

An object that can be used to synchronize access to the System.Collections.ICollection. In the default implementation of System.Collections.ObjectModel.ReadOnlyCollection`1, this property always returns the current instance.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#IList#IsFixedSize

Gets a value indicating whether the System.Collections.IList has a fixed size.

Returns

true if the System.Collections.IList has a fixed size; otherwise, false. In the default implementation of System.Collections.ObjectModel.ReadOnlyCollection`1, this property always returns true.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#IList#IsReadOnly

Gets a value indicating whether the System.Collections.IList is read-only.

Returns

true if the System.Collections.IList is read-only; otherwise, false. In the default implementation of System.Collections.ObjectModel.ReadOnlyCollection`1, this property always returns true.

System.Collections.ObjectModel.ReadOnlyCollection`1.System#Collections#IList#Item()

Gets the element at the specified index. A System.NotSupportedException occurs if you try to set the item at the specified index.

Parameters

NameDescriptionDefault
index The zero-based index of the element to get.

Returns

The element at the specified index.

System.Collections.ObjectModel.ReadOnlyDictionary`2

Represents a read-only, generic collection of key/value pairs.

System.Collections.ObjectModel.ReadOnlyDictionary`2.#ctor()

Initializes a new instance of the System.Collections.ObjectModel.ReadOnlyDictionary`2 class that is a wrapper around the specified dictionary.

Parameters

NameDescriptionDefault
dictionary The dictionary to wrap.

System.Collections.ObjectModel.ReadOnlyDictionary`2.ContainsKey()

Determines whether the dictionary contains an element that has the specified key.

Parameters

NameDescriptionDefault
key The key to locate in the dictionary.

Returns

true if the dictionary contains an element that has the specified key; otherwise, false.

System.Collections.ObjectModel.ReadOnlyDictionary`2.GetEnumerator

Returns an enumerator that iterates through the System.Collections.ObjectModel.ReadOnlyDictionary`2.

Returns

An enumerator that can be used to iterate through the collection.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{TKey@TValue}}#Add()

Throws a System.NotSupportedException exception in all cases.

Parameters

NameDescriptionDefault
item The object to add to the dictionary.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{TKey@TValue}}#Clear

Throws a System.NotSupportedException exception in all cases.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{TKey@TValue}}#Contains()

Determines whether the dictionary contains a specific value.

Parameters

NameDescriptionDefault
item The object to locate in the dictionary.

Returns

true if item is found in the dictionary; otherwise, false.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{TKey@TValue}}#CopyTo()

Copies the elements of the dictionary to an array, starting at the specified array index.

Parameters

NameDescriptionDefault
array The one-dimensional array that is the destination of the elements copied from the dictionary. The array must have zero-based indexing.
arrayIndex The zero-based index in array at which copying begins.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{TKey@TValue}}#Remove()

Throws a System.NotSupportedException exception in all cases.

Parameters

NameDescriptionDefault
item The object to remove from the dictionary.

Returns

Throws a System.NotSupportedException exception in all cases.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#Generic#IDictionary{TKey@TValue}#Add()

Throws a System.NotSupportedException exception in all cases.

Parameters

NameDescriptionDefault
key The object to use as the key of the element to add.
value The object to use as the value of the element to add.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#Generic#IDictionary{TKey@TValue}#Remove()

Throws a System.NotSupportedException exception in all cases.

Parameters

NameDescriptionDefault
key The key of the element to remove.

Returns

Throws a System.NotSupportedException exception in all cases.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#ICollection#CopyTo()

Copies the elements of the dictionary to an array, starting at the specified array index.

Parameters

NameDescriptionDefault
array The one-dimensional array that is the destination of the elements copied from the dictionary. The array must have zero-based indexing.
index The zero-based index in array at which copying begins.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#IDictionary#Add()

Throws a System.NotSupportedException exception in all cases.

Parameters

NameDescriptionDefault
key The key of the element to add.
value The value of the element to add.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#IDictionary#Clear

Throws a System.NotSupportedException exception in all cases.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#IDictionary#Contains()

Determines whether the dictionary contains an element that has the specified key.

Parameters

NameDescriptionDefault
key The key to locate in the dictionary.

Returns

true if the dictionary contains an element that has the specified key; otherwise, false.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#IDictionary#GetEnumerator

Returns an enumerator for the dictionary.

Returns

An enumerator for the dictionary.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#IDictionary#Remove()

Throws a System.NotSupportedException exception in all cases.

Parameters

NameDescriptionDefault
key The key of the element to remove.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#IEnumerable#GetEnumerator

Returns an enumerator that iterates through a collection.

Returns

An enumerator that can be used to iterate through the collection.

System.Collections.ObjectModel.ReadOnlyDictionary`2.TryGetValue()

Retrieves the value that is associated with the specified key.

Parameters

NameDescriptionDefault
key The key whose value will be retrieved.
value When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.

Returns

true if the object that implements System.Collections.ObjectModel.ReadOnlyDictionary`2 contains an element with the specified key; otherwise, false.

System.Collections.ObjectModel.ReadOnlyDictionary`2.Count

Gets the number of items in the dictionary.

Returns

The number of items in the dictionary.

System.Collections.ObjectModel.ReadOnlyDictionary`2.Dictionary

Gets the dictionary that is wrapped by this System.Collections.ObjectModel.ReadOnlyDictionary`2 object.

Returns

The dictionary that is wrapped by this object.

System.Collections.ObjectModel.ReadOnlyDictionary`2.Empty

Returns

System.Collections.ObjectModel.ReadOnlyDictionary`2.Item()

Gets the element that has the specified key.

Parameters

NameDescriptionDefault
key The key of the element to get.

Returns

The element that has the specified key.

System.Collections.ObjectModel.ReadOnlyDictionary`2.Keys

Gets a key collection that contains the keys of the dictionary.

Returns

A key collection that contains the keys of the dictionary.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{TKey@TValue}}#IsReadOnly

Gets a value that indicates whether the dictionary is read-only.

Returns

Always returns true to indicate the dictionary is read-only.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#Generic#IDictionary{TKey@TValue}#Item()

Gets the element that has the specified key.

Parameters

NameDescriptionDefault
key The key of the element to get or set.

Returns

The element that has the specified key.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#Generic#IDictionary{TKey@TValue}#Keys

Gets a collection that contains the keys of the dictionary.

Returns

A collection that contains the keys of the object that implements System.Collections.ObjectModel.ReadOnlyDictionary`2.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#Generic#IDictionary{TKey@TValue}#Values

Gets a collection that contains the values in the dictionary.

Returns

A collection that contains the values in the object that implements System.Collections.ObjectModel.ReadOnlyDictionary`2.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#Generic#IReadOnlyDictionary{TKey@TValue}#Keys

Gets an enumerable collection that contains the keys in the read-only dictionary.

Returns

An enumerable collection that contains the keys in the read-only dictionary.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#Generic#IReadOnlyDictionary{TKey@TValue}#Values

Gets an enumerable collection that contains the values in the read-only dictionary.

Returns

An enumerable collection that contains the values in the read-only dictionary.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#ICollection#IsSynchronized

Gets a value that indicates whether access to the dictionary is synchronized (thread safe).

Returns

true if access to the dictionary is synchronized (thread safe); otherwise, false.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#ICollection#SyncRoot

Gets an object that can be used to synchronize access to the dictionary.

Returns

An object that can be used to synchronize access to the dictionary.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#IDictionary#IsFixedSize

Gets a value that indicates whether the dictionary has a fixed size.

Returns

true if the dictionary has a fixed size; otherwise, false.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#IDictionary#IsReadOnly

Gets a value that indicates whether the dictionary is read-only.

Returns

true in all cases.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#IDictionary#Item()

Gets the element that has the specified key.

Parameters

NameDescriptionDefault
key The key of the element to get or set.

Returns

The element that has the specified key.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#IDictionary#Keys

Gets a collection that contains the keys of the dictionary.

Returns

A collection that contains the keys of the dictionary.

System.Collections.ObjectModel.ReadOnlyDictionary`2.System#Collections#IDictionary#Values

Gets a collection that contains the values in the dictionary.

Returns

A collection that contains the values in the dictionary.

System.Collections.ObjectModel.ReadOnlyDictionary`2.Values

Gets a collection that contains the values in the dictionary.

Returns

A collection that contains the values in the object that implements System.Collections.ObjectModel.ReadOnlyDictionary`2.

System.Collections.ObjectModel.ReadOnlyDictionary`2.KeyCollection

Represents a read-only collection of the keys of a System.Collections.ObjectModel.ReadOnlyDictionary`2 object.

System.Collections.ObjectModel.ReadOnlyDictionary`2.KeyCollection.Contains()

Determines whether the System.Collections.Generic.ICollection`1 contains a specific value.

Parameters

NameDescriptionDefault
item The object to locate in the System.Collections.Generic.ICollection`1.

Returns

true if item is found in the System.Collections.Generic.ICollection`1; otherwise, false.

System.Collections.ObjectModel.ReadOnlyDictionary`2.KeyCollection.CopyTo()

Copies the elements of the collection to an array, starting at a specific array index.

Parameters

NameDescriptionDefault
array The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.
arrayIndex The zero-based index in array at which copying begins.

System.Collections.ObjectModel.ReadOnlyDictionary`2.KeyCollection.GetEnumerator

Returns an enumerator that iterates through the collection.

Returns

An enumerator that can be used to iterate through the collection.

System.Collections.ObjectModel.ReadOnlyDictionary`2.KeyCollection.System#Collections#Generic#ICollection{TKey}#Add()

Throws a System.NotSupportedException exception in all cases.

Parameters

NameDescriptionDefault
item The object to add to the collection.

System.Collections.ObjectModel.ReadOnlyDictionary`2.KeyCollection.System#Collections#Generic#ICollection{TKey}#Clear

Throws a System.NotSupportedException exception in all cases.

System.Collections.ObjectModel.ReadOnlyDictionary`2.KeyCollection.System#Collections#Generic#ICollection{TKey}#Remove()

Throws a System.NotSupportedException exception in all cases.

Parameters

NameDescriptionDefault
item The object to remove from the collection.

Returns

true if item was successfully removed from the collection; otherwise, false. This method also returns false if item is not found in the original collection.

System.Collections.ObjectModel.ReadOnlyDictionary`2.KeyCollection.System#Collections#ICollection#CopyTo()

Copies the elements of the collection to an array, starting at a specific array index.

Parameters

NameDescriptionDefault
array The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.
index The zero-based index in array at which copying begins.

System.Collections.ObjectModel.ReadOnlyDictionary`2.KeyCollection.System#Collections#IEnumerable#GetEnumerator

Returns an enumerator that iterates through the collection.

Returns

An enumerator that can be used to iterate through the collection.

System.Collections.ObjectModel.ReadOnlyDictionary`2.KeyCollection.Count

Gets the number of elements in the collection.

Returns

The number of elements in the collection.

System.Collections.ObjectModel.ReadOnlyDictionary`2.KeyCollection.System#Collections#Generic#ICollection{TKey}#IsReadOnly

Gets a value that indicates whether the dictionary is read-only.

Returns

true in all cases.

System.Collections.ObjectModel.ReadOnlyDictionary`2.KeyCollection.System#Collections#ICollection#IsSynchronized

Gets a value that indicates whether access to the collection is synchronized (thread safe).

Returns

true if access to the collection is synchronized (thread safe); otherwise, false.

System.Collections.ObjectModel.ReadOnlyDictionary`2.KeyCollection.System#Collections#ICollection#SyncRoot

Gets an object that can be used to synchronize access to the collection.

Returns

An object that can be used to synchronize access to the collection.

System.Collections.ObjectModel.ReadOnlyDictionary`2.ValueCollection

Represents a read-only collection of the values of a System.Collections.ObjectModel.ReadOnlyDictionary`2 object.

System.Collections.ObjectModel.ReadOnlyDictionary`2.ValueCollection.CopyTo()

Copies the elements of the collection to an array, starting at a specific array index.

Parameters

NameDescriptionDefault
array The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.
arrayIndex The zero-based index in array at which copying begins.

System.Collections.ObjectModel.ReadOnlyDictionary`2.ValueCollection.GetEnumerator

Returns an enumerator that iterates through the collection.

Returns

An enumerator that can be used to iterate through the collection.

System.Collections.ObjectModel.ReadOnlyDictionary`2.ValueCollection.System#Collections#Generic#ICollection{TValue}#Add()

Throws a System.NotSupportedException exception in all cases.

Parameters

NameDescriptionDefault
item The object to add to the collection.

System.Collections.ObjectModel.ReadOnlyDictionary`2.ValueCollection.System#Collections#Generic#ICollection{TValue}#Clear

Throws a System.NotSupportedException exception in all cases.

System.Collections.ObjectModel.ReadOnlyDictionary`2.ValueCollection.System#Collections#Generic#ICollection{TValue}#Contains()

Determines whether the collection contains a specific value.

Parameters

NameDescriptionDefault
item The object to locate in the collection.

Returns

true if item is found in the collection; otherwise, false.

System.Collections.ObjectModel.ReadOnlyDictionary`2.ValueCollection.System#Collections#Generic#ICollection{TValue}#Remove()

Throws a System.NotSupportedException exception in all cases.

Parameters

NameDescriptionDefault
item The object to remove from the collection.

Returns

true if item was successfully removed from the collection; otherwise, false. This method also returns false if item is not found in the original collection.

System.Collections.ObjectModel.ReadOnlyDictionary`2.ValueCollection.System#Collections#ICollection#CopyTo()

Copies the elements of the collection to an array, starting at a specific array index.

Parameters

NameDescriptionDefault
array The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.
index The zero-based index in array at which copying begins.

System.Collections.ObjectModel.ReadOnlyDictionary`2.ValueCollection.System#Collections#IEnumerable#GetEnumerator

Returns an enumerator that iterates through the collection.

Returns

An enumerator that can be used to iterate through the collection.

System.Collections.ObjectModel.ReadOnlyDictionary`2.ValueCollection.Count

Gets the number of elements in the collection.

Returns

The number of elements in the collection.

System.Collections.ObjectModel.ReadOnlyDictionary`2.ValueCollection.System#Collections#Generic#ICollection{TValue}#IsReadOnly

Gets a value that indicates whether the collection is read-only.

Returns

true in all cases.

System.Collections.ObjectModel.ReadOnlyDictionary`2.ValueCollection.System#Collections#ICollection#IsSynchronized

Gets a value that indicates whether access to the collection is synchronized (thread safe).

Returns

true if access to the collection is synchronized (thread safe); otherwise, false.

System.Collections.ObjectModel.ReadOnlyDictionary`2.ValueCollection.System#Collections#ICollection#SyncRoot

Gets an object that can be used to synchronize access to the collection.

Returns

An object that can be used to synchronize access to the collection.

System.Comparison`1

Represents the method that compares two objects of the same type.

Parameters

NameDescriptionDefault
x The first object to compare.
y The second object to compare.

Returns

A signed integer that indicates the relative values of x and y, as shown in the following table. Value Meaning Less than 0x is less than y. 0x equals y. Greater than 0x is greater than y.

System.ComponentModel.DefaultValueAttribute

Specifies the default value for a property.

System.ComponentModel.DefaultValueAttribute.#ctor()

Initializes a new instance of the System.ComponentModel.DefaultValueAttribute class using a System.Boolean value.

Parameters

NameDescriptionDefault
value A System.Boolean that is the default value.

System.ComponentModel.DefaultValueAttribute.#ctor()

Initializes a new instance of the System.ComponentModel.DefaultValueAttribute class using an 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value An 8-bit unsigned integer that is the default value.

System.ComponentModel.DefaultValueAttribute.#ctor()

Initializes a new instance of the System.ComponentModel.DefaultValueAttribute class using a Unicode character.

Parameters

NameDescriptionDefault
value A Unicode character that is the default value.

System.ComponentModel.DefaultValueAttribute.#ctor()

Initializes a new instance of the System.ComponentModel.DefaultValueAttribute class using a double-precision floating point number.

Parameters

NameDescriptionDefault
value A double-precision floating point number that is the default value.

System.ComponentModel.DefaultValueAttribute.#ctor()

Initializes a new instance of the System.ComponentModel.DefaultValueAttribute class using a 16-bit signed integer.

Parameters

NameDescriptionDefault
value A 16-bit signed integer that is the default value.

System.ComponentModel.DefaultValueAttribute.#ctor()

Initializes a new instance of the System.ComponentModel.DefaultValueAttribute class using a 32-bit signed integer.

Parameters

NameDescriptionDefault
value A 32-bit signed integer that is the default value.

System.ComponentModel.DefaultValueAttribute.#ctor()

Initializes a new instance of the System.ComponentModel.DefaultValueAttribute class using a 64-bit signed integer.

Parameters

NameDescriptionDefault
value A 64-bit signed integer that is the default value.

System.ComponentModel.DefaultValueAttribute.#ctor()

Initializes a new instance of the System.ComponentModel.DefaultValueAttribute class.

Parameters

NameDescriptionDefault
value An System.Object that represents the default value.

System.ComponentModel.DefaultValueAttribute.#ctor()

Initializes a new instance of the System.ComponentModel.DefaultValueAttribute class using a System.SByte value.

Parameters

NameDescriptionDefault
value The default signed byte value.

System.ComponentModel.DefaultValueAttribute.#ctor()

Initializes a new instance of the System.ComponentModel.DefaultValueAttribute class using a single-precision floating point number.

Parameters

NameDescriptionDefault
value A single-precision floating point number that is the default value.

System.ComponentModel.DefaultValueAttribute.#ctor()

Initializes a new instance of the System.ComponentModel.DefaultValueAttribute class using a System.String.

Parameters

NameDescriptionDefault
value A System.String that is the default value.

System.ComponentModel.DefaultValueAttribute.#ctor()

Initializes a new instance of the System.ComponentModel.DefaultValueAttribute class, converting the specified value to the specified type, and using an invariant culture as the translation context.

Parameters

NameDescriptionDefault
type A System.Type that represents the type to convert the value to.
value A System.String that can be converted to the type using the System.ComponentModel.TypeConverter for the type and the U.S. English culture.

System.ComponentModel.DefaultValueAttribute.#ctor()

Initializes a new instance of the System.ComponentModel.DefaultValueAttribute class using a System.UInt16 value.

Parameters

NameDescriptionDefault
value The default unsigned 16-bit integer value.

System.ComponentModel.DefaultValueAttribute.#ctor()

Initializes a new instance of the System.ComponentModel.DefaultValueAttribute class using a System.UInt32 value.

Parameters

NameDescriptionDefault
value The default unsigned integer value.

System.ComponentModel.DefaultValueAttribute.#ctor()

Initializes a new instance of the System.ComponentModel.DefaultValueAttribute class using a System.UInt64 value.

Parameters

NameDescriptionDefault
value The default unsigned long integer value.

System.ComponentModel.DefaultValueAttribute.Equals()

Returns whether the value of the given object is equal to the current System.ComponentModel.DefaultValueAttribute.

Parameters

NameDescriptionDefault
obj The object to test the value equality of.

Returns

true if the value of the given object is equal to that of the current; otherwise, false.

System.ComponentModel.DefaultValueAttribute.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.ComponentModel.DefaultValueAttribute.SetValue()

Sets the default value for the property to which this attribute is bound.

Parameters

NameDescriptionDefault
value The default value.

System.ComponentModel.DefaultValueAttribute.Value

Gets the default value of the property this attribute is bound to.

Returns

An System.Object that represents the default value of the property this attribute is bound to.

System.ComponentModel.EditorBrowsableAttribute

Specifies that a class or member is viewable in an editor. This class cannot be inherited.

System.ComponentModel.EditorBrowsableAttribute.#ctor

Initializes a new instance of the System.ComponentModel.EditorBrowsableAttribute class with System.ComponentModel.EditorBrowsableAttribute.State set to the default state.

System.ComponentModel.EditorBrowsableAttribute.#ctor()

Parameters

NameDescriptionDefault
state The System.ComponentModel.EditorBrowsableState to set System.ComponentModel.EditorBrowsableAttribute.State to.

System.ComponentModel.EditorBrowsableAttribute.Equals()

Returns whether the value of the given object is equal to the current System.ComponentModel.EditorBrowsableAttribute.

Parameters

NameDescriptionDefault
obj The object to test the value equality of.

Returns

true if the value of the given object is equal to that of the current; otherwise, false.

System.ComponentModel.EditorBrowsableAttribute.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.ComponentModel.EditorBrowsableAttribute.State

Gets the browsable state of the property or method.

Returns

An System.ComponentModel.EditorBrowsableState that is the browsable state of the property or method.

System.ComponentModel.EditorBrowsableState

Specifies the browsable state of a property or method from within an editor.

System.ComponentModel.EditorBrowsableState.Advanced

The property or method is a feature that only advanced users should see. An editor can either show or hide such properties.

System.ComponentModel.EditorBrowsableState.Always

The property or method is always browsable from within an editor.

System.ComponentModel.EditorBrowsableState.Never

The property or method is never browsable from within an editor.

System.Configuration.Assemblies.AssemblyHashAlgorithm

Specifies all the hash algorithms used for hashing files and for generating the strong name.

System.Configuration.Assemblies.AssemblyHashAlgorithm.MD5

Retrieves the MD5 message-digest algorithm. MD5 was developed by Rivest in 1991. It is basically MD4 with safety-belts and while it is slightly slower than MD4, it helps provide more security. The algorithm consists of four distinct rounds, which has a slightly different design from that of MD4. Message-digest size, as well as padding requirements, remain the same.

System.Configuration.Assemblies.AssemblyHashAlgorithm.None

A mask indicating that there is no hash algorithm. If you specify None for a multi-module assembly, the common language runtime defaults to the SHA1 algorithm, since multi-module assemblies need to generate a hash. Due to collision problems with SHA1, Microsoft recommends SHA256.

System.Configuration.Assemblies.AssemblyHashAlgorithm.SHA1

A mask used to retrieve a revision of the Secure Hash Algorithm that corrects an unpublished flaw in SHA.

System.Configuration.Assemblies.AssemblyHashAlgorithm.SHA256

A mask used to retrieve a version of the Secure Hash Algorithm with a hash size of 256 bits.

System.Configuration.Assemblies.AssemblyHashAlgorithm.SHA384

A mask used to retrieve a version of the Secure Hash Algorithm with a hash size of 384 bits.

System.Configuration.Assemblies.AssemblyHashAlgorithm.SHA512

A mask used to retrieve a version of the Secure Hash Algorithm with a hash size of 512 bits.

System.Configuration.Assemblies.AssemblyVersionCompatibility

Defines the different types of assembly version compatibility.

System.Configuration.Assemblies.AssemblyVersionCompatibility.SameDomain

The assembly cannot execute with other versions if they are executing in the same application domain.

System.Configuration.Assemblies.AssemblyVersionCompatibility.SameMachine

The assembly cannot execute with other versions if they are executing on the same machine.

System.Configuration.Assemblies.AssemblyVersionCompatibility.SameProcess

The assembly cannot execute with other versions if they are executing in the same process.

System.ContextBoundObject

Defines the base class for all context-bound classes.

System.ContextBoundObject.#ctor

Instantiates an instance of the System.ContextBoundObject class.

System.ContextMarshalException

The exception that is thrown when an attempt to marshal an object across a context boundary fails.

System.ContextMarshalException.#ctor

Initializes a new instance of the System.ContextMarshalException class with default properties.

System.ContextMarshalException.#ctor()

Initializes a new instance of the System.ContextMarshalException class with serialized data.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.ContextMarshalException.#ctor()

Initializes a new instance of the System.ContextMarshalException class with a specified error message.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.

System.ContextMarshalException.#ctor()

Initializes a new instance of the System.ContextMarshalException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
inner The exception that is the cause of the current exception. If the inner parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.ContextStaticAttribute

Indicates that the value of a static field is unique for a particular context.

System.ContextStaticAttribute.#ctor

Initializes a new instance of the System.ContextStaticAttribute class.

System.Convert

Converts a base data type to another base data type.

System.Convert.DBNull

A constant that represents a database column that is absent of data; that is, database null.

System.Convert.ChangeType()

Returns an object of the specified type and whose value is equivalent to the specified object.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
conversionType The type of object to return.

Returns

An object whose type is conversionType and whose value is equivalent to value. -or- A null reference (Nothing in Visual Basic), if value is null and conversionType is not a value type.

System.Convert.ChangeType()

Returns an object of the specified type whose value is equivalent to the specified object. A parameter supplies culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
conversionType The type of object to return.
provider An object that supplies culture-specific formatting information.

Returns

An object whose type is conversionType and whose value is equivalent to value. -or- value, if the System.Type of value and conversionType are equal. -or- A null reference (Nothing in Visual Basic), if value is null and conversionType is not a value type.

System.Convert.ChangeType()

Returns an object of the specified type whose value is equivalent to the specified object.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
typeCode The type of object to return.

Returns

An object whose underlying type is typeCode and whose value is equivalent to value. -or- A null reference (Nothing in Visual Basic), if value is null and typeCode is System.TypeCode.Empty, System.TypeCode.String, or System.TypeCode.Object.

System.Convert.ChangeType()

Returns an object of the specified type whose value is equivalent to the specified object. A parameter supplies culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
typeCode The type of object to return.
provider An object that supplies culture-specific formatting information.

Returns

An object whose underlying type is typeCode and whose value is equivalent to value. -or- A null reference (Nothing in Visual Basic), if value is null and typeCode is System.TypeCode.Empty, System.TypeCode.String, or System.TypeCode.Object.

System.Convert.FromBase64CharArray()

Converts a subset of a Unicode character array, which encodes binary data as base-64 digits, to an equivalent 8-bit unsigned integer array. Parameters specify the subset in the input array and the number of elements to convert.

Parameters

NameDescriptionDefault
inArray A Unicode character array.
offset A position within inArray.
length The number of elements in inArray to convert.

Returns

An array of 8-bit unsigned integers equivalent to length elements at position offset in inArray.

System.Convert.FromBase64String()

Converts the specified string, which encodes binary data as base-64 digits, to an equivalent 8-bit unsigned integer array.

Parameters

NameDescriptionDefault
s The string to convert.

Returns

An array of 8-bit unsigned integers that is equivalent to s.

System.Convert.FromHexString()

Converts the span, which encodes binary data as hex characters, to an equivalent 8-bit unsigned integer array.

Parameters

NameDescriptionDefault
chars The span to convert.

Returns

An array of 8-bit unsigned integers that is equivalent to chars.

System.Convert.FromHexString()

Converts the specified string, which encodes binary data as hex characters, to an equivalent 8-bit unsigned integer array.

Parameters

NameDescriptionDefault
s The string to convert.

Returns

An array of 8-bit unsigned integers that is equivalent to s.

System.Convert.GetTypeCode()

Returns the System.TypeCode for the specified object.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.

Returns

The System.TypeCode for value, or System.TypeCode.Empty if value is null.

System.Convert.IsDBNull()

Returns an indication whether the specified object is of type System.DBNull.

Parameters

NameDescriptionDefault
value An object.

Returns

true if value is of type System.DBNull; otherwise, false.

System.Convert.ToBase64CharArray()

Converts a subset of an 8-bit unsigned integer array to an equivalent subset of a Unicode character array encoded with base-64 digits. Parameters specify the subsets as offsets in the input and output arrays, and the number of elements in the input array to convert.

Parameters

NameDescriptionDefault
inArray An input array of 8-bit unsigned integers.
offsetIn A position within inArray.
length The number of elements of inArray to convert.
outArray An output array of Unicode characters.
offsetOut A position within outArray.

Returns

A 32-bit signed integer containing the number of bytes in outArray.

System.Convert.ToBase64CharArray()

Converts a subset of an 8-bit unsigned integer array to an equivalent subset of a Unicode character array encoded with base-64 digits. Parameters specify the subsets as offsets in the input and output arrays, the number of elements in the input array to convert, and whether line breaks are inserted in the output array.

Parameters

NameDescriptionDefault
inArray An input array of 8-bit unsigned integers.
offsetIn A position within inArray.
length The number of elements of inArray to convert.
outArray An output array of Unicode characters.
offsetOut A position within outArray.
options System.Base64FormattingOptions.InsertLineBreaks to insert a line break every 76 characters, or System.Base64FormattingOptions.None to not insert line breaks.

Returns

A 32-bit signed integer containing the number of bytes in outArray.

System.Convert.ToBase64String()

Converts an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64 digits.

Parameters

NameDescriptionDefault
inArray An array of 8-bit unsigned integers.

Returns

The string representation, in base 64, of the contents of inArray.

System.Convert.ToBase64String()

Converts an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64 digits. You can specify whether to insert line breaks in the return value.

Parameters

NameDescriptionDefault
inArray An array of 8-bit unsigned integers.
options System.Base64FormattingOptions.InsertLineBreaks to insert a line break every 76 characters, or System.Base64FormattingOptions.None to not insert line breaks.

Returns

The string representation in base 64 of the elements in inArray.

System.Convert.ToBase64String()

Converts a subset of an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64 digits. Parameters specify the subset as an offset in the input array, and the number of elements in the array to convert.

Parameters

NameDescriptionDefault
inArray An array of 8-bit unsigned integers.
offset An offset in inArray.
length The number of elements of inArray to convert.

Returns

The string representation in base 64 of length elements of inArray, starting at position offset.

System.Convert.ToBase64String()

Converts a subset of an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64 digits. Parameters specify the subset as an offset in the input array, the number of elements in the array to convert, and whether to insert line breaks in the return value.

Parameters

NameDescriptionDefault
inArray An array of 8-bit unsigned integers.
offset An offset in inArray.
length The number of elements of inArray to convert.
options System.Base64FormattingOptions.InsertLineBreaks to insert a line break every 76 characters, or System.Base64FormattingOptions.None to not insert line breaks.

Returns

The string representation in base 64 of length elements of inArray, starting at position offset.

System.Convert.ToBase64String()

Converts the 8-bit unsigned integers inside the specified read-only span into their equivalent string representation that is encoded with base-64 digits. You can optionally specify whether to insert line breaks in the return value.

Parameters

NameDescriptionDefault
bytes A read-only span of 8-bit unsigned integers.
options One of the enumeration values that specify whether to insert line breaks in the return value. The default value is System.Base64FormattingOptions.None.

Returns

The string representation in base 64 of the elements in inArray. If the length of bytes is 0, an empty string is returned.

System.Convert.ToBoolean()

Returns the specified Boolean value; no actual conversion is performed.

Parameters

NameDescriptionDefault
value The Boolean value to return.

Returns

value is returned unchanged.

System.Convert.ToBoolean()

Converts the value of the specified 8-bit unsigned integer to an equivalent Boolean value.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.

Returns

true if value is not zero; otherwise, false.

System.Convert.ToBoolean()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The Unicode character to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToBoolean()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The date and time value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToBoolean()

Converts the value of the specified decimal number to an equivalent Boolean value.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

true if value is not zero; otherwise, false.

System.Convert.ToBoolean()

Converts the value of the specified double-precision floating-point number to an equivalent Boolean value.

Parameters

NameDescriptionDefault
value The double-precision floating-point number to convert.

Returns

true if value is not zero; otherwise, false.

System.Convert.ToBoolean()

Converts the value of the specified 16-bit signed integer to an equivalent Boolean value.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.

Returns

true if value is not zero; otherwise, false.

System.Convert.ToBoolean()

Converts the value of the specified 32-bit signed integer to an equivalent Boolean value.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.

Returns

true if value is not zero; otherwise, false.

System.Convert.ToBoolean()

Converts the value of the specified 64-bit signed integer to an equivalent Boolean value.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.

Returns

true if value is not zero; otherwise, false.

System.Convert.ToBoolean()

Converts the value of a specified object to an equivalent Boolean value.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface, or null.

Returns

true or false, which reflects the value returned by invoking the System.IConvertible.ToBoolean() method for the underlying type of value. If value is null, the method returns false.

System.Convert.ToBoolean()

Converts the value of the specified object to an equivalent Boolean value, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface, or null.
provider An object that supplies culture-specific formatting information.

Returns

true or false, which reflects the value returned by invoking the System.IConvertible.ToBoolean() method for the underlying type of value. If value is null, the method returns false.

System.Convert.ToBoolean()

Converts the value of the specified 8-bit signed integer to an equivalent Boolean value.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to convert.

Returns

true if value is not zero; otherwise, false.

System.Convert.ToBoolean()

Converts the value of the specified single-precision floating-point number to an equivalent Boolean value.

Parameters

NameDescriptionDefault
value The single-precision floating-point number to convert.

Returns

true if value is not zero; otherwise, false.

System.Convert.ToBoolean()

Converts the specified string representation of a logical value to its Boolean equivalent.

Parameters

NameDescriptionDefault
value A string that contains the value of either System.Boolean.TrueString or System.Boolean.FalseString.

Returns

true if value equals System.Boolean.TrueString, or false if value equals System.Boolean.FalseString or null.

System.Convert.ToBoolean()

Converts the specified string representation of a logical value to its Boolean equivalent, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value A string that contains the value of either System.Boolean.TrueString or System.Boolean.FalseString.
provider An object that supplies culture-specific formatting information. This parameter is ignored.

Returns

true if value equals System.Boolean.TrueString, or false if value equals System.Boolean.FalseString or null.

System.Convert.ToBoolean()

Converts the value of the specified 16-bit unsigned integer to an equivalent Boolean value.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to convert.

Returns

true if value is not zero; otherwise, false.

System.Convert.ToBoolean()

Converts the value of the specified 32-bit unsigned integer to an equivalent Boolean value.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to convert.

Returns

true if value is not zero; otherwise, false.

System.Convert.ToBoolean()

Converts the value of the specified 64-bit unsigned integer to an equivalent Boolean value.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to convert.

Returns

true if value is not zero; otherwise, false.

System.Convert.ToByte()

Converts the specified Boolean value to the equivalent 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value The Boolean value to convert.

Returns

The number 1 if value is true; otherwise, 0.

System.Convert.ToByte()

Returns the specified 8-bit unsigned integer; no actual conversion is performed.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to return.

Returns

value is returned unchanged.

System.Convert.ToByte()

Converts the value of the specified Unicode character to the equivalent 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value The Unicode character to convert.

Returns

An 8-bit unsigned integer that is equivalent to value.

System.Convert.ToByte()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The date and time value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToByte()

Converts the value of the specified decimal number to an equivalent 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

value, rounded to the nearest 8-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToByte()

Converts the value of the specified double-precision floating-point number to an equivalent 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value The double-precision floating-point number to convert.

Returns

value, rounded to the nearest 8-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToByte()

Converts the value of the specified 16-bit signed integer to an equivalent 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.

Returns

An 8-bit unsigned integer that is equivalent to value.

System.Convert.ToByte()

Converts the value of the specified 32-bit signed integer to an equivalent 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.

Returns

An 8-bit unsigned integer that is equivalent to value.

System.Convert.ToByte()

Converts the value of the specified 64-bit signed integer to an equivalent 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.

Returns

An 8-bit unsigned integer that is equivalent to value.

System.Convert.ToByte()

Converts the value of the specified object to an 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface, or null.

Returns

An 8-bit unsigned integer that is equivalent to value, or zero if value is null.

System.Convert.ToByte()

Converts the value of the specified object to an 8-bit unsigned integer, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
provider An object that supplies culture-specific formatting information.

Returns

An 8-bit unsigned integer that is equivalent to value, or zero if value is null.

System.Convert.ToByte()

Converts the value of the specified 8-bit signed integer to an equivalent 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to be converted.

Returns

An 8-bit unsigned integer that is equivalent to value.

System.Convert.ToByte()

Converts the value of the specified single-precision floating-point number to an equivalent 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value A single-precision floating-point number.

Returns

value, rounded to the nearest 8-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToByte()

Converts the specified string representation of a number to an equivalent 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.

Returns

An 8-bit unsigned integer that is equivalent to value, or zero if value is null.

System.Convert.ToByte()

Converts the specified string representation of a number to an equivalent 8-bit unsigned integer, using specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
provider An object that supplies culture-specific formatting information.

Returns

An 8-bit unsigned integer that is equivalent to value, or zero if value is null.

System.Convert.ToByte()

Converts the string representation of a number in a specified base to an equivalent 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
fromBase The base of the number in value, which must be 2, 8, 10, or 16.

Returns

An 8-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToByte()

Converts the value of the specified 16-bit unsigned integer to an equivalent 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to convert.

Returns

An 8-bit unsigned integer that is equivalent to value.

System.Convert.ToByte()

Converts the value of the specified 32-bit unsigned integer to an equivalent 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to convert.

Returns

An 8-bit unsigned integer that is equivalent to value.

System.Convert.ToByte()

Converts the value of the specified 64-bit unsigned integer to an equivalent 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to convert.

Returns

An 8-bit unsigned integer that is equivalent to value.

System.Convert.ToChar()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The Boolean value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToChar()

Converts the value of the specified 8-bit unsigned integer to its equivalent Unicode character.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.

Returns

A Unicode character that is equivalent to value.

System.Convert.ToChar()

Returns the specified Unicode character value; no actual conversion is performed.

Parameters

NameDescriptionDefault
value The Unicode character to return.

Returns

value is returned unchanged.

System.Convert.ToChar()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The date and time value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToChar()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The decimal number to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToChar()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The double-precision floating-point number to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToChar()

Converts the value of the specified 16-bit signed integer to its equivalent Unicode character.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.

Returns

A Unicode character that is equivalent to value.

System.Convert.ToChar()

Converts the value of the specified 32-bit signed integer to its equivalent Unicode character.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.

Returns

A Unicode character that is equivalent to value.

System.Convert.ToChar()

Converts the value of the specified 64-bit signed integer to its equivalent Unicode character.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.

Returns

A Unicode character that is equivalent to value.

System.Convert.ToChar()

Converts the value of the specified object to a Unicode character.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.

Returns

A Unicode character that is equivalent to value, or Char.MinValue if value is null.

System.Convert.ToChar()

Converts the value of the specified object to its equivalent Unicode character, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
provider An object that supplies culture-specific formatting information.

Returns

A Unicode character that is equivalent to value, or Char.MinValue if value is null.

System.Convert.ToChar()

Converts the value of the specified 8-bit signed integer to its equivalent Unicode character.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to convert.

Returns

A Unicode character that is equivalent to value.

System.Convert.ToChar()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The single-precision floating-point number to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToChar()

Converts the first character of a specified string to a Unicode character.

Parameters

NameDescriptionDefault
value A string of length 1.

Returns

A Unicode character that is equivalent to the first and only character in value.

System.Convert.ToChar()

Converts the first character of a specified string to a Unicode character, using specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value A string of length 1 or null.
provider An object that supplies culture-specific formatting information. This parameter is ignored.

Returns

A Unicode character that is equivalent to the first and only character in value.

System.Convert.ToChar()

Converts the value of the specified 16-bit unsigned integer to its equivalent Unicode character.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to convert.

Returns

A Unicode character that is equivalent to value.

System.Convert.ToChar()

Converts the value of the specified 32-bit unsigned integer to its equivalent Unicode character.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to convert.

Returns

A Unicode character that is equivalent to value.

System.Convert.ToChar()

Converts the value of the specified 64-bit unsigned integer to its equivalent Unicode character.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to convert.

Returns

A Unicode character that is equivalent to value.

System.Convert.ToDateTime()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The Boolean value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDateTime()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDateTime()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The Unicode character to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDateTime()

Returns the specified System.DateTime object; no actual conversion is performed.

Parameters

NameDescriptionDefault
value A date and time value.

Returns

value is returned unchanged.

System.Convert.ToDateTime()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The number to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDateTime()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The double-precision floating-point value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDateTime()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDateTime()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDateTime()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDateTime()

Converts the value of the specified object to a System.DateTime object.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface, or null.

Returns

The date and time equivalent of the value of value, or a date and time equivalent of DateTime.MinValue if value is null.

System.Convert.ToDateTime()

Converts the value of the specified object to a System.DateTime object, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
provider An object that supplies culture-specific formatting information.

Returns

The date and time equivalent of the value of value, or the date and time equivalent of DateTime.MinValue if value is null.

System.Convert.ToDateTime()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDateTime()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The single-precision floating-point value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDateTime()

Converts the specified string representation of a date and time to an equivalent date and time value.

Parameters

NameDescriptionDefault
value The string representation of a date and time.

Returns

The date and time equivalent of the value of value, or the date and time equivalent of DateTime.MinValue if value is null.

System.Convert.ToDateTime()

Converts the specified string representation of a number to an equivalent date and time, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value A string that contains a date and time to convert.
provider An object that supplies culture-specific formatting information.

Returns

The date and time equivalent of the value of value, or the date and time equivalent of DateTime.MinValue if value is null.

System.Convert.ToDateTime()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDateTime()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDateTime()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDecimal()

Converts the specified Boolean value to the equivalent decimal number.

Parameters

NameDescriptionDefault
value The Boolean value to convert.

Returns

The number 1 if value is true; otherwise, 0.

System.Convert.ToDecimal()

Converts the value of the specified 8-bit unsigned integer to the equivalent decimal number.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.

Returns

The decimal number that is equivalent to value.

System.Convert.ToDecimal()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The Unicode character to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDecimal()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The date and time value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDecimal()

Returns the specified decimal number; no actual conversion is performed.

Parameters

NameDescriptionDefault
value A decimal number.

Returns

value is returned unchanged.

System.Convert.ToDecimal()

Converts the value of the specified double-precision floating-point number to an equivalent decimal number.

Parameters

NameDescriptionDefault
value The double-precision floating-point number to convert.

Returns

A decimal number that is equivalent to value.

System.Convert.ToDecimal()

Converts the value of the specified 16-bit signed integer to an equivalent decimal number.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.

Returns

A decimal number that is equivalent to value.

System.Convert.ToDecimal()

Converts the value of the specified 32-bit signed integer to an equivalent decimal number.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.

Returns

A decimal number that is equivalent to value.

System.Convert.ToDecimal()

Converts the value of the specified 64-bit signed integer to an equivalent decimal number.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.

Returns

A decimal number that is equivalent to value.

System.Convert.ToDecimal()

Converts the value of the specified object to an equivalent decimal number.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface, or null.

Returns

A decimal number that is equivalent to value, or 0 (zero) if value is null.

System.Convert.ToDecimal()

Converts the value of the specified object to an equivalent decimal number, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
provider An object that supplies culture-specific formatting information.

Returns

A decimal number that is equivalent to value, or 0 (zero) if value is null.

System.Convert.ToDecimal()

Converts the value of the specified 8-bit signed integer to the equivalent decimal number.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to convert.

Returns

A decimal number that is equivalent to value.

System.Convert.ToDecimal()

Converts the value of the specified single-precision floating-point number to the equivalent decimal number.

Parameters

NameDescriptionDefault
value The single-precision floating-point number to convert.

Returns

A decimal number that is equivalent to value.

System.Convert.ToDecimal()

Converts the specified string representation of a number to an equivalent decimal number.

Parameters

NameDescriptionDefault
value A string that contains a number to convert.

Returns

A decimal number that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToDecimal()

Converts the specified string representation of a number to an equivalent decimal number, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value A string that contains a number to convert.
provider An object that supplies culture-specific formatting information.

Returns

A decimal number that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToDecimal()

Converts the value of the specified 16-bit unsigned integer to an equivalent decimal number.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to convert.

Returns

The decimal number that is equivalent to value.

System.Convert.ToDecimal()

Converts the value of the specified 32-bit unsigned integer to an equivalent decimal number.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to convert.

Returns

A decimal number that is equivalent to value.

System.Convert.ToDecimal()

Converts the value of the specified 64-bit unsigned integer to an equivalent decimal number.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to convert.

Returns

A decimal number that is equivalent to value.

System.Convert.ToDouble()

Converts the specified Boolean value to the equivalent double-precision floating-point number.

Parameters

NameDescriptionDefault
value The Boolean value to convert.

Returns

The number 1 if value is true; otherwise, 0.

System.Convert.ToDouble()

Converts the value of the specified 8-bit unsigned integer to the equivalent double-precision floating-point number.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.

Returns

The double-precision floating-point number that is equivalent to value.

System.Convert.ToDouble()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The Unicode character to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDouble()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The date and time value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToDouble()

Converts the value of the specified decimal number to an equivalent double-precision floating-point number.

Parameters

NameDescriptionDefault
value The decimal number to convert.

Returns

A double-precision floating-point number that is equivalent to value.

System.Convert.ToDouble()

Returns the specified double-precision floating-point number; no actual conversion is performed.

Parameters

NameDescriptionDefault
value The double-precision floating-point number to return.

Returns

value is returned unchanged.

System.Convert.ToDouble()

Converts the value of the specified 16-bit signed integer to an equivalent double-precision floating-point number.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.

Returns

A double-precision floating-point number equivalent to value.

System.Convert.ToDouble()

Converts the value of the specified 32-bit signed integer to an equivalent double-precision floating-point number.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.

Returns

A double-precision floating-point number that is equivalent to value.

System.Convert.ToDouble()

Converts the value of the specified 64-bit signed integer to an equivalent double-precision floating-point number.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.

Returns

A double-precision floating-point number that is equivalent to value.

System.Convert.ToDouble()

Converts the value of the specified object to a double-precision floating-point number.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface, or null.

Returns

A double-precision floating-point number that is equivalent to value, or zero if value is null.

System.Convert.ToDouble()

Converts the value of the specified object to an double-precision floating-point number, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
provider An object that supplies culture-specific formatting information.

Returns

A double-precision floating-point number that is equivalent to value, or zero if value is null.

System.Convert.ToDouble()

Converts the value of the specified 8-bit signed integer to the equivalent double-precision floating-point number.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to convert.

Returns

The 8-bit signed integer that is equivalent to value.

System.Convert.ToDouble()

Converts the value of the specified single-precision floating-point number to an equivalent double-precision floating-point number.

Parameters

NameDescriptionDefault
value The single-precision floating-point number.

Returns

A double-precision floating-point number that is equivalent to value.

System.Convert.ToDouble()

Converts the specified string representation of a number to an equivalent double-precision floating-point number.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.

Returns

A double-precision floating-point number that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToDouble()

Converts the specified string representation of a number to an equivalent double-precision floating-point number, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
provider An object that supplies culture-specific formatting information.

Returns

A double-precision floating-point number that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToDouble()

Converts the value of the specified 16-bit unsigned integer to the equivalent double-precision floating-point number.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to convert.

Returns

A double-precision floating-point number that is equivalent to value.

System.Convert.ToDouble()

Converts the value of the specified 32-bit unsigned integer to an equivalent double-precision floating-point number.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to convert.

Returns

A double-precision floating-point number that is equivalent to value.

System.Convert.ToDouble()

Converts the value of the specified 64-bit unsigned integer to an equivalent double-precision floating-point number.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to convert.

Returns

A double-precision floating-point number that is equivalent to value.

System.Convert.ToHexString()

Converts an array of 8-bit unsigned integers to its equivalent string representation that is encoded with uppercase hex characters.

Parameters

NameDescriptionDefault
inArray An array of 8-bit unsigned integers.

Returns

The string representation in hex of the elements in inArray.

System.Convert.ToHexString()

Converts a subset of an array of 8-bit unsigned integers to its equivalent string representation that is encoded with uppercase hex characters. Parameters specify the subset as an offset in the input array and the number of elements in the array to convert.

Parameters

NameDescriptionDefault
inArray An array of 8-bit unsigned integers.
offset An offset in inArray.
length The number of elements of inArray to convert.

Returns

The string representation in hex of length elements of inArray, starting at position offset.

System.Convert.ToHexString()

Converts a span of 8-bit unsigned integers to its equivalent string representation that is encoded with uppercase hex characters.

Parameters

NameDescriptionDefault
bytes A span of 8-bit unsigned integers.

Returns

The string representation in hex of the elements in bytes.

System.Convert.ToInt16()

Converts the specified Boolean value to the equivalent 16-bit signed integer.

Parameters

NameDescriptionDefault
value The Boolean value to convert.

Returns

The number 1 if value is true; otherwise, 0.

System.Convert.ToInt16()

Converts the value of the specified 8-bit unsigned integer to the equivalent 16-bit signed integer.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.

Returns

A 16-bit signed integer that is equivalent to value.

System.Convert.ToInt16()

Converts the value of the specified Unicode character to the equivalent 16-bit signed integer.

Parameters

NameDescriptionDefault
value The Unicode character to convert.

Returns

A 16-bit signed integer that is equivalent to value.

System.Convert.ToInt16()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The date and time value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToInt16()

Converts the value of the specified decimal number to an equivalent 16-bit signed integer.

Parameters

NameDescriptionDefault
value The decimal number to convert.

Returns

value, rounded to the nearest 16-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToInt16()

Converts the value of the specified double-precision floating-point number to an equivalent 16-bit signed integer.

Parameters

NameDescriptionDefault
value The double-precision floating-point number to convert.

Returns

value, rounded to the nearest 16-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToInt16()

Returns the specified 16-bit signed integer; no actual conversion is performed.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to return.

Returns

value is returned unchanged.

System.Convert.ToInt16()

Converts the value of the specified 32-bit signed integer to an equivalent 16-bit signed integer.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.

Returns

The 16-bit signed integer equivalent of value.

System.Convert.ToInt16()

Converts the value of the specified 64-bit signed integer to an equivalent 16-bit signed integer.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.

Returns

A 16-bit signed integer that is equivalent to value.

System.Convert.ToInt16()

Converts the value of the specified object to a 16-bit signed integer.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface, or null.

Returns

A 16-bit signed integer that is equivalent to value, or zero if value is null.

System.Convert.ToInt16()

Converts the value of the specified object to a 16-bit signed integer, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
provider An object that supplies culture-specific formatting information.

Returns

A 16-bit signed integer that is equivalent to value, or zero if value is null.

System.Convert.ToInt16()

Converts the value of the specified 8-bit signed integer to the equivalent 16-bit signed integer.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to convert.

Returns

A 8-bit signed integer that is equivalent to value.

System.Convert.ToInt16()

Converts the value of the specified single-precision floating-point number to an equivalent 16-bit signed integer.

Parameters

NameDescriptionDefault
value The single-precision floating-point number to convert.

Returns

value, rounded to the nearest 16-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToInt16()

Converts the specified string representation of a number to an equivalent 16-bit signed integer.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.

Returns

A 16-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToInt16()

Converts the specified string representation of a number to an equivalent 16-bit signed integer, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
provider An object that supplies culture-specific formatting information.

Returns

A 16-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToInt16()

Converts the string representation of a number in a specified base to an equivalent 16-bit signed integer.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
fromBase The base of the number in value, which must be 2, 8, 10, or 16.

Returns

A 16-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToInt16()

Converts the value of the specified 16-bit unsigned integer to the equivalent 16-bit signed integer.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to convert.

Returns

A 16-bit signed integer that is equivalent to value.

System.Convert.ToInt16()

Converts the value of the specified 32-bit unsigned integer to an equivalent 16-bit signed integer.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to convert.

Returns

A 16-bit signed integer that is equivalent to value.

System.Convert.ToInt16()

Converts the value of the specified 64-bit unsigned integer to an equivalent 16-bit signed integer.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to convert.

Returns

A 16-bit signed integer that is equivalent to value.

System.Convert.ToInt32()

Converts the specified Boolean value to the equivalent 32-bit signed integer.

Parameters

NameDescriptionDefault
value The Boolean value to convert.

Returns

The number 1 if value is true; otherwise, 0.

System.Convert.ToInt32()

Converts the value of the specified 8-bit unsigned integer to the equivalent 32-bit signed integer.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.

Returns

A 32-bit signed integer that is equivalent to value.

System.Convert.ToInt32()

Converts the value of the specified Unicode character to the equivalent 32-bit signed integer.

Parameters

NameDescriptionDefault
value The Unicode character to convert.

Returns

A 32-bit signed integer that is equivalent to value.

System.Convert.ToInt32()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The date and time value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToInt32()

Converts the value of the specified decimal number to an equivalent 32-bit signed integer.

Parameters

NameDescriptionDefault
value The decimal number to convert.

Returns

value, rounded to the nearest 32-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToInt32()

Converts the value of the specified double-precision floating-point number to an equivalent 32-bit signed integer.

Parameters

NameDescriptionDefault
value The double-precision floating-point number to convert.

Returns

value, rounded to the nearest 32-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToInt32()

Converts the value of the specified 16-bit signed integer to an equivalent 32-bit signed integer.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.

Returns

A 32-bit signed integer that is equivalent to value.

System.Convert.ToInt32()

Returns the specified 32-bit signed integer; no actual conversion is performed.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to return.

Returns

value is returned unchanged.

System.Convert.ToInt32()

Converts the value of the specified 64-bit signed integer to an equivalent 32-bit signed integer.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.

Returns

A 32-bit signed integer that is equivalent to value.

System.Convert.ToInt32()

Converts the value of the specified object to a 32-bit signed integer.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface, or null.

Returns

A 32-bit signed integer equivalent to value, or zero if value is null.

System.Convert.ToInt32()

Converts the value of the specified object to a 32-bit signed integer, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
provider An object that supplies culture-specific formatting information.

Returns

A 32-bit signed integer that is equivalent to value, or zero if value is null.

System.Convert.ToInt32()

Converts the value of the specified 8-bit signed integer to the equivalent 32-bit signed integer.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to convert.

Returns

A 8-bit signed integer that is equivalent to value.

System.Convert.ToInt32()

Converts the value of the specified single-precision floating-point number to an equivalent 32-bit signed integer.

Parameters

NameDescriptionDefault
value The single-precision floating-point number to convert.

Returns

value, rounded to the nearest 32-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToInt32()

Converts the specified string representation of a number to an equivalent 32-bit signed integer.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.

Returns

A 32-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToInt32()

Converts the specified string representation of a number to an equivalent 32-bit signed integer, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
provider An object that supplies culture-specific formatting information.

Returns

A 32-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToInt32()

Converts the string representation of a number in a specified base to an equivalent 32-bit signed integer.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
fromBase The base of the number in value, which must be 2, 8, 10, or 16.

Returns

A 32-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToInt32()

Converts the value of the specified 16-bit unsigned integer to the equivalent 32-bit signed integer.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to convert.

Returns

A 32-bit signed integer that is equivalent to value.

System.Convert.ToInt32()

Converts the value of the specified 32-bit unsigned integer to an equivalent 32-bit signed integer.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to convert.

Returns

A 32-bit signed integer that is equivalent to value.

System.Convert.ToInt32()

Converts the value of the specified 64-bit unsigned integer to an equivalent 32-bit signed integer.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to convert.

Returns

A 32-bit signed integer that is equivalent to value.

System.Convert.ToInt64()

Converts the specified Boolean value to the equivalent 64-bit signed integer.

Parameters

NameDescriptionDefault
value The Boolean value to convert.

Returns

The number 1 if value is true; otherwise, 0.

System.Convert.ToInt64()

Converts the value of the specified 8-bit unsigned integer to the equivalent 64-bit signed integer.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.

Returns

A 64-bit signed integer that is equivalent to value.

System.Convert.ToInt64()

Converts the value of the specified Unicode character to the equivalent 64-bit signed integer.

Parameters

NameDescriptionDefault
value The Unicode character to convert.

Returns

A 64-bit signed integer that is equivalent to value.

System.Convert.ToInt64()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The date and time value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToInt64()

Converts the value of the specified decimal number to an equivalent 64-bit signed integer.

Parameters

NameDescriptionDefault
value The decimal number to convert.

Returns

value, rounded to the nearest 64-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToInt64()

Converts the value of the specified double-precision floating-point number to an equivalent 64-bit signed integer.

Parameters

NameDescriptionDefault
value The double-precision floating-point number to convert.

Returns

value, rounded to the nearest 64-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToInt64()

Converts the value of the specified 16-bit signed integer to an equivalent 64-bit signed integer.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.

Returns

A 64-bit signed integer that is equivalent to value.

System.Convert.ToInt64()

Converts the value of the specified 32-bit signed integer to an equivalent 64-bit signed integer.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.

Returns

A 64-bit signed integer that is equivalent to value.

System.Convert.ToInt64()

Returns the specified 64-bit signed integer; no actual conversion is performed.

Parameters

NameDescriptionDefault
value A 64-bit signed integer.

Returns

value is returned unchanged.

System.Convert.ToInt64()

Converts the value of the specified object to a 64-bit signed integer.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface, or null.

Returns

A 64-bit signed integer that is equivalent to value, or zero if value is null.

System.Convert.ToInt64()

Converts the value of the specified object to a 64-bit signed integer, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
provider An object that supplies culture-specific formatting information.

Returns

A 64-bit signed integer that is equivalent to value, or zero if value is null.

System.Convert.ToInt64()

Converts the value of the specified 8-bit signed integer to the equivalent 64-bit signed integer.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to convert.

Returns

A 64-bit signed integer that is equivalent to value.

System.Convert.ToInt64()

Converts the value of the specified single-precision floating-point number to an equivalent 64-bit signed integer.

Parameters

NameDescriptionDefault
value The single-precision floating-point number to convert.

Returns

value, rounded to the nearest 64-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToInt64()

Converts the specified string representation of a number to an equivalent 64-bit signed integer.

Parameters

NameDescriptionDefault
value A string that contains a number to convert.

Returns

A 64-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToInt64()

Converts the specified string representation of a number to an equivalent 64-bit signed integer, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
provider An object that supplies culture-specific formatting information.

Returns

A 64-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToInt64()

Converts the string representation of a number in a specified base to an equivalent 64-bit signed integer.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
fromBase The base of the number in value, which must be 2, 8, 10, or 16.

Returns

A 64-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToInt64()

Converts the value of the specified 16-bit unsigned integer to the equivalent 64-bit signed integer.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to convert.

Returns

A 64-bit signed integer that is equivalent to value.

System.Convert.ToInt64()

Converts the value of the specified 32-bit unsigned integer to an equivalent 64-bit signed integer.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to convert.

Returns

A 64-bit signed integer that is equivalent to value.

System.Convert.ToInt64()

Converts the value of the specified 64-bit unsigned integer to an equivalent 64-bit signed integer.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to convert.

Returns

A 64-bit signed integer that is equivalent to value.

System.Convert.ToSByte()

Converts the specified Boolean value to the equivalent 8-bit signed integer.

Parameters

NameDescriptionDefault
value The Boolean value to convert.

Returns

The number 1 if value is true; otherwise, 0.

System.Convert.ToSByte()

Converts the value of the specified 8-bit unsigned integer to the equivalent 8-bit signed integer.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.

Returns

An 8-bit signed integer that is equivalent to value.

System.Convert.ToSByte()

Converts the value of the specified Unicode character to the equivalent 8-bit signed integer.

Parameters

NameDescriptionDefault
value The Unicode character to convert.

Returns

An 8-bit signed integer that is equivalent to value.

System.Convert.ToSByte()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The date and time value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToSByte()

Converts the value of the specified decimal number to an equivalent 8-bit signed integer.

Parameters

NameDescriptionDefault
value The decimal number to convert.

Returns

value, rounded to the nearest 8-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToSByte()

Converts the value of the specified double-precision floating-point number to an equivalent 8-bit signed integer.

Parameters

NameDescriptionDefault
value The double-precision floating-point number to convert.

Returns

value, rounded to the nearest 8-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToSByte()

Converts the value of the specified 16-bit signed integer to the equivalent 8-bit signed integer.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.

Returns

An 8-bit signed integer that is equivalent to value.

System.Convert.ToSByte()

Converts the value of the specified 32-bit signed integer to an equivalent 8-bit signed integer.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.

Returns

An 8-bit signed integer that is equivalent to value.

System.Convert.ToSByte()

Converts the value of the specified 64-bit signed integer to an equivalent 8-bit signed integer.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.

Returns

An 8-bit signed integer that is equivalent to value.

System.Convert.ToSByte()

Converts the value of the specified object to an 8-bit signed integer.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface, or null.

Returns

An 8-bit signed integer that is equivalent to value, or zero if value is null.

System.Convert.ToSByte()

Converts the value of the specified object to an 8-bit signed integer, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
provider An object that supplies culture-specific formatting information.

Returns

An 8-bit signed integer that is equivalent to value, or zero if value is null.

System.Convert.ToSByte()

Returns the specified 8-bit signed integer; no actual conversion is performed.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to return.

Returns

value is returned unchanged.

System.Convert.ToSByte()

Converts the value of the specified single-precision floating-point number to an equivalent 8-bit signed integer.

Parameters

NameDescriptionDefault
value The single-precision floating-point number to convert.

Returns

value, rounded to the nearest 8-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToSByte()

Converts the specified string representation of a number to an equivalent 8-bit signed integer.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.

Returns

An 8-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToSByte()

Converts the specified string representation of a number to an equivalent 8-bit signed integer, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
provider An object that supplies culture-specific formatting information.

Returns

An 8-bit signed integer that is equivalent to value.

System.Convert.ToSByte()

Converts the string representation of a number in a specified base to an equivalent 8-bit signed integer.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
fromBase The base of the number in value, which must be 2, 8, 10, or 16.

Returns

An 8-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToSByte()

Converts the value of the specified 16-bit unsigned integer to the equivalent 8-bit signed integer.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to convert.

Returns

An 8-bit signed integer that is equivalent to value.

System.Convert.ToSByte()

Converts the value of the specified 32-bit unsigned integer to an equivalent 8-bit signed integer.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to convert.

Returns

An 8-bit signed integer that is equivalent to value.

System.Convert.ToSByte()

Converts the value of the specified 64-bit unsigned integer to an equivalent 8-bit signed integer.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to convert.

Returns

An 8-bit signed integer that is equivalent to value.

System.Convert.ToSingle()

Converts the specified Boolean value to the equivalent single-precision floating-point number.

Parameters

NameDescriptionDefault
value The Boolean value to convert.

Returns

The number 1 if value is true; otherwise, 0.

System.Convert.ToSingle()

Converts the value of the specified 8-bit unsigned integer to the equivalent single-precision floating-point number.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.

Returns

A single-precision floating-point number that is equivalent to value.

System.Convert.ToSingle()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The Unicode character to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToSingle()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The date and time value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToSingle()

Converts the value of the specified decimal number to an equivalent single-precision floating-point number.

Parameters

NameDescriptionDefault
value The decimal number to convert.

Returns

A single-precision floating-point number that is equivalent to value. value is rounded using rounding to nearest. For example, when rounded to two decimals, the value 2.345 becomes 2.34 and the value 2.355 becomes 2.36.

System.Convert.ToSingle()

Converts the value of the specified double-precision floating-point number to an equivalent single-precision floating-point number.

Parameters

NameDescriptionDefault
value The double-precision floating-point number to convert.

Returns

A single-precision floating-point number that is equivalent to value. value is rounded using rounding to nearest. For example, when rounded to two decimals, the value 2.345 becomes 2.34 and the value 2.355 becomes 2.36.

System.Convert.ToSingle()

Converts the value of the specified 16-bit signed integer to an equivalent single-precision floating-point number.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.

Returns

A single-precision floating-point number that is equivalent to value.

System.Convert.ToSingle()

Converts the value of the specified 32-bit signed integer to an equivalent single-precision floating-point number.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.

Returns

A single-precision floating-point number that is equivalent to value.

System.Convert.ToSingle()

Converts the value of the specified 64-bit signed integer to an equivalent single-precision floating-point number.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.

Returns

A single-precision floating-point number that is equivalent to value.

System.Convert.ToSingle()

Converts the value of the specified object to a single-precision floating-point number.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface, or null.

Returns

A single-precision floating-point number that is equivalent to value, or zero if value is null.

System.Convert.ToSingle()

Converts the value of the specified object to an single-precision floating-point number, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
provider An object that supplies culture-specific formatting information.

Returns

A single-precision floating-point number that is equivalent to value, or zero if value is null.

System.Convert.ToSingle()

Converts the value of the specified 8-bit signed integer to the equivalent single-precision floating-point number.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to convert.

Returns

An 8-bit signed integer that is equivalent to value.

System.Convert.ToSingle()

Returns the specified single-precision floating-point number; no actual conversion is performed.

Parameters

NameDescriptionDefault
value The single-precision floating-point number to return.

Returns

value is returned unchanged.

System.Convert.ToSingle()

Converts the specified string representation of a number to an equivalent single-precision floating-point number.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.

Returns

A single-precision floating-point number that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToSingle()

Converts the specified string representation of a number to an equivalent single-precision floating-point number, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
provider An object that supplies culture-specific formatting information.

Returns

A single-precision floating-point number that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToSingle()

Converts the value of the specified 16-bit unsigned integer to the equivalent single-precision floating-point number.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to convert.

Returns

A single-precision floating-point number that is equivalent to value.

System.Convert.ToSingle()

Converts the value of the specified 32-bit unsigned integer to an equivalent single-precision floating-point number.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to convert.

Returns

A single-precision floating-point number that is equivalent to value.

System.Convert.ToSingle()

Converts the value of the specified 64-bit unsigned integer to an equivalent single-precision floating-point number.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to convert.

Returns

A single-precision floating-point number that is equivalent to value.

System.Convert.ToString()

Converts the specified Boolean value to its equivalent string representation.

Parameters

NameDescriptionDefault
value The Boolean value to convert.

Returns

The string representation of value.

System.Convert.ToString()

Converts the specified Boolean value to its equivalent string representation.

Parameters

NameDescriptionDefault
value The Boolean value to convert.
provider An instance of an object. This parameter is ignored.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified 8-bit unsigned integer to its equivalent string representation.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified 8-bit unsigned integer to its equivalent string representation, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of an 8-bit unsigned integer to its equivalent string representation in a specified base.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.
toBase The base of the return value, which must be 2, 8, 10, or 16.

Returns

The string representation of value in base toBase.

System.Convert.ToString()

Converts the value of the specified Unicode character to its equivalent string representation.

Parameters

NameDescriptionDefault
value The Unicode character to convert.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified Unicode character to its equivalent string representation, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value The Unicode character to convert.
provider An object that supplies culture-specific formatting information. This parameter is ignored.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified System.DateTime to its equivalent string representation.

Parameters

NameDescriptionDefault
value The date and time value to convert.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified System.DateTime to its equivalent string representation, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value The date and time value to convert.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified decimal number to its equivalent string representation.

Parameters

NameDescriptionDefault
value The decimal number to convert.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified decimal number to its equivalent string representation, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value The decimal number to convert.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified double-precision floating-point number to its equivalent string representation.

Parameters

NameDescriptionDefault
value The double-precision floating-point number to convert.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified double-precision floating-point number to its equivalent string representation.

Parameters

NameDescriptionDefault
value The double-precision floating-point number to convert.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified 16-bit signed integer to its equivalent string representation.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified 16-bit signed integer to its equivalent string representation, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of a 16-bit signed integer to its equivalent string representation in a specified base.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.
toBase The base of the return value, which must be 2, 8, 10, or 16.

Returns

The string representation of value in base toBase.

System.Convert.ToString()

Converts the value of the specified 32-bit signed integer to its equivalent string representation.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified 32-bit signed integer to its equivalent string representation, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of a 32-bit signed integer to its equivalent string representation in a specified base.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.
toBase The base of the return value, which must be 2, 8, 10, or 16.

Returns

The string representation of value in base toBase.

System.Convert.ToString()

Converts the value of the specified 64-bit signed integer to its equivalent string representation.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified 64-bit signed integer to its equivalent string representation, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of a 64-bit signed integer to its equivalent string representation in a specified base.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.
toBase The base of the return value, which must be 2, 8, 10, or 16.

Returns

The string representation of value in base toBase.

System.Convert.ToString()

Converts the value of the specified object to its equivalent string representation.

Parameters

NameDescriptionDefault
value An object that supplies the value to convert, or null.

Returns

The string representation of value, or System.String.Empty if value is null.

System.Convert.ToString()

Converts the value of the specified object to its equivalent string representation using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that supplies the value to convert, or null.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of value, or System.String.Empty if value is an object whose value is null. If value is null, the method returns null.

System.Convert.ToString()

Converts the value of the specified 8-bit signed integer to its equivalent string representation.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to convert.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified 8-bit signed integer to its equivalent string representation, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to convert.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified single-precision floating-point number to its equivalent string representation.

Parameters

NameDescriptionDefault
value The single-precision floating-point number to convert.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified single-precision floating-point number to its equivalent string representation, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value The single-precision floating-point number to convert.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of value.

System.Convert.ToString()

Returns the specified string instance; no actual conversion is performed.

Parameters

NameDescriptionDefault
value The string to return.

Returns

value is returned unchanged.

System.Convert.ToString()

Returns the specified string instance; no actual conversion is performed.

Parameters

NameDescriptionDefault
value The string to return.
provider An object that supplies culture-specific formatting information. This parameter is ignored.

Returns

value is returned unchanged.

System.Convert.ToString()

Converts the value of the specified 16-bit unsigned integer to its equivalent string representation.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to convert.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified 16-bit unsigned integer to its equivalent string representation, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to convert.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified 32-bit unsigned integer to its equivalent string representation.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to convert.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified 32-bit unsigned integer to its equivalent string representation, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to convert.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified 64-bit unsigned integer to its equivalent string representation.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to convert.

Returns

The string representation of value.

System.Convert.ToString()

Converts the value of the specified 64-bit unsigned integer to its equivalent string representation, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to convert.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of value.

System.Convert.ToUInt16()

Converts the specified Boolean value to the equivalent 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value The Boolean value to convert.

Returns

The number 1 if value is true; otherwise, 0.

System.Convert.ToUInt16()

Converts the value of the specified 8-bit unsigned integer to the equivalent 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.

Returns

A 16-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt16()

Converts the value of the specified Unicode character to the equivalent 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value The Unicode character to convert.

Returns

The 16-bit unsigned integer equivalent to value.

System.Convert.ToUInt16()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The date and time value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToUInt16()

Converts the value of the specified decimal number to an equivalent 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value The decimal number to convert.

Returns

value, rounded to the nearest 16-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToUInt16()

Converts the value of the specified double-precision floating-point number to an equivalent 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value The double-precision floating-point number to convert.

Returns

value, rounded to the nearest 16-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToUInt16()

Converts the value of the specified 16-bit signed integer to the equivalent 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.

Returns

A 16-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt16()

Converts the value of the specified 32-bit signed integer to an equivalent 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.

Returns

A 16-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt16()

Converts the value of the specified 64-bit signed integer to an equivalent 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.

Returns

A 16-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt16()

Converts the value of the specified object to a 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface, or null.

Returns

A 16-bit unsigned integer that is equivalent to value, or zero if value is null.

System.Convert.ToUInt16()

Converts the value of the specified object to a 16-bit unsigned integer, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
provider An object that supplies culture-specific formatting information.

Returns

A 16-bit unsigned integer that is equivalent to value, or zero if value is null.

System.Convert.ToUInt16()

Converts the value of the specified 8-bit signed integer to the equivalent 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to convert.

Returns

A 16-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt16()

Converts the value of the specified single-precision floating-point number to an equivalent 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value The single-precision floating-point number to convert.

Returns

value, rounded to the nearest 16-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToUInt16()

Converts the specified string representation of a number to an equivalent 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.

Returns

A 16-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToUInt16()

Converts the specified string representation of a number to an equivalent 16-bit unsigned integer, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
provider An object that supplies culture-specific formatting information.

Returns

A 16-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToUInt16()

Converts the string representation of a number in a specified base to an equivalent 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
fromBase The base of the number in value, which must be 2, 8, 10, or 16.

Returns

A 16-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToUInt16()

Returns the specified 16-bit unsigned integer; no actual conversion is performed.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to return.

Returns

value is returned unchanged.

System.Convert.ToUInt16()

Converts the value of the specified 32-bit unsigned integer to an equivalent 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to convert.

Returns

A 16-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt16()

Converts the value of the specified 64-bit unsigned integer to an equivalent 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to convert.

Returns

A 16-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt32()

Converts the specified Boolean value to the equivalent 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value The Boolean value to convert.

Returns

The number 1 if value is true; otherwise, 0.

System.Convert.ToUInt32()

Converts the value of the specified 8-bit unsigned integer to the equivalent 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.

Returns

A 32-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt32()

Converts the value of the specified Unicode character to the equivalent 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value The Unicode character to convert.

Returns

A 32-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt32()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The date and time value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToUInt32()

Converts the value of the specified decimal number to an equivalent 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value The decimal number to convert.

Returns

value, rounded to the nearest 32-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToUInt32()

Converts the value of the specified double-precision floating-point number to an equivalent 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value The double-precision floating-point number to convert.

Returns

value, rounded to the nearest 32-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToUInt32()

Converts the value of the specified 16-bit signed integer to the equivalent 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.

Returns

A 32-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt32()

Converts the value of the specified 32-bit signed integer to an equivalent 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.

Returns

A 32-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt32()

Converts the value of the specified 64-bit signed integer to an equivalent 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.

Returns

A 32-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt32()

Converts the value of the specified object to a 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface, or null.

Returns

A 32-bit unsigned integer that is equivalent to value, or 0 (zero) if value is null.

System.Convert.ToUInt32()

Converts the value of the specified object to a 32-bit unsigned integer, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
provider An object that supplies culture-specific formatting information.

Returns

A 32-bit unsigned integer that is equivalent to value, or zero if value is null.

System.Convert.ToUInt32()

Converts the value of the specified 8-bit signed integer to the equivalent 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to convert.

Returns

A 32-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt32()

Converts the value of the specified single-precision floating-point number to an equivalent 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value The single-precision floating-point number to convert.

Returns

value, rounded to the nearest 32-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToUInt32()

Converts the specified string representation of a number to an equivalent 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.

Returns

A 32-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToUInt32()

Converts the specified string representation of a number to an equivalent 32-bit unsigned integer, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
provider An object that supplies culture-specific formatting information.

Returns

A 32-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToUInt32()

Converts the string representation of a number in a specified base to an equivalent 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
fromBase The base of the number in value, which must be 2, 8, 10, or 16.

Returns

A 32-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToUInt32()

Converts the value of the specified 16-bit unsigned integer to the equivalent 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to convert.

Returns

A 32-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt32()

Returns the specified 32-bit unsigned integer; no actual conversion is performed.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to return.

Returns

value is returned unchanged.

System.Convert.ToUInt32()

Converts the value of the specified 64-bit unsigned integer to an equivalent 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to convert.

Returns

A 32-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt64()

Converts the specified Boolean value to the equivalent 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value The Boolean value to convert.

Returns

The number 1 if value is true; otherwise, 0.

System.Convert.ToUInt64()

Converts the value of the specified 8-bit unsigned integer to the equivalent 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.

Returns

A 64-bit signed integer that is equivalent to value.

System.Convert.ToUInt64()

Converts the value of the specified Unicode character to the equivalent 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value The Unicode character to convert.

Returns

A 64-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt64()

Calling this method always throws System.InvalidCastException.

Parameters

NameDescriptionDefault
value The date and time value to convert.

Returns

This conversion is not supported. No value is returned.

System.Convert.ToUInt64()

Converts the value of the specified decimal number to an equivalent 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value The decimal number to convert.

Returns

value, rounded to the nearest 64-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToUInt64()

Converts the value of the specified double-precision floating-point number to an equivalent 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value The double-precision floating-point number to convert.

Returns

value, rounded to the nearest 64-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToUInt64()

Converts the value of the specified 16-bit signed integer to the equivalent 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.

Returns

A 64-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt64()

Converts the value of the specified 32-bit signed integer to an equivalent 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.

Returns

A 64-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt64()

Converts the value of the specified 64-bit signed integer to an equivalent 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.

Returns

A 64-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt64()

Converts the value of the specified object to a 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface, or null.

Returns

A 64-bit unsigned integer that is equivalent to value, or zero if value is null.

System.Convert.ToUInt64()

Converts the value of the specified object to a 64-bit unsigned integer, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value An object that implements the System.IConvertible interface.
provider An object that supplies culture-specific formatting information.

Returns

A 64-bit unsigned integer that is equivalent to value, or zero if value is null.

System.Convert.ToUInt64()

Converts the value of the specified 8-bit signed integer to the equivalent 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to convert.

Returns

A 64-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt64()

Converts the value of the specified single-precision floating-point number to an equivalent 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value The single-precision floating-point number to convert.

Returns

value, rounded to the nearest 64-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6.

System.Convert.ToUInt64()

Converts the specified string representation of a number to an equivalent 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.

Returns

A 64-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToUInt64()

Converts the specified string representation of a number to an equivalent 64-bit unsigned integer, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
provider An object that supplies culture-specific formatting information.

Returns

A 64-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToUInt64()

Converts the string representation of a number in a specified base to an equivalent 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value A string that contains the number to convert.
fromBase The base of the number in value, which must be 2, 8, 10, or 16.

Returns

A 64-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null.

System.Convert.ToUInt64()

Converts the value of the specified 16-bit unsigned integer to the equivalent 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to convert.

Returns

A 64-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt64()

Converts the value of the specified 32-bit unsigned integer to an equivalent 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to convert.

Returns

A 64-bit unsigned integer that is equivalent to value.

System.Convert.ToUInt64()

Returns the specified 64-bit unsigned integer; no actual conversion is performed.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to return.

Returns

value is returned unchanged.

System.Convert.TryFromBase64Chars()

Tries to convert the specified span containing a string representation that is encoded with base-64 digits into a span of 8-bit unsigned integers.

Parameters

NameDescriptionDefault
chars A span containing the string representation that is encoded with base-64 digits.
bytes The span in which to write the converted 8-bit unsigned integers. If this method returns false, either the span remains unmodified or contains an incomplete conversion of chars, up to the last valid character.
bytesWritten When this method returns, contains the number of bytes that were written in bytes.

Returns

true if the conversion was successful; otherwise, false.

System.Convert.TryFromBase64String()

Tries to convert the specified string representation that is encoded with base-64 digits into a span of 8-bit unsigned integers.

Parameters

NameDescriptionDefault
s The string representation that is encoded with base-64 digits.
bytes The span in which to write the converted 8-bit unsigned integers. When this method returns false, either the span remains unmodified or contains an incomplete conversion of s, up to the last valid character.
bytesWritten When this method returns, contains the number of bytes that were written in bytes.

Returns

true if the conversion was successful; otherwise, false.

System.Convert.TryToBase64Chars()

Tries to convert the 8-bit unsigned integers inside the specified read-only span into their equivalent string representation that is encoded with base-64 digits. You can optionally specify whether to insert line breaks in the return value.

Parameters

NameDescriptionDefault
bytes A read-only span of 8-bit unsigned integers.
chars The span in which to write the string representation in base 64 of the elements in bytes. If the length of bytes is 0, or when this method returns false, nothing is written into this parameter.
charsWritten When this method returns, contains the total number of characters written into chars.
options One of the enumeration values that specify whether to insert line breaks in the return value. The default value is System.Base64FormattingOptions.None.

Returns

true if the conversion is successful; otherwise, false.

System.Converter`2

Represents a method that converts an object from one type to another type.

Parameters

NameDescriptionDefault
input The object to convert.

Returns

The that represents the converted .

System.DateOnly

Represents dates with values ranging from January 1, 0001 Anno Domini (Common Era) through December 31, 9999 A.D. (C.E.) in the Gregorian calendar.

System.DateOnly.#ctor()

Creates a new instance of the System.DateOnly structure to the specified year, month, and day.

Parameters

NameDescriptionDefault
year The year (1 through 9999).
month The month (1 through 12).
day The day (1 through the number of days in month).

System.DateOnly.#ctor()

Creates a new instance of the System.DateOnly structure to the specified year, month, and day for the specified calendar.

Parameters

NameDescriptionDefault
year The year (1 through the number of years in calendar).
month The month (1 through the number of months in calendar).
day The day (1 through the number of days in month).
calendar The calendar that is used to interpret year, month, and day.month.

System.DateOnly.AddDays()

Adds the specified number of days to the value of this instance.

Parameters

NameDescriptionDefault
value The number of days to add. To subtract days, specify a negative number.

Returns

An instance whose value is the sum of the date represented by this instance and the number of days represented by value.

System.DateOnly.AddMonths()

Adds the specified number of months to the value of this instance.

Parameters

NameDescriptionDefault
value A number of months. The months parameter can be negative or positive.

Returns

An object whose value is the sum of the date represented by this instance and months.

System.DateOnly.AddYears()

Adds the specified number of years to the value of this instance.

Parameters

NameDescriptionDefault
value A number of years. The value parameter can be negative or positive.

Returns

An object whose value is the sum of the date represented by this instance and the number of years represented by value.

System.DateOnly.CompareTo()

Compares the value of this instance to a specified System.DateOnly value and returns an integer that indicates whether this instance is earlier than, the same as, or later than the specified System.DateOnly value.

Parameters

NameDescriptionDefault
value The object to compare to the current instance.

Returns

Less than zero if this instance is earlier than value. Greater than zero if this instance is later than value. Zero if this instance is the same as value.

System.DateOnly.CompareTo()

Compares the value of this instance to a specified object that contains a specified System.DateOnly value, and returns an integer that indicates whether this instance is earlier than, the same as, or later than the specified System.DateOnly value.

Parameters

NameDescriptionDefault
value A boxed object to compare, or null.

Returns

Less than zero if this instance is earlier than value. Greater than zero if this instance is later than value. Zero if this instance is the same as value.

System.DateOnly.Deconstruct()

Parameters

NameDescriptionDefault
year When this method returns, represents the System.DateOnly.Year value of this System.DateOnly instance.
month When this method returns, represents the System.DateOnly.Month value of this System.DateOnly instance.
day When this method returns, represents the System.DateOnly.Day value of this System.DateOnly instance.

System.DateOnly.Equals()

Returns a value indicating whether the value of this instance is equal to the value of the specified System.DateOnly instance.

Parameters

NameDescriptionDefault
value The object to compare to this instance.

Returns

true if the value parameter equals the value of this instance; otherwise, false.

System.DateOnly.Equals()

Returns a value indicating whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
value The object to compare to this instance.

Returns

true if value is an instance of DateOnly and equals the value of this instance; otherwise, false.

System.DateOnly.FromDateTime()

Returns a System.DateOnly instance that is set to the date part of the specified dateTime.

Parameters

NameDescriptionDefault
dateTime The System.DateTime instance.

Returns

The System.DateOnly instance composed of the date part of the specified input time dateTime instance.

System.DateOnly.FromDayNumber()

Creates a new instance of the System.DateOnly structure to the specified number of days.

Parameters

NameDescriptionDefault
dayNumber The number of days since January 1, 0001 in the Proleptic Gregorian calendar.

Returns

A System.DateOnly structure instance to the specified number of days.

System.DateOnly.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.DateOnly.op_Equality()

Determines whether two specified instances of System.DateOnly are equal.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left and right represent the same date; otherwise, false.

System.DateOnly.op_GreaterThan()

Determines whether one specified System.DateOnly is later than another specified DateTime.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left is later than right; otherwise, false.

System.DateOnly.op_GreaterThanOrEqual()

Determines whether one specified DateOnly represents a date that is the same as or later than another specified System.DateOnly.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left is the same as or later than right; otherwise, false.

System.DateOnly.op_Inequality()

Determines whether two specified instances of System.DateOnly are not equal.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left and right do not represent the same date; otherwise, false.

System.DateOnly.op_LessThan()

Determines whether one specified System.DateOnly is earlier than another specified System.DateOnly.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left is earlier than right; otherwise, false.

System.DateOnly.op_LessThanOrEqual()

Determines whether one specified System.DateOnly represents a date that is the same as or earlier than another specified System.DateOnly.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left is the same as or earlier than right; otherwise, false.

System.DateOnly.Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.

Returns

The result of parsing
s
.

System.DateOnly.Parse()

Converts a memory span that contains string representation of a date to its System.DateOnly equivalent by using culture-specific format information and a formatting style.

Parameters

NameDescriptionDefault
s The memory span that contains the string to parse.
provider An object that supplies culture-specific format information about s.
style A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.DateTimeStyles.None.

Returns

An object that is equivalent to the date contained in s, as specified by provider and styles.

System.DateOnly.Parse()

Converts a string that contains string representation of a date to its System.DateOnly equivalent by using the conventions of the current culture.

Parameters

NameDescriptionDefault
s The string that contains the string to parse.

Returns

An object that is equivalent to the date contained in s.

System.DateOnly.Parse()

Parses a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about
s
.

Returns

The result of parsing
s
.

System.DateOnly.Parse()

Converts a string that contains string representation of a date to its System.DateOnly equivalent by using culture-specific format information and a formatting style.

Parameters

NameDescriptionDefault
s The string that contains the string to parse.
provider An object that supplies culture-specific format information about s.
style A bitwise combination of the enumeration values that indicates the style elements that can be present in s for the parse operation to succeed, and that defines how to interpret the parsed date. A typical value to specify is System.Globalization.DateTimeStyles.None.

Returns

An object that is equivalent to the date contained in s, as specified by provider and styles.

System.DateOnly.ParseExact()

Converts the specified span representation of a date to its System.DateOnly equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format exactly or an exception is thrown.

Parameters

NameDescriptionDefault
s A span containing the characters that represent a date to convert.
format A span containing the characters that represent a format specifier that defines the required format of s.
provider An object that supplies culture-specific formatting information about s.
style A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.DateTimeStyles.None.

Returns

An object that is equivalent to the date contained in s, as specified by format, provider, and style.

System.DateOnly.ParseExact()

Converts the specified span representation of a date to its System.DateOnly equivalent using the specified array of formats. The format of the string representation must match at least one of the specified formats exactly or an exception is thrown.

Parameters

NameDescriptionDefault
s A span containing the characters that represent a date to convert.
formats An array of allowable formats of s.

Returns

An object that is equivalent to the date contained in s, as specified by format, provider, and style.

System.DateOnly.ParseExact()

Converts the specified span representation of a date to its System.DateOnly equivalent using the specified array of formats, culture-specific format information, and style. The format of the string representation must match at least one of the specified formats exactly or an exception is thrown.

Parameters

NameDescriptionDefault
s A span containing the characters that represent a date to convert.
formats An array of allowable formats of s.
provider An object that supplies culture-specific formatting information about s.
style A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.DateTimeStyles.None.

Returns

An object that is equivalent to the date contained in s, as specified by format, provider, and style.

System.DateOnly.ParseExact()

Converts the specified string representation of a date to its System.DateOnly equivalent using the specified format. The format of the string representation must match the specified format exactly or an exception is thrown.

Parameters

NameDescriptionDefault
s A string containing the characters that represent a date to convert.
format A string that represent a format specifier that defines the required format of s.

Returns

An object that is equivalent to the date contained in s, as specified by format.

System.DateOnly.ParseExact()

Converts the specified string representation of a date to its System.DateOnly equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format exactly or an exception is thrown.

Parameters

NameDescriptionDefault
s A string containing the characters that represent a date to convert.
format A string containing the characters that represent a format specifier that defines the required format of s.
provider An object that supplies culture-specific formatting information about s.
style A bitwise combination of the enumeration values that provides additional information about s, about style elements that may be present in s, or about the conversion from s to a System.DateOnly value. A typical value to specify is System.Globalization.DateTimeStyles.None.

Returns

An object that is equivalent to the date contained in s, as specified by format, provider, and style.

System.DateOnly.ParseExact()

Converts the specified span representation of a date to its System.DateOnly equivalent using the specified array of formats. The format of the string representation must match at least one of the specified formats exactly or an exception is thrown.

Parameters

NameDescriptionDefault
s A span containing the characters that represent a date to convert.
formats An array of allowable formats of s.

Returns

An object that is equivalent to the date contained in s, as specified by format, provider, and style.

System.DateOnly.ParseExact()

Converts the specified string representation of a date to its System.DateOnly equivalent using the specified array of formats, culture-specific format information, and style. The format of the string representation must match at least one of the specified formats exactly or an exception is thrown.

Parameters

NameDescriptionDefault
s A string containing the characters that represent a date to convert.
formats An array of allowable formats of s.
provider An object that supplies culture-specific formatting information about s.
style A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.DateTimeStyles.None.

Returns

An object that is equivalent to the date contained in s, as specified by format, provider, and style.

System.DateOnly.ToDateTime()

Returns a System.DateTime that is set to the date of this System.DateOnly instance and the time of specified input time.

Parameters

NameDescriptionDefault
time The time of the day.

Returns

The System.DateTime instance composed of the date of the current System.DateOnly instance and the time specified by the input time.

System.DateOnly.ToDateTime()

Returns a System.DateTime instance with the specified input kind that is set to the date of this System.DateOnly instance and the time of specified input time.

Parameters

NameDescriptionDefault
time The time of the day.
kind One of the enumeration values that indicates whether ticks specifies a local time, Coordinated Universal Time (UTC), or neither.

Returns

The System.DateTime instance composed of the date of the current System.DateOnly instance and the time specified by the input time.

System.DateOnly.ToLongDateString

Converts the value of the current System.DateOnly object to its equivalent long date string representation.

Returns

A string that contains the long date string representation of the current System.DateOnly object.

System.DateOnly.ToShortDateString

Converts the value of the current System.DateOnly object to its equivalent short date string representation.

Returns

A string that contains the short date string representation of the current System.DateOnly object.

System.DateOnly.ToString

Converts the value of the current System.DateOnly object to its equivalent string representation using the formatting conventions of the current culture. The System.DateOnly object will be formatted in short form.

Returns

A string that contains the short date string representation of the current System.DateOnly object.

System.DateOnly.ToString()

Converts the value of the current System.DateOnly object to its equivalent string representation using the specified culture-specific format information.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

A string representation of value of the current System.DateOnly object as specified by provider.

System.DateOnly.ToString()

Converts the value of the current System.DateOnly object to its equivalent string representation using the specified format and the formatting conventions of the current culture.

Parameters

NameDescriptionDefault
format A standard or custom date format string.

Returns

A string representation of value of the current System.DateOnly object as specified by format.

System.DateOnly.ToString()

Converts the value of the current System.DateOnly object to its equivalent string representation using the specified culture-specific format information.

Parameters

NameDescriptionDefault
format A standard or custom date format string.
provider An object that supplies culture-specific formatting information.

Returns

A string representation of value of the current System.DateOnly object as specified by format and provider.

System.DateOnly.TryFormat()

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

Parameters

NameDescriptionDefault
utf8Destination The span in which to write this instance's value formatted as a span of bytes.
bytesWritten When this method returns, contains the number of bytes that were written in
utf8Destination
.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for
utf8Destination
.
provider An optional object that supplies culture-specific formatting information for
utf8Destination
.

Returns

true
if the formatting was successful; otherwise,
false
.

System.DateOnly.TryFormat()

Tries to format the value of the current System.DateOnly instance into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span in which to write this instance's value formatted as a span of characters.
charsWritten When this method returns, contains the number of characters that were written in destination.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for destination.
provider An optional object that supplies culture-specific formatting information for destination.

Returns

true if the formatting was successful; otherwise, false.

System.DateOnly.TryParse()

Converts the specified span representation of a date to its System.DateOnly equivalent and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A span containing the characters representing the date to convert.
result When this method returns, contains the System.DateOnly value equivalent to the date contained in s, if the conversion succeeded, or DateOnly.MinValue if the conversion failed. The conversion fails if the s parameter is empty string, or does not contain a valid string representation of a date. This parameter is passed uninitialized.

Returns

true if the conversion was successful; otherwise, false.

System.DateOnly.TryParse()

Tries to parse a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
, or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.DateOnly.TryParse()

Converts the specified span representation of a date to its System.DateOnly equivalent using the specified array of formats, culture-specific format information, and style. And returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A string containing the characters that represent a date to convert.
provider An object that supplies culture-specific formatting information about s.
style A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.DateTimeStyles.None.
result When this method returns, contains the System.DateOnly value equivalent to the date contained in s, if the conversion succeeded, or DateOnly.MinValue if the conversion failed. The conversion fails if the s parameter is empty string, or does not contain a valid string representation of a date. This parameter is passed uninitialized.

Returns

true if the conversion was successful; otherwise, false.

System.DateOnly.TryParse()

Converts the specified string representation of a date to its System.DateOnly equivalent and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A string containing the characters representing the date to convert.
result When this method returns, contains the System.DateOnly value equivalent to the date contained in s, if the conversion succeeded, or DateOnly.MinValue if the conversion failed. The conversion fails if the s parameter is empty string, or does not contain a valid string representation of a date. This parameter is passed uninitialized.

Returns

true if the conversion was successful; otherwise, false.

System.DateOnly.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.DateOnly.TryParse()

Converts the specified string representation of a date to its System.DateOnly equivalent using the specified array of formats, culture-specific format information, and style. And returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A string containing the characters that represent a date to convert.
provider An object that supplies culture-specific formatting information about s.
style A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.DateTimeStyles.None.
result When this method returns, contains the System.DateOnly value equivalent to the date contained in s, if the conversion succeeded, or DateOnly.MinValue if the conversion failed. The conversion fails if the s parameter is empty string, or does not contain a valid string representation of a date. This parameter is passed uninitialized.

Returns

true if the conversion was successful; otherwise, false.

System.DateOnly.TryParseExact()

Converts the specified span representation of a date to its System.DateOnly equivalent using the specified format and style. The format of the string representation must match the specified format exactly. The method returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A span containing the characters representing a date to convert.
format The required format of s.
result When this method returns, contains the System.DateOnly value equivalent to the date contained in s, if the conversion succeeded, or DateOnly.MinValue if the conversion failed. The conversion fails if the s is an empty string, or does not contain a date that correspond to the pattern specified in format. This parameter is passed uninitialized.

Returns

true if s was converted successfully; otherwise, false.

System.DateOnly.TryParseExact()

Converts the specified span representation of a date to its System.DateOnlyequivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format exactly. The method returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A span containing the characters representing a date to convert.
format The required format of s.
provider An object that supplies culture-specific formatting information about s.
style A bitwise combination of one or more enumeration values that indicate the permitted format of s.
result When this method returns, contains the System.DateOnly value equivalent to the date contained in s, if the conversion succeeded, or DateOnly.MinValue if the conversion failed. The conversion fails if the s is an empty string, or does not contain a date that correspond to the pattern specified in format. This parameter is passed uninitialized.

Returns

true if s was converted successfully; otherwise, false.

System.DateOnly.TryParseExact()

Converts the specified char span of a date to its System.DateOnly equivalent and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s The span containing the string to parse.
formats An array of allowable formats of s.
result When this method returns, contains the System.DateOnly value equivalent to the date contained in s, if the conversion succeeded, or DateOnly.MinValue if the conversion failed. The conversion fails if the s parameter is an empty string, or does not contain a valid string representation of a date. This parameter is passed uninitialized.

Returns

true ifs was converted successfully; otherwise, false.

System.DateOnly.TryParseExact()

Converts the specified char span of a date to its System.DateOnly equivalent and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s The span containing the string to parse.
formats An array of allowable formats of s.
provider An object that supplies culture-specific formatting information about s.
style A bitwise combination of enumeration values that defines how to interpret the parsed date. A typical value to specify is System.Globalization.DateTimeStyles.None.
result When this method returns, contains the System.DateOnly value equivalent to the date contained in s, if the conversion succeeded, or DateOnly.MinValue if the conversion failed. The conversion fails if s is an empty string, or does not contain a valid string representation of a date. This parameter is passed uninitialized.

Returns

true if s was converted successfully; otherwise, false.

System.DateOnly.TryParseExact()

Converts the specified string representation of a date to its System.DateOnly equivalent using the specified format and style. The format of the string representation must match the specified format exactly. The method returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A string containing the characters representing a date to convert.
format The required format of s.
result When this method returns, contains the System.DateOnly value equivalent to the date contained in s, if the conversion succeeded, or DateOnly.MinValue if the conversion failed. The conversion fails if s is an empty string, or does not contain a date that correspond to the pattern specified in format. This parameter is passed uninitialized.

Returns

true if s was converted successfully; otherwise, false.

System.DateOnly.TryParseExact()

Converts the specified span representation of a date to its System.DateOnly equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format exactly. The method returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A span containing the characters representing a date to convert.
format The required format of s.
provider An object that supplies culture-specific formatting information about s.
style A bitwise combination of one or more enumeration values that indicate the permitted format of s.
result When this method returns, contains the System.DateOnly value equivalent to the date contained in s, if the conversion succeeded, or DateOnly.MinValue if the conversion failed. The conversion fails if s is an empty string, or does not contain a date that correspond to the pattern specified in format. This parameter is passed uninitialized.

Returns

true if s was converted successfully; otherwise, false.

System.DateOnly.TryParseExact()

Converts the specified string of a date to its System.DateOnly equivalent and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s The string containing date to parse.
formats An array of allowable formats of s.
result When this method returns, contains the System.DateOnly value equivalent to the date contained in s, if the conversion succeeded, or DateOnly.MinValue if the conversion failed. The conversion fails if s is an empty string, or does not contain a valid string representation of a date. This parameter is passed uninitialized.

Returns

true if s was converted successfully; otherwise, false.

System.DateOnly.TryParseExact()

Converts the specified string of a date to its System.DateOnly equivalent and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s The string containing the date to parse.
formats An array of allowable formats of s.
provider An object that supplies culture-specific formatting information about s.
style A bitwise combination of enumeration values that defines how to interpret the parsed date. A typical value to specify is System.Globalization.DateTimeStyles.None.
result When this method returns, contains the System.DateOnly value equivalent to the date contained in s, if the conversion succeeded, or DateOnly.MinValue if the conversion failed. The conversion fails if s is an empty string, or does not contain a valid string representation of a date. This parameter is passed uninitialized.

Returns

true if s was converted successfully; otherwise, false.

System.DateOnly.Day

Gets the day component of the date represented by this instance.

Returns

A number representing the day component of the date represented by this instance.

System.DateOnly.DayNumber

Gets the number of days since January 1, 0001 in the Proleptic Gregorian calendar represented by this instance.

Returns

The number of days since January 1, 0001 in the Proleptic Gregorian calendar represented by this instance.

System.DateOnly.DayOfWeek

Gets the day of the week represented by this instance.

Returns

A number that represents the day of the week represented by this instance.

System.DateOnly.DayOfYear

Gets the day of the year represented by this instance.

Returns

A number that represents the day of the year represented by this instance.

System.DateOnly.MaxValue

Gets the latest possible date that can be created.

Returns

A System.DateOnly representing the latest possible date that can be created.

System.DateOnly.MinValue

Gets the earliest possible date that can be created.

Returns

A System.DateOnly representing the earliest possible date that can be created.

System.DateOnly.Month

Gets the month component of the date represented by this instance.

Returns

A number that represents the month component of the date.

System.DateOnly.Year

Gets the year component of the date represented by this instance.

Returns

A number that represents the year component of the date.

System.DateTime

Represents an instant in time, typically expressed as a date and time of day.

System.DateTime.MaxValue

Represents the largest possible value of System.DateTime. This field is read-only.

System.DateTime.MinValue

Represents the smallest possible value of System.DateTime. This field is read-only.

System.DateTime.UnixEpoch

The value of this constant is equivalent to 00:00:00.0000000 UTC, January 1, 1970, in the Gregorian calendar. System.DateTime.UnixEpoch defines the point in time when Unix time is equal to 0.

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to the specified System.DateOnly and System.TimeOnly. The new instance will have the System.DateTimeKind.Unspecified kind.

Parameters

NameDescriptionDefault
date The date part.
time The time part.

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to the specified System.DateOnly and System.TimeOnly and respecting the specified System.DateTimeKind.

Parameters

NameDescriptionDefault
date The date part.
time The time part.
kind One of the enumeration values that indicates whether date and time specify a local time, Coordinated Universal Time (UTC), or neither.

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to the specified year, month, and day.

Parameters

NameDescriptionDefault
year The year (1 through 9999).
month The month (1 through 12).
day The day (1 through the number of days in month).

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to the specified year, month, and day for the specified calendar.

Parameters

NameDescriptionDefault
year The year (1 through the number of years in calendar).
month The month (1 through the number of months in calendar).
day The day (1 through the number of days in month).
calendar The calendar that is used to interpret year, month, and day.

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to the specified year, month, day, hour, minute, and second.

Parameters

NameDescriptionDefault
year The year (1 through 9999).
month The month (1 through 12).
day The day (1 through the number of days in month).
hour The hours (0 through 23).
minute The minutes (0 through 59).
second The seconds (0 through 59).

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to the specified year, month, day, hour, minute, second, and Coordinated Universal Time (UTC) or local time.

Parameters

NameDescriptionDefault
year The year (1 through 9999).
month The month (1 through 12).
day The day (1 through the number of days in month).
hour The hours (0 through 23).
minute The minutes (0 through 59).
second The seconds (0 through 59).
kind One of the enumeration values that indicates whether year, month, day, hour, minute and second specify a local time, Coordinated Universal Time (UTC), or neither.

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to the specified year, month, day, hour, minute, and second for the specified calendar.

Parameters

NameDescriptionDefault
year The year (1 through the number of years in calendar).
month The month (1 through the number of months in calendar).
day The day (1 through the number of days in month).
hour The hours (0 through 23).
minute The minutes (0 through 59).
second The seconds (0 through 59).
calendar The calendar that is used to interpret year, month, and day.

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to the specified year, month, day, hour, minute, second, and millisecond.

Parameters

NameDescriptionDefault
year The year (1 through 9999).
month The month (1 through 12).
day The day (1 through the number of days in month).
hour The hours (0 through 23).
minute The minutes (0 through 59).
second The seconds (0 through 59).
millisecond The milliseconds (0 through 999).

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to the specified year, month, day, hour, minute, second, millisecond, and Coordinated Universal Time (UTC) or local time.

Parameters

NameDescriptionDefault
year The year (1 through 9999).
month The month (1 through 12).
day The day (1 through the number of days in month).
hour The hours (0 through 23).
minute The minutes (0 through 59).
second The seconds (0 through 59).
millisecond The milliseconds (0 through 999).
kind One of the enumeration values that indicates whether year, month, day, hour, minute, second, and millisecond specify a local time, Coordinated Universal Time (UTC), or neither.

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to the specified year, month, day, hour, minute, second, and millisecond for the specified calendar.

Parameters

NameDescriptionDefault
year The year (1 through the number of years in calendar).
month The month (1 through the number of months in calendar).
day The day (1 through the number of days in month).
hour The hours (0 through 23).
minute The minutes (0 through 59).
second The seconds (0 through 59).
millisecond The milliseconds (0 through 999).
calendar The calendar that is used to interpret year, month, and day.

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to the specified year, month, day, hour, minute, second, millisecond, and Coordinated Universal Time (UTC) or local time for the specified calendar.

Parameters

NameDescriptionDefault
year The year (1 through the number of years in calendar).
month The month (1 through the number of months in calendar).
day The day (1 through the number of days in month).
hour The hours (0 through 23).
minute The minutes (0 through 59).
second The seconds (0 through 59).
millisecond The milliseconds (0 through 999).
calendar The calendar that is used to interpret year, month, and day.
kind One of the enumeration values that indicates whether year, month, day, hour, minute, second, and millisecond specify a local time, Coordinated Universal Time (UTC), or neither.

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to the specified year, month, day, hour, minute, second, millisecond, and Coordinated Universal Time (UTC) or local time for the specified calendar.

Parameters

NameDescriptionDefault
year The year (1 through 9999).
month The month (1 through 12).
day The day (1 through the number of days in month).
hour The hours (0 through 23).
minute The minutes (0 through 59).
second The seconds (0 through 59).
millisecond The milliseconds (0 through 999).
microsecond The microseconds (0 through 999).

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to the specified year, month, day, hour, minute, second, millisecond, and Coordinated Universal Time (UTC) or local time for the specified calendar.

Parameters

NameDescriptionDefault
year The year (1 through 9999).
month The month (1 through 12).
day The day (1 through the number of days in month).
hour The hours (0 through 23).
minute The minutes (0 through 59).
second The seconds (0 through 59).
millisecond The milliseconds (0 through 999).
microsecond The microseconds (0 through 999).
kind One of the enumeration values that indicates whether year, month, day, hour, minute, second, and millisecond specify a local time, Coordinated Universal Time (UTC), or neither.

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to the specified year, month, day, hour, minute, second, millisecond, and Coordinated Universal Time (UTC) or local time for the specified calendar.

Parameters

NameDescriptionDefault
year The year (1 through the number of years in calendar).
month The month (1 through the number of months in calendar).
day The day (1 through the number of days in month).
hour The hours (0 through 23).
minute The minutes (0 through 59).
second The seconds (0 through 59).
millisecond The milliseconds (0 through 999).
microsecond The microseconds (0 through 999).
calendar The calendar that is used to interpret year, month, and day.

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to the specified year, month, day, hour, minute, second, millisecond, and Coordinated Universal Time (UTC) or local time for the specified calendar.

Parameters

NameDescriptionDefault
year The year (1 through the number of years in calendar).
month The month (1 through the number of months in calendar).
day The day (1 through the number of days in month).
hour The hours (0 through 23).
minute The minutes (0 through 59).
second The seconds (0 through 59).
millisecond The milliseconds (0 through 999).
microsecond The microseconds (0 through 999).
calendar The calendar that is used to interpret year, month, and day.
kind One of the enumeration values that indicates whether year, month, day, hour, minute, second, and millisecond specify a local time, Coordinated Universal Time (UTC), or neither.

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to a specified number of ticks.

Parameters

NameDescriptionDefault
ticks A date and time expressed in the number of 100-nanosecond intervals that have elapsed since January 1, 0001 at 00:00:00.000 in the Gregorian calendar.

System.DateTime.#ctor()

Initializes a new instance of the System.DateTime structure to a specified number of ticks and to Coordinated Universal Time (UTC) or local time.

Parameters

NameDescriptionDefault
ticks A date and time expressed in the number of 100-nanosecond intervals that have elapsed since January 1, 0001 at 00:00:00.000 in the Gregorian calendar.
kind One of the enumeration values that indicates whether ticks specifies a local time, Coordinated Universal Time (UTC), or neither.

System.DateTime.Add()

Returns a new System.DateTime that adds the value of the specified System.TimeSpan to the value of this instance.

Parameters

NameDescriptionDefault
value A positive or negative time interval.

Returns

An object whose value is the sum of the date and time represented by this instance and the time interval represented by value.

System.DateTime.AddDays()

Returns a new System.DateTime that adds the specified number of days to the value of this instance.

Parameters

NameDescriptionDefault
value A number of whole and fractional days. The value parameter can be negative or positive.

Returns

An object whose value is the sum of the date and time represented by this instance and the number of days represented by value.

System.DateTime.AddHours()

Returns a new System.DateTime that adds the specified number of hours to the value of this instance.

Parameters

NameDescriptionDefault
value A number of whole and fractional hours. The value parameter can be negative or positive.

Returns

An object whose value is the sum of the date and time represented by this instance and the number of hours represented by value.

System.DateTime.AddMicroseconds()

Returns a new System.DateTime that adds the specified number of microseconds to the value of this instance.

Parameters

NameDescriptionDefault
value A number of whole and fractional microseconds. The value parameter can be negative or positive. Note that this value is rounded to the nearest integer.

Returns

An object whose value is the sum of the date and time represented by this instance and the number of microseconds represented by value.

System.DateTime.AddMilliseconds()

Returns a new System.DateTime that adds the specified number of milliseconds to the value of this instance.

Parameters

NameDescriptionDefault
value A number of whole and fractional milliseconds. The value parameter can be negative or positive. Note that this value is rounded to the nearest integer.

Returns

An object whose value is the sum of the date and time represented by this instance and the number of milliseconds represented by value.

System.DateTime.AddMinutes()

Returns a new System.DateTime that adds the specified number of minutes to the value of this instance.

Parameters

NameDescriptionDefault
value A number of whole and fractional minutes. The value parameter can be negative or positive.

Returns

An object whose value is the sum of the date and time represented by this instance and the number of minutes represented by value.

System.DateTime.AddMonths()

Returns a new System.DateTime that adds the specified number of months to the value of this instance.

Parameters

NameDescriptionDefault
months A number of months. The months parameter can be negative or positive.

Returns

An object whose value is the sum of the date and time represented by this instance and months.

System.DateTime.AddSeconds()

Returns a new System.DateTime that adds the specified number of seconds to the value of this instance.

Parameters

NameDescriptionDefault
value A number of whole and fractional seconds. The value parameter can be negative or positive.

Returns

An object whose value is the sum of the date and time represented by this instance and the number of seconds represented by value.

System.DateTime.AddTicks()

Returns a new System.DateTime that adds the specified number of ticks to the value of this instance.

Parameters

NameDescriptionDefault
value A number of 100-nanosecond ticks. The value parameter can be positive or negative.

Returns

An object whose value is the sum of the date and time represented by this instance and the time represented by value.

System.DateTime.AddYears()

Returns a new System.DateTime that adds the specified number of years to the value of this instance.

Parameters

NameDescriptionDefault
value A number of years. The value parameter can be negative or positive.

Returns

An object whose value is the sum of the date and time represented by this instance and the number of years represented by value.

System.DateTime.Compare()

Compares two instances of System.DateTime and returns an integer that indicates whether the first instance is earlier than, the same as, or later than the second instance.

Parameters

NameDescriptionDefault
t1 The first object to compare.
t2 The second object to compare.

Returns

A signed number indicating the relative values of t1 and t2. Value Type Condition Less than zerot1 is earlier than t2. Zerot1 is the same as t2. Greater than zerot1 is later than t2.

System.DateTime.CompareTo()

Compares the value of this instance to a specified System.DateTime value and returns an integer that indicates whether this instance is earlier than, the same as, or later than the specified System.DateTime value.

Parameters

NameDescriptionDefault
value The object to compare to the current instance.

Returns

A signed number indicating the relative values of this instance and the value parameter. Value Description Less than zero This instance is earlier than value. Zero This instance is the same as value. Greater than zero This instance is later than value.

System.DateTime.CompareTo()

Compares the value of this instance to a specified object that contains a specified System.DateTime value, and returns an integer that indicates whether this instance is earlier than, the same as, or later than the specified System.DateTime value.

Parameters

NameDescriptionDefault
value A boxed object to compare, or null.

Returns

A signed number indicating the relative values of this instance and value. Value Description Less than zero This instance is earlier than value. Zero This instance is the same as value. Greater than zero This instance is later than value, or value is null.

System.DateTime.DaysInMonth()

Returns the number of days in the specified month and year.

Parameters

NameDescriptionDefault
year The year.
month The month (a number ranging from 1 to 12).

Returns

The number of days in month for the specified year. For example, if month equals 2 for February, the return value is 28 or 29 depending upon whether year is a leap year.

System.DateTime.Deconstruct()

Deconstructs this System.DateTime instance by System.DateOnly and System.TimeOnly.

Parameters

NameDescriptionDefault
date When this method returns, represents the System.DateOnly value of this System.DateTime instance.
time When this method returns, represents the System.TimeOnly value of this System.DateTime instance.

System.DateTime.Deconstruct()

Parameters

NameDescriptionDefault
year When this method returns, represents the System.DateTime.Year value of this System.DateTime instance.
month When this method returns, represents the System.DateTime.Month value of this System.DateTime instance.
day When this method returns, represents the System.DateTime.Day value of this System.DateTime instance.

System.DateTime.Equals()

Returns a value indicating whether the value of this instance is equal to the value of the specified System.DateTime instance.

Parameters

NameDescriptionDefault
value The object to compare to this instance.

Returns

true if the value parameter equals the value of this instance; otherwise, false.

System.DateTime.Equals()

Returns a value indicating whether two System.DateTime instances have the same date and time value.

Parameters

NameDescriptionDefault
t1 The first object to compare.
t2 The second object to compare.

Returns

true if the two values are equal; otherwise, false.

System.DateTime.Equals()

Returns a value indicating whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
value The object to compare to this instance.

Returns

true if value is an instance of System.DateTime and equals the value of this instance; otherwise, false.

System.DateTime.FromBinary()

Deserializes a 64-bit binary value and recreates an original serialized System.DateTime object.

Parameters

NameDescriptionDefault
dateData A 64-bit signed integer that encodes the System.DateTime.Kind property in a 2-bit field and the System.DateTime.Ticks property in a 62-bit field.

Returns

An object that is equivalent to the System.DateTime object that was serialized by the System.DateTime.ToBinary method.

System.DateTime.FromFileTime()

Converts the specified Windows file time to an equivalent local time.

Parameters

NameDescriptionDefault
fileTime A Windows file time expressed in ticks.

Returns

An object that represents the local time equivalent of the date and time represented by the fileTime parameter.

System.DateTime.FromFileTimeUtc()

Converts the specified Windows file time to an equivalent UTC time.

Parameters

NameDescriptionDefault
fileTime A Windows file time expressed in ticks.

Returns

An object that represents the UTC time equivalent of the date and time represented by the fileTime parameter.

System.DateTime.FromOADate()

Returns a System.DateTime equivalent to the specified OLE Automation Date.

Parameters

NameDescriptionDefault
d An OLE Automation Date value.

Returns

An object that represents the same date and time as d.

System.DateTime.GetDateTimeFormats

Converts the value of this instance to all the string representations supported by the standard date and time format specifiers.

Returns

A string array where each element is the representation of the value of this instance formatted with one of the standard date and time format specifiers.

System.DateTime.GetDateTimeFormats()

Converts the value of this instance to all the string representations supported by the specified standard date and time format specifier.

Parameters

NameDescriptionDefault
format A standard date and time format string.

Returns

A string array where each element is the representation of the value of this instance formatted with the format standard date and time format specifier.

System.DateTime.GetDateTimeFormats()

Converts the value of this instance to all the string representations supported by the specified standard date and time format specifier and culture-specific formatting information.

Parameters

NameDescriptionDefault
format A date and time format string.
provider An object that supplies culture-specific formatting information about this instance.

Returns

A string array where each element is the representation of the value of this instance formatted with one of the standard date and time format specifiers.

System.DateTime.GetDateTimeFormats()

Converts the value of this instance to all the string representations supported by the standard date and time format specifiers and the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information about this instance.

Returns

A string array where each element is the representation of the value of this instance formatted with one of the standard date and time format specifiers.

System.DateTime.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.DateTime.GetTypeCode

Returns the System.TypeCode for value type System.DateTime.

Returns

The enumerated constant, System.TypeCode.DateTime.

System.DateTime.IsDaylightSavingTime

Indicates whether this instance of System.DateTime is within the daylight saving time range for the current time zone.

Returns

true if the value of the System.DateTime.Kind property is System.DateTimeKind.Local or System.DateTimeKind.Unspecified and the value of this instance of System.DateTime is within the daylight saving time range for the local time zone; false if System.DateTime.Kind is System.DateTimeKind.Utc.

System.DateTime.IsLeapYear()

Returns an indication whether the specified year is a leap year.

Parameters

NameDescriptionDefault
year A 4-digit year.

Returns

true if year is a leap year; otherwise, false.

System.DateTime.op_Addition()

Adds a specified time interval to a specified date and time, yielding a new date and time.

Parameters

NameDescriptionDefault
d The date and time value to add.
t The time interval to add.

Returns

An object that is the sum of the values of d and t.

System.DateTime.op_Equality()

Determines whether two specified instances of System.DateTime are equal.

Parameters

NameDescriptionDefault
d1 The first object to compare.
d2 The second object to compare.

Returns

true if d1 and d2 represent the same date and time; otherwise, false.

System.DateTime.op_GreaterThan()

Determines whether one specified is later than another specified .

Parameters

NameDescriptionDefault
t1 The first object to compare.
t2 The second object to compare.

Returns

true
if
t1
is later than
t2
; otherwise,
false
.

System.DateTime.op_GreaterThanOrEqual()

Determines whether one specified represents a date and time that is the same as or later than another specified .

Parameters

NameDescriptionDefault
t1 The first object to compare.
t2 The second object to compare.

Returns

true
if
t1
is the same as or later than
t2
; otherwise,
false
.

System.DateTime.op_Inequality()

Determines whether two specified instances of System.DateTime are not equal.

Parameters

NameDescriptionDefault
d1 The first object to compare.
d2 The second object to compare.

Returns

true if d1 and d2 do not represent the same date and time; otherwise, false.

System.DateTime.op_LessThan()

Determines whether one specified is earlier than another specified .

Parameters

NameDescriptionDefault
t1 The first object to compare.
t2 The second object to compare.

Returns

true
if
t1
is earlier than
t2
; otherwise,
false
.

System.DateTime.op_LessThanOrEqual()

Determines whether one specified represents a date and time that is the same as or earlier than another specified .

Parameters

NameDescriptionDefault
t1 The first object to compare.
t2 The second object to compare.

Returns

true
if
t1
is the same as or earlier than
t2
; otherwise,
false
.

System.DateTime.op_Subtraction()

Subtracts a specified date and time from another specified date and time and returns a time interval.

Parameters

NameDescriptionDefault
d1 The date and time value to subtract from (the minuend).
d2 The date and time value to subtract (the subtrahend).

Returns

The time interval between d1 and d2; that is, d1 minus d2.

System.DateTime.op_Subtraction()

Subtracts a specified time interval from a specified date and time and returns a new date and time.

Parameters

NameDescriptionDefault
d The date and time value to subtract from.
t The time interval to subtract.

Returns

An object whose value is the value of d minus the value of t.

System.DateTime.Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.

Returns

The result of parsing
s
.

System.DateTime.Parse()

Converts a memory span that contains string representation of a date and time to its System.DateTime equivalent by using culture-specific format information and a formatting style.

Parameters

NameDescriptionDefault
s The memory span that contains the string to parse. See The string to parse for more information.
provider An object that supplies culture-specific format information about s. See Parsing and cultural conventions
styles A bitwise combination of the enumeration values that indicates the style elements that can be present in s for the parse operation to succeed, and that defines how to interpret the parsed date in relation to the current time zone or the current date. A typical value to specify is System.Globalization.DateTimeStyles.None.

Returns

An object that is equivalent to the date and time contained in s, as specified by provider and styles.

System.DateTime.Parse()

Converts the string representation of a date and time to its System.DateTime equivalent by using the conventions of the current culture.

Parameters

NameDescriptionDefault
s A string that contains a date and time to convert. See The string to parse for more information.

Returns

An object that is equivalent to the date and time contained in s.

System.DateTime.Parse()

Converts the string representation of a date and time to its System.DateTime equivalent by using culture-specific format information.

Parameters

NameDescriptionDefault
s A string that contains a date and time to convert. See The string to parse for more information.
provider An object that supplies culture-specific format information about s. See Parsing and cultural conventions

Returns

An object that is equivalent to the date and time contained in s as specified by provider.

System.DateTime.Parse()

Converts the string representation of a date and time to its System.DateTime equivalent by using culture-specific format information and a formatting style.

Parameters

NameDescriptionDefault
s A string that contains a date and time to convert. See The string to parse for more information.
provider An object that supplies culture-specific formatting information about s. See Parsing and cultural conventions
styles A bitwise combination of the enumeration values that indicates the style elements that can be present in s for the parse operation to succeed, and that defines how to interpret the parsed date in relation to the current time zone or the current date. A typical value to specify is System.Globalization.DateTimeStyles.None.

Returns

An object that is equivalent to the date and time contained in s, as specified by provider and styles.

System.DateTime.ParseExact()

Converts the specified span representation of a date and time to its System.DateTime equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format exactly or an exception is thrown.

Parameters

NameDescriptionDefault
s A span containing the characters that represent a date and time to convert.
format A span containing the characters that represent a format specifier that defines the required format of s.
provider An object that supplies culture-specific formatting information about s.
style A bitwise combination of the enumeration values that provides additional information about s, about style elements that may be present in s, or about the conversion from s to a System.DateTime value. A typical value to specify is System.Globalization.DateTimeStyles.None.

Returns

An object that is equivalent to the date and time contained in s, as specified by format, provider, and style.

System.DateTime.ParseExact()

Converts the specified span representation of a date and time to its System.DateTime equivalent using the specified array of formats, culture-specific format information, and style. The format of the string representation must match at least one of the specified formats exactly or an exception is thrown.

Parameters

NameDescriptionDefault
s A span containing the characters that represent a date and time to convert.
formats An array of allowable formats of s.
provider An object that supplies culture-specific format information about s.
style A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.DateTimeStyles.None.

Returns

An object that is equivalent to the date and time contained in s, as specified by formats, provider, and style.

System.DateTime.ParseExact()

Converts the specified string representation of a date and time to its System.DateTime equivalent using the specified format and culture-specific format information. The format of the string representation must match the specified format exactly.

Parameters

NameDescriptionDefault
s A string that contains a date and time to convert.
format A format specifier that defines the required format of s. For more information, see the Remarks section.
provider An object that supplies culture-specific format information about s.

Returns

An object that is equivalent to the date and time contained in s, as specified by format and provider.

System.DateTime.ParseExact()

Converts the specified string representation of a date and time to its System.DateTime equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format exactly or an exception is thrown.

Parameters

NameDescriptionDefault
s A string containing a date and time to convert.
format A format specifier that defines the required format of s. For more information, see the Remarks section.
provider An object that supplies culture-specific formatting information about s.
style A bitwise combination of the enumeration values that provides additional information about s, about style elements that may be present in s, or about the conversion from s to a System.DateTime value. A typical value to specify is System.Globalization.DateTimeStyles.None.

Returns

An object that is equivalent to the date and time contained in s, as specified by format, provider, and style.

System.DateTime.ParseExact()

Converts the specified string representation of a date and time to its System.DateTime equivalent using the specified array of formats, culture-specific format information, and style. The format of the string representation must match at least one of the specified formats exactly or an exception is thrown.

Parameters

NameDescriptionDefault
s A string that contains a date and time to convert.
formats An array of allowable formats of s. For more information, see the Remarks section.
provider An object that supplies culture-specific format information about s.
style A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.DateTimeStyles.None.

Returns

An object that is equivalent to the date and time contained in s, as specified by formats, provider, and style.

System.DateTime.SpecifyKind()

Creates a new System.DateTime object that has the same number of ticks as the specified System.DateTime, but is designated as either local time, Coordinated Universal Time (UTC), or neither, as indicated by the specified System.DateTimeKind value.

Parameters

NameDescriptionDefault
value A date and time.
kind One of the enumeration values that indicates whether the new object represents local time, UTC, or neither.

Returns

A new object that has the same number of ticks as the object represented by the value parameter and the System.DateTimeKind value specified by the kind parameter.

System.DateTime.Subtract()

Returns a new System.TimeSpan that subtracts the specified date and time from the value of this instance.

Parameters

NameDescriptionDefault
value The date and time value to subtract.

Returns

A time interval that is equal to the date and time represented by this instance minus the date and time represented by value.

System.DateTime.Subtract()

Returns a new System.DateTime that subtracts the specified duration from the value of this instance.

Parameters

NameDescriptionDefault
value The time interval to subtract.

Returns

An object that is equal to the date and time represented by this instance minus the time interval represented by value.

System.DateTime.System#IConvertible#ToBoolean()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

The return value for this member is not used.

System.DateTime.System#IConvertible#ToByte()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

The return value for this member is not used.

System.DateTime.System#IConvertible#ToChar()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

The return value for this member is not used.

System.DateTime.System#IConvertible#ToDateTime()

Returns the current System.DateTime object.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

The current object.

System.DateTime.System#IConvertible#ToDecimal()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

The return value for this member is not used.

System.DateTime.System#IConvertible#ToDouble()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

The return value for this member is not used.

System.DateTime.System#IConvertible#ToInt16()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

The return value for this member is not used.

System.DateTime.System#IConvertible#ToInt32()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

The return value for this member is not used.

System.DateTime.System#IConvertible#ToInt64()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

The return value for this member is not used.

System.DateTime.System#IConvertible#ToSByte()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

The return value for this member is not used.

System.DateTime.System#IConvertible#ToSingle()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

The return value for this member is not used.

System.DateTime.System#IConvertible#ToType()

Converts the current System.DateTime object to an object of a specified type.

Parameters

NameDescriptionDefault
type The desired type.
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

An object of the type specified by the type parameter, with a value equivalent to the current System.DateTime object.

System.DateTime.System#IConvertible#ToUInt16()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

The return value for this member is not used.

System.DateTime.System#IConvertible#ToUInt32()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

The return value for this member is not used.

System.DateTime.System#IConvertible#ToUInt64()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

The return value for this member is not used.

System.DateTime.System#Runtime#Serialization#ISerializable#GetObjectData()

Populates a System.Runtime.Serialization.SerializationInfo object with the data needed to serialize the current System.DateTime object.

Parameters

NameDescriptionDefault
info The object to populate with data.
context The destination for this serialization. (This parameter is not used; specify null.)

System.DateTime.ToBinary

Serializes the current System.DateTime object to a 64-bit binary value that subsequently can be used to recreate the System.DateTime object.

Returns

A 64-bit signed integer that encodes the System.DateTime.Kind and System.DateTime.Ticks properties.

System.DateTime.ToFileTime

Converts the value of the current System.DateTime object to a Windows file time.

Returns

The value of the current System.DateTime object expressed as a Windows file time.

System.DateTime.ToFileTimeUtc

Converts the value of the current System.DateTime object to a Windows file time.

Returns

The value of the current System.DateTime object expressed as a Windows file time.

System.DateTime.ToLocalTime

Converts the value of the current System.DateTime object to local time.

Returns

An object whose System.DateTime.Kind property is System.DateTimeKind.Local, and whose value is the local time equivalent to the value of the current System.DateTime object, or DateTime.MaxValue if the converted value is too large to be represented by a System.DateTime object, or DateTime.MinValue if the converted value is too small to be represented as a System.DateTime object.

System.DateTime.ToLongDateString

Converts the value of the current System.DateTime object to its equivalent long date string representation.

Returns

A string that contains the long date string representation of the current System.DateTime object.

System.DateTime.ToLongTimeString

Converts the value of the current System.DateTime object to its equivalent long time string representation.

Returns

A string that contains the long time string representation of the current System.DateTime object.

System.DateTime.ToOADate

Converts the value of this instance to the equivalent OLE Automation date.

Returns

A double-precision floating-point number that contains an OLE Automation date equivalent to the value of this instance.

System.DateTime.ToShortDateString

Converts the value of the current System.DateTime object to its equivalent short date string representation.

Returns

A string that contains the short date string representation of the current System.DateTime object.

System.DateTime.ToShortTimeString

Converts the value of the current System.DateTime object to its equivalent short time string representation.

Returns

A string that contains the short time string representation of the current System.DateTime object.

System.DateTime.ToString

Converts the value of the current System.DateTime object to its equivalent string representation using the formatting conventions of the current culture.

Returns

A string representation of the value of the current System.DateTime object.

System.DateTime.ToString()

Converts the value of the current System.DateTime object to its equivalent string representation using the specified culture-specific format information.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

A string representation of value of the current System.DateTime object as specified by provider.

System.DateTime.ToString()

Converts the value of the current System.DateTime object to its equivalent string representation using the specified format and the formatting conventions of the current culture.

Parameters

NameDescriptionDefault
format A standard or custom date and time format string.

Returns

A string representation of value of the current System.DateTime object as specified by format.

System.DateTime.ToString()

Converts the value of the current System.DateTime object to its equivalent string representation using the specified format and culture-specific format information.

Parameters

NameDescriptionDefault
format A standard or custom date and time format string.
provider An object that supplies culture-specific formatting information.

Returns

A string representation of value of the current System.DateTime object as specified by format and provider.

System.DateTime.ToUniversalTime

Converts the value of the current System.DateTime object to Coordinated Universal Time (UTC).

Returns

An object whose System.DateTime.Kind property is System.DateTimeKind.Utc, and whose value is the UTC equivalent to the value of the current System.DateTime object, or DateTime.MaxValue if the converted value is too large to be represented by a System.DateTime object, or DateTime.MinValue if the converted value is too small to be represented by a System.DateTime object.

System.DateTime.TryFormat()

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

Parameters

NameDescriptionDefault
utf8Destination The span in which to write this instance's value formatted as a span of bytes.
bytesWritten When this method returns, contains the number of bytes that were written in
utf8Destination
.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for
utf8Destination
.
provider An optional object that supplies culture-specific formatting information for
utf8Destination
.

Returns

true
if the formatting was successful; otherwise,
false
.

System.DateTime.TryFormat()

Tries to format the value of the current datetime instance into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span in which to write this instance's value formatted as a span of characters.
charsWritten When this method returns, contains the number of characters that were written in destination.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for destination.
provider An optional object that supplies culture-specific formatting information for destination.

Returns

true if the formatting was successful; otherwise, false.

System.DateTime.TryParse()

Converts the specified char span of a date and time to its System.DateTime equivalent and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A string containing a date and time to convert.
result When this method returns, contains the System.DateTime value equivalent to the date and time contained in s, if the conversion succeeded, or DateTime.MinValue if the conversion failed. The conversion fails if the s parameter is null, is an empty string (""), or does not contain a valid string representation of a date and time. This parameter is passed uninitialized.

Returns

true if the s parameter was converted successfully; otherwise, false.

System.DateTime.TryParse()

Tries to parse a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
, or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.DateTime.TryParse()

Converts the span representation of a date and time to its System.DateTime equivalent using the specified culture-specific format information and formatting style, and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A span containing the characters representing the date and time to convert.
provider An object that supplies culture-specific formatting information about s.
styles A bitwise combination of enumeration values that defines how to interpret the parsed date in relation to the current time zone or the current date. A typical value to specify is System.Globalization.DateTimeStyles.None.
result When this method returns, contains the System.DateTime value equivalent to the date and time contained in s, if the conversion succeeded, or DateTime.MinValue if the conversion failed. The conversion fails if the s parameter is null, is an empty string (""), or does not contain a valid string representation of a date and time. This parameter is passed uninitialized.

Returns

true if the s parameter was converted successfully; otherwise, false.

System.DateTime.TryParse()

Converts the specified string representation of a date and time to its System.DateTime equivalent and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A string containing a date and time to convert.
result When this method returns, contains the System.DateTime value equivalent to the date and time contained in s, if the conversion succeeded, or DateTime.MinValue if the conversion failed. The conversion fails if the s parameter is null, is an empty string (""), or does not contain a valid string representation of a date and time. This parameter is passed uninitialized.

Returns

true if the s parameter was converted successfully; otherwise, false.

System.DateTime.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.DateTime.TryParse()

Converts the specified string representation of a date and time to its System.DateTime equivalent using the specified culture-specific format information and formatting style, and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A string containing a date and time to convert.
provider An object that supplies culture-specific formatting information about s.
styles A bitwise combination of enumeration values that defines how to interpret the parsed date in relation to the current time zone or the current date. A typical value to specify is System.Globalization.DateTimeStyles.None.
result When this method returns, contains the System.DateTime value equivalent to the date and time contained in s, if the conversion succeeded, or DateTime.MinValue if the conversion failed. The conversion fails if the s parameter is null, is an empty string (""), or does not contain a valid string representation of a date and time. This parameter is passed uninitialized.

Returns

true if the s parameter was converted successfully; otherwise, false.

System.DateTime.TryParseExact()

Converts the specified span representation of a date and time to its System.DateTime equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format exactly. The method returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A span containing the characters representing a date and time to convert.
format The required format of s.
provider An object that supplies culture-specific formatting information about s.
style A bitwise combination of one or more enumeration values that indicate the permitted format of s.
result When this method returns, contains the System.DateTime value equivalent to the date and time contained in s, if the conversion succeeded, or DateTime.MinValue if the conversion failed. The conversion fails if either the s or format parameter is null, is an empty string, or does not contain a date and time that correspond to the pattern specified in format. This parameter is passed uninitialized.

Returns

true if s was converted successfully; otherwise, false.

System.DateTime.TryParseExact()

Converts the specified char span of a date and time to its System.DateTime equivalent and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s The span containing the string to parse.
formats An array of allowable formats of s.
provider An object that supplies culture-specific formatting information about s.
style A bitwise combination of enumeration values that defines how to interpret the parsed date in relation to the current time zone or the current date. A typical value to specify is System.Globalization.DateTimeStyles.None.
result When this method returns, contains the System.DateTime value equivalent to the date and time contained in s, if the conversion succeeded, or DateTime.MinValue if the conversion failed. The conversion fails if the s parameter is null, is System.String.Empty, or does not contain a valid string representation of a date and time. This parameter is passed uninitialized.

Returns

true if the s parameter was converted successfully; otherwise, false.

System.DateTime.TryParseExact()

Converts the specified string representation of a date and time to its System.DateTime equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format exactly. The method returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A string containing a date and time to convert.
format The required format of s.
provider An object that supplies culture-specific formatting information about s.
style A bitwise combination of one or more enumeration values that indicate the permitted format of s.
result When this method returns, contains the System.DateTime value equivalent to the date and time contained in s, if the conversion succeeded, or DateTime.MinValue if the conversion failed. The conversion fails if either the s or format parameter is null, is an empty string, or does not contain a date and time that correspond to the pattern specified in format. This parameter is passed uninitialized.

Returns

true if s was converted successfully; otherwise, false.

System.DateTime.TryParseExact()

Converts the specified string representation of a date and time to its System.DateTime equivalent using the specified array of formats, culture-specific format information, and style. The format of the string representation must match at least one of the specified formats exactly. The method returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A string that contains a date and time to convert.
formats An array of allowable formats of s.
provider An object that supplies culture-specific format information about s.
style A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.DateTimeStyles.None.
result When this method returns, contains the System.DateTime value equivalent to the date and time contained in s, if the conversion succeeded, or DateTime.MinValue if the conversion failed. The conversion fails if s or formats is null, s or an element of formats is an empty string, or the format of s is not exactly as specified by at least one of the format patterns in formats. This parameter is passed uninitialized.

Returns

true if the s parameter was converted successfully; otherwise, false.

System.DateTime.Date

Gets the date component of this instance.

Returns

A new object with the same date as this instance, and the time value set to 12:00:00 midnight (00:00:00).

System.DateTime.Day

Gets the day of the month represented by this instance.

Returns

The day component, expressed as a value between 1 and 31.

System.DateTime.DayOfWeek

Gets the day of the week represented by this instance.

Returns

An enumerated constant that indicates the day of the week of this System.DateTime value.

System.DateTime.DayOfYear

Gets the day of the year represented by this instance.

Returns

The day of the year, expressed as a value between 1 and 366.

System.DateTime.Hour

Gets the hour component of the date represented by this instance.

Returns

The hour component, expressed as a value between 0 and 23.

System.DateTime.Kind

Gets a value that indicates whether the time represented by this instance is based on local time, Coordinated Universal Time (UTC), or neither.

Returns

One of the enumeration values that indicates what the current time represents. The default is System.DateTimeKind.Unspecified.

System.DateTime.Microsecond

The microseconds component, expressed as a value between 0 and 999.

System.DateTime.Millisecond

Gets the milliseconds component of the date represented by this instance.

Returns

The milliseconds component, expressed as a value between 0 and 999.

System.DateTime.Minute

Gets the minute component of the date represented by this instance.

Returns

The minute component, expressed as a value between 0 and 59.

System.DateTime.Month

Gets the month component of the date represented by this instance.

Returns

The month component, expressed as a value between 1 and 12.

System.DateTime.Nanosecond

The nanoseconds component, expressed as a value between 0 and 900 (in increments of 100 nanoseconds).

System.DateTime.Now

Gets a System.DateTime object that is set to the current date and time on this computer, expressed as the local time.

Returns

An object whose value is the current local date and time.

System.DateTime.Second

Gets the seconds component of the date represented by this instance.

Returns

The seconds component, expressed as a value between 0 and 59.

System.DateTime.Ticks

Gets the number of ticks that represent the date and time of this instance.

Returns

The number of ticks that represent the date and time of this instance. The value is between DateTime.MinValue.Ticks and DateTime.MaxValue.Ticks.

System.DateTime.TimeOfDay

Gets the time of day for this instance.

Returns

A time interval that represents the fraction of the day that has elapsed since midnight.

System.DateTime.Today

Gets the current date.

Returns

An object that is set to today's date, with the time component set to 00:00:00.

System.DateTime.UtcNow

Gets a System.DateTime object that is set to the current date and time on this computer, expressed as the Coordinated Universal Time (UTC).

Returns

An object whose value is the current UTC date and time.

System.DateTime.Year

Gets the year component of the date represented by this instance.

Returns

The year, between 1 and 9999.

System.DateTimeKind

Specifies whether a System.DateTime object represents a local time, a Coordinated Universal Time (UTC), or is not specified as either local time or UTC.

System.DateTimeKind.Local

The time represented is local time.

System.DateTimeKind.Unspecified

The time represented is not specified as either local time or Coordinated Universal Time (UTC).

System.DateTimeKind.Utc

The time represented is UTC.

System.DateTimeOffset

Represents a point in time, typically expressed as a date and time of day, relative to Coordinated Universal Time (UTC).

System.DateTimeOffset.MaxValue

Represents the greatest possible value of System.DateTimeOffset. This field is read-only.

System.DateTimeOffset.MinValue

Represents the earliest possible System.DateTimeOffset value. This field is read-only.

System.DateTimeOffset.UnixEpoch

The value of this constant is equivalent to 00:00:00.0000000 UTC, January 1, 1970, in the Gregorian calendar. System.DateTimeOffset.UnixEpoch defines the point in time when Unix time is equal to 0.

System.DateTimeOffset.#ctor()

Initializes a new instance of the System.DateTimeOffset structure using the specified date, time, and offset.

Parameters

NameDescriptionDefault
date The date part.
time The time part.
offset The time's offset from Coordinated Universal Time (UTC).

System.DateTimeOffset.#ctor()

Initializes a new instance of the System.DateTimeOffset structure using the specified System.DateTime value.

Parameters

NameDescriptionDefault
dateTime A date and time.

System.DateTimeOffset.#ctor()

Initializes a new instance of the System.DateTimeOffset structure using the specified System.DateTime value and offset.

Parameters

NameDescriptionDefault
dateTime A date and time.
offset The time's offset from Coordinated Universal Time (UTC).

System.DateTimeOffset.#ctor()

Initializes a new instance of the System.DateTimeOffset structure using the specified year, month, day, hour, minute, second, millisecond, and offset of a specified calendar.

Parameters

NameDescriptionDefault
year The year.
month The month (1 through 12).
day The day (1 through the number of days in month).
hour The hours (0 through 23).
minute The minutes (0 through 59).
second The seconds (0 through 59).
millisecond The milliseconds (0 through 999).
calendar The calendar that is used to interpret year, month, and day.
offset The time's offset from Coordinated Universal Time (UTC).

System.DateTimeOffset.#ctor()

Initializes a new instance of the System.DateTimeOffset structure using the specified year, month, day, hour, minute, second, millisecond, microsecond and offset.

Parameters

NameDescriptionDefault
year The year (1 through 9999).
month The month (1 through 12).
day The day (1 through the number of days in month).
hour The hours (0 through 23).
minute The minutes (0 through 59).
second The seconds (0 through 59).
millisecond The milliseconds (0 through 999).
microsecond The microseconds (0 through 999).
calendar The calendar that is used to interpret year, month, and day.
offset The time's offset from Coordinated Universal Time (UTC).

System.DateTimeOffset.#ctor()

Initializes a new instance of the System.DateTimeOffset structure using the specified year, month, day, hour, minute, second, millisecond, microsecond and offset.

Parameters

NameDescriptionDefault
year The year (1 through 9999).
month The month (1 through 12).
day The day (1 through the number of days in month).
hour The hours (0 through 23).
minute The minutes (0 through 59).
second The seconds (0 through 59).
millisecond The milliseconds (0 through 999).
microsecond The microseconds (0 through 999).
offset The time's offset from Coordinated Universal Time (UTC).

System.DateTimeOffset.#ctor()

Initializes a new instance of the System.DateTimeOffset structure using the specified year, month, day, hour, minute, second, millisecond, and offset.

Parameters

NameDescriptionDefault
year The year (1 through 9999).
month The month (1 through 12).
day The day (1 through the number of days in month).
hour The hours (0 through 23).
minute The minutes (0 through 59).
second The seconds (0 through 59).
millisecond The milliseconds (0 through 999).
offset The time's offset from Coordinated Universal Time (UTC).

System.DateTimeOffset.#ctor()

Initializes a new instance of the System.DateTimeOffset structure using the specified year, month, day, hour, minute, second, and offset.

Parameters

NameDescriptionDefault
year The year (1 through 9999).
month The month (1 through 12).
day The day (1 through the number of days in month).
hour The hours (0 through 23).
minute The minutes (0 through 59).
second The seconds (0 through 59).
offset The time's offset from Coordinated Universal Time (UTC).

System.DateTimeOffset.#ctor()

Initializes a new instance of the System.DateTimeOffset structure using the specified number of ticks and offset.

Parameters

NameDescriptionDefault
ticks A date and time expressed as the number of 100-nanosecond intervals that have elapsed since 12:00:00 midnight on January 1, 0001.
offset The time's offset from Coordinated Universal Time (UTC).

System.DateTimeOffset.Add()

Returns a new System.DateTimeOffset object that adds a specified time interval to the value of this instance.

Parameters

NameDescriptionDefault
timeSpan A System.TimeSpan object that represents a positive or a negative time interval.

Returns

An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the time interval represented by timeSpan.

System.DateTimeOffset.AddDays()

Returns a new System.DateTimeOffset object that adds a specified number of whole and fractional days to the value of this instance.

Parameters

NameDescriptionDefault
days A number of whole and fractional days. The number can be negative or positive.

Returns

An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of days represented by days.

System.DateTimeOffset.AddHours()

Returns a new System.DateTimeOffset object that adds a specified number of whole and fractional hours to the value of this instance.

Parameters

NameDescriptionDefault
hours A number of whole and fractional hours. The number can be negative or positive.

Returns

An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of hours represented by hours.

System.DateTimeOffset.AddMicroseconds()

Returns a new System.DateTimeOffset object that adds a specified number of microseconds to the value of this instance.

Parameters

NameDescriptionDefault
microseconds A number of whole and fractional microseconds. The number can be negative or positive.

Returns

An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of whole microseconds represented by microseconds.

System.DateTimeOffset.AddMilliseconds()

Returns a new System.DateTimeOffset object that adds a specified number of milliseconds to the value of this instance.

Parameters

NameDescriptionDefault
milliseconds A number of whole and fractional milliseconds. The number can be negative or positive.

Returns

An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of whole milliseconds represented by milliseconds.

System.DateTimeOffset.AddMinutes()

Returns a new System.DateTimeOffset object that adds a specified number of whole and fractional minutes to the value of this instance.

Parameters

NameDescriptionDefault
minutes A number of whole and fractional minutes. The number can be negative or positive.

Returns

An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of minutes represented by minutes.

System.DateTimeOffset.AddMonths()

Returns a new System.DateTimeOffset object that adds a specified number of months to the value of this instance.

Parameters

NameDescriptionDefault
months A number of whole months. The number can be negative or positive.

Returns

An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of months represented by months.

System.DateTimeOffset.AddSeconds()

Returns a new System.DateTimeOffset object that adds a specified number of whole and fractional seconds to the value of this instance.

Parameters

NameDescriptionDefault
seconds A number of whole and fractional seconds. The number can be negative or positive.

Returns

An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of seconds represented by seconds.

System.DateTimeOffset.AddTicks()

Returns a new System.DateTimeOffset object that adds a specified number of ticks to the value of this instance.

Parameters

NameDescriptionDefault
ticks A number of 100-nanosecond ticks. The number can be negative or positive.

Returns

An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of ticks represented by ticks.

System.DateTimeOffset.AddYears()

Returns a new System.DateTimeOffset object that adds a specified number of years to the value of this instance.

Parameters

NameDescriptionDefault
years A number of years. The number can be negative or positive.

Returns

An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of years represented by years.

System.DateTimeOffset.Compare()

Compares two System.DateTimeOffset objects and indicates whether the first is earlier than the second, equal to the second, or later than the second.

Parameters

NameDescriptionDefault
first The first object to compare.
second The second object to compare.

Returns

A signed integer that indicates whether the value of the first parameter is earlier than, later than, or the same time as the value of the second parameter, as the following table shows. Return value Meaning Less than zerofirst is earlier than second. Zerofirst is equal to second. Greater than zerofirst is later than second.

System.DateTimeOffset.CompareTo()

Compares the current System.DateTimeOffset object to a specified System.DateTimeOffset object and indicates whether the current object is earlier than, the same as, or later than the second System.DateTimeOffset object.

Parameters

NameDescriptionDefault
other An object to compare with the current System.DateTimeOffset object.

Returns

A signed integer that indicates the relationship between the current System.DateTimeOffset object and other, as the following table shows. Return Value Description Less than zero The current System.DateTimeOffset object is earlier than other. Zero The current System.DateTimeOffset object is the same as other. Greater than zero. The current System.DateTimeOffset object is later than other.

System.DateTimeOffset.Deconstruct()

Parameters

NameDescriptionDefault
date When this method returns, represents the System.DateOnly value of this System.DateTimeOffset instance.
time When this method returns, represents the System.TimeOnly value of this System.DateTimeOffset instance.
offset When this method returns, represents the System.DateTimeOffset.Offset value of this System.DateTimeOffset instance.

System.DateTimeOffset.Equals()

Determines whether the current System.DateTimeOffset object represents the same point in time as a specified System.DateTimeOffset object.

Parameters

NameDescriptionDefault
other An object to compare to the current System.DateTimeOffset object.

Returns

true if both System.DateTimeOffset objects have the same System.DateTimeOffset.UtcDateTime value; otherwise, false.

System.DateTimeOffset.Equals()

Determines whether two specified System.DateTimeOffset objects represent the same point in time.

Parameters

NameDescriptionDefault
first The first object to compare.
second The second object to compare.

Returns

true if the two System.DateTimeOffset objects have the same System.DateTimeOffset.UtcDateTime value; otherwise, false.

System.DateTimeOffset.Equals()

Determines whether a System.DateTimeOffset object represents the same point in time as a specified object.

Parameters

NameDescriptionDefault
obj The object to compare to the current System.DateTimeOffset object.

Returns

true if the obj parameter is a System.DateTimeOffset object and represents the same point in time as the current System.DateTimeOffset object; otherwise, false.

System.DateTimeOffset.EqualsExact()

Determines whether the current System.DateTimeOffset object represents the same time and has the same offset as a specified System.DateTimeOffset object.

Parameters

NameDescriptionDefault
other The object to compare to the current System.DateTimeOffset object.

Returns

true if the current System.DateTimeOffset object and other have the same date and time value and the same System.DateTimeOffset.Offset value; otherwise, false.

System.DateTimeOffset.FromFileTime()

Converts the specified Windows file time to an equivalent local time.

Parameters

NameDescriptionDefault
fileTime A Windows file time, expressed in ticks.

Returns

An object that represents the date and time of fileTime with the offset set to the local time offset.

System.DateTimeOffset.FromUnixTimeMilliseconds()

Converts a Unix time expressed as the number of milliseconds that have elapsed since 1970-01-01T00:00:00Z to a System.DateTimeOffset value.

Parameters

NameDescriptionDefault
milliseconds A Unix time, expressed as the number of milliseconds that have elapsed since 1970-01-01T00:00:00Z (January 1, 1970, at 12:00 AM UTC). For Unix times before this date, its value is negative.

Returns

A date and time value that represents the same moment in time as the Unix time.

System.DateTimeOffset.FromUnixTimeSeconds()

Converts a Unix time expressed as the number of seconds that have elapsed since 1970-01-01T00:00:00Z to a System.DateTimeOffset value.

Parameters

NameDescriptionDefault
seconds A Unix time, expressed as the number of seconds that have elapsed since 1970-01-01T00:00:00Z (January 1, 1970, at 12:00 AM UTC). For Unix times before this date, its value is negative.

Returns

A date and time value that represents the same moment in time as the Unix time.

System.DateTimeOffset.GetHashCode

Returns the hash code for the current System.DateTimeOffset object.

Returns

A 32-bit signed integer hash code.

System.DateTimeOffset.op_Addition()

Adds a specified time interval to a System.DateTimeOffset object that has a specified date and time, and yields a System.DateTimeOffset object that has new a date and time.

Parameters

NameDescriptionDefault
dateTimeOffset The object to add the time interval to.
timeSpan The time interval to add.

Returns

An object whose value is the sum of the values of dateTimeTz and timeSpan.

System.DateTimeOffset.op_Equality()

Determines whether two specified System.DateTimeOffset objects represent the same point in time.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if both System.DateTimeOffset objects have the same System.DateTimeOffset.UtcDateTime value; otherwise, false.

System.DateTimeOffset.op_GreaterThan()

Determines whether one specified object is greater than (or later than) a second specified object.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true
if the value of
left
is later than the value of
right
; otherwise,
false
.

System.DateTimeOffset.op_GreaterThanOrEqual()

Determines whether one specified object is greater than or equal to a second specified object.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true
if the value of
left
is the same as or later than the value of
right
; otherwise,
false
.

System.DateTimeOffset.op_Implicit()

Defines an implicit conversion of a System.DateTime object to a System.DateTimeOffset object.

Parameters

NameDescriptionDefault
dateTime The object to convert.

Returns

The converted object.

System.DateTimeOffset.op_Inequality()

Determines whether two specified System.DateTimeOffset objects refer to different points in time.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left and right do not have the same System.DateTimeOffset.UtcDateTime value; otherwise, false.

System.DateTimeOffset.op_LessThan()

Determines whether one specified object is less than a second specified object.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true
if the value of
left
is earlier than the value of
right
; otherwise,
false
.

System.DateTimeOffset.op_LessThanOrEqual()

Determines whether one specified object is less than a second specified object.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true
if the value of
left
is earlier than the value of
right
; otherwise,
false
.

System.DateTimeOffset.op_Subtraction()

Subtracts one System.DateTimeOffset object from another and yields a time interval.

Parameters

NameDescriptionDefault
left The minuend.
right The subtrahend.

Returns

An object that represents the difference between left and right.

System.DateTimeOffset.op_Subtraction()

Subtracts a specified time interval from a specified date and time, and yields a new date and time.

Parameters

NameDescriptionDefault
dateTimeOffset The date and time object to subtract from.
timeSpan The time interval to subtract.

Returns

An object that is equal to the value of dateTimeOffset minus timeSpan.

System.DateTimeOffset.Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.

Returns

The result of parsing
s
.

System.DateTimeOffset.Parse()

Converts the specified span representation of a date and time to its System.DateTimeOffset equivalent using the specified culture-specific format information and formatting style.

Parameters

NameDescriptionDefault
input A span containing the characters that represent a date and time to convert.
formatProvider An object that provides culture-specific format information about input.
styles A bitwise combination of enumeration values that indicates the permitted format of input. A typical value to specify is System.Globalization.DateTimeStyles.None.

Returns

An object that is equivalent to the date and time that is contained in input as specified by formatProvider and styles.

System.DateTimeOffset.Parse()

Converts the specified string representation of a date, time, and offset to its System.DateTimeOffset equivalent.

Parameters

NameDescriptionDefault
input A string that contains a date and time to convert.

Returns

An object that is equivalent to the date and time that is contained in input.

System.DateTimeOffset.Parse()

Converts the specified string representation of a date and time to its System.DateTimeOffset equivalent using the specified culture-specific format information.

Parameters

NameDescriptionDefault
input A string that contains a date and time to convert.
formatProvider An object that provides culture-specific format information about input.

Returns

An object that is equivalent to the date and time that is contained in input, as specified by formatProvider.

System.DateTimeOffset.Parse()

Converts the specified string representation of a date and time to its System.DateTimeOffset equivalent using the specified culture-specific format information and formatting style.

Parameters

NameDescriptionDefault
input A string that contains a date and time to convert.
formatProvider An object that provides culture-specific format information about input.
styles A bitwise combination of enumeration values that indicates the permitted format of input. A typical value to specify is System.Globalization.DateTimeStyles.None.

Returns

An object that is equivalent to the date and time that is contained in input as specified by formatProvider and styles.

System.DateTimeOffset.ParseExact()

Converts a character span that represents a date and time to its System.DateTimeOffset equivalent using the specified format, culture-specific format information, and style. The format of the date and time representation must match the specified format exactly.

Parameters

NameDescriptionDefault
input A character span that represents a date and time.
format A character span that contains a format specifier that defines the expected format of input.
formatProvider An object that provides culture-specific formatting information about input.
styles A bitwise combination of enumeration values that indicates the permitted format of input.

Returns

An object that is equivalent to the date and time that is contained in the input parameter, as specified by the format, formatProvider, and styles parameters.

System.DateTimeOffset.ParseExact()

Converts a character span that contains the string representation of a date and time to its System.DateTimeOffset equivalent using the specified formats, culture-specific format information, and style. The format of the date and time representation must match one of the specified formats exactly.

Parameters

NameDescriptionDefault
input A character span that contains a date and time to convert.
formats An array of format specifiers that define the expected formats of input.
formatProvider An object that supplies culture-specific formatting information about input.
styles A bitwise combination of enumeration values that indicates the permitted format of input.

Returns

An object that is equivalent to the date and time that is contained in the input parameter, as specified by the formats, formatProvider, and styles parameters.

System.DateTimeOffset.ParseExact()

Converts the specified string representation of a date and time to its System.DateTimeOffset equivalent using the specified format and culture-specific format information. The format of the string representation must match the specified format exactly.

Parameters

NameDescriptionDefault
input A string that contains a date and time to convert.
format A format specifier that defines the expected format of input.
formatProvider An object that supplies culture-specific formatting information about input.

Returns

An object that is equivalent to the date and time that is contained in input as specified by format and formatProvider.

System.DateTimeOffset.ParseExact()

Converts the specified string representation of a date and time to its System.DateTimeOffset equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format exactly.

Parameters

NameDescriptionDefault
input A string that contains a date and time to convert.
format A format specifier that defines the expected format of input.
formatProvider An object that supplies culture-specific formatting information about input.
styles A bitwise combination of enumeration values that indicates the permitted format of input.

Returns

An object that is equivalent to the date and time that is contained in the input parameter, as specified by the format, formatProvider, and styles parameters.

System.DateTimeOffset.ParseExact()

Converts the specified string representation of a date and time to its System.DateTimeOffset equivalent using the specified formats, culture-specific format information, and style. The format of the string representation must match one of the specified formats exactly.

Parameters

NameDescriptionDefault
input A string that contains a date and time to convert.
formats An array of format specifiers that define the expected formats of input.
formatProvider An object that supplies culture-specific formatting information about input.
styles A bitwise combination of enumeration values that indicates the permitted format of input.

Returns

An object that is equivalent to the date and time that is contained in the input parameter, as specified by the formats, formatProvider, and styles parameters.

System.DateTimeOffset.Subtract()

Subtracts a System.DateTimeOffset value that represents a specific date and time from the current System.DateTimeOffset object.

Parameters

NameDescriptionDefault
value An object that represents the value to subtract.

Returns

An object that specifies the interval between the two System.DateTimeOffset objects.

System.DateTimeOffset.Subtract()

Subtracts a specified time interval from the current System.DateTimeOffset object.

Parameters

NameDescriptionDefault
value The time interval to subtract.

Returns

An object that is equal to the date and time represented by the current System.DateTimeOffset object, minus the time interval represented by value.

System.DateTimeOffset.System#IComparable#CompareTo()

Compares the value of the current System.DateTimeOffset object with another object of the same type.

Parameters

NameDescriptionDefault
obj The object to compare with the current System.DateTimeOffset object.

Returns

A 32-bit signed integer that indicates whether the current System.DateTimeOffset object is less than, equal to, or greater than obj. The return values of the method are interpreted as follows: Return Value Description Less than zero The current System.DateTimeOffset object is less than (earlier than) obj. Zero The current System.DateTimeOffset object is equal to (the same point in time as) obj. Greater than zero The current System.DateTimeOffset object is greater than (later than) obj.

System.DateTimeOffset.System#Runtime#Serialization#IDeserializationCallback#OnDeserialization()

Runs when the deserialization of an object has been completed.

Parameters

NameDescriptionDefault
sender The object that initiated the callback. The functionality for this parameter is not currently implemented.

System.DateTimeOffset.System#Runtime#Serialization#ISerializable#GetObjectData()

Populates a System.Runtime.Serialization.SerializationInfo object with the data required to serialize the current System.DateTimeOffset object.

Parameters

NameDescriptionDefault
info The object to populate with data.
context The destination for this serialization (see System.Runtime.Serialization.StreamingContext).

System.DateTimeOffset.ToFileTime

Converts the value of the current System.DateTimeOffset object to a Windows file time.

Returns

The value of the current System.DateTimeOffset object, expressed as a Windows file time.

System.DateTimeOffset.ToLocalTime

Converts the current System.DateTimeOffset object to a System.DateTimeOffset object that represents the local time.

Returns

An object that represents the date and time of the current System.DateTimeOffset object converted to local time.

System.DateTimeOffset.ToOffset()

Converts the value of the current System.DateTimeOffset object to the date and time specified by an offset value.

Parameters

NameDescriptionDefault
offset The offset to convert the System.DateTimeOffset value to.

Returns

An object that is equal to the original System.DateTimeOffset object (that is, their System.DateTimeOffset.ToUniversalTime methods return identical points in time) but whose System.DateTimeOffset.Offset property is set to offset.

System.DateTimeOffset.ToString

Converts the value of the current System.DateTimeOffset object to its equivalent string representation.

Returns

A string representation of a System.DateTimeOffset object that includes the offset appended at the end of the string.

System.DateTimeOffset.ToString()

Converts the value of the current System.DateTimeOffset object to its equivalent string representation using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
formatProvider An object that supplies culture-specific formatting information.

Returns

A string representation of the value of the current System.DateTimeOffset object, as specified by formatProvider.

System.DateTimeOffset.ToString()

Converts the value of the current System.DateTimeOffset object to its equivalent string representation using the specified format.

Parameters

NameDescriptionDefault
format A format string.

Returns

A string representation of the value of the current System.DateTimeOffset object, as specified by format.

System.DateTimeOffset.ToString()

Converts the value of the current System.DateTimeOffset object to its equivalent string representation using the specified format and culture-specific format information.

Parameters

NameDescriptionDefault
format A format string.
formatProvider An object that supplies culture-specific formatting information.

Returns

A string representation of the value of the current System.DateTimeOffset object, as specified by format and provider.

System.DateTimeOffset.ToUniversalTime

Converts the current System.DateTimeOffset object to a System.DateTimeOffset value that represents the Coordinated Universal Time (UTC).

Returns

An object that represents the date and time of the current System.DateTimeOffset object converted to Coordinated Universal Time (UTC).

System.DateTimeOffset.ToUnixTimeMilliseconds

Returns the number of milliseconds that have elapsed since 1970-01-01T00:00:00.000Z.

Returns

The number of milliseconds that have elapsed since 1970-01-01T00:00:00.000Z.

System.DateTimeOffset.ToUnixTimeSeconds

Returns the number of seconds that have elapsed since 1970-01-01T00:00:00Z.

Returns

The number of seconds that have elapsed since 1970-01-01T00:00:00Z.

System.DateTimeOffset.TryFormat()

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

Parameters

NameDescriptionDefault
utf8Destination The span in which to write this instance's value formatted as a span of bytes.
bytesWritten When this method returns, contains the number of bytes that were written in
utf8Destination
.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for
utf8Destination
.
formatProvider

Returns

true
if the formatting was successful; otherwise,
false
.

System.DateTimeOffset.TryFormat()

Tries to format the value of the current datetime offset instance into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span in which to write this instance's value formatted as a span of characters.
charsWritten When this method returns, the number of characters that were written in destination.
format A span containing the charactes that represent a standard or custom format string that defines the acceptable format for destination.
formatProvider An optional object that supplies culture-specific formatting information for destination.

Returns

true if the formatting was successful; otherwise, false.

System.DateTimeOffset.TryParse()

Tries to convert a specified span representation of a date and time to its System.DateTimeOffset equivalent, and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
input A span containing the characters representing the date and time to convert.
result When the method returns, contains the System.DateTimeOffset equivalent to the date and time of input, if the conversion succeeded, or DateTimeOffset.MinValue, if the conversion failed. The conversion fails if the input parameter is null or does not contain a valid string representation of a date and time. This parameter is passed uninitialized.

Returns

true if the input parameter is successfully converted; otherwise, false.

System.DateTimeOffset.TryParse()

Tries to parse a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
, or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.DateTimeOffset.TryParse()

Tries to convert a specified span representation of a date and time to its System.DateTimeOffset equivalent, and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
input A span containing the characters representing the date and time to convert.
formatProvider An object that provides culture-specific formatting information about input.
styles A bitwise combination of enumeration values that indicates the permitted format of input.
result When the method returns, contains the System.DateTimeOffset value equivalent to the date and time of input, if the conversion succeeded, or DateTimeOffset.MinValue, if the conversion failed. The conversion fails if the input parameter is null or does not contain a valid string representation of a date and time. This parameter is passed uninitialized.

Returns

true if the input parameter is successfully converted; otherwise, false.

System.DateTimeOffset.TryParse()

Tries to converts a specified string representation of a date and time to its System.DateTimeOffset equivalent, and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
input A string that contains a date and time to convert.
result When the method returns, contains the System.DateTimeOffset equivalent to the date and time of input, if the conversion succeeded, or DateTimeOffset.MinValue, if the conversion failed. The conversion fails if the input parameter is null or does not contain a valid string representation of a date and time. This parameter is passed uninitialized.

Returns

true if the input parameter is successfully converted; otherwise, false.

System.DateTimeOffset.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.DateTimeOffset.TryParse()

Tries to convert a specified string representation of a date and time to its System.DateTimeOffset equivalent, and returns a value that indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
input A string that contains a date and time to convert.
formatProvider An object that provides culture-specific formatting information about input.
styles A bitwise combination of enumeration values that indicates the permitted format of input.
result When the method returns, contains the System.DateTimeOffset value equivalent to the date and time of input, if the conversion succeeded, or DateTimeOffset.MinValue, if the conversion failed. The conversion fails if the input parameter is null or does not contain a valid string representation of a date and time. This parameter is passed uninitialized.

Returns

true if the input parameter is successfully converted; otherwise, false.

System.DateTimeOffset.TryParseExact()

Converts the representation of a date and time in a character span to its System.DateTimeOffset equivalent using the specified format, culture-specific format information, and style. The format of the date and time representation must match the specified format exactly.

Parameters

NameDescriptionDefault
input A span containing the characters that represent a date and time to convert.
format A format specifier that defines the required format of input.
formatProvider An object that supplies culture-specific formatting information about input.
styles A bitwise combination of enumeration values that indicates the permitted format of input. A typical value to specify is System.Globalization.DateTimeStyles.None.
result When the method returns, contains the System.DateTimeOffset equivalent to the date and time of input, if the conversion succeeded, or DateTimeOffset.MinValue if the conversion failed. The conversion fails if the

Returns

true if the input parameter is successfully converted; otherwise, false.

System.DateTimeOffset.TryParseExact()

Converts the representation of a date and time in a character span to its System.DateTimeOffset equivalent using the specified formats, culture-specific format information, and style. The format of the date and time representation must match one of the specified formats exactly.

Parameters

NameDescriptionDefault
input A span containing the characters that represent a date and time to convert.
formats A array of standard or custom format strings that define the acceptable formats of input.
formatProvider An object that supplies culture-specific formatting information about input.
styles A bitwise combination of enumeration values that indicates the permitted format of input. A typical value to specify is System.Globalization.DateTimeStyles.None.
result When the method returns, contains the System.DateTimeOffset equivalent to the date and time of input, if the conversion succeeded, or DateTimeOffset.MinValue if the conversion failed. The conversion fails if the

Returns

true if the input parameter is successfully converted; otherwise, false.

System.DateTimeOffset.TryParseExact()

Converts the specified string representation of a date and time to its System.DateTimeOffset equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format exactly.

Parameters

NameDescriptionDefault
input A string that contains a date and time to convert.
format A format specifier that defines the required format of input.
formatProvider An object that supplies culture-specific formatting information about input.
styles A bitwise combination of enumeration values that indicates the permitted format of input. A typical value to specify is None.
result When the method returns, contains the System.DateTimeOffset equivalent to the date and time of input, if the conversion succeeded, or DateTimeOffset.MinValue, if the conversion failed. The conversion fails if the input parameter is null, or does not contain a valid string representation of a date and time in the expected format defined by format and provider. This parameter is passed uninitialized.

Returns

true if the input parameter is successfully converted; otherwise, false.

System.DateTimeOffset.TryParseExact()

Converts the specified string representation of a date and time to its System.DateTimeOffset equivalent using the specified array of formats, culture-specific format information, and style. The format of the string representation must match one of the specified formats exactly.

Parameters

NameDescriptionDefault
input A string that contains a date and time to convert.
formats An array that defines the expected formats of input.
formatProvider An object that supplies culture-specific formatting information about input.
styles A bitwise combination of enumeration values that indicates the permitted format of input. A typical value to specify is None.
result When the method returns, contains the System.DateTimeOffset equivalent to the date and time of input, if the conversion succeeded, or DateTimeOffset.MinValue, if the conversion failed. The conversion fails if the input does not contain a valid string representation of a date and time, or does not contain the date and time in the expected format defined by format, or if formats is null. This parameter is passed uninitialized.

Returns

true if the input parameter is successfully converted; otherwise, false.

System.DateTimeOffset.Date

Gets a System.DateTime value that represents the date component of the current System.DateTimeOffset object.

Returns

A System.DateTime value that represents the date component of the current System.DateTimeOffset object.

System.DateTimeOffset.DateTime

Gets a System.DateTime value that represents the date and time of the current System.DateTimeOffset object.

Returns

The date and time of the current System.DateTimeOffset object.

System.DateTimeOffset.Day

Gets the day of the month represented by the current System.DateTimeOffset object.

Returns

The day component of the current System.DateTimeOffset object, expressed as a value between 1 and 31.

System.DateTimeOffset.DayOfWeek

Gets the day of the week represented by the current System.DateTimeOffset object.

Returns

One of the enumeration values that indicates the day of the week of the current System.DateTimeOffset object.

System.DateTimeOffset.DayOfYear

Gets the day of the year represented by the current System.DateTimeOffset object.

Returns

The day of the year of the current System.DateTimeOffset object, expressed as a value between 1 and 366.

System.DateTimeOffset.Hour

Gets the hour component of the time represented by the current System.DateTimeOffset object.

Returns

The hour component of the current System.DateTimeOffset object. This property uses a 24-hour clock; the value ranges from 0 to 23.

System.DateTimeOffset.LocalDateTime

Gets a System.DateTime value that represents the local date and time of the current System.DateTimeOffset object.

Returns

The local date and time of the current System.DateTimeOffset object.

System.DateTimeOffset.Microsecond

Gets the microsecond component of the time represented by the current System.DateTimeOffset object.

System.DateTimeOffset.Millisecond

Gets the millisecond component of the time represented by the current System.DateTimeOffset object.

Returns

The millisecond component of the current System.DateTimeOffset object, expressed as an integer between 0 and 999.

System.DateTimeOffset.Minute

Gets the minute component of the time represented by the current System.DateTimeOffset object.

Returns

The minute component of the current System.DateTimeOffset object, expressed as an integer between 0 and 59.

System.DateTimeOffset.Month

Gets the month component of the date represented by the current System.DateTimeOffset object.

Returns

The month component of the current System.DateTimeOffset object, expressed as an integer between 1 and 12.

System.DateTimeOffset.Nanosecond

Gets the nanosecond component of the time represented by the current System.DateTimeOffset object.

System.DateTimeOffset.Now

Gets a System.DateTimeOffset object that is set to the current date and time on the current computer, with the offset set to the local time's offset from Coordinated Universal Time (UTC).

Returns

A System.DateTimeOffset object whose date and time is the current local time and whose offset is the local time zone's offset from Coordinated Universal Time (UTC).

System.DateTimeOffset.Offset

Gets the time's offset from Coordinated Universal Time (UTC).

Returns

The difference between the current System.DateTimeOffset object's time value and Coordinated Universal Time (UTC).

System.DateTimeOffset.Second

Gets the second component of the clock time represented by the current System.DateTimeOffset object.

Returns

The second component of the System.DateTimeOffset object, expressed as an integer value between 0 and 59.

System.DateTimeOffset.Ticks

Gets the number of ticks that represents the date and time of the current System.DateTimeOffset object in clock time.

Returns

The number of ticks in the System.DateTimeOffset object's clock time.

System.DateTimeOffset.TimeOfDay

Gets the time of day for the current System.DateTimeOffset object.

Returns

The time interval of the current date that has elapsed since midnight.

System.DateTimeOffset.TotalOffsetMinutes

Gets the time's offset from Coordinated Universal Time (UTC) in minutes.

System.DateTimeOffset.UtcDateTime

Gets a System.DateTime value that represents the Coordinated Universal Time (UTC) date and time of the current System.DateTimeOffset object.

Returns

The Coordinated Universal Time (UTC) date and time of the current System.DateTimeOffset object.

System.DateTimeOffset.UtcNow

Gets a System.DateTimeOffset object whose date and time are set to the current Coordinated Universal Time (UTC) date and time and whose offset is System.TimeSpan.Zero.

Returns

An object whose date and time is the current Coordinated Universal Time (UTC) and whose offset is System.TimeSpan.Zero.

System.DateTimeOffset.UtcTicks

Gets the number of ticks that represents the date and time of the current System.DateTimeOffset object in Coordinated Universal Time (UTC).

Returns

The number of ticks in the System.DateTimeOffset object's Coordinated Universal Time (UTC).

System.DateTimeOffset.Year

Gets the year component of the date represented by the current System.DateTimeOffset object.

Returns

The year component of the current System.DateTimeOffset object, expressed as an integer value between 0 and 9999.

System.DayOfWeek

Specifies the day of the week.

System.DayOfWeek.Friday

Indicates Friday.

System.DayOfWeek.Monday

Indicates Monday.

System.DayOfWeek.Saturday

Indicates Saturday.

System.DayOfWeek.Sunday

Indicates Sunday.

System.DayOfWeek.Thursday

Indicates Thursday.

System.DayOfWeek.Tuesday

Indicates Tuesday.

System.DayOfWeek.Wednesday

Indicates Wednesday.

System.DBNull

Represents a nonexistent value. This class cannot be inherited.

System.DBNull.Value

Represents the sole instance of the System.DBNull class.

System.DBNull.GetObjectData()

Implements the System.Runtime.Serialization.ISerializable interface and returns the data needed to serialize the System.DBNull object.

Parameters

NameDescriptionDefault
info A System.Runtime.Serialization.SerializationInfo object containing information required to serialize the System.DBNull object.
context A System.Runtime.Serialization.StreamingContext object containing the source and destination of the serialized stream associated with the System.DBNull object.

System.DBNull.GetTypeCode

Gets the System.TypeCode value for System.DBNull.

Returns

System.DBNull.System#IConvertible#ToBoolean()

This conversion is not supported. Attempting to make this conversion throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

None. The return value for this member is not used.

System.DBNull.System#IConvertible#ToByte()

This conversion is not supported. Attempting to make this conversion throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

None. The return value for this member is not used.

System.DBNull.System#IConvertible#ToChar()

This conversion is not supported. Attempting to make this conversion throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

None. The return value for this member is not used.

System.DBNull.System#IConvertible#ToDateTime()

This conversion is not supported. Attempting to make this conversion throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

None. The return value for this member is not used.

System.DBNull.System#IConvertible#ToDecimal()

This conversion is not supported. Attempting to make this conversion throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

None. The return value for this member is not used.

System.DBNull.System#IConvertible#ToDouble()

This conversion is not supported. Attempting to make this conversion throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

None. The return value for this member is not used.

System.DBNull.System#IConvertible#ToInt16()

This conversion is not supported. Attempting to make this conversion throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

None. The return value for this member is not used.

System.DBNull.System#IConvertible#ToInt32()

This conversion is not supported. Attempting to make this conversion throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

None. The return value for this member is not used.

System.DBNull.System#IConvertible#ToInt64()

This conversion is not supported. Attempting to make this conversion throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

None. The return value for this member is not used.

System.DBNull.System#IConvertible#ToSByte()

This conversion is not supported. Attempting to make this conversion throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

None. The return value for this member is not used.

System.DBNull.System#IConvertible#ToSingle()

This conversion is not supported. Attempting to make this conversion throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

None. The return value for this member is not used.

System.DBNull.System#IConvertible#ToType()

Converts the current System.DBNull object to the specified type.

Parameters

NameDescriptionDefault
type The type to convert the current System.DBNull object to.
provider An object that implements the System.IFormatProvider interface and is used to augment the conversion. If null is specified, format information is obtained from the current culture.

Returns

The boxed equivalent of the current System.DBNull object, if that conversion is supported; otherwise, an exception is thrown and no value is returned.

System.DBNull.System#IConvertible#ToUInt16()

This conversion is not supported. Attempting to make this conversion throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

None. The return value for this member is not used.

System.DBNull.System#IConvertible#ToUInt32()

This conversion is not supported. Attempting to make this conversion throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

None. The return value for this member is not used.

System.DBNull.System#IConvertible#ToUInt64()

This conversion is not supported. Attempting to make this conversion throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider An object that implements the System.IFormatProvider interface. (This parameter is not used; specify null.)

Returns

None. The return value for this member is not used.

System.DBNull.ToString

Returns an empty string (System.String.Empty).

Returns

An empty string (System.String.Empty).

System.DBNull.ToString()

Returns an empty string using the specified System.IFormatProvider.

Parameters

NameDescriptionDefault
provider The System.IFormatProvider to be used to format the return value. -or- null to obtain the format information from the current locale setting of the operating system.

Returns

An empty string (System.String.Empty).

System.Decimal

Represents a decimal floating-point number.

System.Decimal.MaxValue

Represents the largest possible value of System.Decimal. This field is constant and read-only.

System.Decimal.MinusOne

Represents the number negative one (-1).

System.Decimal.MinValue

Represents the smallest possible value of System.Decimal. This field is constant and read-only.

System.Decimal.One

Represents the number one (1).

System.Decimal.Zero

Represents the number zero (0).

System.Decimal.#ctor()

Initializes a new instance of System.Decimal to the value of the specified double-precision floating-point number.

Parameters

NameDescriptionDefault
value The value to represent as a System.Decimal.

System.Decimal.#ctor()

Initializes a new instance of System.Decimal to the value of the specified 32-bit signed integer.

Parameters

NameDescriptionDefault
value The value to represent as a System.Decimal.

System.Decimal.#ctor()

Initializes a new instance of System.Decimal from parameters specifying the instance's constituent parts.

Parameters

NameDescriptionDefault
lo The low 32 bits of a 96-bit integer.
mid The middle 32 bits of a 96-bit integer.
hi The high 32 bits of a 96-bit integer.
isNegative true to indicate a negative number; false to indicate a positive number.
scale A power of 10 ranging from 0 to 28.

System.Decimal.#ctor()

Initializes a new instance of System.Decimal to a decimal value represented in binary and contained in a specified array.

Parameters

NameDescriptionDefault
bits An array of 32-bit signed integers containing a representation of a decimal value.

System.Decimal.#ctor()

Initializes a new instance of System.Decimal to the value of the specified 64-bit signed integer.

Parameters

NameDescriptionDefault
value The value to represent as a System.Decimal.

System.Decimal.#ctor()

Initializes a new instance of System.Decimal to a decimal value represented in binary and contained in the specified span.

Parameters

NameDescriptionDefault
bits A span of four System.Int32 values that contains a binary representation of a decimal value.

System.Decimal.#ctor()

Initializes a new instance of System.Decimal to the value of the specified single-precision floating-point number.

Parameters

NameDescriptionDefault
value The value to represent as a System.Decimal.

System.Decimal.#ctor()

Initializes a new instance of System.Decimal to the value of the specified 32-bit unsigned integer.

Parameters

NameDescriptionDefault
value The value to represent as a System.Decimal.

System.Decimal.#ctor()

Initializes a new instance of System.Decimal to the value of the specified 64-bit unsigned integer.

Parameters

NameDescriptionDefault
value The value to represent as a System.Decimal.

System.Decimal.Abs()

Computes the absolute of a value.

Parameters

NameDescriptionDefault
value The value for which to get its absolute.

Returns

The absolute of
value
.

System.Decimal.Add()

Adds two specified System.Decimal values.

Parameters

NameDescriptionDefault
d1 The first value to add.
d2 The second value to add.

Returns

The sum of d1 and d2.

System.Decimal.Ceiling()

Returns the smallest integral value that is greater than or equal to the specified decimal number.

Parameters

NameDescriptionDefault
d A decimal number.

Returns

The smallest integral value that is greater than or equal to the d parameter. Note that this method returns a System.Decimal instead of an integral type.

System.Decimal.Clamp()

Clamps a value to an inclusive minimum and maximum value.

Parameters

NameDescriptionDefault
value The value to clamp.
min The inclusive minimum to which
value
should clamp.
max The inclusive maximum to which
value
should clamp.

Returns

The result of clamping
value
to the inclusive range of
min
and
max
.

System.Decimal.Compare()

Compares two specified System.Decimal values.

Parameters

NameDescriptionDefault
d1 The first value to compare.
d2 The second value to compare.

Returns

A signed number indicating the relative values of d1 and d2. Return value Meaning Less than zerod1 is less than d2. Zerod1 and d2 are equal. Greater than zerod1 is greater than d2.

System.Decimal.CompareTo()

Compares this instance to a specified System.Decimal object and returns a comparison of their relative values.

Parameters

NameDescriptionDefault
value The object to compare with this instance.

Returns

A signed number indicating the relative values of this instance and value. Return value Meaning Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value.

System.Decimal.CompareTo()

Compares this instance to a specified object and returns a comparison of their relative values.

Parameters

NameDescriptionDefault
value The object to compare with this instance, or null.

Returns

A signed number indicating the relative values of this instance and value. Return value Meaning Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value, or value is null.

System.Decimal.CopySign()

Copies the sign of a value to the sign of another value.

Parameters

NameDescriptionDefault
value The value whose magnitude is used in the result.
sign The value whose sign is used in the result.

Returns

A value with the magnitude of
value
and the sign of
sign
.

System.Decimal.CreateChecked``1()

Creates an instance of the current type from a value, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
.

System.Decimal.CreateSaturating``1()

Creates an instance of the current type from a value, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, saturating if
value
falls outside the representable range of
TSelf
.

System.Decimal.CreateTruncating``1()

Creates an instance of the current type from a value, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, truncating if
value
falls outside the representable range of
TSelf
.

System.Decimal.Divide()

Divides two specified System.Decimal values.

Parameters

NameDescriptionDefault
d1 The dividend.
d2 The divisor.

Returns

The result of dividing d1 by d2.

System.Decimal.Equals()

Returns a value indicating whether this instance and a specified System.Decimal object represent the same value.

Parameters

NameDescriptionDefault
value An object to compare to this instance.

Returns

true if value is equal to this instance; otherwise, false.

System.Decimal.Equals()

Returns a value indicating whether two specified instances of System.Decimal represent the same value.

Parameters

NameDescriptionDefault
d1 The first value to compare.
d2 The second value to compare.

Returns

true if d1 and d2 are equal; otherwise, false.

System.Decimal.Equals()

Returns a value indicating whether this instance and a specified System.Object represent the same type and value.

Parameters

NameDescriptionDefault
value The object to compare with this instance.

Returns

true if value is a System.Decimal and equal to this instance; otherwise, false.

System.Decimal.Floor()

Rounds a specified System.Decimal number to the closest integer toward negative infinity.

Parameters

NameDescriptionDefault
d The value to round.

Returns

If d has a fractional part, the next whole System.Decimal number toward negative infinity that is less than d. -or- If d doesn't have a fractional part, d is returned unchanged. Note that the method returns an integral value of type System.Decimal.

System.Decimal.FromOACurrency()

Converts the specified 64-bit signed integer, which contains an OLE Automation Currency value, to the equivalent System.Decimal value.

Parameters

NameDescriptionDefault
cy An OLE Automation Currency value.

Returns

A System.Decimal that contains the equivalent of cy.

System.Decimal.GetBits()

Converts the value of a specified instance of System.Decimal to its equivalent binary representation.

Parameters

NameDescriptionDefault
d The value to convert.

Returns

A 32-bit signed integer array with four elements that contain the binary representation of d.

System.Decimal.GetBits()

Converts the value of a specified instance of System.Decimal to its equivalent binary representation.

Parameters

NameDescriptionDefault
d The value to convert.
destination The span into which to store the four-integer binary representation.

Returns

4, which is the number of integers in the binary representation.

System.Decimal.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Decimal.GetTypeCode

Returns the System.TypeCode for value type System.Decimal.

Returns

The enumerated constant System.TypeCode.Decimal.

System.Decimal.IsCanonical()

Determines if a value is in its canonical representation.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is in its canonical representation; otherwise,
false
.

System.Decimal.IsEvenInteger()

Determines if a value represents an even integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an even integer; otherwise,
false
.

System.Decimal.IsInteger()

Determines if a value represents an integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an integer; otherwise,
false
.

System.Decimal.IsNegative()

Determines if a value is negative.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is negative; otherwise,
false
.

System.Decimal.IsOddInteger()

Determines if a value represents an odd integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an odd integer; otherwise,
false
.

System.Decimal.IsPositive()

Determines if a value is positive.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is positive; otherwise,
false
.

System.Decimal.Max()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Decimal.MaxMagnitude()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Decimal.Min()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Decimal.MinMagnitude()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Decimal.Multiply()

Multiplies two specified System.Decimal values.

Parameters

NameDescriptionDefault
d1 The multiplicand.
d2 The multiplier.

Returns

The result of multiplying d1 and d2.

System.Decimal.Negate()

Returns the result of multiplying the specified System.Decimal value by negative one.

Parameters

NameDescriptionDefault
d The value to negate.

Returns

A decimal number with the value of d, but the opposite sign. -or- Zero, if d is zero.

System.Decimal.op_Addition()

Adds two specified System.Decimal values.

Parameters

NameDescriptionDefault
d1 The first value to add.
d2 The second value to add.

Returns

The result of adding d1 and d2.

System.Decimal.op_Decrement()

Decrements the operand by one.

Parameters

NameDescriptionDefault
d The value to decrement.

Returns

The value of
d
decremented by 1.

System.Decimal.op_Division()

Divides two specified values.

Parameters

NameDescriptionDefault
d1 The dividend.
d2 The divisor.

Returns

The result of dividing
d1
by
d2
.

System.Decimal.op_Equality()

Returns a value that indicates whether two values are equal.

Parameters

NameDescriptionDefault
d1 The first value to compare.
d2 The second value to compare.

Returns

true
if
d1
and
d2
are equal; otherwise,
false
.

System.Decimal.op_Explicit()

Defines an explicit conversion of a System.Decimal to an 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

An 8-bit unsigned integer that represents the converted System.Decimal.

System.Decimal.op_Explicit()

Defines an explicit conversion of a System.Decimal to a Unicode character.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

A Unicode character that represents the converted System.Decimal.

System.Decimal.op_Explicit()

Defines an explicit conversion of a System.Decimal to a double-precision floating-point number.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

A double-precision floating-point number that represents the converted System.Decimal.

System.Decimal.op_Explicit()

Defines an explicit conversion of a System.Decimal to a 16-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

A 16-bit signed integer that represents the converted System.Decimal.

System.Decimal.op_Explicit()

Defines an explicit conversion of a System.Decimal to a 32-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

A 32-bit signed integer that represents the converted System.Decimal.

System.Decimal.op_Explicit()

Defines an explicit conversion of a System.Decimal to a 64-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

A 64-bit signed integer that represents the converted System.Decimal.

System.Decimal.op_Explicit()

Defines an explicit conversion of a System.Decimal to an 8-bit signed integer. This API is not CLS-compliant.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

An 8-bit signed integer that represents the converted System.Decimal.

System.Decimal.op_Explicit()

Defines an explicit conversion of a System.Decimal to a single-precision floating-point number.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

A single-precision floating-point number that represents the converted System.Decimal.

System.Decimal.op_Explicit()

Defines an explicit conversion of a System.Decimal to a 16-bit unsigned integer. This API is not CLS-compliant.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

A 16-bit unsigned integer that represents the converted System.Decimal.

System.Decimal.op_Explicit()

Defines an explicit conversion of a System.Decimal to a 32-bit unsigned integer. This API is not CLS-compliant.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

A 32-bit unsigned integer that represents the converted System.Decimal.

System.Decimal.op_Explicit()

Defines an explicit conversion of a System.Decimal to a 64-bit unsigned integer. This API is not CLS-compliant.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

A 64-bit unsigned integer that represents the converted System.Decimal.

System.Decimal.op_Explicit()

Defines an explicit conversion of a double-precision floating-point number to a System.Decimal.

Parameters

NameDescriptionDefault
value The double-precision floating-point number to convert.

Returns

The converted double-precision floating point number.

System.Decimal.op_Explicit()

Defines an explicit conversion of a single-precision floating-point number to a System.Decimal.

Parameters

NameDescriptionDefault
value The single-precision floating-point number to convert.

Returns

The converted single-precision floating point number.

System.Decimal.op_GreaterThan()

Returns a value indicating whether a specified is greater than another specified .

Parameters

NameDescriptionDefault
d1 The first value to compare.
d2 The second value to compare.

Returns

true
if
d1
is greater than
d2
; otherwise,
false
.

System.Decimal.op_GreaterThanOrEqual()

Returns a value indicating whether a specified is greater than or equal to another specified .

Parameters

NameDescriptionDefault
d1 The first value to compare.
d2 The second value to compare.

Returns

true
if
d1
is greater than or equal to
d2
; otherwise,
false
.

System.Decimal.op_Implicit()

Defines an implicit conversion of an 8-bit unsigned integer to a System.Decimal.

Parameters

NameDescriptionDefault
value The 8-bit unsigned integer to convert.

Returns

The converted 8-bit unsigned integer.

System.Decimal.op_Implicit()

Defines an implicit conversion of a Unicode character to a System.Decimal.

Parameters

NameDescriptionDefault
value The Unicode character to convert.

Returns

The converted Unicode character.

System.Decimal.op_Implicit()

Defines an implicit conversion of a 16-bit signed integer to a System.Decimal.

Parameters

NameDescriptionDefault
value The 16-bit signed integer to convert.

Returns

The converted 16-bit signed integer.

System.Decimal.op_Implicit()

Defines an implicit conversion of a 32-bit signed integer to a System.Decimal.

Parameters

NameDescriptionDefault
value The 32-bit signed integer to convert.

Returns

The converted 32-bit signed integer.

System.Decimal.op_Implicit()

Defines an implicit conversion of a 64-bit signed integer to a System.Decimal.

Parameters

NameDescriptionDefault
value The 64-bit signed integer to convert.

Returns

The converted 64-bit signed integer.

System.Decimal.op_Implicit()

Defines an implicit conversion of an 8-bit signed integer to a System.Decimal. This API is not CLS-compliant.

Parameters

NameDescriptionDefault
value The 8-bit signed integer to convert.

Returns

The converted 8-bit signed integer.

System.Decimal.op_Implicit()

Defines an implicit conversion of a 16-bit unsigned integer to a System.Decimal. This API is not CLS-compliant.

Parameters

NameDescriptionDefault
value The 16-bit unsigned integer to convert.

Returns

The converted 16-bit unsigned integer.

System.Decimal.op_Implicit()

Defines an implicit conversion of a 32-bit unsigned integer to a System.Decimal. This API is not CLS-compliant.

Parameters

NameDescriptionDefault
value The 32-bit unsigned integer to convert.

Returns

The converted 32-bit unsigned integer.

System.Decimal.op_Implicit()

Defines an implicit conversion of a 64-bit unsigned integer to a System.Decimal. This API is not CLS-compliant.

Parameters

NameDescriptionDefault
value The 64-bit unsigned integer to convert.

Returns

The converted 64-bit unsigned integer.

System.Decimal.op_Increment()

Increments the operand by 1.

Parameters

NameDescriptionDefault
d The value to increment.

Returns

The value of
d
incremented by 1.

System.Decimal.op_Inequality()

Returns a value that indicates whether two objects have different values.

Parameters

NameDescriptionDefault
d1 The first value to compare.
d2 The second value to compare.

Returns

true
if
d1
and
d2
are not equal; otherwise,
false
.

System.Decimal.op_LessThan()

Returns a value indicating whether a specified is less than another specified .

Parameters

NameDescriptionDefault
d1 The first value to compare.
d2 The second value to compare.

Returns

true
if
d1
is less than
d2
; otherwise,
false
.

System.Decimal.op_LessThanOrEqual()

Returns a value indicating whether a specified is less than or equal to another specified .

Parameters

NameDescriptionDefault
d1 The first value to compare.
d2 The second value to compare.

Returns

true
if
d1
is less than or equal to
d2
; otherwise,
false
.

System.Decimal.op_Modulus()

Returns the remainder resulting from dividing two specified values.

Parameters

NameDescriptionDefault
d1 The dividend.
d2 The divisor.

Returns

The remainder resulting from dividing
d1
by
d2
.

System.Decimal.op_Multiply()

Multiplies two specified values.

Parameters

NameDescriptionDefault
d1 The first value to multiply.
d2 The second value to multiply.

Returns

The result of multiplying
d1
by
d2
.

System.Decimal.op_Subtraction()

Subtracts two specified System.Decimal values.

Parameters

NameDescriptionDefault
d1 The minuend.
d2 The subtrahend.

Returns

The result of subtracting d2 from d1.

System.Decimal.op_UnaryNegation()

Negates the value of the specified System.Decimal operand.

Parameters

NameDescriptionDefault
d The value to negate.

Returns

The result of d multiplied by negative one (-1).

System.Decimal.op_UnaryPlus()

Returns the value of the System.Decimal operand (the sign of the operand is unchanged).

Parameters

NameDescriptionDefault
d The operand to return.

Returns

The value of the operand, d.

System.Decimal.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.Decimal.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.Decimal.Parse()

Converts the span representation of a number to its System.Decimal equivalent using the specified style and culture-specific format.

Parameters

NameDescriptionDefault
s The span containing the characters representing the number to convert.
style A bitwise combination of System.Globalization.NumberStyles values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Number.
provider An System.IFormatProvider object that supplies culture-specific information about the format of s.

Returns

The System.Decimal number equivalent to the number contained in s as specified by style and provider.

System.Decimal.Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.

Returns

The result of parsing
s
.

System.Decimal.Parse()

Converts the string representation of a number to its System.Decimal equivalent.

Parameters

NameDescriptionDefault
s The string representation of the number to convert.

Returns

The equivalent to the number contained in s.

System.Decimal.Parse()

Converts the string representation of a number in a specified style to its System.Decimal equivalent.

Parameters

NameDescriptionDefault
s The string representation of the number to convert.
style A bitwise combination of System.Globalization.NumberStyles values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Number.

Returns

The System.Decimal number equivalent to the number contained in s as specified by style.

System.Decimal.Parse()

Converts the string representation of a number to its System.Decimal equivalent using the specified style and culture-specific format.

Parameters

NameDescriptionDefault
s The string representation of the number to convert.
style A bitwise combination of System.Globalization.NumberStyles values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Number.
provider An System.IFormatProvider object that supplies culture-specific information about the format of s.

Returns

The System.Decimal number equivalent to the number contained in s as specified by style and provider.

System.Decimal.Parse()

Converts the string representation of a number to its System.Decimal equivalent using the specified culture-specific format information.

Parameters

NameDescriptionDefault
s The string representation of the number to convert.
provider An System.IFormatProvider that supplies culture-specific parsing information about s.

Returns

The System.Decimal number equivalent to the number contained in s as specified by provider.

System.Decimal.Remainder()

Computes the remainder after dividing two System.Decimal values.

Parameters

NameDescriptionDefault
d1 The dividend.
d2 The divisor.

Returns

The remainder after dividing d1 by d2.

System.Decimal.Round()

Rounds a decimal value to the nearest integer.

Parameters

NameDescriptionDefault
d A decimal number to round.

Returns

The integer that is nearest to the d parameter. If d is halfway between two integers, one of which is even and the other odd, the even number is returned.

System.Decimal.Round()

Rounds a System.Decimal value to a specified number of decimal places.

Parameters

NameDescriptionDefault
d A decimal number to round.
decimals A value from 0 to 28 that specifies the number of decimal places to round to.

Returns

The decimal number equivalent to d rounded to decimals decimal places.

System.Decimal.Round()

Rounds a decimal value to the specified precision using the specified rounding strategy.

Parameters

NameDescriptionDefault
d A decimal number to round.
decimals The number of significant decimal places (precision) in the return value.
mode One of the enumeration values that specifies which rounding strategy to use.

Returns

The number that d is rounded to using the mode rounding strategy and with a precision of decimals. If the precision of d is less than decimals, d is returned unchanged.

System.Decimal.Round()

Rounds a decimal value to an integer using the specified rounding strategy.

Parameters

NameDescriptionDefault
d A decimal number to round.
mode One of the enumeration values that specifies which rounding strategy to use.

Returns

The integer that d is rounded to using the mode rounding strategy.

System.Decimal.Sign()

Computes the sign of a value.

Parameters

NameDescriptionDefault
d The value whose sign is to be computed.

Returns

A positive value if
d
is positive, if
d
is zero, and a negative value if
d
is negative.

System.Decimal.Subtract()

Subtracts one specified System.Decimal value from another.

Parameters

NameDescriptionDefault
d1 The minuend.
d2 The subtrahend.

Returns

The result of subtracting d2 from d1.

System.Decimal.System#IConvertible#ToBoolean()

For a description of this member, see System.IConvertible.ToBoolean().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

true if the value of the current instance is not zero; otherwise, false.

System.Decimal.System#IConvertible#ToByte()

For a description of this member, see System.IConvertible.ToByte().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Byte.

System.Decimal.System#IConvertible#ToChar()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

None. This conversion is not supported.

System.Decimal.System#IConvertible#ToDateTime()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

None. This conversion is not supported.

System.Decimal.System#IConvertible#ToDecimal()

For a description of this member, see System.IConvertible.ToDecimal().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, unchanged.

System.Decimal.System#IConvertible#ToDouble()

For a description of this member, see System.IConvertible.ToDouble().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Double.

System.Decimal.System#IConvertible#ToInt16()

For a description of this member, see System.IConvertible.ToInt16().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Int16.

System.Decimal.System#IConvertible#ToInt32()

For a description of this member, see System.IConvertible.ToInt32().

Parameters

NameDescriptionDefault
provider The parameter is ignored.

Returns

The value of the current instance, converted to a System.Int32.

System.Decimal.System#IConvertible#ToInt64()

For a description of this member, see System.IConvertible.ToInt64().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Int64.

System.Decimal.System#IConvertible#ToSByte()

For a description of this member, see System.IConvertible.ToSByte().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.SByte.

System.Decimal.System#IConvertible#ToSingle()

For a description of this member, see System.IConvertible.ToSingle().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Single.

System.Decimal.System#IConvertible#ToType()

For a description of this member, see System.IConvertible.ToType().

Parameters

NameDescriptionDefault
type The type to which to convert the value of this System.Decimal instance.
provider An System.IFormatProvider implementation that supplies culture-specific information about the format of the returned value.

Returns

The value of the current instance, converted to a type.

System.Decimal.System#IConvertible#ToUInt16()

For a description of this member, see System.IConvertible.ToUInt16().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt16.

System.Decimal.System#IConvertible#ToUInt32()

For a description of this member, see System.IConvertible.ToInt32().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt32.

System.Decimal.System#IConvertible#ToUInt64()

For a description of this member, see System.IConvertible.ToInt64().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt64.

System.Decimal.System#Numerics#IFloatingPoint<System#Decimal>#GetExponentByteCount

Gets the number of bytes that will be written as part of .

Returns

The number of bytes that will be written as part of .

System.Decimal.System#Numerics#IFloatingPoint<System#Decimal>#GetExponentShortestBitLength

Gets the length, in bits, of the shortest two's complement representation of the current exponent.

Returns

The length, in bits, of the shortest two's complement representation of the current exponent.

System.Decimal.System#Numerics#IFloatingPoint<System#Decimal>#GetSignificandBitLength

Gets the length, in bits, of the current significand.

Returns

The length, in bits, of the current significand.

System.Decimal.System#Numerics#IFloatingPoint<System#Decimal>#GetSignificandByteCount

Gets the number of bytes that will be written as part of .

Returns

The number of bytes that will be written as part of .

System.Decimal.System#Numerics#IFloatingPoint<System#Decimal>#TryWriteExponentBigEndian()

Tries to write the current exponent, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current exponent should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the exponent was succesfully written to
destination
; otherwise,
false
.

System.Decimal.System#Numerics#IFloatingPoint<System#Decimal>#TryWriteExponentLittleEndian()

Tries to write the current exponent, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current exponent should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the exponent was succesfully written to
destination
; otherwise,
false
.

System.Decimal.System#Numerics#IFloatingPoint<System#Decimal>#TryWriteSignificandBigEndian()

Tries to write the current significand, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current significand should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the significand was succesfully written to
destination
; otherwise,
false
.

System.Decimal.System#Numerics#IFloatingPoint<System#Decimal>#TryWriteSignificandLittleEndian()

Tries to write the current significand, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current significand should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the significand was succesfully written to
destination
; otherwise,
false
.

System.Decimal.System#Numerics#INumber{System#Decimal}#MaxNumber()

Compares two values to compute which is greater and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Decimal.System#Numerics#INumber{System#Decimal}#MinNumber()

Compares two values to compute which is lesser and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#IsComplexNumber()

Determines if a value represents a complex number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a complex number; otherwise, false.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#IsFinite()

Determines if a value is finite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is finite; otherwise, false.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#IsImaginaryNumber()

Determines if a value represents a pure imaginary number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a pure imaginary number; otherwise, false.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#IsInfinity()

Determines if a value is infinite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is infinite; otherwise, false.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#IsNaN()

Determines if a value is NaN.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is NaN; otherwise, false.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#IsNegativeInfinity()

Determines if a value is negative infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is negative infinity; otherwise, false.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#IsNormal()

Determines if a value is normal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is normal; otherwise, false.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#IsPositiveInfinity()

Determines if a value is positive infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is positive infinity; otherwise, false.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#IsRealNumber()

Determines if a value represents a real number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a real number; otherwise, false.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#IsSubnormal()

Determines if a value is subnormal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is subnormal; otherwise, false.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#IsZero()

Determines if a value is zero.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is zero; otherwise, false.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#MaxMagnitudeNumber()

Compares two values to compute which has the greater magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#MinMagnitudeNumber()

Compares two values to compute which has the lesser magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#TryConvertFromChecked``1()

Parameters

NameDescriptionDefault
value
result

System.Decimal.System#Numerics#INumberBase{System#Decimal}#TryConvertFromSaturating``1()

Parameters

NameDescriptionDefault
value
result

System.Decimal.System#Numerics#INumberBase{System#Decimal}#TryConvertFromTruncating``1()

Parameters

NameDescriptionDefault
value
result

System.Decimal.System#Numerics#INumberBase{System#Decimal}#TryConvertToChecked``1()

Tries to convert an instance of the the current type to another type, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#TryConvertToSaturating``1()

Tries to convert an instance of the the current type to another type, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#TryConvertToTruncating``1()

Tries to convert an instance of the the current type to another type, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Decimal.System#Runtime#Serialization#IDeserializationCallback#OnDeserialization()

Runs when the deserialization of an object has been completed.

Parameters

NameDescriptionDefault
sender The object that initiated the callback. The functionality for this parameter is not currently implemented.

System.Decimal.System#Runtime#Serialization#ISerializable#GetObjectData()

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo to populate with data.
context The destination (see System.Runtime.Serialization.StreamingContext) for this serialization.

System.Decimal.ToByte()

Converts the value of the specified System.Decimal to the equivalent 8-bit unsigned integer.

Parameters

NameDescriptionDefault
value The decimal number to convert.

Returns

An 8-bit unsigned integer equivalent to value.

System.Decimal.ToDouble()

Converts the value of the specified System.Decimal to the equivalent double-precision floating-point number.

Parameters

NameDescriptionDefault
d The decimal number to convert.

Returns

A double-precision floating-point number equivalent to d.

System.Decimal.ToInt16()

Converts the value of the specified System.Decimal to the equivalent 16-bit signed integer.

Parameters

NameDescriptionDefault
value The decimal number to convert.

Returns

A 16-bit signed integer equivalent to value.

System.Decimal.ToInt32()

Converts the value of the specified System.Decimal to the equivalent 32-bit signed integer.

Parameters

NameDescriptionDefault
d The decimal number to convert.

Returns

A 32-bit signed integer equivalent to the value of d.

System.Decimal.ToInt64()

Converts the value of the specified System.Decimal to the equivalent 64-bit signed integer.

Parameters

NameDescriptionDefault
d The decimal number to convert.

Returns

A 64-bit signed integer equivalent to the value of d.

System.Decimal.ToOACurrency()

Converts the specified System.Decimal value to the equivalent OLE Automation Currency value, which is contained in a 64-bit signed integer.

Parameters

NameDescriptionDefault
value The decimal number to convert.

Returns

A 64-bit signed integer that contains the OLE Automation equivalent of value.

System.Decimal.ToSByte()

Converts the value of the specified System.Decimal to the equivalent 8-bit signed integer.

Parameters

NameDescriptionDefault
value The decimal number to convert.

Returns

An 8-bit signed integer equivalent to value.

System.Decimal.ToSingle()

Converts the value of the specified System.Decimal to the equivalent single-precision floating-point number.

Parameters

NameDescriptionDefault
d The decimal number to convert.

Returns

A single-precision floating-point number equivalent to the value of d.

System.Decimal.ToString

Converts the numeric value of this instance to its equivalent string representation.

Returns

A string that represents the value of this instance.

System.Decimal.ToString()

Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

The string representation of the value of this instance as specified by provider.

System.Decimal.ToString()

Converts the numeric value of this instance to its equivalent string representation, using the specified format.

Parameters

NameDescriptionDefault
format A standard or custom numeric format string.

Returns

The string representation of the value of this instance as specified by format.

System.Decimal.ToString()

Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information.

Parameters

NameDescriptionDefault
format A numeric format string.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of the value of this instance as specified by format and provider.

System.Decimal.ToUInt16()

Converts the value of the specified System.Decimal to the equivalent 16-bit unsigned integer.

Parameters

NameDescriptionDefault
value The decimal number to convert.

Returns

A 16-bit unsigned integer equivalent to the value of value.

System.Decimal.ToUInt32()

Converts the value of the specified System.Decimal to the equivalent 32-bit unsigned integer.

Parameters

NameDescriptionDefault
d The decimal number to convert.

Returns

A 32-bit unsigned integer equivalent to the value of d.

System.Decimal.ToUInt64()

Converts the value of the specified System.Decimal to the equivalent 64-bit unsigned integer.

Parameters

NameDescriptionDefault
d The decimal number to convert.

Returns

A 64-bit unsigned integer equivalent to the value of d.

System.Decimal.Truncate()

Returns the integral digits of the specified System.Decimal; any fractional digits are discarded.

Parameters

NameDescriptionDefault
d The decimal number to truncate.

Returns

The result of d rounded toward zero, to the nearest whole number.

System.Decimal.TryFormat()

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

Parameters

NameDescriptionDefault
utf8Destination The span in which to write this instance's value formatted as a span of bytes.
bytesWritten When this method returns, contains the number of bytes that were written in
utf8Destination
.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for
utf8Destination
.
provider An optional object that supplies culture-specific formatting information for
utf8Destination
.

Returns

true
if the formatting was successful; otherwise,
false
.

System.Decimal.TryFormat()

Tries to format the value of the current decimal instance into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span in which to write this instance's value formatted as a span of characters.
charsWritten When this method returns, contains the number of characters that were written in destination.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for destination.
provider An optional object that supplies culture-specific formatting information for destination.

Returns

true if the formatting was successful; otherwise, false.

System.Decimal.TryGetBits()

Tries to convert the value of a specified instance of System.Decimal to its equivalent binary representation.

Parameters

NameDescriptionDefault
d The value to convert.
destination The span into which to store the binary representation.
valuesWritten When this method returns, contains the number of integers written to the destination.

Returns

true if the decimal's binary representation was written to the destination; false if the destination wasn't long enough.

System.Decimal.TryParse()

Tries to convert a UTF-8 character span containing the string representation of a number to its signed decimal equivalent.

Parameters

NameDescriptionDefault
utf8Text A span containing the UTF-8 characters representing the number to convert.
result When this method returns, contains the signed decimal value equivalent to the number contained in utf8Text if the conversion succeeded, or zero if the conversion failed. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if utf8Text was converted successfully; otherwise, false.

System.Decimal.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.Decimal.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.Decimal.TryParse()

Converts the span representation of a number to its System.Decimal equivalent using the specified style and culture-specific format. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A span containing the characters representing the number to convert.
result When this method returns, contains the System.Decimal number that is equivalent to the numeric value contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or System.String.Empty, is not a number in a format compliant with style, or represents a number less than Decimal.MinValue or greater than Decimal.MaxValue. This parameter is passed uininitialized; any value originally supplied in result is overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Decimal.TryParse()

Converts the span representation of a number to its System.Decimal equivalent using the specified style and culture-specific format. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A span containing the characters representing the number to convert.
style A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.NumberStyles.Number.
provider An object that supplies culture-specific parsing information about s.
result When this method returns, contains the System.Decimal number that is equivalent to the numeric value contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or System.String.Empty, is not a number in a format compliant with style, or represents a number less than Decimal.MinValue or greater than Decimal.MaxValue. This parameter is passed uininitialized; any value originally supplied in result is overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Decimal.TryParse()

Tries to parse a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
, or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Decimal.TryParse()

Converts the string representation of a number to its System.Decimal equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s The string representation of the number to convert.
result When this method returns, contains the System.Decimal number that is equivalent to the numeric value contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or System.String.Empty, is not a number in a valid format, or represents a number less than Decimal.MinValue or greater than Decimal.MaxValue. This parameter is passed uininitialized; any value originally supplied in result is overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Decimal.TryParse()

Converts the string representation of a number to its System.Decimal equivalent using the specified style and culture-specific format. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s The string representation of the number to convert.
style A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.NumberStyles.Number.
provider An object that supplies culture-specific parsing information about s.
result When this method returns, contains the System.Decimal number that is equivalent to the numeric value contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or System.String.Empty, is not a number in a format compliant with style, or represents a number less than Decimal.MinValue or greater than Decimal.MaxValue. This parameter is passed uininitialized; any value originally supplied in result is overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Decimal.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Decimal.Scale

Gets the scaling factor of the decimal, which is a number from 0 to 28 that represents the number of decimal digits.

System.Decimal.System#Numerics#IAdditiveIdentity{System#Decimal@System#Decimal}#AdditiveIdentity

Gets the additive identity of the current type.

System.Decimal.System#Numerics#IFloatingPointConstants{System#Decimal}#E

Gets the mathematical constant e.

System.Decimal.System#Numerics#IFloatingPointConstants{System#Decimal}#Pi

Gets the mathematical constant pi.

System.Decimal.System#Numerics#IFloatingPointConstants{System#Decimal}#Tau

Gets the mathematical constant tau.

System.Decimal.System#Numerics#IMinMaxValue{System#Decimal}#MaxValue

Gets the maximum value of the current type.

System.Decimal.System#Numerics#IMinMaxValue{System#Decimal}#MinValue

Gets the minimum value of the current type.

System.Decimal.System#Numerics#IMultiplicativeIdentity{System#Decimal@System#Decimal}#MultiplicativeIdentity

Gets the multiplicative identity of the current type.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#One

Gets the value 1 for the type.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#Radix

Gets the radix, or base, for the type.

System.Decimal.System#Numerics#INumberBase{System#Decimal}#Zero

Gets the value 0 for the type.

System.Decimal.System#Numerics#ISignedNumber{System#Decimal}#NegativeOne

Gets the value -1 for the type.

System.Delegate

Represents a delegate, which is a data structure that refers to a static method or to a class instance and an instance method of that class.

System.Delegate.#ctor()

Initializes a delegate that invokes the specified instance method on the specified class instance.

Parameters

NameDescriptionDefault
target The class instance on which the delegate invokes method.
method The name of the instance method that the delegate represents.

System.Delegate.#ctor()

Initializes a delegate that invokes the specified static method from the specified class.

Parameters

NameDescriptionDefault
target The System.Type representing the class that defines method.
method The name of the static method that the delegate represents.

System.Delegate.Clone

Creates a shallow copy of the delegate.

Returns

A shallow copy of the delegate.

System.Delegate.Combine()

Concatenates the invocation lists of two delegates.

Parameters

NameDescriptionDefault
a The delegate whose invocation list comes first.
b The delegate whose invocation list comes last.

Returns

A new delegate with an invocation list that concatenates the invocation lists of a and b in that order. Returns a if b is null, returns b if a is a null reference, and returns a null reference if both a and b are null references.

System.Delegate.Combine()

Concatenates the invocation lists of an array of delegates.

Parameters

NameDescriptionDefault
delegates The array of delegates to combine.

Returns

A new delegate with an invocation list that concatenates the invocation lists of the delegates in the delegates array. Returns null if delegates is null, if delegates contains zero elements, or if every entry in delegates is null.

System.Delegate.CombineImpl()

Concatenates the invocation lists of the specified multicast (combinable) delegate and the current multicast (combinable) delegate.

Parameters

NameDescriptionDefault
d The multicast (combinable) delegate whose invocation list to append to the end of the invocation list of the current multicast (combinable) delegate.

Returns

A new multicast (combinable) delegate with an invocation list that concatenates the invocation list of the current multicast (combinable) delegate and the invocation list of d, or the current multicast (combinable) delegate if d is null.

System.Delegate.CreateDelegate()

Creates a delegate of the specified type that represents the specified static or instance method, with the specified first argument.

Parameters

NameDescriptionDefault
type The System.Type of delegate to create.
firstArgument The object to which the delegate is bound, or null to treat method as static (Shared in Visual Basic).
method The System.Reflection.MethodInfo describing the static or instance method the delegate is to represent.

Returns

A delegate of the specified type that represents the specified static or instance method.

System.Delegate.CreateDelegate()

Creates a delegate of the specified type that represents the specified static or instance method, with the specified first argument and the specified behavior on failure to bind.

Parameters

NameDescriptionDefault
type A System.Type representing the type of delegate to create.
firstArgument An System.Object that is the first argument of the method the delegate represents. For instance methods, it must be compatible with the instance type.
method The System.Reflection.MethodInfo describing the static or instance method the delegate is to represent.
throwOnBindFailure true to throw an exception if method cannot be bound; otherwise, false.

Returns

A delegate of the specified type that represents the specified static or instance method, or null if throwOnBindFailure is false and the delegate cannot be bound to method.

System.Delegate.CreateDelegate()

Creates a delegate of the specified type that represents the specified instance method to invoke on the specified class instance.

Parameters

NameDescriptionDefault
type The System.Type of delegate to create.
target The class instance on which method is invoked.
method The name of the instance method that the delegate is to represent.

Returns

A delegate of the specified type that represents the specified instance method to invoke on the specified class instance.

System.Delegate.CreateDelegate()

Creates a delegate of the specified type that represents the specified instance method to invoke on the specified class instance with the specified case-sensitivity.

Parameters

NameDescriptionDefault
type The System.Type of delegate to create.
target The class instance on which method is invoked.
method The name of the instance method that the delegate is to represent.
ignoreCase A Boolean indicating whether to ignore the case when comparing the name of the method.

Returns

A delegate of the specified type that represents the specified instance method to invoke on the specified class instance.

System.Delegate.CreateDelegate()

Creates a delegate of the specified type that represents the specified instance method to invoke on the specified class instance, with the specified case-sensitivity and the specified behavior on failure to bind.

Parameters

NameDescriptionDefault
type The System.Type of delegate to create.
target The class instance on which method is invoked.
method The name of the instance method that the delegate is to represent.
ignoreCase A Boolean indicating whether to ignore the case when comparing the name of the method.
throwOnBindFailure true to throw an exception if method cannot be bound; otherwise, false.

Returns

A delegate of the specified type that represents the specified instance method to invoke on the specified class instance.

System.Delegate.CreateDelegate()

Creates a delegate of the specified type to represent the specified method.

Parameters

NameDescriptionDefault
type The System.Type of delegate to create.
method The System.Reflection.MethodInfo describing the static or instance method the delegate is to represent.

Returns

A delegate of the specified type to represent the specified method.

System.Delegate.CreateDelegate()

Creates a delegate of the specified type to represent the specified static method, with the specified behavior on failure to bind.

Parameters

NameDescriptionDefault
type The System.Type of delegate to create.
method The System.Reflection.MethodInfo describing the static or instance method the delegate is to represent.
throwOnBindFailure true to throw an exception if method cannot be bound; otherwise, false.

Returns

A delegate of the specified type to represent the specified static method.

System.Delegate.CreateDelegate()

Creates a delegate of the specified type that represents the specified static method of the specified class.

Parameters

NameDescriptionDefault
type The System.Type of delegate to create.
target The System.Type representing the class that implements method.
method The name of the static method that the delegate is to represent.

Returns

A delegate of the specified type that represents the specified static method of the specified class.

System.Delegate.CreateDelegate()

Creates a delegate of the specified type that represents the specified static method of the specified class, with the specified case-sensitivity.

Parameters

NameDescriptionDefault
type The System.Type of delegate to create.
target The System.Type representing the class that implements method.
method The name of the static method that the delegate is to represent.
ignoreCase A Boolean indicating whether to ignore the case when comparing the name of the method.

Returns

A delegate of the specified type that represents the specified static method of the specified class.

System.Delegate.CreateDelegate()

Creates a delegate of the specified type that represents the specified static method of the specified class, with the specified case-sensitivity and the specified behavior on failure to bind.

Parameters

NameDescriptionDefault
type The System.Type of delegate to create.
target The System.Type representing the class that implements method.
method The name of the static method that the delegate is to represent.
ignoreCase A Boolean indicating whether to ignore the case when comparing the name of the method.
throwOnBindFailure true to throw an exception if method cannot be bound; otherwise, false.

Returns

A delegate of the specified type that represents the specified static method of the specified class.

System.Delegate.DynamicInvoke()

Dynamically invokes (late-bound) the method represented by the current delegate.

Parameters

NameDescriptionDefault
args An array of objects that are the arguments to pass to the method represented by the current delegate. -or- null, if the method represented by the current delegate does not require arguments.

Returns

The object returned by the method represented by the delegate.

System.Delegate.DynamicInvokeImpl()

Dynamically invokes (late-bound) the method represented by the current delegate.

Parameters

NameDescriptionDefault
args An array of objects that are the arguments to pass to the method represented by the current delegate. -or- null, if the method represented by the current delegate does not require arguments.

Returns

The object returned by the method represented by the delegate.

System.Delegate.Equals()

Determines whether the specified object and the current delegate are of the same type and share the same targets, methods, and invocation list.

Parameters

NameDescriptionDefault
obj The object to compare with the current delegate.

Returns

true if obj and the current delegate have the same targets, methods, and invocation list; otherwise, false.

System.Delegate.GetHashCode

Returns a hash code for the delegate.

Returns

A hash code for the delegate.

System.Delegate.GetInvocationList

Returns the invocation list of the delegate.

Returns

An array of delegates representing the invocation list of the current delegate.

System.Delegate.GetMethodImpl

Gets the method represented by the current delegate.

Returns

A System.Reflection.MethodInfo describing the method represented by the current delegate.

System.Delegate.GetObjectData()

Not supported.

Parameters

NameDescriptionDefault
info Not supported.
context Not supported.

System.Delegate.op_Equality()

Determines whether the specified delegates are equal.

Parameters

NameDescriptionDefault
d1 The first delegate to compare.
d2 The second delegate to compare.

Returns

true if d1 is equal to d2; otherwise, false.

System.Delegate.op_Inequality()

Determines whether the specified delegates are not equal.

Parameters

NameDescriptionDefault
d1 The first delegate to compare.
d2 The second delegate to compare.

Returns

true if d1 is not equal to d2; otherwise, false.

System.Delegate.Remove()

Removes the last occurrence of the invocation list of a delegate from the invocation list of another delegate.

Parameters

NameDescriptionDefault
source The delegate from which to remove the invocation list of value.
value The delegate that supplies the invocation list to remove from the invocation list of source.

Returns

A new delegate with an invocation list formed by taking the invocation list of source and removing the last occurrence of the invocation list of value, if the invocation list of value is found within the invocation list of source. Returns source if value is null or if the invocation list of value is not found within the invocation list of source. Returns a null reference if the invocation list of value is equal to the invocation list of source or if source is a null reference.

System.Delegate.RemoveAll()

Removes all occurrences of the invocation list of a delegate from the invocation list of another delegate.

Parameters

NameDescriptionDefault
source The delegate from which to remove the invocation list of value.
value The delegate that supplies the invocation list to remove from the invocation list of source.

Returns

A new delegate with an invocation list formed by taking the invocation list of source and removing all occurrences of the invocation list of value, if the invocation list of value is found within the invocation list of source. Returns source if value is null or if the invocation list of value is not found within the invocation list of source. Returns a null reference if the invocation list of value is equal to the invocation list of source, if source contains only a series of invocation lists that are equal to the invocation list of value, or if source is a null reference.

System.Delegate.RemoveImpl()

Removes the invocation list of a delegate from the invocation list of another delegate.

Parameters

NameDescriptionDefault
d The delegate that supplies the invocation list to remove from the invocation list of the current delegate.

Returns

A new delegate with an invocation list formed by taking the invocation list of the current delegate and removing the invocation list of value, if the invocation list of value is found within the current delegate's invocation list. Returns the current delegate if value is null or if the invocation list of value is not found within the current delegate's invocation list. Returns null if the invocation list of value is equal to the current delegate's invocation list.

System.Delegate.Method

Gets the method represented by the delegate.

Returns

A System.Reflection.MethodInfo describing the method represented by the delegate.

System.Delegate.Target

Gets the class instance on which the current delegate invokes the instance method.

Returns

The object on which the current delegate invokes the instance method, if the delegate represents an instance method; null if the delegate represents a static method.

System.Diagnostics.CodeAnalysis.AllowNullAttribute

Specifies that null is allowed as an input even if the corresponding type disallows it.

System.Diagnostics.CodeAnalysis.AllowNullAttribute.#ctor

Initializes a new instance of the System.Diagnostics.CodeAnalysis.AllowNullAttribute class.

System.Diagnostics.CodeAnalysis.ConstantExpectedAttribute

Indicates that the specified method parameter expects a constant.

System.Diagnostics.CodeAnalysis.ConstantExpectedAttribute.#ctor

Initializes a new instance of the System.Diagnostics.CodeAnalysis.ConstantExpectedAttribute class.

System.Diagnostics.CodeAnalysis.ConstantExpectedAttribute.Max

Gets or sets the maximum bound of the expected constant, inclusive.

System.Diagnostics.CodeAnalysis.ConstantExpectedAttribute.Min

Gets or sets the minimum bound of the expected constant, inclusive.

System.Diagnostics.CodeAnalysis.DisallowNullAttribute

Specifies that null is disallowed as an input even if the corresponding type allows it.

System.Diagnostics.CodeAnalysis.DisallowNullAttribute.#ctor

Initializes a new instance of the System.Diagnostics.CodeAnalysis.DisallowNullAttribute class.

System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute

Specifies that a method that will never return under any circumstance.

System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute.#ctor

Initializes a new instance of the System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute class.

System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute

Specifies that the method will not return if the associated System.Boolean parameter is passed the specified value.

System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute class with the specified parameter value.

Parameters

NameDescriptionDefault
parameterValue The condition parameter value. Code after the method is considered unreachable by diagnostics if the argument to the associated parameter matches this value.

System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue

Gets the condition parameter value.

Returns

The condition parameter value. Code after the method is considered unreachable by diagnostics if the argument to the associated parameter matches this value.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute

Indicates that certain members on a specified System.Type are accessed dynamically, for example, through System.Reflection.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute class with the specified member types.

Parameters

NameDescriptionDefault
memberTypes The types of the dynamically accessed members.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes

Gets the System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes that specifies the type of dynamically accessed members.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes

Specifies the types of members that are dynamically accessed. This enumeration has a System.FlagsAttribute attribute that allows a bitwise combination of its member values.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All

Specifies all members.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces

Specifies all interfaces implemented by the type.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None

Specifies no members.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors

Specifies all non-public constructors.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents

Specifies all non-public events.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields

Specifies all non-public fields.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods

Specifies all non-public methods.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes

Specifies all non-public nested types.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties

Specifies all non-public properties.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors

Specifies all public constructors.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents

Specifies all public events.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields

Specifies all public fields.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods

Specifies all public methods.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes

Specifies all public nested types.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor

Specifies the default, parameterless public constructor.

System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties

Specifies all public properties.

System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute

States a dependency that one member has on another.

System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute class with the specified types of members on a type in an assembly.

Parameters

NameDescriptionDefault
memberTypes The types of members depended on.
typeName The full name of the type containing the specified members.
assemblyName The assembly name of the type containing the specified members.

System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute class with the specified types of members on a System.Type.

Parameters

NameDescriptionDefault
memberTypes The types of members depended on.
type The type that contains the specified members.

System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute class with the specified signature of a member on the same type as the consumer.

Parameters

NameDescriptionDefault
memberSignature The signature of the member depended on.

System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute class with the specified signature of a member on a type in an assembly.

Parameters

NameDescriptionDefault
memberSignature The signature of the member depended on.
typeName The full name of the type containing the specified member.
assemblyName The assembly name of the type containing the specified member.

System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute class with the specified signature of a member on a System.Type.

Parameters

NameDescriptionDefault
memberSignature The signature of the member depended on.
type The type that contains memberSignature.

System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.AssemblyName

Gets the assembly name of the specified type.

System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Condition

Gets or sets the condition in which the dependency is applicable.

System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature

Gets the signature of the member depended on.

System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes

Gets the types of the members that are depended on, for example, fields and properties.

System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type

Gets the System.Type containing the specified member.

System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName

Gets the full name of the type containing the specified member.

System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute

Specifies that the attributed code should be excluded from code coverage information.

System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute.#ctor

Initializes a new instance of the System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute class.

System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute.Justification

Gets or sets the justification for excluding the member from code coverage.

System.Diagnostics.CodeAnalysis.ExperimentalAttribute

Indicates that an API is experimental and it may change in the future.

System.Diagnostics.CodeAnalysis.ExperimentalAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.CodeAnalysis.ExperimentalAttribute class, specifying the ID that the compiler will use when reporting a use of the API the attribute applies to.

Parameters

NameDescriptionDefault
diagnosticId The ID that the compiler will use when reporting a use of the API the attribute applies to.

System.Diagnostics.CodeAnalysis.ExperimentalAttribute.DiagnosticId

Gets the ID that the compiler will use when reporting a use of the API the attribute applies to.

Returns

The unique diagnostic ID.

System.Diagnostics.CodeAnalysis.ExperimentalAttribute.UrlFormat

Gets or sets the URL for corresponding documentation. The API accepts a format string instead of an actual URL, creating a generic URL that includes the diagnostic ID.

Returns

The format string that represents a URL to corresponding documentation.

System.Diagnostics.CodeAnalysis.MaybeNullAttribute

Specifies that an output may be null even if the corresponding type disallows it.

System.Diagnostics.CodeAnalysis.MaybeNullAttribute.#ctor

Initializes a new instance of the System.Diagnostics.CodeAnalysis.MaybeNullAttribute class.

System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute

Specifies that when a method returns System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue, the parameter may be null even if the corresponding type disallows it.

System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor()

Initializes the attribute with the specified return value condition.

Parameters

NameDescriptionDefault
returnValue The return value condition. If the method returns this value, the associated parameter may be null.

System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue

Gets the return value condition.

Returns

The return value condition. If the method returns this value, the associated parameter may be null.

System.Diagnostics.CodeAnalysis.MemberNotNullAttribute

Specifies that the method or property will ensure that the listed field and property members have values that aren't null.

System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor()

Initializes the attribute with a field or property member.

Parameters

NameDescriptionDefault
member The field or property member that is promised to be non-null.

System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor()

Initializes the attribute with the list of field and property members.

Parameters

NameDescriptionDefault
members The list of field and property members that are promised to be non-null.

System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members

Gets field or property member names.

System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute

Specifies that the method or property will ensure that the listed field and property members have non-null values when returning with the specified return value condition.

System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor()

Initializes the attribute with the specified return value condition and a field or property member.

Parameters

NameDescriptionDefault
returnValue The return value condition. If the method returns this value, the associated parameter will not be null.
member The field or property member that is promised to be non-null.

System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor()

Initializes the attribute with the specified return value condition and list of field and property members.

Parameters

NameDescriptionDefault
returnValue The return value condition. If the method returns this value, the associated parameter will not be null.
members The list of field and property members that are promised to be non-null.

System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members

Gets field or property member names.

System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue

Gets the return value condition.

System.Diagnostics.CodeAnalysis.NotNullAttribute

Specifies that an output is not null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.

System.Diagnostics.CodeAnalysis.NotNullAttribute.#ctor

Initializes a new instance of the System.Diagnostics.CodeAnalysis.NotNullAttribute class.

System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute

Specifies that the output will be non-null if the named parameter is non-null.

System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor()

Initializes the attribute with the associated parameter name.

Parameters

NameDescriptionDefault
parameterName The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.

System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName

Gets the associated parameter name.

Returns

The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.

System.Diagnostics.CodeAnalysis.NotNullWhenAttribute

Specifies that when a method returns System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue, the parameter will not be null even if the corresponding type allows it.

System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor()

Initializes the attribute with the specified return value condition.

Parameters

NameDescriptionDefault
returnValue The return value condition. If the method returns this value, the associated parameter will not be null.

System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue

Gets the return value condition.

Returns

The return value condition. If the method returns this value, the associated parameter will not be null.

System.Diagnostics.CodeAnalysis.RequiresAssemblyFilesAttribute

Indicates that the specified member requires assembly files to be on disk.

System.Diagnostics.CodeAnalysis.RequiresAssemblyFilesAttribute.#ctor

Initializes a new instance of the System.Diagnostics.CodeAnalysis.RequiresAssemblyFilesAttribute class.

System.Diagnostics.CodeAnalysis.RequiresAssemblyFilesAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.CodeAnalysis.RequiresAssemblyFilesAttribute class.

Parameters

NameDescriptionDefault
message A message that contains information about the need for assembly files to be on disk.

System.Diagnostics.CodeAnalysis.RequiresAssemblyFilesAttribute.Message

Gets an optional message that contains information about the need for assembly files to be on disk.

System.Diagnostics.CodeAnalysis.RequiresAssemblyFilesAttribute.Url

Gets or sets an optional URL that contains more information about the member, why it requires assembly files to be on disk, and what options a consumer has to deal with it.

System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute

Indicates that the specified method requires the ability to generate new code at runtime, for example through System.Reflection.

System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute class with the specified message.

Parameters

NameDescriptionDefault
message A message that contains information about the usage of dynamic code.

System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Message

Gets a message that contains information about the usage of dynamic code.

System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Url

Gets or sets an optional URL that contains more information about the method, why it requires dynamic code, and what options a consumer has to deal with it.

System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute

Indicates that the specified method requires dynamic access to code that is not referenced statically, for example, through System.Reflection.

System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute class with the specified message.

Parameters

NameDescriptionDefault
message A message that contains information about the usage of unreferenced code.

System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Message

Gets a message that contains information about the usage of unreferenced code.

System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Url

Gets or sets an optional URL that contains more information about the method, why it requires unreferenced code, and what options a consumer has to deal with it.

System.Diagnostics.CodeAnalysis.SetsRequiredMembersAttribute

Specifies that this constructor sets all required members for the current type, and callers do not need to set any required members themselves.

System.Diagnostics.CodeAnalysis.SetsRequiredMembersAttribute.#ctor

Initializes a new instance of the System.Diagnostics.CodeAnalysis.SetsRequiredMembersAttribute class.

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute

Specifies the syntax used in a string.

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.CompositeFormat

The syntax identifier for strings containing composite formats for string formatting.

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.DateOnlyFormat

The syntax identifier for strings containing date format specifiers.

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.DateTimeFormat

The syntax identifier for strings containing date and time format specifiers.

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.EnumFormat

The syntax identifier for strings containing System.Enum format specifiers.

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat

The syntax identifier for strings containing System.Guid format specifiers.

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Json

The syntax identifier for strings containing JavaScript Object Notation (JSON).

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat

The syntax identifier for strings containing numeric format specifiers.

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Regex

The syntax identifier for strings containing regular expressions.

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.TimeOnlyFormat

The syntax identifier for strings containing time format specifiers.

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.TimeSpanFormat

The syntax identifier for strings containing System.TimeSpan format specifiers.

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Uri

The syntax identifier for strings containing URIs.

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Xml

The syntax identifier for strings containing XML.

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.#ctor()

Initializes the System.Diagnostics.CodeAnalysis.StringSyntaxAttribute with the identifier of the syntax used.

Parameters

NameDescriptionDefault
syntax The syntax identifier.

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.#ctor()

Initializes the System.Diagnostics.CodeAnalysis.StringSyntaxAttribute with the identifier of the syntax used.

Parameters

NameDescriptionDefault
syntax The syntax identifier.
arguments Optional arguments associated with the specific syntax employed.

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Arguments

Gets the optional arguments associated with the specific syntax employed.

System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Syntax

Gets the identifier of the syntax used.

System.Diagnostics.CodeAnalysis.SuppressMessageAttribute

Suppresses reporting of a specific code analysis rule violation, allowing multiple suppressions on a single code artifact. Does not apply to compiler diagnostics.

System.Diagnostics.CodeAnalysis.SuppressMessageAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.CodeAnalysis.SuppressMessageAttribute class, specifying the category of the code analysis tool and the identifier for an analysis rule.

Parameters

NameDescriptionDefault
category The category for the attribute.
checkId The identifier of the analysis tool rule the attribute applies to.

System.Diagnostics.CodeAnalysis.SuppressMessageAttribute.Category

Gets the category identifying the classification of the attribute.

Returns

The category identifying the attribute.

System.Diagnostics.CodeAnalysis.SuppressMessageAttribute.CheckId

Gets the identifier of the code analysis tool rule to be suppressed.

Returns

The identifier of the code analysis tool rule to be suppressed.

System.Diagnostics.CodeAnalysis.SuppressMessageAttribute.Justification

Gets or sets the justification for suppressing the code analysis message.

Returns

The justification for suppressing the message.

System.Diagnostics.CodeAnalysis.SuppressMessageAttribute.MessageId

Gets or sets the expanded exclusion criteria.

Returns

A string containing the expanded exclusion criteria.

System.Diagnostics.CodeAnalysis.SuppressMessageAttribute.Scope

Gets or sets the scope of the code that is relevant for the attribute.

Returns

The scope of the code that is relevant for the attribute.

System.Diagnostics.CodeAnalysis.SuppressMessageAttribute.Target

Gets or sets a fully qualified path that represents the code analysis target.

Returns

A fully qualified path that represents the code analysis target.

System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute

Suppresses reporting of a specific rule violation, allowing multiple suppressions on a single code artifact.

System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute class, specifying the category of the tool and the identifier for an analysis rule.

Parameters

NameDescriptionDefault
category The category for the attribute.
checkId The identifier of the analysis rule the attribute applies to.

System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category

Gets the category identifying the classification of the attribute.

System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId

Gets the identifier of the analysis tool rule to be suppressed.

System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Justification

Gets or sets the justification for suppressing the code analysis message.

System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId

Gets or sets an optional argument expanding on exclusion criteria.

System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Scope

Gets or sets the scope of the code that is relevant for the attribute.

System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target

Gets or sets a fully qualified path that represents the target of the attribute.

System.Diagnostics.CodeAnalysis.UnscopedRefAttribute

Used to indicate a byref escapes and is not scoped.

System.Diagnostics.CodeAnalysis.UnscopedRefAttribute.#ctor

Initializes a new instance of the System.Diagnostics.CodeAnalysis.UnscopedRefAttribute class.

System.Diagnostics.ConditionalAttribute

Indicates to compilers that a method call or attribute should be ignored unless a specified conditional compilation symbol is defined.

System.Diagnostics.ConditionalAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.ConditionalAttribute class.

Parameters

NameDescriptionDefault
conditionString A string that specifies the case-sensitive conditional compilation symbol that is associated with the attribute.

System.Diagnostics.ConditionalAttribute.ConditionString

Gets the conditional compilation symbol that is associated with the System.Diagnostics.ConditionalAttribute attribute.

Returns

A string that specifies the case-sensitive conditional compilation symbol that is associated with the System.Diagnostics.ConditionalAttribute attribute.

System.Diagnostics.Debug

Provides a set of methods and properties that help debug your code.

System.Diagnostics.Debug.Assert()

Checks for a condition; if the condition is false, displays a message box that shows the call stack.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, a failure message is not sent and the message box is not displayed.

System.Diagnostics.Debug.Assert()

Checks for a condition; if the condition is false, outputs a specified message and displays a message box that shows the call stack.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, the specified message is not sent and the message box is not displayed.
message The message to send to the System.Diagnostics.Trace.Listeners collection.

System.Diagnostics.Debug.Assert()

Checks for a condition; if the condition is false, outputs a specified message and displays a message box that shows the call stack.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, the specified message is not sent and the message box is not displayed.
message The message to send to the System.Diagnostics.Trace.Listeners collection.
detailMessage The detailed message to send to the System.Diagnostics.Trace.Listeners collection.

System.Diagnostics.Debug.Assert()

Checks for a condition; if the condition is false, outputs a specified message and displays a message box that shows the call stack.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, the specified message is not sent and the message box is not displayed.
message The message to send to the System.Diagnostics.Trace.Listeners collection.

System.Diagnostics.Debug.Assert()

Checks for a condition; if the condition is false, outputs two specified messages and displays a message box that shows the call stack.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, the specified messages are not sent and the message box is not displayed.
message The message to send to the System.Diagnostics.Trace.Listeners collection.
detailMessage The detailed message to send to the System.Diagnostics.Trace.Listeners collection.

System.Diagnostics.Debug.Assert()

Checks for a condition; if the condition is false, outputs two messages (simple and formatted) and displays a message box that shows the call stack.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, the specified messages are not sent and the message box is not displayed.
message The message to send to the System.Diagnostics.Trace.Listeners collection.
detailMessageFormat The composite format string to send to the System.Diagnostics.Trace.Listeners collection. This message contains text intermixed with zero or more format items, which correspond to objects in the args array.
args An object array that contains zero or more objects to format.

System.Diagnostics.Debug.Close

Flushes the output buffer and then calls the Close method on each of the System.Diagnostics.Debug.Listeners.

System.Diagnostics.Debug.Fail()

Emits the specified error message.

Parameters

NameDescriptionDefault
message A message to emit.

System.Diagnostics.Debug.Fail()

Emits an error message and a detailed error message.

Parameters

NameDescriptionDefault
message A message to emit.
detailMessage A detailed message to emit.

System.Diagnostics.Debug.Flush

Flushes the output buffer and causes buffered data to write to the System.Diagnostics.Debug.Listeners collection.

System.Diagnostics.Debug.Indent

Increases the current System.Diagnostics.Debug.IndentLevel by one.

System.Diagnostics.Debug.Print()

Writes a message followed by a line terminator to the trace listeners in the System.Diagnostics.Debug.Listeners collection.

Parameters

NameDescriptionDefault
message The message to write.

System.Diagnostics.Debug.Print()

Writes a formatted string followed by a line terminator to the trace listeners in the System.Diagnostics.Debug.Listeners collection.

Parameters

NameDescriptionDefault
format A composite format string that contains text intermixed with zero or more format items, which correspond to objects in the args array.
args An object array containing zero or more objects to format.

System.Diagnostics.Debug.Unindent

Decreases the current System.Diagnostics.Debug.IndentLevel by one.

System.Diagnostics.Debug.Write()

Writes the value of the object's System.Object.ToString method to the trace listeners in the System.Diagnostics.Debug.Listeners collection.

Parameters

NameDescriptionDefault
value An object whose name is sent to the System.Diagnostics.Debug.Listeners.

System.Diagnostics.Debug.Write()

Writes a category name and the value of the object's System.Object.ToString method to the trace listeners in the System.Diagnostics.Debug.Listeners collection.

Parameters

NameDescriptionDefault
value An object whose name is sent to the System.Diagnostics.Debug.Listeners.
category A category name used to organize the output.

System.Diagnostics.Debug.Write()

Writes a message to the trace listeners in the System.Diagnostics.Debug.Listeners collection.

Parameters

NameDescriptionDefault
message A message to write.

System.Diagnostics.Debug.Write()

Writes a category name and message to the trace listeners in the System.Diagnostics.Debug.Listeners collection.

Parameters

NameDescriptionDefault
message A message to write.
category A category name used to organize the output.

System.Diagnostics.Debug.WriteIf()

If condition is true, writes a category name and message to the trace listeners in the System.Diagnostics.Debug.Listeners collection.

Parameters

NameDescriptionDefault
message The message to write if condition is true.
condition The conditional expression to evaluate. If the condition is true, the value is written to the trace listeners in the collection.

System.Diagnostics.Debug.WriteIf()

Writes a category name and message to the trace listeners in the System.Diagnostics.Debug.Listeners collection if a specified condition is true.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, the message is written to the trace listeners in the collection.
message The message to write.
category A category name used to organize the output.

System.Diagnostics.Debug.WriteIf()

Writes the value of the object's System.Object.ToString method to the trace listeners in the System.Diagnostics.Debug.Listeners collection if a condition is true.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, the value is written to the trace listeners in the collection.
value An object whose name is sent to the System.Diagnostics.Debug.Listeners.

System.Diagnostics.Debug.WriteIf()

Writes a category name and the value of the object's System.Object.ToString method to the trace listeners in the System.Diagnostics.Debug.Listeners collection if a condition is true.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, the category name and value are written to the trace listeners in the collection.
value An object whose name is sent to the System.Diagnostics.Debug.Listeners.
category A category name used to organize the output.

System.Diagnostics.Debug.WriteIf()

Writes a message to the trace listeners in the System.Diagnostics.Debug.Listeners collection if a condition is true.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, the message is written to the trace listeners in the collection.
message A message to write.

System.Diagnostics.Debug.WriteIf()

Writes a category name and message to the trace listeners in the System.Diagnostics.Debug.Listeners collection if a condition is true.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, the category name and message are written to the trace listeners in the collection.
message A message to write.
category A category name used to organize the output.

System.Diagnostics.Debug.WriteLine()

Writes the value of the object's System.Object.ToString method to the trace listeners in the System.Diagnostics.Debug.Listeners collection.

Parameters

NameDescriptionDefault
value An object whose name is sent to the System.Diagnostics.Debug.Listeners.

System.Diagnostics.Debug.WriteLine()

Writes a category name and the value of the object's System.Object.ToString method to the trace listeners in the System.Diagnostics.Debug.Listeners collection.

Parameters

NameDescriptionDefault
value An object whose name is sent to the System.Diagnostics.Debug.Listeners.
category A category name used to organize the output.

System.Diagnostics.Debug.WriteLine()

Writes a message followed by a line terminator to the trace listeners in the System.Diagnostics.Debug.Listeners collection.

Parameters

NameDescriptionDefault
message A message to write.

System.Diagnostics.Debug.WriteLine()

Writes a formatted message followed by a line terminator to the trace listeners in the System.Diagnostics.Debug.Listeners collection.

Parameters

NameDescriptionDefault
format A composite format string that contains text intermixed with zero or more format items, which correspond to objects in the args array.
args An object array that contains zero or more objects to format.

System.Diagnostics.Debug.WriteLine()

Writes a category name and message to the trace listeners in the System.Diagnostics.Debug.Listeners collection.

Parameters

NameDescriptionDefault
message A message to write.
category A category name used to organize the output.

System.Diagnostics.Debug.WriteLineIf()

Writes a message to the trace listeners in the System.Diagnostics.Debug.Listeners collection if a specified condition is true.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, the message is written to the trace listeners in the collection.
message The message to write.

System.Diagnostics.Debug.WriteLineIf()

Writes a category name and message to the trace listeners in the System.Diagnostics.Debug.Listeners collection if a specified condition is true.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, the message and category name are written to the trace listeners in the collection.
message The message to write.
category A category name used to organize the output.

System.Diagnostics.Debug.WriteLineIf()

Writes the value of the object's System.Object.ToString method to the trace listeners in the System.Diagnostics.Debug.Listeners collection if a condition is true.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, the value is written to the trace listeners in the collection.
value An object whose name is sent to the System.Diagnostics.Debug.Listeners.

System.Diagnostics.Debug.WriteLineIf()

Writes a category name and the value of the object's System.Object.ToString method to the trace listeners in the System.Diagnostics.Debug.Listeners collection if a condition is true.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, the category name and value are written to the trace listeners in the collection.
value An object whose name is sent to the System.Diagnostics.Debug.Listeners.
category A category name used to organize the output.

System.Diagnostics.Debug.WriteLineIf()

Writes a message to the trace listeners in the System.Diagnostics.Debug.Listeners collection if a condition is true.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, the message is written to the trace listeners in the collection.
message The message to write.

System.Diagnostics.Debug.WriteLineIf()

Writes a category name and message to the trace listeners in the System.Diagnostics.Debug.Listeners collection if a condition is true.

Parameters

NameDescriptionDefault
condition The conditional expression to evaluate. If the condition is true, the message and cateogry name are written to the trace listeners in the collection.
message The message to write.
category A category name used to organize the output.

System.Diagnostics.Debug.AutoFlush

Gets or sets a value indicating whether System.Diagnostics.Debug.Flush should be called on the System.Diagnostics.Debug.Listeners after every write.

Returns

true if System.Diagnostics.Debug.Flush is called on the System.Diagnostics.Debug.Listeners after every write; otherwise, false.

System.Diagnostics.Debug.IndentLevel

Gets or sets the indent level.

Returns

The indent level. The default is 0.

System.Diagnostics.Debug.IndentSize

Gets or sets the number of spaces in an indent.

Returns

The number of spaces in an indent. The default is four.

System.Diagnostics.Debug.AssertInterpolatedStringHandler

Provides an interpolated string handler for System.Diagnostics.Debug.Assert() that only performs formatting if the assert fails.

System.Diagnostics.Debug.AssertInterpolatedStringHandler.#ctor()

Creates an instance of the handler.

Parameters

NameDescriptionDefault
literalLength The number of constant characters outside of interpolation expressions in the interpolated string.
formattedCount The number of interpolation expressions in the interpolated string.
condition The condition Boolean passed to the System.Diagnostics.Debug method.
shouldAppend A value indicating whether formatting should proceed.

System.Diagnostics.Debug.AssertInterpolatedStringHandler.AppendFormatted()

Writes the specified value to the handler.

Parameters

NameDescriptionDefault
value The value to write.
alignment Minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value.
format The format string.

System.Diagnostics.Debug.AssertInterpolatedStringHandler.AppendFormatted()

Writes the specified character span to the handler.

Parameters

NameDescriptionDefault
value The span to write.

System.Diagnostics.Debug.AssertInterpolatedStringHandler.AppendFormatted()

Writes the specified string of chars to the handler.

Parameters

NameDescriptionDefault
value The span to write.
alignment Minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value.
format The format string.

System.Diagnostics.Debug.AssertInterpolatedStringHandler.AppendFormatted()

Writes the specified value to the handler.

Parameters

NameDescriptionDefault
value The value to write.

System.Diagnostics.Debug.AssertInterpolatedStringHandler.AppendFormatted()

Writes the specified value to the handler.

Parameters

NameDescriptionDefault
value The value to write.
alignment Minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value.
format The format string.

System.Diagnostics.Debug.AssertInterpolatedStringHandler.AppendFormatted``1()

Writes the specified value to the handler.

Parameters

NameDescriptionDefault
value The value to write.

System.Diagnostics.Debug.AssertInterpolatedStringHandler.AppendFormatted``1()

Writes the specified value to the handler.

Parameters

NameDescriptionDefault
value The value to write.
alignment Minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value.

System.Diagnostics.Debug.AssertInterpolatedStringHandler.AppendFormatted``1()

Writes the specified value to the handler.

Parameters

NameDescriptionDefault
value The value to write.
alignment Minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value.
format The format string.

System.Diagnostics.Debug.AssertInterpolatedStringHandler.AppendFormatted``1()

Writes the specified value to the handler.

Parameters

NameDescriptionDefault
value The value to write.
format The format string.

System.Diagnostics.Debug.AssertInterpolatedStringHandler.AppendLiteral()

Writes the specified string to the handler.

Parameters

NameDescriptionDefault
value The string to write.

System.Diagnostics.Debug.WriteIfInterpolatedStringHandler

Provides an interpolated string handler for System.Diagnostics.Debug.WriteIf() and System.Diagnostics.Debug.WriteLineIf() that only performs formatting if the condition applies.

System.Diagnostics.Debug.WriteIfInterpolatedStringHandler.#ctor()

Creates an instance of the handler.

Parameters

NameDescriptionDefault
literalLength The number of constant characters outside of interpolation expressions in the interpolated string.
formattedCount The number of interpolation expressions in the interpolated string.
condition The condition Boolean passed to the System.Diagnostics.Debug method.
shouldAppend A value indicating whether formatting should proceed.

System.Diagnostics.Debug.WriteIfInterpolatedStringHandler.AppendFormatted()

Writes the specified value to the handler.

Parameters

NameDescriptionDefault
value The value to write.
alignment Minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value.
format The format string.

System.Diagnostics.Debug.WriteIfInterpolatedStringHandler.AppendFormatted()

Writes the specified character span to the handler.

Parameters

NameDescriptionDefault
value The span to write.

System.Diagnostics.Debug.WriteIfInterpolatedStringHandler.AppendFormatted()

Writes the specified string of chars to the handler.

Parameters

NameDescriptionDefault
value The span to write.
alignment Minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value.
format The format string.

System.Diagnostics.Debug.WriteIfInterpolatedStringHandler.AppendFormatted()

Writes the specified value to the handler.

Parameters

NameDescriptionDefault
value The value to write.

System.Diagnostics.Debug.WriteIfInterpolatedStringHandler.AppendFormatted()

Writes the specified value to the handler.

Parameters

NameDescriptionDefault
value The value to write.
alignment Minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value.
format The format string.

System.Diagnostics.Debug.WriteIfInterpolatedStringHandler.AppendFormatted``1()

Writes the specified value to the handler.

Parameters

NameDescriptionDefault
value The value to write.

System.Diagnostics.Debug.WriteIfInterpolatedStringHandler.AppendFormatted``1()

Writes the specified value to the handler.

Parameters

NameDescriptionDefault
value The value to write.
alignment Minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value.

System.Diagnostics.Debug.WriteIfInterpolatedStringHandler.AppendFormatted``1()

Writes the specified value to the handler.

Parameters

NameDescriptionDefault
value The value to write.
alignment Minimum number of characters that should be written for this value. If the value is negative, it indicates left-aligned and the required minimum is the absolute value.
format The format string.

System.Diagnostics.Debug.WriteIfInterpolatedStringHandler.AppendFormatted``1()

Writes the specified value to the handler.

Parameters

NameDescriptionDefault
value The value to write.
format The format string.

System.Diagnostics.Debug.WriteIfInterpolatedStringHandler.AppendLiteral()

Writes the specified string to the handler.

Parameters

NameDescriptionDefault
value The string to write.

System.Diagnostics.DebuggableAttribute

Modifies code generation for runtime just-in-time (JIT) debugging. This class cannot be inherited.

System.Diagnostics.DebuggableAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.DebuggableAttribute class, using the specified tracking and optimization options for the just-in-time (JIT) compiler.

Parameters

NameDescriptionDefault
isJITTrackingEnabled true to enable debugging; otherwise, false.
isJITOptimizerDisabled true to disable the optimizer for execution; otherwise, false.

System.Diagnostics.DebuggableAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.DebuggableAttribute class, using the specified debugging modes for the just-in-time (JIT) compiler.

Parameters

NameDescriptionDefault
modes A bitwise combination of the System.Diagnostics.DebuggableAttribute.DebuggingModes values specifying the debugging mode for the JIT compiler.

System.Diagnostics.DebuggableAttribute.DebuggingFlags

Gets the debugging modes for the attribute.

Returns

A bitwise combination of the System.Diagnostics.DebuggableAttribute.DebuggingModes values describing the debugging mode for the just-in-time (JIT) compiler. The default is System.Diagnostics.DebuggableAttribute.DebuggingModes.Default.

System.Diagnostics.DebuggableAttribute.IsJITOptimizerDisabled

Gets a value that indicates whether the runtime optimizer is disabled.

Returns

true if the runtime optimizer is disabled; otherwise, false.

System.Diagnostics.DebuggableAttribute.IsJITTrackingEnabled

Gets a value that indicates whether the runtime will track information during code generation for the debugger.

Returns

true if the runtime will track information during code generation for the debugger; otherwise, false.

System.Diagnostics.DebuggableAttribute.DebuggingModes

Specifies the debugging mode for the just-in-time (JIT) compiler.

System.Diagnostics.DebuggableAttribute.DebuggingModes.Default

Instructs the just-in-time (JIT) compiler to use its default behavior, which includes enabling optimizations, disabling Edit and Continue support, and using symbol store sequence points if present. Starting with the .NET Framework version 2.0, JIT tracking information, the Microsoft intermediate language (MSIL) offset to the native-code offset within a method, is always generated.

System.Diagnostics.DebuggableAttribute.DebuggingModes.DisableOptimizations

Disable optimizations performed by the compiler to make your output file smaller, faster, and more efficient. Optimizations result in code rearrangement in the output file, which can make debugging difficult. Typically optimization should be disabled while debugging. In versions 2.0 or later, combine this value with Default (Default | DisableOptimizations) to enable JIT tracking and disable optimizations.

System.Diagnostics.DebuggableAttribute.DebuggingModes.EnableEditAndContinue

Enable edit and continue. Edit and continue enables you to make changes to your source code while your program is in break mode. The ability to edit and continue is compiler dependent.

System.Diagnostics.DebuggableAttribute.DebuggingModes.IgnoreSymbolStoreSequencePoints

Use the implicit MSIL sequence points, not the program database (PDB) sequence points. The symbolic information normally includes at least one Microsoft intermediate language (MSIL) offset for each source line. When the just-in-time (JIT) compiler is about to compile a method, it asks the profiling services for a list of MSIL offsets that should be preserved. These MSIL offsets are called sequence points.

System.Diagnostics.DebuggableAttribute.DebuggingModes.None

Starting with the .NET Framework version 2.0, JIT tracking information is always generated, and this flag has the same effect as System.Diagnostics.DebuggableAttribute.DebuggingModes.Default, except that it sets the System.Diagnostics.DebuggableAttribute.IsJITTrackingEnabled property to false. However, because JIT tracking is always enabled, the property value is ignored in version 2.0 or later. Note that, unlike the System.Diagnostics.DebuggableAttribute.DebuggingModes.DisableOptimizations flag, the System.Diagnostics.DebuggableAttribute.DebuggingModes.None flag cannot be used to disable JIT optimizations.

System.Diagnostics.Debugger

Enables communication with a debugger. This class cannot be inherited.

System.Diagnostics.Debugger.DefaultCategory

Represents the default category of message with a constant.

System.Diagnostics.Debugger.Break

Signals a breakpoint to an attached debugger.

System.Diagnostics.Debugger.IsLogging

Checks to see if logging is enabled by an attached debugger.

Returns

true if a debugger is attached and logging is enabled; otherwise, false. The attached debugger is the registered managed debugger in the DbgManagedDebugger registry key. For more information on this key, see Enabling JIT-Attach Debugging.

System.Diagnostics.Debugger.Launch

Launches and attaches a debugger to the process.

Returns

true if the startup is successful or if the debugger is already attached; otherwise, false.

System.Diagnostics.Debugger.Log()

Posts a message for the attached debugger.

Parameters

NameDescriptionDefault
level A description of the importance of the message.
category The category of the message.
message The message to show.

System.Diagnostics.Debugger.NotifyOfCrossThreadDependency

Notifies a debugger that execution is about to enter a path that involves a cross-thread dependency.

System.Diagnostics.Debugger.IsAttached

Gets a value that indicates whether a debugger is attached to the process.

Returns

true if a debugger is attached; otherwise, false.

System.Diagnostics.DebuggerBrowsableAttribute

Determines if and how a member is displayed in the debugger variable windows. This class cannot be inherited.

System.Diagnostics.DebuggerBrowsableAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.DebuggerBrowsableAttribute class.

Parameters

NameDescriptionDefault
state One of the System.Diagnostics.DebuggerBrowsableState values that specifies how to display the member.

System.Diagnostics.DebuggerBrowsableAttribute.State

Gets the display state for the attribute.

Returns

System.Diagnostics.DebuggerBrowsableState

Provides display instructions for the debugger.

System.Diagnostics.DebuggerBrowsableState.Collapsed

Show the element as collapsed.

System.Diagnostics.DebuggerBrowsableState.Never

Never show the element.

System.Diagnostics.DebuggerBrowsableState.RootHidden

Do not display the root element; display the child elements if the element is a collection or array of items.

System.Diagnostics.DebuggerDisplayAttribute

Determines how a class or field is displayed in the debugger variable windows.

System.Diagnostics.DebuggerDisplayAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.DebuggerDisplayAttribute class.

Parameters

NameDescriptionDefault
value The string to be displayed in the value column for instances of the type; an empty string ("") causes the value column to be hidden.

System.Diagnostics.DebuggerDisplayAttribute.Name

Gets or sets the name to display in the debugger variable windows.

Returns

The name to display in the debugger variable windows.

System.Diagnostics.DebuggerDisplayAttribute.Target

Gets or sets the type of the attribute's target.

Returns

The attribute's target type.

System.Diagnostics.DebuggerDisplayAttribute.TargetTypeName

Gets or sets the type name of the attribute's target.

Returns

The name of the attribute's target type.

System.Diagnostics.DebuggerDisplayAttribute.Type

Gets or sets the string to display in the type column of the debugger variable windows.

Returns

The string to display in the type column of the debugger variable windows.

System.Diagnostics.DebuggerDisplayAttribute.Value

Gets the string to display in the value column of the debugger variable windows.

Returns

The string to display in the value column of the debugger variable.

System.Diagnostics.DebuggerHiddenAttribute

Specifies the System.Diagnostics.DebuggerHiddenAttribute. This class cannot be inherited.

System.Diagnostics.DebuggerHiddenAttribute.#ctor

Initializes a new instance of the System.Diagnostics.DebuggerHiddenAttribute class.

System.Diagnostics.DebuggerNonUserCodeAttribute

Identifies a type or member that is not part of the user code for an application.

System.Diagnostics.DebuggerNonUserCodeAttribute.#ctor

Initializes a new instance of the System.Diagnostics.DebuggerNonUserCodeAttribute class.

System.Diagnostics.DebuggerStepperBoundaryAttribute

Indicates the code following the attribute is to be executed in run, not step, mode.

System.Diagnostics.DebuggerStepperBoundaryAttribute.#ctor

Initializes a new instance of the System.Diagnostics.DebuggerStepperBoundaryAttribute class.

System.Diagnostics.DebuggerStepThroughAttribute

Instructs the debugger to step through the code instead of stepping into the code. This class cannot be inherited.

System.Diagnostics.DebuggerStepThroughAttribute.#ctor

Initializes a new instance of the System.Diagnostics.DebuggerStepThroughAttribute class.

System.Diagnostics.DebuggerTypeProxyAttribute

Specifies the display proxy for a type.

System.Diagnostics.DebuggerTypeProxyAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.DebuggerTypeProxyAttribute class using the type name of the proxy.

Parameters

NameDescriptionDefault
typeName The type name of the proxy type.

System.Diagnostics.DebuggerTypeProxyAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.DebuggerTypeProxyAttribute class using the type of the proxy.

Parameters

NameDescriptionDefault
type The proxy type.

System.Diagnostics.DebuggerTypeProxyAttribute.ProxyTypeName

Gets the type name of the proxy type.

Returns

The type name of the proxy type.

System.Diagnostics.DebuggerTypeProxyAttribute.Target

Gets or sets the target type for the attribute.

Returns

The target type for the attribute.

System.Diagnostics.DebuggerTypeProxyAttribute.TargetTypeName

Gets or sets the name of the target type.

Returns

The name of the target type.

System.Diagnostics.DebuggerVisualizerAttribute

Specifies that the type has a visualizer. This class cannot be inherited.

System.Diagnostics.DebuggerVisualizerAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.DebuggerVisualizerAttribute class, specifying the type name of the visualizer.

Parameters

NameDescriptionDefault
visualizerTypeName The fully qualified type name of the visualizer.

System.Diagnostics.DebuggerVisualizerAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.DebuggerVisualizerAttribute class, specifying the type name of the visualizer and the type name of the visualizer object source.

Parameters

NameDescriptionDefault
visualizerTypeName The fully qualified type name of the visualizer.
visualizerObjectSourceTypeName The fully qualified type name of the visualizer object source.

System.Diagnostics.DebuggerVisualizerAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.DebuggerVisualizerAttribute class, specifying the type name of the visualizer and the type of the visualizer object source.

Parameters

NameDescriptionDefault
visualizerTypeName The fully qualified type name of the visualizer.
visualizerObjectSource The type of the visualizer object source.

System.Diagnostics.DebuggerVisualizerAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.DebuggerVisualizerAttribute class, specifying the type of the visualizer.

Parameters

NameDescriptionDefault
visualizer The type of the visualizer.

System.Diagnostics.DebuggerVisualizerAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.DebuggerVisualizerAttribute class, specifying the type of the visualizer and the type name of the visualizer object source.

Parameters

NameDescriptionDefault
visualizer The type of the visualizer.
visualizerObjectSourceTypeName The fully qualified type name of the visualizer object source.

System.Diagnostics.DebuggerVisualizerAttribute.#ctor()

Initializes a new instance of the System.Diagnostics.DebuggerVisualizerAttribute class, specifying the type of the visualizer and the type of the visualizer object source.

Parameters

NameDescriptionDefault
visualizer The type of the visualizer.
visualizerObjectSource The type of the visualizer object source.

System.Diagnostics.DebuggerVisualizerAttribute.Description

Gets or sets the description of the visualizer.

Returns

The description of the visualizer.

System.Diagnostics.DebuggerVisualizerAttribute.Target

Gets or sets the target type when the attribute is applied at the assembly level.

Returns

The type that is the target of the visualizer.

System.Diagnostics.DebuggerVisualizerAttribute.TargetTypeName

Gets or sets the fully qualified type name when the attribute is applied at the assembly level.

Returns

The fully qualified type name of the target type.

System.Diagnostics.DebuggerVisualizerAttribute.VisualizerObjectSourceTypeName

Gets the fully qualified type name of the visualizer object source.

Returns

The fully qualified type name of the visualizer object source.

System.Diagnostics.DebuggerVisualizerAttribute.VisualizerTypeName

Gets the fully qualified type name of the visualizer.

Returns

The fully qualified visualizer type name.

System.Diagnostics.StackTraceHiddenAttribute

Types and Methods attributed with StackTraceHidden will be omitted from the stack trace text shown in StackTrace.ToString() and Exception.StackTrace

System.Diagnostics.StackTraceHiddenAttribute.#ctor

Initializes a new instance of the System.Diagnostics.StackTraceHiddenAttribute class.

System.Diagnostics.Stopwatch

Provides a set of methods and properties that you can use to accurately measure elapsed time.

System.Diagnostics.Stopwatch.Frequency

Gets the frequency of the timer as the number of ticks per second. This field is read-only.

System.Diagnostics.Stopwatch.IsHighResolution

Indicates whether the timer is based on a high-resolution performance counter. This field is read-only.

System.Diagnostics.Stopwatch.#ctor

Initializes a new instance of the System.Diagnostics.Stopwatch class.

System.Diagnostics.Stopwatch.GetElapsedTime()

Gets the elapsed time since the startingTimestamp value retrieved using System.Diagnostics.Stopwatch.GetTimestamp.

Parameters

NameDescriptionDefault
startingTimestamp The timestamp marking the beginning of the time period.

Returns

A System.TimeSpan for the elapsed time between the starting timestamp and the time of this call.

System.Diagnostics.Stopwatch.GetElapsedTime()

Gets the elapsed time between two timestamps retrieved using System.Diagnostics.Stopwatch.GetTimestamp.

Parameters

NameDescriptionDefault
startingTimestamp The timestamp marking the beginning of the time period.
endingTimestamp The timestamp marking the end of the time period.

Returns

A System.TimeSpan for the elapsed time between the starting and ending timestamps.

System.Diagnostics.Stopwatch.GetTimestamp

Gets the current number of ticks in the timer mechanism.

Returns

A long integer representing the tick counter value of the underlying timer mechanism.

System.Diagnostics.Stopwatch.Reset

Stops time interval measurement and resets the elapsed time to zero.

System.Diagnostics.Stopwatch.Restart

Stops time interval measurement, resets the elapsed time to zero, and starts measuring elapsed time.

System.Diagnostics.Stopwatch.Start

Starts, or resumes, measuring elapsed time for an interval.

System.Diagnostics.Stopwatch.StartNew

Initializes a new System.Diagnostics.Stopwatch instance, sets the elapsed time property to zero, and starts measuring elapsed time.

Returns

A System.Diagnostics.Stopwatch that has just begun measuring elapsed time.

System.Diagnostics.Stopwatch.Stop

Stops measuring elapsed time for an interval.

System.Diagnostics.Stopwatch.ToString

Returns the System.Diagnostics.Stopwatch.Elapsed time as a string.

Returns

The elapsed time string in the same format used by System.TimeSpan.ToString.

System.Diagnostics.Stopwatch.Elapsed

Gets the total elapsed time measured by the current instance.

Returns

A read-only System.TimeSpan representing the total elapsed time measured by the current instance.

System.Diagnostics.Stopwatch.ElapsedMilliseconds

Gets the total elapsed time measured by the current instance, in milliseconds.

Returns

A read-only long integer representing the total number of milliseconds measured by the current instance.

System.Diagnostics.Stopwatch.ElapsedTicks

Gets the total elapsed time measured by the current instance, in timer ticks.

Returns

A read-only long integer representing the total number of timer ticks measured by the current instance.

System.Diagnostics.Stopwatch.IsRunning

Gets a value indicating whether the System.Diagnostics.Stopwatch timer is running.

Returns

true if the System.Diagnostics.Stopwatch instance is currently running and measuring elapsed time for an interval; otherwise, false.

System.Diagnostics.UnreachableException

The exception that is thrown when the program executes an instruction that was thought to be unreachable.

System.Diagnostics.UnreachableException.#ctor

Initializes a new instance of the System.Diagnostics.UnreachableException class with the default error message.

System.Diagnostics.UnreachableException.#ctor()

Initializes a new instance of the System.Diagnostics.UnreachableException class with a specified error message.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.

System.Diagnostics.UnreachableException.#ctor()

Initializes a new instance of the System.Diagnostics.UnreachableException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception.

System.DivideByZeroException

The exception that is thrown when there is an attempt to divide an integral or System.Decimal value by zero.

System.DivideByZeroException.#ctor

Initializes a new instance of the System.DivideByZeroException class.

System.DivideByZeroException.#ctor()

Initializes a new instance of the System.DivideByZeroException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.DivideByZeroException.#ctor()

Initializes a new instance of the System.DivideByZeroException class with a specified error message.

Parameters

NameDescriptionDefault
message A System.String that describes the error.

System.DivideByZeroException.#ctor()

Initializes a new instance of the System.DivideByZeroException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.Double

Represents a double-precision floating-point number.

System.Double.E

Represents the natural logarithmic base, specified by the constant, e.

System.Double.Epsilon

Represents the smallest positive System.Double value that is greater than zero. This field is constant.

System.Double.MaxValue

Represents the largest possible value of a System.Double. This field is constant.

System.Double.MinValue

Represents the smallest possible value of a System.Double. This field is constant.

System.Double.NaN

Represents a value that is not a number (NaN). This field is constant.

System.Double.NegativeInfinity

Represents negative infinity. This field is constant.

System.Double.NegativeZero

Represents the number negative zero (-0).

System.Double.Pi

Represents the ratio of the circumference of a circle to its diameter, specified by the constant, π.

System.Double.PositiveInfinity

Represents positive infinity. This field is constant.

System.Double.Tau

Represents the number of radians in one turn, specified by the constant, Ļ„.

System.Double.Abs()

Computes the absolute of a value.

Parameters

NameDescriptionDefault
value The value for which to get its absolute.

Returns

The absolute of
value
.

System.Double.Acos()

Computes the arc-cosine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose arc-cosine is to be computed.

Returns

The arc-cosine of
x
.

System.Double.Acosh()

Computes the hyperbolic arc-cosine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic arc-cosine is to be computed.

Returns

The hyperbolic arc-cosine of
x
.

System.Double.AcosPi()

Computes the arc-cosine of a value and divides the result by
pi
.

Parameters

NameDescriptionDefault
x The value whose arc-cosine is to be computed.

Returns

The arc-cosine of
x
, divided by
pi
.

System.Double.Asin()

Computes the arc-sine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose arc-sine is to be computed.

Returns

The arc-sine of
x
.

System.Double.Asinh()

Computes the hyperbolic arc-sine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic arc-sine is to be computed.

Returns

The hyperbolic arc-sine of
x
.

System.Double.AsinPi()

Computes the arc-sine of a value and divides the result by
pi
.

Parameters

NameDescriptionDefault
x The value whose arc-sine is to be computed.

Returns

The arc-sine of
x
, divided by
pi
.

System.Double.Atan()

Computes the arc-tangent of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose arc-tangent is to be computed.

Returns

The arc-tangent of
x
.

System.Double.Atan2()

Computes the arc-tangent of the quotient of two values.

Parameters

NameDescriptionDefault
y The y-coordinate of a point.
x The x-coordinate of a point.

Returns

The arc-tangent of
y
divided-by
x
.

System.Double.Atan2Pi()

Computes the arc-tangent for the quotient of two values and divides the result by
pi
.

Parameters

NameDescriptionDefault
y The y-coordinate of a point.
x The x-coordinate of a point.

Returns

The arc-tangent of
y
divided-by
x
, divided by
pi
.

System.Double.Atanh()

Computes the hyperbolic arc-tangent of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic arc-tangent is to be computed.

Returns

The hyperbolic arc-tangent of
x
.

System.Double.AtanPi()

Computes the arc-tangent of a value and divides the result by pi.

Parameters

NameDescriptionDefault
x The value whose arc-tangent is to be computed.

Returns

The arc-tangent of
x
, divided by
pi
.

System.Double.BitDecrement()

Decrements a value to the smallest value that compares less than a given value.

Parameters

NameDescriptionDefault
x The value to be bitwise decremented.

Returns

The smallest value that compares less than
x
.

System.Double.BitIncrement()

Increments a value to the smallest value that compares greater than a given value.

Parameters

NameDescriptionDefault
x The value to be bitwise incremented.

Returns

The smallest value that compares greater than
x
.

System.Double.Cbrt()

Computes the cube-root of a value.

Parameters

NameDescriptionDefault
x The value whose cube-root is to be computed.

Returns

The cube-root of
x
.

System.Double.Ceiling()

Computes the ceiling of a value.

Parameters

NameDescriptionDefault
x The value whose ceiling is to be computed.

Returns

The ceiling of
x
.

System.Double.Clamp()

Clamps a value to an inclusive minimum and maximum value.

Parameters

NameDescriptionDefault
value The value to clamp.
min The inclusive minimum to which
value
should clamp.
max The inclusive maximum to which
value
should clamp.

Returns

The result of clamping
value
to the inclusive range of
min
and
max
.

System.Double.CompareTo()

Compares this instance to a specified double-precision floating-point number and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified double-precision floating-point number.

Parameters

NameDescriptionDefault
value A double-precision floating-point number to compare.

Returns

A signed number indicating the relative values of this instance and value. Return Value Description Less than zero This instance is less than value, or this instance is not a number (System.Double.NaN) and value is a number. Zero This instance is equal to value, or both this instance and value are not a number (System.Double.NaN), System.Double.PositiveInfinity, or System.Double.NegativeInfinity. Greater than zero This instance is greater than value, or this instance is a number and value is not a number (System.Double.NaN).

System.Double.CompareTo()

Compares this instance to a specified object and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified object.

Parameters

NameDescriptionDefault
value An object to compare, or null.

Returns

A signed number indicating the relative values of this instance and value. Value Description A negative integer This instance is less than value, or this instance is not a number (System.Double.NaN) and value is a number. Zero This instance is equal to value, or this instance and value are both Double.NaN, System.Double.PositiveInfinity, or System.Double.NegativeInfinity A positive integer This instance is greater than value, OR this instance is a number and value is not a number (System.Double.NaN), OR value is null.

System.Double.CopySign()

Copies the sign of a value to the sign of another value.

Parameters

NameDescriptionDefault
value The value whose magnitude is used in the result.
sign The value whose sign is used in the result.

Returns

A value with the magnitude of
value
and the sign of
sign
.

System.Double.Cos()

Computes the cosine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose cosine is to be computed.

Returns

The cosine of
x
.

System.Double.Cosh()

Computes the hyperbolic cosine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic cosine is to be computed.

Returns

The hyperbolic cosine of
x
.

System.Double.CosPi()

Computes the cosine of a value that has been multipled by
pi
.

Parameters

NameDescriptionDefault
x The value, in half-revolutions, whose cosine is to be computed.

Returns

The cosine of
x
multiplied-by
pi
.

System.Double.CreateChecked``1()

Creates an instance of the current type from a value, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
.

System.Double.CreateSaturating``1()

Creates an instance of the current type from a value, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, saturating if
value
falls outside the representable range of
TSelf
.

System.Double.CreateTruncating``1()

Creates an instance of the current type from a value, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, truncating if
value
falls outside the representable range of
TSelf
.

System.Double.DegreesToRadians()

Converts a given value from degrees to radians.

Parameters

NameDescriptionDefault
degrees The value to convert to radians.

Returns

The value of
degrees
converted to radians.

System.Double.Equals()

Returns a value indicating whether this instance and a specified System.Double object represent the same value.

Parameters

NameDescriptionDefault
obj A System.Double object to compare to this instance.

Returns

true if obj is equal to this instance; otherwise, false.

System.Double.Equals()

Returns a value indicating whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance.

Returns

true if obj is an instance of System.Double and equals the value of this instance; otherwise, false.

System.Double.Exp()

Computes
E
raised to a given power.

Parameters

NameDescriptionDefault
x The power to which
E
is raised.

Returns

E
raised to the power of
x
.

System.Double.Exp10()

Computes
10
raised to a given power.

Parameters

NameDescriptionDefault
x The power to which
10
is raised.

Returns

10x

System.Double.Exp10M1()

Computes
10
raised to a given power and subtracts one.

Parameters

NameDescriptionDefault
x The power to which
10
is raised.

Returns

10x - 1

System.Double.Exp2()

Computes
2
raised to a given power.

Parameters

NameDescriptionDefault
x The power to which
2
is raised.

Returns

2x

System.Double.Exp2M1()

Computes
2
raised to a given power and subtracts one.

Parameters

NameDescriptionDefault
x The power to which
2
is raised.

Returns

2x - 1

System.Double.ExpM1()

Computes
E
raised to a given power and subtracts one.

Parameters

NameDescriptionDefault
x The power to which
E
is raised.

Returns

Ex - 1

System.Double.Floor()

Computes the floor of a value.

Parameters

NameDescriptionDefault
x The value whose floor is to be computed.

Returns

The floor of
x
.

System.Double.FusedMultiplyAdd()

Computes the fused multiply-add of three values.

Parameters

NameDescriptionDefault
left The value which
right
multiplies.
right The value which multiplies
left
.
addend The value that is added to the product of
left
and
right
.

Returns

The result of
left
times
right
plus
addend
computed as one ternary operation.

System.Double.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Double.GetTypeCode

Returns the System.TypeCode for value type System.Double.

Returns

The enumerated constant, System.TypeCode.Double.

System.Double.Hypot()

Computes the hypotenuse given two values representing the lengths of the shorter sides in a right-angled triangle.

Parameters

NameDescriptionDefault
x The value to square and add to
y
.
y The value to square and add to
x
.

Returns

The square root of
x
-squared plus
y
-squared.

System.Double.Ieee754Remainder()

Computes the remainder of two values as specified by IEEE 754.

Parameters

NameDescriptionDefault
left The value which
right
divides.
right The value which divides
left
.

Returns

The remainder of
left
divided-by
right
as specified by IEEE 754.

System.Double.ILogB()

Computes the integer logarithm of a value.

Parameters

NameDescriptionDefault
x The value whose integer logarithm is to be computed.

Returns

The integer logarithm of
x
.

System.Double.IsEvenInteger()

Determines if a value represents an even integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an even integer; otherwise,
false
.

System.Double.IsFinite()

Determines whether the specified value is finite (zero, subnormal, or normal).

Parameters

NameDescriptionDefault
d A double-precision floating-point number.

Returns

true if the value is finite (zero, subnormal or normal); false otherwise.

System.Double.IsInfinity()

Returns a value indicating whether the specified number evaluates to negative or positive infinity.

Parameters

NameDescriptionDefault
d A double-precision floating-point number.

Returns

System.Double.IsInteger()

Determines if a value represents an integral value.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an integer; otherwise,
false
.

System.Double.IsNaN()

Returns a value that indicates whether the specified value is not a number (System.Double.NaN).

Parameters

NameDescriptionDefault
d A double-precision floating-point number.

Returns

true if d evaluates to System.Double.NaN; otherwise, false.

System.Double.IsNegative()

Determines whether the specified value is negative.

Parameters

NameDescriptionDefault
d A double-precision floating-point number.

Returns

true if the value is negative; false otherwise.

System.Double.IsNegativeInfinity()

Returns a value indicating whether the specified number evaluates to negative infinity.

Parameters

NameDescriptionDefault
d A double-precision floating-point number.

Returns

true if d evaluates to System.Double.NegativeInfinity; otherwise, false.

System.Double.IsNormal()

Determines whether the specified value is normal.

Parameters

NameDescriptionDefault
d A double-precision floating-point number.

Returns

true if the value is normal; false otherwise.

System.Double.IsOddInteger()

Determines if a value represents an odd integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an odd integer; otherwise,
false
.

System.Double.IsPositive()

Determines if a value is positive.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is positive; otherwise,
false
.

System.Double.IsPositiveInfinity()

Returns a value indicating whether the specified number evaluates to positive infinity.

Parameters

NameDescriptionDefault
d A double-precision floating-point number.

Returns

true if d evaluates to System.Double.PositiveInfinity; otherwise, false.

System.Double.IsPow2()

Determines if a value is a power of two.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is a power of two; otherwise,
false
.

System.Double.IsRealNumber()

Determines if a value represents a real number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is a real number; otherwise,
false
.

System.Double.IsSubnormal()

Determines whether the specified value is subnormal.

Parameters

NameDescriptionDefault
d A double-precision floating-point number.

Returns

true if the value is subnormal; false otherwise.

System.Double.Lerp()

Performs a linear interpolation between two values based on the given weight.

Parameters

NameDescriptionDefault
value1 The first value, which is intended to be the lower bound.
value2 The second value, which is intended to be the upper bound.
amount A value, intended to be between 0 and 1, that indicates the weight of the interpolation.

Returns

The interpolated value.

System.Double.Log()

Computes the natural (
base-E
logarithm of a value.

Parameters

NameDescriptionDefault
x The value whose natural logarithm is to be computed.

Returns

The natural logarithm of
x
.

System.Double.Log()

Computes the logarithm of a value in the specified base.

Parameters

NameDescriptionDefault
x The value whose logarithm is to be computed.
newBase The base in which the logarithm is to be computed.

Returns

The base-
newBase
logarithm of
x
.

System.Double.Log10()

Computes the base-10 logarithm of a value.

Parameters

NameDescriptionDefault
x The value whose base-10 logarithm is to be computed.

Returns

The base-10 logarithm of
x
.

System.Double.Log10P1()

Computes the base-10 logarithm of a value plus one.

Parameters

NameDescriptionDefault
x The value to which one is added before computing the base-10 logarithm.

Returns

log10(x + 1)

System.Double.Log2()

Computes the log2 of a value.

Parameters

NameDescriptionDefault
value The value whose log2 is to be computed.

Returns

The log2 of
value
.

System.Double.Log2P1()

Computes the base-2 logarithm of a value plus one.

Parameters

NameDescriptionDefault
x The value to which one is added before computing the base-2 logarithm.

Returns

log2(x + 1)

System.Double.LogP1()

Computes the natural (
base-E
) logarithm of a value plus one.

Parameters

NameDescriptionDefault
x The value to which one is added before computing the natural logarithm.

Returns

loge(x + 1)

System.Double.Max()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Double.MaxMagnitude()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Double.MaxMagnitudeNumber()

Compares two values to compute which has the greater magnitude and returning the other value if an input is
NaN
.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Double.MaxNumber()

Compares two values to compute which is greater and returning the other value if an input is
NaN
.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Double.Min()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Double.MinMagnitude()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Double.MinMagnitudeNumber()

Compares two values to compute which has the lesser magnitude and returning the other value if an input is
NaN
.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Double.MinNumber()

Compares two values to compute which is lesser and returning the other value if an input is
NaN
.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Double.op_Equality()

Returns a value that indicates whether two specified values are equal.

Parameters

NameDescriptionDefault
left The first value to compare.
right The second value to compare.

Returns

true
if
left
and
right
are equal; otherwise,
false
.

System.Double.op_GreaterThan()

Returns a value that indicates whether a specified value is greater than another specified value.

Parameters

NameDescriptionDefault
left The first value to compare.
right The second value to compare.

Returns

true
if
left
is greater than
right
; otherwise,
false
.

System.Double.op_GreaterThanOrEqual()

Returns a value that indicates whether a specified value is greater than or equal to another specified value.

Parameters

NameDescriptionDefault
left The first value to compare.
right The second value to compare.

Returns

true
if
left
is greater than or equal to
right
; otherwise,
false
.

System.Double.op_Inequality()

Returns a value that indicates whether two specified values are not equal.

Parameters

NameDescriptionDefault
left The first value to compare.
right The second value to compare.

Returns

true
if
left
and
right
are not equal; otherwise,
false
.

System.Double.op_LessThan()

Returns a value that indicates whether a specified value is less than another specified value.

Parameters

NameDescriptionDefault
left The first value to compare.
right The second value to compare.

Returns

true
if
left
is less than
right
; otherwise,
false
.

System.Double.op_LessThanOrEqual()

Returns a value that indicates whether a specified value is less than or equal to another specified value.

Parameters

NameDescriptionDefault
left The first value to compare.
right The second value to compare.

Returns

true
if
left
is less than or equal to
right
; otherwise,
false
.

System.Double.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.Double.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.Double.Parse()

Converts a character span that contains the string representation of a number in a specified style and culture-specific format to its double-precision floating-point number equivalent.

Parameters

NameDescriptionDefault
s A character span that contains the number to convert.
style A bitwise combination of enumeration values that indicate the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Float combined with System.Globalization.NumberStyles.AllowThousands.
provider An object that supplies culture-specific formatting information about s.

Returns

A double-precision floating-point number that is equivalent to the numeric value or symbol specified in s.

System.Double.Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.

Returns

The result of parsing
s
.

System.Double.Parse()

Converts the string representation of a number to its double-precision floating-point number equivalent.

Parameters

NameDescriptionDefault
s A string that contains a number to convert.

Returns

A double-precision floating-point number that is equivalent to the numeric value or symbol specified in s.

System.Double.Parse()

Converts the string representation of a number in a specified style to its double-precision floating-point number equivalent.

Parameters

NameDescriptionDefault
s A string that contains a number to convert.
style A bitwise combination of enumeration values that indicate the style elements that can be present in s. A typical value to specify is a combination of System.Globalization.NumberStyles.Float combined with System.Globalization.NumberStyles.AllowThousands.

Returns

A double-precision floating-point number that is equivalent to the numeric value or symbol specified in s.

System.Double.Parse()

Converts the string representation of a number in a specified style and culture-specific format to its double-precision floating-point number equivalent.

Parameters

NameDescriptionDefault
s A string that contains a number to convert.
style A bitwise combination of enumeration values that indicate the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Float combined with System.Globalization.NumberStyles.AllowThousands.
provider An object that supplies culture-specific formatting information about s.

Returns

A double-precision floating-point number that is equivalent to the numeric value or symbol specified in s.

System.Double.Parse()

Converts the string representation of a number in a specified culture-specific format to its double-precision floating-point number equivalent.

Parameters

NameDescriptionDefault
s A string that contains a number to convert.
provider An object that supplies culture-specific formatting information about s.

Returns

A double-precision floating-point number that is equivalent to the numeric value or symbol specified in s.

System.Double.Pow()

Computes a value raised to a given power.

Parameters

NameDescriptionDefault
x The value which is raised to the power of
x
.
y The power to which
x
is raised.

Returns

x
raised to the power of
y
.

System.Double.RadiansToDegrees()

Converts a given value from radians to degrees.

Parameters

NameDescriptionDefault
radians The value to convert to degrees.

Returns

The value of
radians
converted to degrees.

System.Double.ReciprocalEstimate()

Computes an estimate of the reciprocal of a value.

Parameters

NameDescriptionDefault
x The value whose estimate of the reciprocal is to be computed.

Returns

An estimate of the reciprocal of
x
.

System.Double.ReciprocalSqrtEstimate()

Computes an estimate of the reciprocal square root of a value.

Parameters

NameDescriptionDefault
x The value whose estimate of the reciprocal square root is to be computed.

Returns

An estimate of the reciprocal square root of
x
.

System.Double.RootN()

Computes the n-th root of a value.

Parameters

NameDescriptionDefault
x The value whose
n
-th root is to be computed.
n The degree of the root to be computed.

Returns

The
n
-th root of
x
.

System.Double.Round()

Rounds a value to the nearest integer using the default rounding mode ().

Parameters

NameDescriptionDefault
x The value to round.

Returns

The result of rounding
x
to the nearest integer using the default rounding mode.

System.Double.Round()

Rounds a value to a specified number of fractional-digits using the default rounding mode ().

Parameters

NameDescriptionDefault
x The value to round.
digits The number of fractional digits to which
x
should be rounded.

Returns

The result of rounding
x
to
digits
fractional-digits using the default rounding mode.

System.Double.Round()

Rounds a value to a specified number of fractional-digits using the default rounding mode ().

Parameters

NameDescriptionDefault
x The value to round.
digits The number of fractional digits to which
x
should be rounded.
mode The mode under which
x
should be rounded.

Returns

The result of rounding
x
to
digits
fractional-digits using
mode
.

System.Double.Round()

Rounds a value to the nearest integer using the specified rounding mode.

Parameters

NameDescriptionDefault
x The value to round.
mode The mode under which
x
should be rounded.

Returns

The result of rounding
x
to the nearest integer using
mode
.

System.Double.ScaleB()

Computes the product of a value and its base-radix raised to the specified power.

Parameters

NameDescriptionDefault
x The value which base-radix raised to the power of
n
multiplies.
n The value to which base-radix is raised before multipliying
x
.

Returns

The product of
x
and base-radix raised to the power of
n
.

System.Double.Sign()

Computes the sign of a value.

Parameters

NameDescriptionDefault
value The value whose sign is to be computed.

Returns

A positive value if
value
is positive, if
value
is zero, and a negative value if
value
is negative.

System.Double.Sin()

Computes the sine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose sine is to be computed.

Returns

The sine of
x
.

System.Double.SinCos()

Computes the sine and cosine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose sine and cosine are to be computed.

Returns

The sine and cosine of
x
.

System.Double.SinCosPi()

Computes the sine and cosine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose sine and cosine are to be computed.

Returns

The sine and cosine of
x
.

System.Double.Sinh()

Computes the hyperbolic sine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic sine is to be computed.

Returns

The hyperbolic sine of
x
.

System.Double.SinPi()

Computes the sine of a value that has been multiplied by
pi
.

Parameters

NameDescriptionDefault
x The value, in half-revolutions, that is multipled by
pi
before computing its sine.

Returns

The sine of
x
multiplied-by
pi
.

System.Double.Sqrt()

Computes the square-root of a value.

Parameters

NameDescriptionDefault
x The value whose square-root is to be computed.

Returns

The square-root of
x
.

System.Double.System#IConvertible#ToBoolean()

For a description of this member, see System.IConvertible.ToBoolean().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

true if the value of the current instance is not zero; otherwise, false.

System.Double.System#IConvertible#ToByte()

For a description of this member, see System.IConvertible.ToByte().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Byte.

System.Double.System#IConvertible#ToChar()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

This conversion is not supported. No value is returned.

System.Double.System#IConvertible#ToDateTime()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

This conversion is not supported. No value is returned.

System.Double.System#IConvertible#ToDecimal()

For a description of this member, see System.IConvertible.ToDecimal().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Decimal.

System.Double.System#IConvertible#ToDouble()

For a description of this member, see System.IConvertible.ToDouble().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, unchanged.

System.Double.System#IConvertible#ToInt16()

For a description of this member, see System.IConvertible.ToInt16().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.Int16.

System.Double.System#IConvertible#ToInt32()

For a description of this member, see System.IConvertible.ToInt32().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.Int32.

System.Double.System#IConvertible#ToInt64()

For a description of this member, see System.IConvertible.ToInt64().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.Int64.

System.Double.System#IConvertible#ToSByte()

For a description of this member, see System.IConvertible.ToSByte().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.SByte.

System.Double.System#IConvertible#ToSingle()

For a description of this member, see System.IConvertible.ToSingle().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Single.

System.Double.System#IConvertible#ToType()

For a description of this member, see System.IConvertible.ToType().

Parameters

NameDescriptionDefault
type The type to which to convert this System.Double value.
provider An System.IFormatProvider implementation that supplies culture-specific information about the format of the returned value.

Returns

The value of the current instance, converted to type.

System.Double.System#IConvertible#ToUInt16()

For a description of this member, see System.IConvertible.ToUInt16().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt16.

System.Double.System#IConvertible#ToUInt32()

For a description of this member, see System.IConvertible.ToUInt32().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt32.

System.Double.System#IConvertible#ToUInt64()

For a description of this member, see System.IConvertible.ToUInt64().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt64.

System.Double.System#Numerics#IAdditionOperators{System#Double@System#Double@System#Double}#op_Addition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which right is added.
right The value that's added to left.

Returns

The sum of left and right.

System.Double.System#Numerics#IBitwiseOperators{System#Double@System#Double@System#Double}#op_BitwiseAnd()

Computes the bitwise-and of two values.

Parameters

NameDescriptionDefault
left The value to and with right.
right The value to and with left.

Returns

The bitwise-and of left and right.

System.Double.System#Numerics#IBitwiseOperators{System#Double@System#Double@System#Double}#op_BitwiseOr()

Computes the bitwise-or of two values.

Parameters

NameDescriptionDefault
left The value to or with right.
right The value to or with left.

Returns

The bitwise-or of left and right.

System.Double.System#Numerics#IBitwiseOperators{System#Double@System#Double@System#Double}#op_ExclusiveOr()

Computes the exclusive-or of two values.

Parameters

NameDescriptionDefault
left The value to xor with right.
right The value to xor with left.

Returns

The exclusive-or of left and right.

System.Double.System#Numerics#IBitwiseOperators{System#Double@System#Double@System#Double}#op_OnesComplement()

Computes the ones-complement representation of a given value.

Parameters

NameDescriptionDefault
value The value for which to compute the ones-complement.

Returns

The ones-complement of value.

System.Double.System#Numerics#IDecrementOperators{System#Double}#op_Decrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing value.

System.Double.System#Numerics#IDivisionOperators{System#Double@System#Double@System#Double}#op_Division()

Divides one value by another to compute their quotient.

Parameters

NameDescriptionDefault
left The value that right divides.
right The value that divides left.

Returns

The quotient of left divided by right.

System.Double.System#Numerics#IFloatingPoint<System#Double>#GetExponentByteCount

Gets the number of bytes that will be written as part of .

Returns

The number of bytes that will be written as part of .

System.Double.System#Numerics#IFloatingPoint<System#Double>#GetExponentShortestBitLength

Gets the length, in bits, of the shortest two's complement representation of the current exponent.

Returns

The length, in bits, of the shortest two's complement representation of the current exponent.

System.Double.System#Numerics#IFloatingPoint<System#Double>#GetSignificandBitLength

Gets the length, in bits, of the current significand.

Returns

The length, in bits, of the current significand.

System.Double.System#Numerics#IFloatingPoint<System#Double>#GetSignificandByteCount

Gets the number of bytes that will be written as part of .

Returns

The number of bytes that will be written as part of .

System.Double.System#Numerics#IFloatingPoint<System#Double>#TryWriteExponentBigEndian()

Tries to write the current exponent, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current exponent should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the exponent was succesfully written to
destination
; otherwise,
false
.

System.Double.System#Numerics#IFloatingPoint<System#Double>#TryWriteExponentLittleEndian()

Tries to write the current exponent, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current exponent should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the exponent was succesfully written to
destination
; otherwise,
false
.

System.Double.System#Numerics#IFloatingPoint<System#Double>#TryWriteSignificandBigEndian()

Tries to write the current significand, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current significand should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the significand was succesfully written to
destination
; otherwise,
false
.

System.Double.System#Numerics#IFloatingPoint<System#Double>#TryWriteSignificandLittleEndian()

Tries to write the current significand, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current significand should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the significand was succesfully written to
destination
; otherwise,
false
.

System.Double.System#Numerics#IIncrementOperators{System#Double}#op_Increment()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing value.

System.Double.System#Numerics#IModulusOperators{System#Double@System#Double@System#Double}#op_Modulus()

Divides two values together to compute their modulus or remainder.

Parameters

NameDescriptionDefault
left The value that right divides.
right The value that divides left.

Returns

The modulus or remainder of left divided by right.

System.Double.System#Numerics#IMultiplyOperators{System#Double@System#Double@System#Double}#op_Multiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value that right multiplies.
right The value that multiplies left.

Returns

The product of left multiplied by right.

System.Double.System#Numerics#INumberBase{System#Double}#IsCanonical()

Determines if a value is in its canonical representation.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is in its canonical representation; otherwise, false.

System.Double.System#Numerics#INumberBase{System#Double}#IsComplexNumber()

Determines if a value represents a complex number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a complex number; otherwise, false.

System.Double.System#Numerics#INumberBase{System#Double}#IsImaginaryNumber()

Determines if a value represents a pure imaginary number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a pure imaginary number; otherwise, false.

System.Double.System#Numerics#INumberBase{System#Double}#IsZero()

Determines if a value is zero.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is zero; otherwise, false.

System.Double.System#Numerics#INumberBase{System#Double}#TryConvertFromChecked``1()

Parameters

NameDescriptionDefault
value
result

System.Double.System#Numerics#INumberBase{System#Double}#TryConvertFromSaturating``1()

Parameters

NameDescriptionDefault
value
result

System.Double.System#Numerics#INumberBase{System#Double}#TryConvertFromTruncating``1()

Parameters

NameDescriptionDefault
value
result

System.Double.System#Numerics#INumberBase{System#Double}#TryConvertToChecked``1()

Tries to convert an instance of the the current type to another type, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Double.System#Numerics#INumberBase{System#Double}#TryConvertToSaturating``1()

Tries to convert an instance of the the current type to another type, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Double.System#Numerics#INumberBase{System#Double}#TryConvertToTruncating``1()

Tries to convert an instance of the the current type to another type, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Double.System#Numerics#ISubtractionOperators{System#Double@System#Double@System#Double}#op_Subtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which right is subtracted.
right The value that's subtracted from left.

Returns

The value of right subtracted from left.

System.Double.System#Numerics#IUnaryNegationOperators{System#Double@System#Double}#op_UnaryNegation()

Computes the unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of value.

System.Double.System#Numerics#IUnaryPlusOperators{System#Double@System#Double}#op_UnaryPlus()

Computes the unary plus of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary plus.

Returns

The unary plus of value.

System.Double.Tan()

Computes the tangent of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose tangent is to be computed.

Returns

The tangent of
x
.

System.Double.Tanh()

Computes the hyperbolic tangent of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic tangent is to be computed.

Returns

The hyperbolic tangent of
x
.

System.Double.TanPi()

Computes the tangent of a value that has been multipled by
pi
.

Parameters

NameDescriptionDefault
x The value, in half-revolutions, that is multipled by
pi
before computing its tangent.

Returns

The tangent of
x
multiplied-by
pi
.

System.Double.ToString

Converts the numeric value of this instance to its equivalent string representation.

Returns

The string representation of the value of this instance.

System.Double.ToString()

Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

The string representation of the value of this instance as specified by provider.

System.Double.ToString()

Converts the numeric value of this instance to its equivalent string representation, using the specified format.

Parameters

NameDescriptionDefault
format A numeric format string.

Returns

The string representation of the value of this instance as specified by format.

System.Double.ToString()

Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information.

Parameters

NameDescriptionDefault
format A numeric format string.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of the value of this instance as specified by format and provider.

System.Double.Truncate()

Truncates a value.

Parameters

NameDescriptionDefault
x The value to truncate.

Returns

The truncation of
x
.

System.Double.TryFormat()

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

Parameters

NameDescriptionDefault
utf8Destination The span in which to write this instance's value formatted as a span of bytes.
bytesWritten When this method returns, contains the number of bytes that were written in
utf8Destination
.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for
utf8Destination
.
provider An optional object that supplies culture-specific formatting information for
utf8Destination
.

Returns

true
if the formatting was successful; otherwise,
false
.

System.Double.TryFormat()

Tries to format the value of the current double instance into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span in which to write this instance's value formatted as a span of characters.
charsWritten When this method returns, contains the number of characters that were written in destination.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for destination.
provider An optional object that supplies culture-specific formatting information for destination.

Returns

true if the formatting was successful; otherwise, false.

System.Double.TryParse()

Tries to convert a UTF-8 character span containing the string representation of a number to its double-precision floating-point number equivalent.

Parameters

NameDescriptionDefault
utf8Text A read-only UTF-8 character span that contains the number to convert.
result When this method returns, contains a double-precision floating-point number equivalent of the numeric value or symbol contained in utf8Text if the conversion succeeded or zero if the conversion failed. The conversion fails if the utf8Text is System.ReadOnlySpan`1.Empty or is not in a valid format. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if utf8Text was converted successfully; otherwise, false.

System.Double.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.Double.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.Double.TryParse()

Converts the span representation of a number in a specified style and culture-specific format to its double-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A character span that contains the string representation of the number to convert.
result When this method returns, contains the double-precision floating-point number equivalent of the numeric value or symbol contained in s parameter, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or empty, or is not in a format compliant with style. The conversion also fails if style is not a valid combination of System.Globalization.NumberStyles enumerated constants. If s is a valid number less than Double.MinValue, result is System.Double.NegativeInfinity. If s is a valid number greater than Double.MaxValue, result is System.Double.PositiveInfinity. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Double.TryParse()

Converts a character span containing the string representation of a number in a specified style and culture-specific format to its double-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A read-only character span that contains the number to convert.
style A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s. A typical value to specify is System.Globalization.NumberStyles.Float combined with System.Globalization.NumberStyles.AllowThousands.
provider An object that supplies culture-specific formatting information about s.
result When this method returns and if the conversion succeeded, contains a double-precision floating-point number equivalent of the numeric value or symbol contained in s. Contains zero if the conversion failed. The conversion fails if the s parameter is null, an empty character span, or not a number in a format compliant with style. If s is a valid number less than Double.MinValue, result is System.Double.NegativeInfinity. If s is a valid number greater than Double.MaxValue, result is System.Double.PositiveInfinity. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Double.TryParse()

Tries to parse a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
, or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Double.TryParse()

Converts the string representation of a number to its double-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
result When this method returns, contains the double-precision floating-point number equivalent of the s parameter, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or System.String.Empty or is not a number in a valid format. It also fails on .NET Framework and .NET Core 2.2 and earlier versions if s represents a number less than Double.MinValue or greater than Double.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Double.TryParse()

Converts the string representation of a number in a specified style and culture-specific format to its double-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
style A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s. A typical value to specify is System.Globalization.NumberStyles.Float combined with System.Globalization.NumberStyles.AllowThousands.
provider An System.IFormatProvider that supplies culture-specific formatting information about s.
result When this method returns, contains a double-precision floating-point number equivalent of the numeric value or symbol contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or System.String.Empty or is not in a format compliant with style, or if style is not a valid combination of System.Globalization.NumberStyles enumeration constants. It also fails on .NET Framework or .NET Core 2.2 and earlier versions if s represents a number less than SByte.MinValue or greater than SByte.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Double.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Double.System#Numerics#IAdditiveIdentity{System#Double@System#Double}#AdditiveIdentity

Gets the additive identity of the current type.

System.Double.System#Numerics#IBinaryNumber{System#Double}#AllBitsSet

Gets an instance of the binary type in which all bits are set.

System.Double.System#Numerics#IFloatingPointConstants{System#Double}#E

Gets the mathematical constant e.

System.Double.System#Numerics#IFloatingPointConstants{System#Double}#Pi

Gets the mathematical constant pi.

System.Double.System#Numerics#IFloatingPointConstants{System#Double}#Tau

Gets the mathematical constant tau.

System.Double.System#Numerics#IFloatingPointIeee754{System#Double}#Epsilon

Gets the smallest value such that can be added to 0 that does not result in 0.

System.Double.System#Numerics#IFloatingPointIeee754{System#Double}#NaN

Gets a value that represents NaN.

System.Double.System#Numerics#IFloatingPointIeee754{System#Double}#NegativeInfinity

Gets a value that represents negative infinity.

System.Double.System#Numerics#IFloatingPointIeee754{System#Double}#NegativeZero

Gets a value that represents negative zero.

System.Double.System#Numerics#IFloatingPointIeee754{System#Double}#PositiveInfinity

Gets a value that represents positive infinity.

System.Double.System#Numerics#IMinMaxValue{System#Double}#MaxValue

Gets the maximum value of the current type.

System.Double.System#Numerics#IMinMaxValue{System#Double}#MinValue

Gets the minimum value of the current type.

System.Double.System#Numerics#IMultiplicativeIdentity{System#Double@System#Double}#MultiplicativeIdentity

Gets the multiplicative identity of the current type.

System.Double.System#Numerics#INumberBase{System#Double}#One

Gets the value 1 for the type.

System.Double.System#Numerics#INumberBase{System#Double}#Radix

Gets the radix, or base, for the type.

System.Double.System#Numerics#INumberBase{System#Double}#Zero

Gets the value 0 for the type.

System.Double.System#Numerics#ISignedNumber{System#Double}#NegativeOne

Gets the value -1 for the type.

System.DuplicateWaitObjectException

The exception that is thrown when an object appears more than once in an array of synchronization objects.

System.DuplicateWaitObjectException.#ctor

Initializes a new instance of the System.DuplicateWaitObjectException class.

System.DuplicateWaitObjectException.#ctor()

Initializes a new instance of the System.DuplicateWaitObjectException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.DuplicateWaitObjectException.#ctor()

Initializes a new instance of the System.DuplicateWaitObjectException class with the name of the parameter that causes this exception.

Parameters

NameDescriptionDefault
parameterName The name of the parameter that caused the exception.

System.DuplicateWaitObjectException.#ctor()

Initializes a new instance of the System.DuplicateWaitObjectException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.DuplicateWaitObjectException.#ctor()

Initializes a new instance of the System.DuplicateWaitObjectException class with a specified error message and the name of the parameter that causes this exception.

Parameters

NameDescriptionDefault
parameterName The name of the parameter that caused the exception.
message The message that describes the error.

System.EntryPointNotFoundException

The exception that is thrown when an attempt to load a class fails due to the absence of an entry method.

System.EntryPointNotFoundException.#ctor

Initializes a new instance of the System.EntryPointNotFoundException class.

System.EntryPointNotFoundException.#ctor()

Initializes a new instance of the System.EntryPointNotFoundException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.EntryPointNotFoundException.#ctor()

Initializes a new instance of the System.EntryPointNotFoundException class with a specified error message.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.

System.EntryPointNotFoundException.#ctor()

Initializes a new instance of the System.EntryPointNotFoundException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
inner The exception that is the cause of the current exception. If the inner parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.Enum

Provides the base class for enumerations.

System.Enum.#ctor

Initializes a new instance of the System.Enum class.

System.Enum.CompareTo()

Compares this instance to a specified object and returns an indication of their relative values.

Parameters

NameDescriptionDefault
target An object to compare, or
null
.

Returns

A signed number that indicates the relative values of this instance and
target
. Value Meaning Less than zero The value of this instance is less than the value of
target
. Zero The value of this instance is equal to the value of
target
. Greater than zero The value of this instance is greater than the value of
target
, or
target
is
null
.

System.Enum.Equals()

Returns a value indicating whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance, or
null
.

Returns

true
if
obj
is an enumeration value of the same type and with the same underlying value as this instance; otherwise,
false
.

System.Enum.Format()

Converts the specified value of a specified enumerated type to its equivalent string representation according to the specified format.

Parameters

NameDescriptionDefault
enumType The enumeration type of the value to convert.
value The value to convert.
format The output format to use.

Returns

A string representation of value.

System.Enum.GetHashCode

Returns the hash code for the value of this instance.

Returns

A 32-bit signed integer hash code.

System.Enum.GetName()

Retrieves the name of the constant in the specified enumeration that has the specified value.

Parameters

NameDescriptionDefault
enumType An enumeration type.
value The value of a particular enumerated constant in terms of its underlying type.

Returns

A string containing the name of the enumerated constant in enumType whose value is value; or null if no such constant is found.

System.Enum.GetName``1()

Retrieves the name of the constant in the specified enumeration type that has the specified value.

Parameters

NameDescriptionDefault
value The value of a particular enumerated constant in terms of its underlying type.

Returns

A string containing the name of the enumerated constant in whose value is value; or null if no such constant is found.

System.Enum.GetNames()

Retrieves an array of the names of the constants in a specified enumeration.

Parameters

NameDescriptionDefault
enumType An enumeration type.

Returns

A string array of the names of the constants in enumType.

System.Enum.GetNames``1

Retrieves an array of the names of the constants in a specified enumeration type.

Returns

A string array of the names of the constants in .

System.Enum.GetTypeCode

Returns the type code of the underlying type of this enumeration member.

Returns

The type code of the underlying type of this instance.

System.Enum.GetUnderlyingType()

Returns the underlying type of the specified enumeration.

Parameters

NameDescriptionDefault
enumType The enumeration whose underlying type will be retrieved.

Returns

The underlying type of enumType.

System.Enum.GetValues()

Retrieves an array of the values of the constants in a specified enumeration.

Parameters

NameDescriptionDefault
enumType An enumeration type.

Returns

An array that contains the values of the constants in enumType.

System.Enum.GetValues``1

Retrieves an array of the values of the constants in a specified enumeration type.

Returns

An array that contains the values of the constants in .

System.Enum.GetValuesAsUnderlyingType()

Retrieves an array of the values of the underlying type constants in a specified enumeration.

Parameters

NameDescriptionDefault
enumType An enumeration type.

Returns

An array that contains the values of the underlying type constants in enumType.

System.Enum.GetValuesAsUnderlyingType``1

Retrieves an array of the values of the underlying type constants in a specified enumeration type.

Returns

An array that contains the values of the underlying type constants in .

System.Enum.HasFlag()

Determines whether one or more bit fields are set in the current instance.

Parameters

NameDescriptionDefault
flag An enumeration value.

Returns

true if the bit field or bit fields that are set in flag are also set in the current instance; otherwise, false.

System.Enum.IsDefined()

Returns a Boolean telling whether a given integral value, or its name as a string, exists in a specified enumeration.

Parameters

NameDescriptionDefault
enumType An enumeration type.
value The value or name of a constant in enumType.

Returns

true if a constant in enumType has a value equal to value; otherwise, false.

System.Enum.IsDefined``1()

Returns a boolean telling whether a given integral value, or its name as a string, exists in a specified enumeration.

Parameters

NameDescriptionDefault
value The value or name of a constant in .

Returns

true if a given integral value, or its name as a string, exists in a specified enumeration; false otherwise.

System.Enum.Parse()

Converts the span of characters representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object.

Parameters

NameDescriptionDefault
enumType An enumeration type.
value A span containing the name or value to convert.

Returns

An object of type enumType whose value is represented by value.

System.Enum.Parse()

Converts the span of characters representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. A parameter specifies whether the operation is case-insensitive.

Parameters

NameDescriptionDefault
enumType An enumeration type.
value A span containing the name or value to convert.
ignoreCase true to ignore case; false to regard case.

Returns

An object of type enumType whose value is represented by value.

System.Enum.Parse()

Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object.

Parameters

NameDescriptionDefault
enumType An enumeration type.
value A string containing the name or value to convert.

Returns

An object of type enumType whose value is represented by value.

System.Enum.Parse()

Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. A parameter specifies whether the operation is case-insensitive.

Parameters

NameDescriptionDefault
enumType An enumeration type.
value A string containing the name or value to convert.
ignoreCase true to ignore case; false to regard case.

Returns

An object of type enumType whose value is represented by value.

System.Enum.Parse``1()

Converts the span of characters representation of the name or numeric value of one or more enumerated constants specified by to an equivalent enumerated object.

Parameters

NameDescriptionDefault
value A span containing the name or value to convert.

Returns

An object of type whose value is represented by value.

System.Enum.Parse``1()

Converts the span of characters representation of the name or numeric value of one or more enumerated constants specified by to an equivalent enumerated object. A parameter specifies whether the operation is case-insensitive.

Parameters

NameDescriptionDefault
value A span containing the name or value to convert.
ignoreCase true to ignore case; false to regard case.

Returns

An object of type whose value is represented by value.

System.Enum.Parse``1()

Converts the string representation of the name or numeric value of one or more enumerated constants specified by to an equivalent enumerated object.

Parameters

NameDescriptionDefault
value A string containing the name or value to convert.

Returns

An object of type TEnum whose value is represented by value.

System.Enum.Parse``1()

Converts the string representation of the name or numeric value of one or more enumerated constants specified by to an equivalent enumerated object. A parameter specifies whether the operation is case-insensitive.

Parameters

NameDescriptionDefault
value A string containing the name or value to convert.
ignoreCase true to ignore case; false to regard case.

Returns

An object of type TEnum whose value is represented by value.

System.Enum.System#IConvertible#ToBoolean()

Converts the current value to a Boolean value based on the underlying type.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

This member always throws an exception.

System.Enum.System#IConvertible#ToByte()

Converts the current value to an 8-bit unsigned integer based on the underlying type.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

The converted value.

System.Enum.System#IConvertible#ToChar()

Converts the current value to a Unicode character based on the underlying type.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

This member always throws an exception.

System.Enum.System#IConvertible#ToDateTime()

Converts the current value to a System.DateTime based on the underlying type.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

This member always throws an exception.

System.Enum.System#IConvertible#ToDecimal()

Converts the current value to a System.Decimal based on the underlying type.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

This member always throws an exception.

System.Enum.System#IConvertible#ToDouble()

Converts the current value to a double-precision floating point number based on the underlying type.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

This member always throws an exception.

System.Enum.System#IConvertible#ToInt16()

Converts the current value to a 16-bit signed integer based on the underlying type.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

The converted value.

System.Enum.System#IConvertible#ToInt32()

Converts the current value to a 32-bit signed integer based on the underlying type.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

The converted value.

System.Enum.System#IConvertible#ToInt64()

Converts the current value to a 64-bit signed integer based on the underlying type.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

The converted value.

System.Enum.System#IConvertible#ToSByte()

Converts the current value to an 8-bit signed integer based on the underlying type.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

The converted value.

System.Enum.System#IConvertible#ToSingle()

Converts the current value to a single-precision floating-point number based on the underlying type.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

This member always throws an exception.

System.Enum.System#IConvertible#ToType()

Converts the current value to a specified type based on the underlying type.

Parameters

NameDescriptionDefault
type The type to convert to.
provider An object that supplies culture-specific formatting information.

Returns

The converted value.

System.Enum.System#IConvertible#ToUInt16()

Converts the current value to a 16-bit unsigned integer based on the underlying type.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

The converted value.

System.Enum.System#IConvertible#ToUInt32()

Converts the current value to a 32-bit unsigned integer based on the underlying type.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

The converted value.

System.Enum.System#IConvertible#ToUInt64()

Converts the current value to a 64-bit unsigned integer based on the underlying type.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

The converted value.

System.Enum.System#ISpanFormattable#TryFormat()

Tries to format the value of the enum into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span in which to write this instance's value formatted as a span of characters.
charsWritten When this method returns, contains the number of characters that were written in destination.
format The format specifier.
provider An optional object that supplies culture-specific formatting information for destination. This parameter is ignored.

Returns

true if the formatting was successful; otherwise, false.

System.Enum.ToObject()

Converts the specified 8-bit unsigned integer to an enumeration member.

Parameters

NameDescriptionDefault
enumType The enumeration type to return.
value The value to convert to an enumeration member.

Returns

An instance of the enumeration set to value.

System.Enum.ToObject()

Converts the specified 16-bit signed integer to an enumeration member.

Parameters

NameDescriptionDefault
enumType The enumeration type to return.
value The value to convert to an enumeration member.

Returns

An instance of the enumeration set to value.

System.Enum.ToObject()

Converts the specified 32-bit signed integer to an enumeration member.

Parameters

NameDescriptionDefault
enumType The enumeration type to return.
value The value to convert to an enumeration member.

Returns

An instance of the enumeration set to value.

System.Enum.ToObject()

Converts the specified 64-bit signed integer to an enumeration member.

Parameters

NameDescriptionDefault
enumType The enumeration type to return.
value The value to convert to an enumeration member.

Returns

An instance of the enumeration set to value.

System.Enum.ToObject()

Converts the specified object with an integer value to an enumeration member.

Parameters

NameDescriptionDefault
enumType The enumeration type to return.
value The value convert to an enumeration member.

Returns

An enumeration object whose value is value.

System.Enum.ToObject()

Converts the specified 8-bit signed integer value to an enumeration member.

Parameters

NameDescriptionDefault
enumType The enumeration type to return.
value The value to convert to an enumeration member.

Returns

An instance of the enumeration set to value.

System.Enum.ToObject()

Converts the specified 16-bit unsigned integer value to an enumeration member.

Parameters

NameDescriptionDefault
enumType The enumeration type to return.
value The value to convert to an enumeration member.

Returns

An instance of the enumeration set to value.

System.Enum.ToObject()

Converts the specified 32-bit unsigned integer value to an enumeration member.

Parameters

NameDescriptionDefault
enumType The enumeration type to return.
value The value to convert to an enumeration member.

Returns

An instance of the enumeration set to value.

System.Enum.ToObject()

Converts the specified 64-bit unsigned integer value to an enumeration member.

Parameters

NameDescriptionDefault
enumType The enumeration type to return.
value The value to convert to an enumeration member.

Returns

An instance of the enumeration set to value.

System.Enum.ToString

Converts the value of this instance to its equivalent string representation.

Returns

The string representation of the value of this instance.

System.Enum.ToString()

This method overload is obsolete; use System.Enum.ToString.

Parameters

NameDescriptionDefault
provider (obsolete)

Returns

The string representation of the value of this instance.

System.Enum.ToString()

Converts the value of this instance to its equivalent string representation using the specified format.

Parameters

NameDescriptionDefault
format A format string.

Returns

The string representation of the value of this instance as specified by format.

System.Enum.ToString()

This method overload is obsolete; use System.Enum.ToString().

Parameters

NameDescriptionDefault
format A format specification.
provider (Obsolete.)

Returns

The string representation of the value of this instance as specified by format.

System.Enum.TryFormat``1()

Tries to format the value of the enumerated type instance into the provided span of characters.

Parameters

NameDescriptionDefault
value
destination The span into which to write the instance's value formatted as a span of characters.
charsWritten When this method returns, contains the number of characters that were written in destination.
format A span containing the character that represents the standard format string that defines the acceptable format of destination. This value can be empty, or "g", "d", "f", or "x".

Returns

true if the formatting was successful; otherwise, false if the destination span wasn't large enough to contain the formatted value.

System.Enum.TryParse()

Converts the span of characters representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. A parameter specifies whether the operation is case-insensitive.

Parameters

NameDescriptionDefault
enumType The enum type to use for parsing.
value The span representation of the name or numeric value of one or more enumerated constants.
ignoreCase true to read enumType in case insensitive mode; false to read enumType in case sensitive mode.
result When this method returns true, contains an enumeration constant that represents the parsed value.

Returns

true if the conversion succeeded; false otherwise.

System.Enum.TryParse()

Converts the span of characters representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object.

Parameters

NameDescriptionDefault
enumType The enum type to use for parsing.
value The span representation of the name or numeric value of one or more enumerated constants.
result When this method returns true, contains an enumeration constant that represents the parsed value.

Returns

true if the conversion succeeded; false otherwise.

System.Enum.TryParse()

Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object.

Parameters

NameDescriptionDefault
enumType The enum type to use for parsing.
value The string representation of the name or numeric value of one or more enumerated constants.
ignoreCase true to read value in case insensitive mode; false to read value in case sensitive mode.
result When this method returns true, contains an enumeration constant that represents the parsed value.

Returns

true if the conversion succeeded; false otherwise.

System.Enum.TryParse()

Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object.

Parameters

NameDescriptionDefault
enumType The enum type to use for parsing.
value The string representation of the name or numeric value of one or more enumerated constants.
result When this method returns true, contains an enumeration constant that represents the parsed value.

Returns

true if the conversion succeeded; false otherwise.

System.Enum.TryParse``1()

Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object.

Parameters

NameDescriptionDefault
value The span representation of the name or numeric value of one or more enumerated constants.
result When this method returns true, contains an enumeration constant that represents the parsed value.

Returns

true if the conversion succeeded; false otherwise.

System.Enum.TryParse``1()

Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. A parameter specifies whether the operation is case-sensitive. The return value indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
value The span representation of the name or numeric value of one or more enumerated constants.
ignoreCase true to ignore case; false to consider case.
result When this method returns true, contains an enumeration constant that represents the parsed value.

Returns

true if the conversion succeeded; false otherwise.

System.Enum.TryParse``1()

Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. The return value indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
value The case-sensitive string representation of the enumeration name or underlying value to convert.
result When this method returns, contains an object of type TEnum whose value is represented by value if the parse operation succeeds. If the parse operation fails, contains the default value of the underlying type of TEnum. This parameter is passed uninitialized.

Returns

true if the value parameter was converted successfully; otherwise, false.

System.Enum.TryParse``1()

Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. A parameter specifies whether the operation is case-sensitive. The return value indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
value The string representation of the enumeration name or underlying value to convert.
ignoreCase true to ignore case; false to consider case.
result When this method returns, contains an object of type TEnum whose value is represented by value if the parse operation succeeds. If the parse operation fails, contains the default value of the underlying type of TEnum. This parameter is passed uninitialized.

Returns

true if the value parameter was converted successfully; otherwise, false.

System.Environment

Provides information about, and means to manipulate, the current environment and platform. This class cannot be inherited.

System.Environment.Exit()

Terminates this process and returns an exit code to the operating system.

Parameters

NameDescriptionDefault
exitCode The exit code to return to the operating system. Use 0 (zero) to indicate that the process completed successfully.

System.Environment.ExpandEnvironmentVariables()

Replaces the name of each environment variable embedded in the specified string with the string equivalent of the value of the variable, then returns the resulting string.

Parameters

NameDescriptionDefault
name A string containing the names of zero or more environment variables. Each environment variable is quoted with the percent sign character (%).

Returns

A string with each environment variable replaced by its value.

System.Environment.FailFast()

Immediately terminates a process after writing a message to the Windows Application event log, and then includes the message in error reporting to Microsoft.

Parameters

NameDescriptionDefault
message A message that explains why the process was terminated, or null if no explanation is provided.

System.Environment.FailFast()

Immediately terminates a process after writing a message to the Windows Application event log, and then includes the message and exception information in error reporting to Microsoft.

Parameters

NameDescriptionDefault
message A message that explains why the process was terminated, or null if no explanation is provided.
exception An exception that represents the error that caused the termination. This is typically the exception in a catch block.

System.Environment.GetCommandLineArgs

Returns a string array containing the command-line arguments for the current process.

Returns

An array of strings where each element contains a command-line argument. The first element is the executable file name, and the following zero or more elements contain the remaining command-line arguments.

System.Environment.GetEnvironmentVariable()

Retrieves the value of an environment variable from the current process.

Parameters

NameDescriptionDefault
variable The name of the environment variable.

Returns

The value of the environment variable specified by variable, or null if the environment variable is not found.

System.Environment.GetEnvironmentVariable()

Retrieves the value of an environment variable from the current process or from the Windows operating system registry key for the current user or local machine.

Parameters

NameDescriptionDefault
variable The name of an environment variable.
target One of the System.EnvironmentVariableTarget values. Only System.EnvironmentVariableTarget.Process is supported on .NET running on Unix-based systems.

Returns

The value of the environment variable specified by the variable and target parameters, or null if the environment variable is not found.

System.Environment.GetEnvironmentVariables

Retrieves all environment variable names and their values from the current process.

Returns

A dictionary that contains all environment variable names and their values; otherwise, an empty dictionary if no environment variables are found.

System.Environment.GetEnvironmentVariables()

Retrieves all environment variable names and their values from the current process, or from the Windows operating system registry key for the current user or local machine.

Parameters

NameDescriptionDefault
target One of the System.EnvironmentVariableTarget values. Only System.EnvironmentVariableTarget.Process is supported on .NET running on Unix-based systems.

Returns

A dictionary that contains all environment variable names and their values from the source specified by the target parameter; otherwise, an empty dictionary if no environment variables are found.

System.Environment.GetFolderPath()

Gets the path to the specified system special folder.

Parameters

NameDescriptionDefault
folder One of the enumeration values that identifies a system special folder.

Returns

The path to the specified system special folder, if that folder physically exists on your computer; otherwise, an empty string (""). A folder will not physically exist if the operating system did not create it, the existing folder was deleted, or the folder is a virtual directory, such as My Computer, which does not correspond to a physical path.

System.Environment.GetFolderPath()

Gets the path to the specified system special folder using a specified option for accessing special folders.

Parameters

NameDescriptionDefault
folder One of the enumeration values that identifies a system special folder.
option One of the enumeration values that specifies options to use for accessing a special folder.

Returns

The path to the specified system special folder, if that folder physically exists on your computer; otherwise, an empty string (""). A folder will not physically exist if the operating system did not create it, the existing folder was deleted, or the folder is a virtual directory, such as My Computer, which does not correspond to a physical path.

System.Environment.GetLogicalDrives

Returns an array of string containing the names of the logical drives on the current computer.

Returns

An array of strings where each element contains the name of a logical drive. For example, if the computer's hard drive is the first logical drive, the first element returned is "C:\".

System.Environment.SetEnvironmentVariable()

Creates, modifies, or deletes an environment variable stored in the current process.

Parameters

NameDescriptionDefault
variable The name of an environment variable.
value A value to assign to variable.

System.Environment.SetEnvironmentVariable()

Creates, modifies, or deletes an environment variable stored in the current process or in the Windows operating system registry key reserved for the current user or local machine.

Parameters

NameDescriptionDefault
variable The name of an environment variable.
value A value to assign to variable.
target One of the enumeration values that specifies the location of the environment variable.

System.Environment.CommandLine

Gets the command line for this process.

Returns

A string containing command-line arguments.

System.Environment.CurrentDirectory

Gets or sets the fully qualified path of the current working directory.

Returns

The directory path.

System.Environment.CurrentManagedThreadId

Gets a unique identifier for the current managed thread.

Returns

A unique identifier for this managed thread.

System.Environment.ExitCode

Gets or sets the exit code of the process.

Returns

A 32-bit signed integer containing the exit code. The default value is 0 (zero), which indicates that the process completed successfully.

System.Environment.HasShutdownStarted

Gets a value that indicates whether the current application domain is being unloaded or the common language runtime (CLR) is shutting down.

Returns

true if the current application domain is being unloaded or the CLR is shutting down; otherwise, false.

System.Environment.Is64BitOperatingSystem

Gets a value that indicates whether the current operating system is a 64-bit operating system.

Returns

true if the operating system is 64-bit; otherwise, false.

System.Environment.Is64BitProcess

Gets a value that indicates whether the current process is a 64-bit process.

Returns

true if the process is 64-bit; otherwise, false.

System.Environment.IsPrivilegedProcess

Gets a value that indicates whether the current process is authorized to perform security-relevant functions.

System.Environment.MachineName

Gets the NetBIOS name of this local computer.

Returns

The name of this computer.

System.Environment.NewLine

Gets the newline string defined for this environment.

Returns

\r\n for non-Unix platforms, or \n for Unix platforms.

System.Environment.OSVersion

Gets the current platform identifier and version number.

Returns

The platform identifier and version number.

System.Environment.ProcessId

Gets the unique identifier for the current process.

Returns

A number that represents the unique identifier for the current process.

System.Environment.ProcessorCount

Gets the number of processors available to the current process.

Returns

The 32-bit signed integer that specifies the number of processors that are available.

System.Environment.ProcessPath

Returns the path of the executable that started the currently executing process. Returns null when the path is not available.

Returns

The path of the executable that started the currently executing process.

System.Environment.StackTrace

Gets current stack trace information.

Returns

A string containing stack trace information. This value can be System.String.Empty.

System.Environment.SystemDirectory

Gets the fully qualified path of the system directory.

Returns

A string containing a directory path.

System.Environment.SystemPageSize

Gets the number of bytes in the operating system's memory page.

Returns

The number of bytes in the system memory page.

System.Environment.TickCount

Gets the number of milliseconds elapsed since the system started.

Returns

A 32-bit signed integer containing the amount of time in milliseconds that has passed since the last time the computer was started.

System.Environment.TickCount64

Gets the number of milliseconds elapsed since the system started.

Returns

The elapsed milliseconds since the system started.

System.Environment.UserDomainName

Gets the network domain name associated with the current user.

Returns

The network domain name associated with the current user.

System.Environment.UserInteractive

Gets a value indicating whether the current process is running in user interactive mode.

Returns

true if the current process is running in user interactive mode; otherwise, false.

System.Environment.UserName

Gets the user name of the person who is associated with the current thread.

Returns

The user name of the person who is associated with the current thread.

System.Environment.Version

Gets a version consisting of the major, minor, build, and revision numbers of the common language runtime.

Returns

The version of the common language runtime.

System.Environment.WorkingSet

Gets the amount of physical memory mapped to the process context.

Returns

A 64-bit signed integer containing the number of bytes of physical memory mapped to the process context.

System.Environment.SpecialFolder

Specifies enumerated constants used to retrieve directory paths to system special folders.

System.Environment.SpecialFolder.AdminTools

The file system directory that is used to store administrative tools for an individual user. The Microsoft Management Console (MMC) will save customized consoles to this directory, and it will roam with the user.

System.Environment.SpecialFolder.ApplicationData

The directory that serves as a common repository for application-specific data for the current roaming user. A roaming user works on more than one computer on a network. A roaming user's profile is kept on a server on the network and is loaded onto a system when the user logs on.

System.Environment.SpecialFolder.CDBurning

The file system directory that acts as a staging area for files waiting to be written to a CD.

System.Environment.SpecialFolder.CommonAdminTools

The file system directory that contains administrative tools for all users of the computer.

System.Environment.SpecialFolder.CommonApplicationData

The directory that serves as a common repository for application-specific data that is used by all users.

System.Environment.SpecialFolder.CommonDesktopDirectory

The file system directory that contains files and folders that appear on the desktop for all users.

System.Environment.SpecialFolder.CommonDocuments

The file system directory that contains documents that are common to all users.

System.Environment.SpecialFolder.CommonMusic

The file system directory that serves as a repository for music files common to all users.

System.Environment.SpecialFolder.CommonPictures

The file system directory that serves as a repository for image files common to all users.

System.Environment.SpecialFolder.CommonProgramFiles

The directory for components that are shared across applications. To get the x86 common program files directory in a non-x86 process, use the System.Environment.SpecialFolder.ProgramFilesX86 member.

System.Environment.SpecialFolder.CommonProgramFilesX86

The Program Files folder.

System.Environment.SpecialFolder.CommonPrograms

A folder for components that are shared across applications.

System.Environment.SpecialFolder.CommonStartMenu

The file system directory that contains the programs and folders that appear on the Start menu for all users.

System.Environment.SpecialFolder.CommonStartup

The file system directory that contains the programs that appear in the Startup folder for all users.

System.Environment.SpecialFolder.CommonTemplates

The file system directory that contains the templates that are available to all users.

System.Environment.SpecialFolder.CommonVideos

The file system directory that serves as a repository for video files common to all users.

System.Environment.SpecialFolder.Cookies

The directory that serves as a common repository for Internet cookies.

System.Environment.SpecialFolder.Desktop

The logical Desktop rather than the physical file system location.

System.Environment.SpecialFolder.DesktopDirectory

The directory used to physically store file objects on the desktop. Do not confuse this directory with the desktop folder itself, which is a virtual folder.

System.Environment.SpecialFolder.Favorites

The directory that serves as a common repository for the user's favorite items.

System.Environment.SpecialFolder.Fonts

A virtual folder that contains fonts.

System.Environment.SpecialFolder.History

The directory that serves as a common repository for Internet history items.

System.Environment.SpecialFolder.InternetCache

The directory that serves as a common repository for temporary Internet files.

System.Environment.SpecialFolder.LocalApplicationData

The directory that serves as a common repository for application-specific data that is used by the current, non-roaming user.

System.Environment.SpecialFolder.LocalizedResources

The file system directory that contains localized resource data.

System.Environment.SpecialFolder.MyComputer

The My Computer folder. When passed to the Environment.GetFolderPath method, the MyComputer enumeration member always yields the empty string ("") because no path is defined for the My Computer folder.

System.Environment.SpecialFolder.MyDocuments

The My Documents folder. This member is equivalent to System.Environment.SpecialFolder.Personal.

System.Environment.SpecialFolder.MyMusic

The My Music folder.

System.Environment.SpecialFolder.MyPictures

The My Pictures folder.

System.Environment.SpecialFolder.MyVideos

The file system directory that serves as a repository for videos that belong to a user.

System.Environment.SpecialFolder.NetworkShortcuts

A file system directory that contains the link objects that may exist in the My Network Places virtual folder.

System.Environment.SpecialFolder.Personal

The directory that serves as a common repository for documents. This member is equivalent to System.Environment.SpecialFolder.MyDocuments.

System.Environment.SpecialFolder.PrinterShortcuts

The file system directory that contains the link objects that can exist in the Printers virtual folder.

System.Environment.SpecialFolder.ProgramFiles

The program files directory. In a non-x86 process, passing System.Environment.SpecialFolder.ProgramFiles to the System.Environment.GetFolderPath() method returns the path for non-x86 programs. To get the x86 program files directory in a non-x86 process, use the System.Environment.SpecialFolder.ProgramFilesX86 member.

System.Environment.SpecialFolder.ProgramFilesX86

The x86 Program Files folder.

System.Environment.SpecialFolder.Programs

The directory that contains the user's program groups.

System.Environment.SpecialFolder.Recent

The directory that contains the user's most recently used documents.

System.Environment.SpecialFolder.Resources

The file system directory that contains resource data.

System.Environment.SpecialFolder.SendTo

The directory that contains the Send To menu items.

System.Environment.SpecialFolder.StartMenu

The directory that contains the Start menu items.

System.Environment.SpecialFolder.Startup

The directory that corresponds to the user's Startup program group. The system starts these programs whenever a user logs on or starts Windows.

System.Environment.SpecialFolder.System

The System directory.

System.Environment.SpecialFolder.SystemX86

The Windows System folder.

System.Environment.SpecialFolder.Templates

The directory that serves as a common repository for document templates.

System.Environment.SpecialFolder.UserProfile

The user's profile folder. Applications should not create files or folders at this level; they should put their data under the locations referred to by System.Environment.SpecialFolder.ApplicationData.

System.Environment.SpecialFolder.Windows

The Windows directory or SYSROOT. This corresponds to the %windir% or %SYSTEMROOT% environment variables.

System.Environment.SpecialFolderOption

Specifies options to use for getting the path to a special folder.

System.Environment.SpecialFolderOption.Create

The path to the folder is created if it does not already exist.

System.Environment.SpecialFolderOption.DoNotVerify

The path to the folder is returned without verifying whether the path exists. If the folder is located on a network, specifying this option can reduce lag time.

System.Environment.SpecialFolderOption.None

The path to the folder is verified. If the folder exists, the path is returned. If the folder does not exist, an empty string is returned. This is the default behavior.

System.EnvironmentVariableTarget

Specifies the location where an environment variable is stored or retrieved in a set or get operation.

System.EnvironmentVariableTarget.Machine

The environment variable is stored or retrieved from the HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Session Manager\Environment key in the Windows operating system registry. This value should be used on .NET implementations running on Windows systems only.

System.EnvironmentVariableTarget.Process

The environment variable is stored or retrieved from the environment block associated with the current process.

System.EnvironmentVariableTarget.User

The environment variable is stored or retrieved from the HKEY_CURRENT_USER\Environment key in the Windows operating system registry. This value should be used on .NET implementations running on Windows systems only.

System.EventArgs

Represents the base class for classes that contain event data, and provides a value to use for events that do not include event data.

System.EventArgs.Empty

Provides a value to use with events that do not have event data.

System.EventArgs.#ctor

Initializes a new instance of the System.EventArgs class.

System.EventHandler

Represents the method that will handle an event that has no event data.

Parameters

NameDescriptionDefault
sender The source of the event.
e An object that contains no event data.

System.EventHandler`1

Represents the method that will handle an event when the event provides data.

Parameters

NameDescriptionDefault
sender The source of the event.
e An object that contains the event data.

System.Exception

Represents errors that occur during application execution.

System.Exception.SerializeObjectState

Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.

System.Exception.#ctor

Initializes a new instance of the System.Exception class.

System.Exception.#ctor()

Initializes a new instance of the System.Exception class with serialized data.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.Exception.#ctor()

Initializes a new instance of the System.Exception class with a specified error message.

Parameters

NameDescriptionDefault
message The message that describes the error.

System.Exception.#ctor()

Initializes a new instance of the System.Exception class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.

System.Exception.GetBaseException

When overridden in a derived class, returns the System.Exception that is the root cause of one or more subsequent exceptions.

Returns

The first exception thrown in a chain of exceptions. If the System.Exception.InnerException property of the current exception is a null reference (Nothing in Visual Basic), this property returns the current exception.

System.Exception.GetObjectData()

When overridden in a derived class, sets the System.Runtime.Serialization.SerializationInfo with information about the exception.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.Exception.GetType

Gets the runtime type of the current instance.

Returns

A System.Type object that represents the exact runtime type of the current instance.

System.Exception.ToString

Creates and returns a string representation of the current exception.

Returns

A string representation of the current exception.

System.Exception.Data

Gets a collection of key/value pairs that provide additional user-defined information about the exception.

Returns

An object that implements the System.Collections.IDictionary interface and contains a collection of user-defined key/value pairs. The default is an empty collection.

System.Exception.HResult

Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.

Returns

The HRESULT value.

System.Exception.InnerException

Gets the System.Exception instance that caused the current exception.

Returns

An object that describes the error that caused the current exception. The System.Exception.InnerException property returns the same value as was passed into the System.Exception.#ctor() constructor, or null if the inner exception value was not supplied to the constructor. This property is read-only.

System.Exception.Message

Gets a message that describes the current exception.

Returns

The error message that explains the reason for the exception, or an empty string ("").

System.Exception.Source

Gets or sets the name of the application or the object that causes the error.

Returns

The name of the application or the object that causes the error.

System.Exception.StackTrace

Gets a string representation of the immediate frames on the call stack.

Returns

A string that describes the immediate frames of the call stack.

System.Exception.TargetSite

Gets the method that throws the current exception.

Returns

The System.Reflection.MethodBase that threw the current exception.

System.ExecutionEngineException

The exception that is thrown when there is an internal error in the execution engine of the common language runtime. This class cannot be inherited.

System.ExecutionEngineException.#ctor

Initializes a new instance of the System.ExecutionEngineException class.

System.ExecutionEngineException.#ctor()

Initializes a new instance of the System.ExecutionEngineException class with a specified error message.

Parameters

NameDescriptionDefault
message The message that describes the error.

System.ExecutionEngineException.#ctor()

Initializes a new instance of the System.ExecutionEngineException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.FieldAccessException

The exception that is thrown when there is an invalid attempt to access a private or protected field inside a class.

System.FieldAccessException.#ctor

Initializes a new instance of the System.FieldAccessException class.

System.FieldAccessException.#ctor()

Initializes a new instance of the System.FieldAccessException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.FieldAccessException.#ctor()

Initializes a new instance of the System.FieldAccessException class with a specified error message.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.

System.FieldAccessException.#ctor()

Initializes a new instance of the System.FieldAccessException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
inner The exception that is the cause of the current exception. If the inner parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.FileStyleUriParser

A customizable parser based on the File scheme.

System.FileStyleUriParser.#ctor

Creates a customizable parser based on the File scheme.

System.FlagsAttribute

Indicates that an enumeration can be treated as a bit field; that is, a set of flags.

System.FlagsAttribute.#ctor

Initializes a new instance of the System.FlagsAttribute class.

System.FormatException

The exception that is thrown when the format of an argument is invalid, or when a composite format string is not well formed.

System.FormatException.#ctor

Initializes a new instance of the System.FormatException class.

System.FormatException.#ctor()

Initializes a new instance of the System.FormatException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.FormatException.#ctor()

Initializes a new instance of the System.FormatException class with a specified error message.

Parameters

NameDescriptionDefault
message The message that describes the error.

System.FormatException.#ctor()

Initializes a new instance of the System.FormatException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.FormattableString

Represents a composite format string, along with the arguments to be formatted.

System.FormattableString.#ctor

Instantiates a new instance of the System.FormattableString class.

System.FormattableString.CurrentCulture()

Returns a result string in which arguments are formatted by using the conventions of the current culture.

Parameters

NameDescriptionDefault
formattable The string to be formatted.

Returns

The string that results from formatting the current instance by using the conventions of the current culture.

System.FormattableString.GetArgument()

Returns the argument at the specified index position.

Parameters

NameDescriptionDefault
index The index of the argument. Its value can range from zero to one less than the value of System.FormattableString.ArgumentCount.

Returns

The argument.

System.FormattableString.GetArguments

Returns an object array that contains one or more objects to format.

Returns

An object array that contains one or more objects to format.

System.FormattableString.Invariant()

Returns a result string in which arguments are formatted by using the conventions of the invariant culture.

Parameters

NameDescriptionDefault
formattable The object to convert to a result string.

Returns

The string that results from formatting the current instance by using the conventions of the invariant culture.

System.FormattableString.System#IFormattable#ToString()

Returns the string that results from formatting the format string along with its arguments by using the formatting conventions of a specified culture.

Parameters

NameDescriptionDefault
ignored A string. This argument is ignored.
formatProvider An object that provides culture-specific formatting information.

Returns

A string formatted using the conventions of the formatProvider parameter.

System.FormattableString.ToString

Returns the string that results from formatting the composite format string along with its arguments by using the formatting conventions of the current culture.

Returns

A result string formatted by using the conventions of the current culture.

System.FormattableString.ToString()

Returns the string that results from formatting the composite format string along with its arguments by using the formatting conventions of a specified culture.

Parameters

NameDescriptionDefault
formatProvider An object that provides culture-specific formatting information.

Returns

A result string formatted by using the conventions of formatProvider.

System.FormattableString.ArgumentCount

Gets the number of arguments to be formatted.

Returns

The number of arguments to be formatted.

System.FormattableString.Format

Returns the composite format string.

Returns

The composite format string.

System.FtpStyleUriParser

A customizable parser based on the File Transfer Protocol (FTP) scheme.

System.FtpStyleUriParser.#ctor

Creates a customizable parser based on the File Transfer Protocol (FTP) scheme.

System.Func`1

Encapsulates a method that has no parameters and returns a value of the type specified by the parameter.

Returns

The return value of the method that this delegate encapsulates.

System.Func`10

Encapsulates a method that has nine parameters and returns a value of the type specified by the parameter.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.
arg9 The ninth parameter of the method that this delegate encapsulates.

Returns

The return value of the method that this delegate encapsulates.

System.Func`11

Encapsulates a method that has 10 parameters and returns a value of the type specified by the parameter.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.
arg9 The ninth parameter of the method that this delegate encapsulates.
arg10 The tenth parameter of the method that this delegate encapsulates.

Returns

The return value of the method that this delegate encapsulates.

System.Func`12

Encapsulates a method that has 11 parameters and returns a value of the type specified by the parameter.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.
arg9 The ninth parameter of the method that this delegate encapsulates.
arg10 The tenth parameter of the method that this delegate encapsulates.
arg11 The eleventh parameter of the method that this delegate encapsulates.

Returns

The return value of the method that this delegate encapsulates.

System.Func`13

Encapsulates a method that has 12 parameters and returns a value of the type specified by the parameter.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.
arg9 The ninth parameter of the method that this delegate encapsulates.
arg10 The tenth parameter of the method that this delegate encapsulates.
arg11 The eleventh parameter of the method that this delegate encapsulates.
arg12 The twelfth parameter of the method that this delegate encapsulates.

Returns

The return value of the method that this delegate encapsulates.

System.Func`14

Encapsulates a method that has 13 parameters and returns a value of the type specified by the parameter.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.
arg9 The ninth parameter of the method that this delegate encapsulates.
arg10 The tenth parameter of the method that this delegate encapsulates.
arg11 The eleventh parameter of the method that this delegate encapsulates.
arg12 The twelfth parameter of the method that this delegate encapsulates.
arg13 The thirteenth parameter of the method that this delegate encapsulates.

Returns

The return value of the method that this delegate encapsulates.

System.Func`15

Encapsulates a method that has 14 parameters and returns a value of the type specified by the parameter.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.
arg9 The ninth parameter of the method that this delegate encapsulates.
arg10 The tenth parameter of the method that this delegate encapsulates.
arg11 The eleventh parameter of the method that this delegate encapsulates.
arg12 The twelfth parameter of the method that this delegate encapsulates.
arg13 The thirteenth parameter of the method that this delegate encapsulates.
arg14 The fourteenth parameter of the method that this delegate encapsulates.

Returns

The return value of the method that this delegate encapsulates.

System.Func`16

Encapsulates a method that has 15 parameters and returns a value of the type specified by the parameter.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.
arg9 The ninth parameter of the method that this delegate encapsulates.
arg10 The tenth parameter of the method that this delegate encapsulates.
arg11 The eleventh parameter of the method that this delegate encapsulates.
arg12 The twelfth parameter of the method that this delegate encapsulates.
arg13 The thirteenth parameter of the method that this delegate encapsulates.
arg14 The fourteenth parameter of the method that this delegate encapsulates.
arg15 The fifteenth parameter of the method that this delegate encapsulates.

Returns

The return value of the method that this delegate encapsulates.

System.Func`17

Encapsulates a method that has 16 parameters and returns a value of the type specified by the parameter.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.
arg9 The ninth parameter of the method that this delegate encapsulates.
arg10 The tenth parameter of the method that this delegate encapsulates.
arg11 The eleventh parameter of the method that this delegate encapsulates.
arg12 The twelfth parameter of the method that this delegate encapsulates.
arg13 The thirteenth parameter of the method that this delegate encapsulates.
arg14 The fourteenth parameter of the method that this delegate encapsulates.
arg15 The fifteenth parameter of the method that this delegate encapsulates.
arg16 The sixteenth parameter of the method that this delegate encapsulates.

Returns

The return value of the method that this delegate encapsulates.

System.Func`2

Encapsulates a method that has one parameter and returns a value of the type specified by the parameter.

Parameters

NameDescriptionDefault
arg The parameter of the method that this delegate encapsulates.

Returns

The return value of the method that this delegate encapsulates.

System.Func`3

Encapsulates a method that has two parameters and returns a value of the type specified by the parameter.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.

Returns

The return value of the method that this delegate encapsulates.

System.Func`4

Encapsulates a method that has three parameters and returns a value of the type specified by the parameter.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.

Returns

The return value of the method that this delegate encapsulates.

System.Func`5

Encapsulates a method that has four parameters and returns a value of the type specified by the parameter.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.

Returns

The return value of the method that this delegate encapsulates.

System.Func`6

Encapsulates a method that has five parameters and returns a value of the type specified by the parameter.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.

Returns

The return value of the method that this delegate encapsulates.

System.Func`7

Encapsulates a method that has six parameters and returns a value of the type specified by the parameter.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.

Returns

The return value of the method that this delegate encapsulates.

System.Func`8

Encapsulates a method that has seven parameters and returns a value of the type specified by the parameter.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.

Returns

The return value of the method that this delegate encapsulates.

System.Func`9

Encapsulates a method that has eight parameters and returns a value of the type specified by the parameter.

Parameters

NameDescriptionDefault
arg1 The first parameter of the method that this delegate encapsulates.
arg2 The second parameter of the method that this delegate encapsulates.
arg3 The third parameter of the method that this delegate encapsulates.
arg4 The fourth parameter of the method that this delegate encapsulates.
arg5 The fifth parameter of the method that this delegate encapsulates.
arg6 The sixth parameter of the method that this delegate encapsulates.
arg7 The seventh parameter of the method that this delegate encapsulates.
arg8 The eighth parameter of the method that this delegate encapsulates.

Returns

The return value of the method that this delegate encapsulates.

System.GC

Controls the system garbage collector, a service that automatically reclaims unused memory.

System.GC.AddMemoryPressure()

Informs the runtime of a large allocation of unmanaged memory that should be taken into account when scheduling garbage collection.

Parameters

NameDescriptionDefault
bytesAllocated The incremental amount of unmanaged memory that has been allocated.

System.GC.AllocateArray``1()

Allocates an array.

Parameters

NameDescriptionDefault
length Specifies the length of the array.
pinned Specifies whether the allocated array must be pinned.

Returns

An array object.

System.GC.AllocateUninitializedArray``1()

Allocates an array while skipping zero-initialization, if possible.

Parameters

NameDescriptionDefault
length Specifies the length of the array.
pinned Specifies whether the allocated array must be pinned.

Returns

An array object with uninitialized memory.

System.GC.CancelFullGCNotification

Cancels the registration of a garbage collection notification.

System.GC.Collect

Forces an immediate garbage collection of all generations.

System.GC.Collect()

Forces an immediate garbage collection from generation 0 through a specified generation.

Parameters

NameDescriptionDefault
generation The number of the oldest generation to be garbage collected.

System.GC.Collect()

Forces a garbage collection from generation 0 through a specified generation, at a time specified by a System.GCCollectionMode value.

Parameters

NameDescriptionDefault
generation The number of the oldest generation to be garbage collected.
mode An enumeration value that specifies whether the garbage collection is forced (System.GCCollectionMode.Default or System.GCCollectionMode.Forced) or optimized (System.GCCollectionMode.Optimized).

System.GC.Collect()

Forces a garbage collection from generation 0 through a specified generation, at a time specified by a System.GCCollectionMode value, with a value specifying whether the collection should be blocking.

Parameters

NameDescriptionDefault
generation The number of the oldest generation to be garbage collected.
mode An enumeration value that specifies whether the garbage collection is forced (System.GCCollectionMode.Default or System.GCCollectionMode.Forced) or optimized (System.GCCollectionMode.Optimized).
blocking true to perform a blocking garbage collection; false to perform a background garbage collection where possible.

System.GC.Collect()

Forces a garbage collection from generation 0 through a specified generation, at a time specified by a System.GCCollectionMode value, with values that specify whether the collection should be blocking and compacting.

Parameters

NameDescriptionDefault
generation The number of the oldest generation to be garbage collected.
mode An enumeration value that specifies whether the garbage collection is forced (System.GCCollectionMode.Default or System.GCCollectionMode.Forced) or optimized (System.GCCollectionMode.Optimized).
blocking true to perform a blocking garbage collection; false to perform a background garbage collection where possible.
compacting true to compact the small object heap; false to sweep only.

System.GC.CollectionCount()

Returns the number of times garbage collection has occurred for the specified generation of objects.

Parameters

NameDescriptionDefault
generation The generation of objects for which the garbage collection count is to be determined.

Returns

The number of times garbage collection has occurred for the specified generation since the process was started.

System.GC.EndNoGCRegion

Ends the no GC region latency mode.

System.GC.GetAllocatedBytesForCurrentThread

Gets the total number of bytes allocated to the current thread since the beginning of its lifetime.

Returns

The total number of bytes allocated to the current thread since the beginning of its lifetime.

System.GC.GetConfigurationVariables

Gets the configurations used by the garbage collector.

Returns

A read-only dictionary with the configuration names and values as the keys and values of the dictionary, respectively.

System.GC.GetGCMemoryInfo

Gets garbage collection memory information.

Returns

An object that contains information about the garbage collector's memory usage.

System.GC.GetGCMemoryInfo()

Gets garbage collection memory information.

Parameters

NameDescriptionDefault
kind The kind of collection for which to retrieve memory information.

Returns

An object that contains information about the garbage collector's memory usage.

System.GC.GetGeneration()

Returns the current generation number of the specified object.

Parameters

NameDescriptionDefault
obj The object that generation information is retrieved for.

Returns

The current generation number of obj, or Int32.MaxValue.

System.GC.GetGeneration()

Returns the current generation number of the target of a specified weak reference.

Parameters

NameDescriptionDefault
wo A System.WeakReference that refers to the target object whose generation number is to be determined.

Returns

The current generation number of the target of wo, or System.Int32.MaxValue.

System.GC.GetTotalAllocatedBytes()

Gets a count of the bytes allocated over the lifetime of the process. The returned value does not include any native allocations.

Parameters

NameDescriptionDefault
precise If true, gather a precise number; otherwise, gather an approximate count. Gathering a precise value entails a significant performance penalty.

Returns

The total number of bytes allocated over the lifetime of the process.

System.GC.GetTotalMemory()

Retrieves the heap size excluding fragmentation. For example if the total GC heap size is 100mb and fragmentation, ie, space taken up by free objects, takes up 40mb, this API would report 60mb. A parameter indicates whether this method can wait a short interval before returning, to allow the system to collect garbage and finalize objects.

Parameters

NameDescriptionDefault
forceFullCollection true to indicate that this method can wait for garbage collection to occur before returning; otherwise, false.

Returns

The heap size, in bytes, excluding fragmentation.

System.GC.GetTotalPauseDuration

Gets the total amount of time paused in GC since the beginning of the process.

Returns

The total amount of time paused in GC since the beginning of the process.

System.GC.KeepAlive()

References the specified object, which makes it ineligible for garbage collection from the start of the current routine to the point where this method is called.

Parameters

NameDescriptionDefault
obj The object to reference.

System.GC.RefreshMemoryLimit

Instructs the Garbage Collector to reconfigure itself by detecting the various memory limits on the system.

System.GC.RegisterForFullGCNotification()

Specifies that a garbage collection notification should be raised when conditions favor full garbage collection and when the collection has been completed.

Parameters

NameDescriptionDefault
maxGenerationThreshold A number between 1 and 99 that specifies when the notification should be raised based on the objects allocated in generation 2.
largeObjectHeapThreshold A number between 1 and 99 that specifies when the notification should be raised based on objects allocated in the large object heap.

System.GC.RegisterNoGCRegionCallback()

Registers a callback to be invoked when a certain amount of memory is allocated in the no GC region.

Parameters

NameDescriptionDefault
totalSize The total size of the no GC region.
callback The callback to be executed a certain amount of memory is allocated in the no GC region.

System.GC.RemoveMemoryPressure()

Informs the runtime that unmanaged memory has been released and no longer needs to be taken into account when scheduling garbage collection.

Parameters

NameDescriptionDefault
bytesAllocated The amount of unmanaged memory that has been released.

System.GC.ReRegisterForFinalize()

Requests that the system call the finalizer for the specified object for which System.GC.SuppressFinalize() has previously been called.

Parameters

NameDescriptionDefault
obj The object that a finalizer must be called for.

System.GC.SuppressFinalize()

Requests that the common language runtime not call the finalizer for the specified object.

Parameters

NameDescriptionDefault
obj The object whose finalizer must not be executed.

System.GC.TryStartNoGCRegion()

Attempts to disallow garbage collection during the execution of a critical path if a specified amount of memory is available.

Parameters

NameDescriptionDefault
totalSize The amount of memory in bytes to allocate without triggering a garbage collection. It must be less than or equal to the size of an ephemeral segment. For information on the size of an ephemeral segment, see the "Ephemeral generations and segments" section in the Fundamentals of Garbage Collection article.

Returns

true if the runtime was able to commit the required amount of memory and the garbage collector is able to enter no GC region latency mode; otherwise, false.

System.GC.TryStartNoGCRegion()

Attempts to disallow garbage collection during the execution of a critical path if a specified amount of memory is available, and controls whether the garbage collector does a full blocking garbage collection if not enough memory is initially available.

Parameters

NameDescriptionDefault
totalSize The amount of memory in bytes to allocate without triggering a garbage collection. It must be less than or equal to the size of an ephemeral segment. For information on the size of an ephemeral segment, see the "Ephemeral generations and segments" section in the Fundamentals of Garbage Collection article.
disallowFullBlockingGC true to omit a full blocking garbage collection if the garbage collector is initially unable to allocate totalSize bytes; otherwise, false.

Returns

true if the runtime was able to commit the required amount of memory and the garbage collector is able to enter no GC region latency mode; otherwise, false.

System.GC.TryStartNoGCRegion()

Attempts to disallow garbage collection during the execution of a critical path if a specified amount of memory is available for the large object heap and the small object heap.

Parameters

NameDescriptionDefault
totalSize The amount of memory in bytes to allocate without triggering a garbage collection. totalSize -lohSize must be less than or equal to the size of an ephemeral segment. For information on the size of an ephemeral segment, see the "Ephemeral generations and segments" section in the Fundamentals of Garbage Collection article.
lohSize The number of bytes in totalSize to use for large object heap (LOH) allocations.

Returns

true if the runtime was able to commit the required amount of memory and the garbage collector is able to enter no GC region latency mode; otherwise, false.

System.GC.TryStartNoGCRegion()

Attempts to disallow garbage collection during the execution of a critical path if a specified amount of memory is available for the large object heap and the small object heap, and controls whether the garbage collector does a full blocking garbage collection if not enough memory is initially available.

Parameters

NameDescriptionDefault
totalSize The amount of memory in bytes to allocate without triggering a garbage collection. totalSize -lohSize must be less than or equal to the size of an ephemeral segment. For information on the size of an ephemeral segment, see the "Ephemeral generations and segments" section in the Fundamentals of Garbage Collection article.
lohSize The number of bytes in totalSize to use for large object heap (LOH) allocations.
disallowFullBlockingGC true to omit a full blocking garbage collection if the garbage collector is initially unable to allocate the specified memory on the small object heap (SOH) and LOH; otherwise, false.

Returns

true if the runtime was able to commit the required amount of memory and the garbage collector is able to enter no GC region latency mode; otherwise, false.

System.GC.WaitForFullGCApproach

Returns the status of a registered notification for determining whether a full, blocking garbage collection by the common language runtime is imminent.

Returns

The status of the registered garbage collection notification.

System.GC.WaitForFullGCApproach()

Returns, in a specified time-out period, the status of a registered notification for determining whether a full, blocking garbage collection by the common language runtime is imminent.

Parameters

NameDescriptionDefault
millisecondsTimeout The length of time to wait before a notification status can be obtained. Specify -1 to wait indefinitely.

Returns

The status of the registered garbage collection notification.

System.GC.WaitForFullGCApproach()

Returns, in a specified time-out period, the status of a registered notification for determining whether a full, blocking garbage collection by the common language runtime is imminent.

Parameters

NameDescriptionDefault
timeout The timeout on waiting for a full GC approach

Returns

The status of a registered full GC notification

System.GC.WaitForFullGCComplete

Returns the status of a registered notification for determining whether a full, blocking garbage collection by the common language runtime has completed.

Returns

The status of the registered garbage collection notification.

System.GC.WaitForFullGCComplete()

Returns, in a specified time-out period, the status of a registered notification for determining whether a full, blocking garbage collection by common language the runtime has completed.

Parameters

NameDescriptionDefault
millisecondsTimeout The length of time to wait before a notification status can be obtained. Specify -1 to wait indefinitely.

Returns

The status of the registered garbage collection notification.

System.GC.WaitForFullGCComplete()

Returns the status of a registered notification about whether a blocking garbage collection has completed. May wait indefinitely for a full collection.

Parameters

NameDescriptionDefault
timeout The timeout on waiting for a full collection

Returns

The status of a registered full GC notification

System.GC.WaitForPendingFinalizers

Suspends the current thread until the thread that is processing the queue of finalizers has emptied that queue.

System.GC.MaxGeneration

Gets the maximum number of generations that the system currently supports.

Returns

A value that ranges from zero to the maximum number of supported generations.

System.GCCollectionMode

Specifies the behavior for a forced garbage collection.

System.GCCollectionMode.Aggressive

Requests that the garbage collector decommit as much memory as possible.

System.GCCollectionMode.Default

The default setting for this enumeration, which is currently System.GCCollectionMode.Forced.

System.GCCollectionMode.Forced

Forces the garbage collection to occur immediately.

System.GCCollectionMode.Optimized

Allows the garbage collector to determine whether the current time is optimal to reclaim objects.

System.GCGenerationInfo

Represents the size and the fragmenation of a generation on entry and on exit of the GC reported in System.GCMemoryInfo.

System.GCGenerationInfo.FragmentationAfterBytes

Gets the fragmentation in bytes on exit from the reported collection.

Returns

A number representing the fragmentation in bytes on exit from the reported collection.

System.GCGenerationInfo.FragmentationBeforeBytes

Gets the fragmentation in bytes on entry to the reported collection.

Returns

A number representing the fragmentation in bytes on entry to the reported collection.

System.GCGenerationInfo.SizeAfterBytes

Gets the size in bytes on exit from the reported collection.

Returns

A number representing the size in bytes on exit from the reported collection.

System.GCGenerationInfo.SizeBeforeBytes

Gets the size in bytes on entry to the reported collection.

Returns

A number representing the size in bytes on entry to the reported collection.

System.GCKind

Specifies the kind of a garbage collection.

System.GCKind.Any

Any kind of collection.

System.GCKind.Background

A background collection. This is always a generation 2 collection.

System.GCKind.Ephemeral

A gen0 or gen1 collection.

System.GCKind.FullBlocking

A blocking gen2 collection.

System.GCMemoryInfo

Provides a set of APIs that can be used to retrieve garbage collection information.

System.GCMemoryInfo.Compacted

Gets a value that indicates if this is a compacting GC or not.

Returns

true if this is a compacting GC; false otherwise.

System.GCMemoryInfo.Concurrent

Gets a value that indicates if this is a concurrent GC (background GC) or not.

Returns

true if this is a concurrent GC (background GC); false otherwise.

System.GCMemoryInfo.FinalizationPendingCount

Gets the number of objects that are ready for finalization that this GC observed.

Returns

The total number of objects observed by this GC that are ready for finalization.

System.GCMemoryInfo.FragmentedBytes

Gets the total fragmentation when the last garbage collection occurred.

Returns

The total fragmentation when the last garbage collection occurred.

System.GCMemoryInfo.Generation

Gets the generation this GC collected. Collecting a generation also collects younger generations.

Returns

The generation this GC collected.

System.GCMemoryInfo.GenerationInfo

Gets the generation information for all generations.

Returns

The generation information for all generations.

System.GCMemoryInfo.HeapSizeBytes

Gets the total heap size when the last garbage collection occurred.

Returns

The total heap size, in bytes, when the last garbage collection occurred.

System.GCMemoryInfo.HighMemoryLoadThresholdBytes

Gets the high memory load threshold when the last garbage collection occurred.

Returns

The high memory load threshold, in bytes, when the last garbage collection occurred.

System.GCMemoryInfo.Index

Gets the index of this GC.

Returns

The index of this GC.

System.GCMemoryInfo.MemoryLoadBytes

Gets the physical memory load when the last garbage collection occurred.

Returns

The physical memory load, in bytes, when the last garbage collection occurred.

System.GCMemoryInfo.PauseDurations

Gets the durations of the pauses when all managed threads are suspended.

Returns

A timespan representing the pause durations.

System.GCMemoryInfo.PauseTimePercentage

Gets the pause time percentage in the GC so far. If the pause time is 1.2%, this property's value is 1.2. The value is calculated by taking the sum of all GC pauses so far and dividing that by the total elapsed time of the process since the runtime was loaded. This running counter is updated at the end of each GC. It does not distinguish between System.GCKind. That is, at every GC, the calculated value is updated, and when you access this property, it gets the latest calculated value.

Returns

The pause time percentage.

System.GCMemoryInfo.PinnedObjectsCount

Gets the number of pinned objects this GC observed.

Returns

The total number of pinned objects observed by this GC.

System.GCMemoryInfo.PromotedBytes

Gets the promoted bytes for this GC.

Returns

The number of promoted bytes for this GC.

System.GCMemoryInfo.TotalAvailableMemoryBytes

Gets the total available memory for the garbage collector to use when the last garbage collection occurred.

Returns

The total available memory, in bytes, for the garbage collector to use when the last garbage collection occurred.

System.GCMemoryInfo.TotalCommittedBytes

Gets the total committed bytes of the managed heap.

Returns

The total committed bytes of the managed heap.

System.GCNotificationStatus

Provides information about the current registration for notification of the next full garbage collection.

System.GCNotificationStatus.Canceled

The current registration was canceled by the user.

System.GCNotificationStatus.Failed

The notification failed for any reason.

System.GCNotificationStatus.NotApplicable

This value can result when there's no current registration for a garbage collection notification, or a full GC has happened but was done as a background GC (that is, a GC that runs mostly concurrently with user threads) instead of a full blocking GC. Background GC is enabled by default; disabling it improves the prediction accuracy but incurs larger GC pauses.

System.GCNotificationStatus.Succeeded

The notification was successful and the registration was not canceled.

System.GCNotificationStatus.Timeout

The time specified by the millisecondsTimeout parameter for either System.GC.WaitForFullGCApproach() or System.GC.WaitForFullGCComplete() has elapsed.

System.GenericUriParser

A customizable parser for a hierarchical URI.

System.GenericUriParser.#ctor()

Create a customizable parser for a hierarchical URI.

Parameters

NameDescriptionDefault
options Specify the options for this System.GenericUriParser.

System.GenericUriParserOptions

Specifies options for a System.UriParser.

System.GenericUriParserOptions.AllowEmptyAuthority

The parser allows a URI with no authority.

System.GenericUriParserOptions.Default

The parser: requires an authority; converts backslashes into forward slashes; unescapes path dots, forward slashes, and back slashes; and removes trailing dots, empty segments, and dots-only segments.

System.GenericUriParserOptions.DontCompressPath

The parser does not canonicalize the URI.

System.GenericUriParserOptions.DontConvertPathBackslashes

The parser does not convert back slashes into forward slashes.

System.GenericUriParserOptions.DontUnescapePathDotsAndSlashes

The parser does not unescape path dots, forward slashes, or back slashes.

System.GenericUriParserOptions.GenericAuthority

The parser allows a registry-based authority.

System.GenericUriParserOptions.Idn

The parser supports Internationalized Domain Name (IDN) parsing (IDN) of host names. Whether IDN is used is dictated by configuration values.

System.GenericUriParserOptions.IriParsing

The parser supports the parsing rules specified in RFC 3987 for International Resource Identifiers (IRI). Whether IRI is used is dictated by configuration values.

System.GenericUriParserOptions.NoFragment

The scheme does not define a fragment part.

System.GenericUriParserOptions.NoPort

The scheme does not define a port.

System.GenericUriParserOptions.NoQuery

The scheme does not define a query part.

System.GenericUriParserOptions.NoUserInfo

The scheme does not define a user information part.

System.Globalization.Calendar

Represents time in divisions, such as weeks, months, and years.

System.Globalization.Calendar.CurrentEra

Represents the current era of the current calendar. The value of this field is 0.

System.Globalization.Calendar.#ctor

Initializes a new instance of the System.Globalization.Calendar class.

System.Globalization.Calendar.AddDays()

Returns a System.DateTime that is the specified number of days away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add days.
days The number of days to add.

Returns

The System.DateTime that results from adding the specified number of days to the specified System.DateTime.

System.Globalization.Calendar.AddHours()

Returns a System.DateTime that is the specified number of hours away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add hours.
hours The number of hours to add.

Returns

The System.DateTime that results from adding the specified number of hours to the specified System.DateTime.

System.Globalization.Calendar.AddMilliseconds()

Returns a System.DateTime that is the specified number of milliseconds away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to add milliseconds to.
milliseconds The number of milliseconds to add.

Returns

The System.DateTime that results from adding the specified number of milliseconds to the specified System.DateTime.

System.Globalization.Calendar.AddMinutes()

Returns a System.DateTime that is the specified number of minutes away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add minutes.
minutes The number of minutes to add.

Returns

The System.DateTime that results from adding the specified number of minutes to the specified System.DateTime.

System.Globalization.Calendar.AddMonths()

When overridden in a derived class, returns a System.DateTime that is the specified number of months away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add months.
months The number of months to add.

Returns

The System.DateTime that results from adding the specified number of months to the specified System.DateTime.

System.Globalization.Calendar.AddSeconds()

Returns a System.DateTime that is the specified number of seconds away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add seconds.
seconds The number of seconds to add.

Returns

The System.DateTime that results from adding the specified number of seconds to the specified System.DateTime.

System.Globalization.Calendar.AddWeeks()

Returns a System.DateTime that is the specified number of weeks away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add weeks.
weeks The number of weeks to add.

Returns

The System.DateTime that results from adding the specified number of weeks to the specified System.DateTime.

System.Globalization.Calendar.AddYears()

When overridden in a derived class, returns a System.DateTime that is the specified number of years away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add years.
years The number of years to add.

Returns

The System.DateTime that results from adding the specified number of years to the specified System.DateTime.

System.Globalization.Calendar.Clone

Creates a new object that is a copy of the current System.Globalization.Calendar object.

Returns

A new instance of System.Object that is the memberwise clone of the current System.Globalization.Calendar object.

System.Globalization.Calendar.GetDayOfMonth()

When overridden in a derived class, returns the day of the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

A positive integer that represents the day of the month in the time parameter.

System.Globalization.Calendar.GetDayOfWeek()

When overridden in a derived class, returns the day of the week in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

A System.DayOfWeek value that represents the day of the week in the time parameter.

System.Globalization.Calendar.GetDayOfYear()

When overridden in a derived class, returns the day of the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

A positive integer that represents the day of the year in the time parameter.

System.Globalization.Calendar.GetDaysInMonth()

Returns the number of days in the specified month and year of the current era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month A positive integer that represents the month.

Returns

The number of days in the specified month in the specified year in the current era.

System.Globalization.Calendar.GetDaysInMonth()

When overridden in a derived class, returns the number of days in the specified month, year, and era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month A positive integer that represents the month.
era An integer that represents the era.

Returns

The number of days in the specified month in the specified year in the specified era.

System.Globalization.Calendar.GetDaysInYear()

Returns the number of days in the specified year of the current era.

Parameters

NameDescriptionDefault
year An integer that represents the year.

Returns

The number of days in the specified year in the current era.

System.Globalization.Calendar.GetDaysInYear()

When overridden in a derived class, returns the number of days in the specified year and era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of days in the specified year in the specified era.

System.Globalization.Calendar.GetEra()

When overridden in a derived class, returns the era of the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the era of time.

System.Globalization.Calendar.GetHour()

Returns the hours value in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 0 to 23 that represents the hour in time.

System.Globalization.Calendar.GetLeapMonth()

Calculates the leap month for a specified year.

Parameters

NameDescriptionDefault
year A year.

Returns

A positive integer that indicates the leap month in the specified year. -or- Zero if this calendar does not support a leap month or if the year parameter does not represent a leap year.

System.Globalization.Calendar.GetLeapMonth()

Calculates the leap month for a specified year and era.

Parameters

NameDescriptionDefault
year A year.
era An era.

Returns

A positive integer that indicates the leap month in the specified year and era. -or- Zero if this calendar does not support a leap month or if the year and era parameters do not specify a leap year.

System.Globalization.Calendar.GetMilliseconds()

Returns the milliseconds value in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

A double-precision floating-point number from 0 to 999 that represents the milliseconds in the time parameter.

System.Globalization.Calendar.GetMinute()

Returns the minutes value in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 0 to 59 that represents the minutes in time.

System.Globalization.Calendar.GetMonth()

When overridden in a derived class, returns the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

A positive integer that represents the month in time.

System.Globalization.Calendar.GetMonthsInYear()

Returns the number of months in the specified year in the current era.

Parameters

NameDescriptionDefault
year An integer that represents the year.

Returns

The number of months in the specified year in the current era.

System.Globalization.Calendar.GetMonthsInYear()

When overridden in a derived class, returns the number of months in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of months in the specified year in the specified era.

System.Globalization.Calendar.GetSecond()

Returns the seconds value in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 0 to 59 that represents the seconds in time.

System.Globalization.Calendar.GetWeekOfYear()

Returns the week of the year that includes the date in the specified System.DateTime value.

Parameters

NameDescriptionDefault
time A date and time value.
rule An enumeration value that defines a calendar week.
firstDayOfWeek An enumeration value that represents the first day of the week.

Returns

A positive integer that represents the week of the year that includes the date in the time parameter.

System.Globalization.Calendar.GetYear()

When overridden in a derived class, returns the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the year in time.

System.Globalization.Calendar.IsLeapDay()

Determines whether the specified date in the current era is a leap day.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month A positive integer that represents the month.
day A positive integer that represents the day.

Returns

true if the specified day is a leap day; otherwise, false.

System.Globalization.Calendar.IsLeapDay()

When overridden in a derived class, determines whether the specified date in the specified era is a leap day.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month A positive integer that represents the month.
day A positive integer that represents the day.
era An integer that represents the era.

Returns

true if the specified day is a leap day; otherwise, false.

System.Globalization.Calendar.IsLeapMonth()

Determines whether the specified month in the specified year in the current era is a leap month.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month A positive integer that represents the month.

Returns

true if the specified month is a leap month; otherwise, false.

System.Globalization.Calendar.IsLeapMonth()

When overridden in a derived class, determines whether the specified month in the specified year in the specified era is a leap month.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month A positive integer that represents the month.
era An integer that represents the era.

Returns

true if the specified month is a leap month; otherwise, false.

System.Globalization.Calendar.IsLeapYear()

Determines whether the specified year in the current era is a leap year.

Parameters

NameDescriptionDefault
year An integer that represents the year.

Returns

true if the specified year is a leap year; otherwise, false.

System.Globalization.Calendar.IsLeapYear()

When overridden in a derived class, determines whether the specified year in the specified era is a leap year.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

true if the specified year is a leap year; otherwise, false.

System.Globalization.Calendar.ReadOnly()

Returns a read-only version of the specified System.Globalization.Calendar object.

Parameters

NameDescriptionDefault
calendar A System.Globalization.Calendar object.

Returns

The System.Globalization.Calendar object specified by the calendar parameter, if calendar is read-only. -or- A read-only memberwise clone of the System.Globalization.Calendar object specified by calendar, if calendar is not read-only.

System.Globalization.Calendar.ToDateTime()

Returns a System.DateTime that is set to the specified date and time in the current era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month A positive integer that represents the month.
day A positive integer that represents the day.
hour An integer from 0 to 23 that represents the hour.
minute An integer from 0 to 59 that represents the minute.
second An integer from 0 to 59 that represents the second.
millisecond An integer from 0 to 999 that represents the millisecond.

Returns

The System.DateTime that is set to the specified date and time in the current era.

System.Globalization.Calendar.ToDateTime()

When overridden in a derived class, returns a System.DateTime that is set to the specified date and time in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month A positive integer that represents the month.
day A positive integer that represents the day.
hour An integer from 0 to 23 that represents the hour.
minute An integer from 0 to 59 that represents the minute.
second An integer from 0 to 59 that represents the second.
millisecond An integer from 0 to 999 that represents the millisecond.
era An integer that represents the era.

Returns

The System.DateTime that is set to the specified date and time in the current era.

System.Globalization.Calendar.ToFourDigitYear()

Converts the specified year to a four-digit year by using the System.Globalization.Calendar.TwoDigitYearMax property to determine the appropriate century.

Parameters

NameDescriptionDefault
year A two-digit or four-digit integer that represents the year to convert.

Returns

An integer that contains the four-digit representation of year.

System.Globalization.Calendar.AlgorithmType

Gets a value indicating whether the current calendar is solar-based, lunar-based, or a combination of both.

Returns

System.Globalization.Calendar.DaysInYearBeforeMinSupportedYear

Gets the number of days in the year that precedes the year that is specified by the System.Globalization.Calendar.MinSupportedDateTime property.

Returns

The number of days in the year that precedes the year specified by System.Globalization.Calendar.MinSupportedDateTime.

System.Globalization.Calendar.Eras

When overridden in a derived class, gets the list of eras in the current calendar.

Returns

An array of integers that represents the eras in the current calendar.

System.Globalization.Calendar.IsReadOnly

Gets a value indicating whether this System.Globalization.Calendar object is read-only.

Returns

true if this System.Globalization.Calendar object is read-only; otherwise, false.

System.Globalization.Calendar.MaxSupportedDateTime

Gets the latest date and time supported by this System.Globalization.Calendar object.

Returns

The latest date and time supported by this calendar. The default is DateTime.MaxValue.

System.Globalization.Calendar.MinSupportedDateTime

Gets the earliest date and time supported by this System.Globalization.Calendar object.

Returns

The earliest date and time supported by this calendar. The default is DateTime.MinValue.

System.Globalization.Calendar.TwoDigitYearMax

Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.

Returns

The last year of a 100-year range that can be represented by a 2-digit year.

System.Globalization.CalendarAlgorithmType

Specifies whether a calendar is solar-based, lunar-based, or lunisolar-based.

System.Globalization.CalendarAlgorithmType.LunarCalendar

A lunar-based calendar.

System.Globalization.CalendarAlgorithmType.LunisolarCalendar

A lunisolar-based calendar.

System.Globalization.CalendarAlgorithmType.SolarCalendar

A solar-based calendar.

System.Globalization.CalendarAlgorithmType.Unknown

An unknown calendar basis.

System.Globalization.CalendarWeekRule

Defines different rules for determining the first week of the year.

System.Globalization.CalendarWeekRule.FirstDay

Indicates that the first week of the year starts on the first day of the year and ends before the following designated first day of the week. The value is 0.

System.Globalization.CalendarWeekRule.FirstFourDayWeek

Indicates that the first week of the year is the first week with four or more days before the designated first day of the week. The value is 2.

System.Globalization.CalendarWeekRule.FirstFullWeek

Indicates that the first week of the year begins on the first occurrence of the designated first day of the week on or after the first day of the year. The value is 1.

System.Globalization.CharUnicodeInfo

Retrieves information about a Unicode character. This class cannot be inherited.

System.Globalization.CharUnicodeInfo.GetDecimalDigitValue()

Gets the decimal digit value of the specified numeric character.

Parameters

NameDescriptionDefault
ch The Unicode character for which to get the decimal digit value.

Returns

The decimal digit value of the specified numeric character. -or- -1, if the specified character is not a decimal digit.

System.Globalization.CharUnicodeInfo.GetDecimalDigitValue()

Gets the decimal digit value of the numeric character at the specified index of the specified string.

Parameters

NameDescriptionDefault
s The System.String containing the Unicode character for which to get the decimal digit value.
index The index of the Unicode character for which to get the decimal digit value.

Returns

The decimal digit value of the numeric character at the specified index of the specified string. -or- -1, if the character at the specified index of the specified string is not a decimal digit.

System.Globalization.CharUnicodeInfo.GetDigitValue()

Gets the digit value of the specified numeric character.

Parameters

NameDescriptionDefault
ch The Unicode character for which to get the digit value.

Returns

The digit value of the specified numeric character. -or- -1, if the specified character is not a digit.

System.Globalization.CharUnicodeInfo.GetDigitValue()

Gets the digit value of the numeric character at the specified index of the specified string.

Parameters

NameDescriptionDefault
s The System.String containing the Unicode character for which to get the digit value.
index The index of the Unicode character for which to get the digit value.

Returns

The digit value of the numeric character at the specified index of the specified string. -or- -1, if the character at the specified index of the specified string is not a digit.

System.Globalization.CharUnicodeInfo.GetNumericValue()

Gets the numeric value associated with the specified character.

Parameters

NameDescriptionDefault
ch The Unicode character for which to get the numeric value.

Returns

The numeric value associated with the specified character. -or- -1, if the specified character is not a numeric character.

System.Globalization.CharUnicodeInfo.GetNumericValue()

Gets the numeric value associated with the character at the specified index of the specified string.

Parameters

NameDescriptionDefault
s The System.String containing the Unicode character for which to get the numeric value.
index The index of the Unicode character for which to get the numeric value.

Returns

The numeric value associated with the character at the specified index of the specified string. -or- -1, if the character at the specified index of the specified string is not a numeric character.

System.Globalization.CharUnicodeInfo.GetUnicodeCategory()

Gets the Unicode category of the specified character.

Parameters

NameDescriptionDefault
ch The Unicode character for which to get the Unicode category.

Returns

A System.Globalization.UnicodeCategory value indicating the category of the specified character.

System.Globalization.CharUnicodeInfo.GetUnicodeCategory()

Gets the Unicode category of the specified character.

Parameters

NameDescriptionDefault
codePoint A number representing the 32-bit code point value of the Unicode character.

Returns

A System.Globalization.UnicodeCategory value indicating the category of the specified character.

System.Globalization.CharUnicodeInfo.GetUnicodeCategory()

Gets the Unicode category of the character at the specified index of the specified string.

Parameters

NameDescriptionDefault
s The System.String containing the Unicode character for which to get the Unicode category.
index The index of the Unicode character for which to get the Unicode category.

Returns

A System.Globalization.UnicodeCategory value indicating the category of the character at the specified index of the specified string.

System.Globalization.ChineseLunisolarCalendar

Represents time in divisions, such as months, days, and years. Years are calculated using the Chinese calendar, while days and months are calculated using the lunisolar calendar.

System.Globalization.ChineseLunisolarCalendar.ChineseEra

Specifies the era that corresponds to the current System.Globalization.ChineseLunisolarCalendar object.

System.Globalization.ChineseLunisolarCalendar.#ctor

Initializes a new instance of the System.Globalization.ChineseLunisolarCalendar class.

System.Globalization.ChineseLunisolarCalendar.GetEra()

Retrieves the era that corresponds to the specified System.DateTime type.

Parameters

NameDescriptionDefault
time The System.DateTime type to read.

Returns

An integer that represents the era in the time parameter.

System.Globalization.ChineseLunisolarCalendar.DaysInYearBeforeMinSupportedYear

Gets the number of days in the year that precedes the year that is specified by the System.Globalization.ChineseLunisolarCalendar.MinSupportedDateTime property.

Returns

The number of days in the year that precedes the year specified by System.Globalization.ChineseLunisolarCalendar.MinSupportedDateTime.

System.Globalization.ChineseLunisolarCalendar.Eras

Gets the eras that correspond to the range of dates and times supported by the current System.Globalization.ChineseLunisolarCalendar object.

Returns

An array of 32-bit signed integers that specify the relevant eras. The return value for a System.Globalization.ChineseLunisolarCalendar object is always an array containing one element equal to the System.Globalization.ChineseLunisolarCalendar.ChineseEra value.

System.Globalization.ChineseLunisolarCalendar.MaxSupportedDateTime

Gets the maximum date and time supported by the System.Globalization.ChineseLunisolarCalendar class.

Returns

A System.DateTime type that represents the last moment on January 28, 2101 in the Gregorian calendar, which is approximately equal to the constructor DateTime(2101, 1, 28, 23, 59, 59, 999).

System.Globalization.ChineseLunisolarCalendar.MinSupportedDateTime

Gets the minimum date and time supported by the System.Globalization.ChineseLunisolarCalendar class.

Returns

A System.DateTime type that represents February 19, 1901 in the Gregorian calendar, which is equivalent to the constructor, DateTime(1901, 2, 19).

System.Globalization.CompareInfo

Implements a set of methods for culture-sensitive string comparisons.

System.Globalization.CompareInfo.Compare()

Compares two read-only spans of characters.

Parameters

NameDescriptionDefault
string1 The first read-only span of characters to compare.
string2 The second read-only span of characters to compare.
options An optional combination of System.Globalization.CompareOptions enumeration values to use during the comparison. The default value is System.Globalization.CompareOptions.None.

Returns

Zero if string1 and string2 are equal; or a negative value if string1 sorts before string2; or a positive value if string1 sorts after string2.

System.Globalization.CompareInfo.Compare()

Compares a section of one string with a section of another string.

Parameters

NameDescriptionDefault
string1 The first string to compare.
offset1 The zero-based index of the character in string1 at which to start comparing.
length1 The number of consecutive characters in string1 to compare.
string2 The second string to compare.
offset2 The zero-based index of the character in string2 at which to start comparing.
length2 The number of consecutive characters in string2 to compare.

Returns

A 32-bit signed integer indicating the lexical relationship between the two comparands. Value Condition zero The two strings are equal. less than zero The specified section of string1 is less than the specified section of string2. greater than zero The specified section of string1 is greater than the specified section of string2.

System.Globalization.CompareInfo.Compare()

Compares a section of one string with a section of another string using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
string1 The first string to compare.
offset1 The zero-based index of the character in string1 at which to start comparing.
length1 The number of consecutive characters in string1 to compare.
string2 The second string to compare.
offset2 The zero-based index of the character in string2 at which to start comparing.
length2 The number of consecutive characters in string2 to compare.
options A value that defines how string1 and string2 should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, System.Globalization.CompareOptions.IgnoreKanaType, and System.Globalization.CompareOptions.StringSort.

Returns

A 32-bit signed integer indicating the lexical relationship between the two comparands. Value Condition zero The two strings are equal. less than zero The specified section of string1 is less than the specified section of string2. greater than zero The specified section of string1 is greater than the specified section of string2.

System.Globalization.CompareInfo.Compare()

Compares the end section of a string with the end section of another string.

Parameters

NameDescriptionDefault
string1 The first string to compare.
offset1 The zero-based index of the character in string1 at which to start comparing.
string2 The second string to compare.
offset2 The zero-based index of the character in string2 at which to start comparing.

Returns

A 32-bit signed integer indicating the lexical relationship between the two comparands. Value Condition zero The two strings are equal. less than zero The specified section of string1 is less than the specified section of string2. greater than zero The specified section of string1 is greater than the specified section of string2.

System.Globalization.CompareInfo.Compare()

Compares the end section of a string with the end section of another string using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
string1 The first string to compare.
offset1 The zero-based index of the character in string1 at which to start comparing.
string2 The second string to compare.
offset2 The zero-based index of the character in string2 at which to start comparing.
options A value that defines how string1 and string2 should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, System.Globalization.CompareOptions.IgnoreKanaType, and System.Globalization.CompareOptions.StringSort.

Returns

A 32-bit signed integer indicating the lexical relationship between the two comparands. Value Condition zero The two strings are equal. less than zero The specified section of string1 is less than the specified section of string2. greater than zero The specified section of string1 is greater than the specified section of string2.

System.Globalization.CompareInfo.Compare()

Compares two strings.

Parameters

NameDescriptionDefault
string1 The first string to compare.
string2 The second string to compare.

Returns

A 32-bit signed integer indicating the lexical relationship between the two comparands. Value Condition zero The two strings are equal. less than zerostring1 is less than string2. greater than zerostring1 is greater than string2.

System.Globalization.CompareInfo.Compare()

Compares two strings using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
string1 The first string to compare.
string2 The second string to compare.
options A value that defines how string1 and string2 should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, System.Globalization.CompareOptions.IgnoreKanaType, and System.Globalization.CompareOptions.StringSort.

Returns

A 32-bit signed integer indicating the lexical relationship between the two comparands. Value Condition zero The two strings are equal. less than zerostring1 is less than string2. greater than zerostring1 is greater than string2.

System.Globalization.CompareInfo.Equals()

Determines whether the specified object is equal to the current System.Globalization.CompareInfo object.

Parameters

NameDescriptionDefault
value The object to compare with the current System.Globalization.CompareInfo.

Returns

true if the specified object is equal to the current System.Globalization.CompareInfo; otherwise, false.

System.Globalization.CompareInfo.GetCompareInfo()

Initializes a new System.Globalization.CompareInfo object that is associated with the culture with the specified identifier.

Parameters

NameDescriptionDefault
culture An integer representing the culture identifier.

Returns

A new System.Globalization.CompareInfo object associated with the culture with the specified identifier and using string comparison methods in the current System.Reflection.Assembly.

System.Globalization.CompareInfo.GetCompareInfo()

Initializes a new System.Globalization.CompareInfo object that is associated with the specified culture and that uses string comparison methods in the specified System.Reflection.Assembly.

Parameters

NameDescriptionDefault
culture An integer representing the culture identifier.
assembly An System.Reflection.Assembly that contains the string comparison methods to use.

Returns

A new System.Globalization.CompareInfo object associated with the culture with the specified identifier and using string comparison methods in the current System.Reflection.Assembly.

System.Globalization.CompareInfo.GetCompareInfo()

Initializes a new System.Globalization.CompareInfo object that is associated with the culture with the specified name.

Parameters

NameDescriptionDefault
name A string representing the culture name.

Returns

A new System.Globalization.CompareInfo object associated with the culture with the specified identifier and using string comparison methods in the current System.Reflection.Assembly.

System.Globalization.CompareInfo.GetCompareInfo()

Initializes a new System.Globalization.CompareInfo object that is associated with the specified culture and that uses string comparison methods in the specified System.Reflection.Assembly.

Parameters

NameDescriptionDefault
name A string representing the culture name.
assembly An System.Reflection.Assembly that contains the string comparison methods to use.

Returns

A new System.Globalization.CompareInfo object associated with the culture with the specified identifier and using string comparison methods in the current System.Reflection.Assembly.

System.Globalization.CompareInfo.GetHashCode

Serves as a hash function for the current System.Globalization.CompareInfo for hashing algorithms and data structures, such as a hash table.

Returns

A hash code for the current System.Globalization.CompareInfo.

System.Globalization.CompareInfo.GetHashCode()

Gets the hash code for a character span based on specified comparison options.

Parameters

NameDescriptionDefault
source The character span whose hash code is to be returned.
options A value that determines how strings are compared.

Returns

A 32-bit signed integer hash code.

System.Globalization.CompareInfo.GetHashCode()

Gets the hash code for a string based on specified comparison options.

Parameters

NameDescriptionDefault
source The string whose hash code is to be returned.
options A value that determines how strings are compared.

Returns

A 32-bit signed integer hash code.

System.Globalization.CompareInfo.GetSortKey()

Computes a sort key for the specified input.

Parameters

NameDescriptionDefault
source The text to get the sort key for.
destination The buffer into which the resulting sort key bytes are stored.
options An optional combination of System.Globalization.CompareOptions enumeration values to use for computing the sort key. The default value is System.Globalization.CompareOptions.None.

Returns

The number of bytes written to destination.

System.Globalization.CompareInfo.GetSortKey()

Gets the sort key for the specified string.

Parameters

NameDescriptionDefault
source The string for which a System.Globalization.SortKey object is obtained.

Returns

The System.Globalization.SortKey object that contains the sort key for the specified string.

System.Globalization.CompareInfo.GetSortKey()

Gets a System.Globalization.SortKey object for the specified string using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
source The string for which a System.Globalization.SortKey object is obtained.
options A bitwise combination of one or more of the following enumeration values that define how the sort key is calculated: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, System.Globalization.CompareOptions.IgnoreKanaType, and System.Globalization.CompareOptions.StringSort.

Returns

The System.Globalization.SortKey object that contains the sort key for the specified string.

System.Globalization.CompareInfo.GetSortKeyLength()

Gets the total number of sort key bytes that would be produced from the specified input.

Parameters

NameDescriptionDefault
source The text to get the sort key for.
options An optional combination of System.Globalization.CompareOptions enumeration values to use for computing the sort key. The default value is System.Globalization.CompareOptions.None.

Returns

The length, in bytes, of the sort key.

System.Globalization.CompareInfo.IndexOf()

Searches for the first occurrence of a substring within the specified read-only span of characters.

Parameters

NameDescriptionDefault
source The string to search within.
value The substring to locate within source.
options An optional combination of System.Globalization.CompareOptions enumeration values to use during the search. The default value is System.Globalization.CompareOptions.None.

Returns

The zero-based index into source where the substring value first appears; or a negative value if value cannot be found within source.

System.Globalization.CompareInfo.IndexOf()

Searches for the first occurrence of a substring within a source string.

Parameters

NameDescriptionDefault
source The read-only span of characters to search within.
value The read-only span of characters containing the substring to locate within source.
options The System.Globalization.CompareOptions to use during the search.
matchLength When this method returns, contains the number of characters of source that matched the desired value. This may be different than the length of value if a linguistic comparison is performed. Set to 0 if value is not found within source.

Returns

The zero-based index into source where the substring value first appears; or a negative value if value cannot be found within source.

System.Globalization.CompareInfo.IndexOf()

Searches for the first occurrence of a System.Text.Rune within the specified read-only span of characters.

Parameters

NameDescriptionDefault
source The read-only span of characters to search within.
value The System.Text.Rune to locate within source.
options An optional combination of System.Globalization.CompareOptions enumeration values to use during the search. The default value is System.Globalization.CompareOptions.None.

Returns

The zero-based index into source where value first appears; or a negative value if value cannot be found within source.

System.Globalization.CompareInfo.IndexOf()

Searches for the specified character and returns the zero-based index of the first occurrence within the entire source string.

Parameters

NameDescriptionDefault
source The string to search.
value The character to locate within source.

Returns

The zero-based index of the first occurrence of value, if found, within source; otherwise, -1. Returns 0 (zero) if value is an ignorable character.

System.Globalization.CompareInfo.IndexOf()

Searches for the specified character and returns the zero-based index of the first occurrence within the entire source string using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
source The string to search.
value The character to locate within source.
options A value that defines how the strings should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, and System.Globalization.CompareOptions.IgnoreKanaType.

Returns

The zero-based index of the first occurrence of value, if found, within source, using the specified comparison options; otherwise, -1. Returns 0 (zero) if value is an ignorable character.

System.Globalization.CompareInfo.IndexOf()

Searches for the specified character and returns the zero-based index of the first occurrence within the section of the source string that extends from the specified index to the end of the string.

Parameters

NameDescriptionDefault
source The string to search.
value The character to locate within source.
startIndex The zero-based starting index of the search.

Returns

The zero-based index of the first occurrence of value, if found, within the section of source that extends from startIndex to the end of source; otherwise, -1. Returns startIndex if value is an ignorable character.

System.Globalization.CompareInfo.IndexOf()

Searches for the specified character and returns the zero-based index of the first occurrence within the section of the source string that extends from the specified index to the end of the string using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
source The string to search.
value The character to locate within source.
startIndex The zero-based starting index of the search.
options A value that defines how source and value should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, and System.Globalization.CompareOptions.IgnoreKanaType.

Returns

The zero-based index of the first occurrence of value, if found, within the section of source that extends from startIndex to the end of source, using the specified comparison options; otherwise, -1. Returns startIndex if value is an ignorable character.

System.Globalization.CompareInfo.IndexOf()

Searches for the specified character and returns the zero-based index of the first occurrence within the section of the source string that starts at the specified index and contains the specified number of elements.

Parameters

NameDescriptionDefault
source The string to search.
value The character to locate within source.
startIndex The zero-based starting index of the search.
count The number of elements in the section to search.

Returns

The zero-based index of the first occurrence of value, if found, within the section of source that starts at startIndex and contains the number of elements specified by count; otherwise, -1. Returns startIndex if value is an ignorable character.

System.Globalization.CompareInfo.IndexOf()

Searches for the specified character and returns the zero-based index of the first occurrence within the section of the source string that starts at the specified index and contains the specified number of elements using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
source The string to search.
value The character to locate within source.
startIndex The zero-based starting index of the search.
count The number of elements in the section to search.
options A value that defines how source and value should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, and System.Globalization.CompareOptions.IgnoreKanaType.

Returns

The zero-based index of the first occurrence of value, if found, within the section of source that starts at startIndex and contains the number of elements specified by count, using the specified comparison options; otherwise, -1. Returns startIndex if value is an ignorable character.

System.Globalization.CompareInfo.IndexOf()

Searches for the specified substring and returns the zero-based index of the first occurrence within the entire source string.

Parameters

NameDescriptionDefault
source The string to search.
value The string to locate within source.

Returns

The zero-based index of the first occurrence of value, if found, within source; otherwise, -1. Returns 0 (zero) if value is an ignorable character.

System.Globalization.CompareInfo.IndexOf()

Searches for the specified substring and returns the zero-based index of the first occurrence within the entire source string using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
source The string to search.
value The string to locate within source.
options A value that defines how source and value should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, and System.Globalization.CompareOptions.IgnoreKanaType.

Returns

The zero-based index of the first occurrence of value, if found, within source, using the specified comparison options; otherwise, -1. Returns 0 (zero) if value is an ignorable character.

System.Globalization.CompareInfo.IndexOf()

Searches for the specified substring and returns the zero-based index of the first occurrence within the section of the source string that extends from the specified index to the end of the string.

Parameters

NameDescriptionDefault
source The string to search.
value The string to locate within source.
startIndex The zero-based starting index of the search.

Returns

The zero-based index of the first occurrence of value, if found, within the section of source that extends from startIndex to the end of source; otherwise, -1. Returns startIndex if value is an ignorable character.

System.Globalization.CompareInfo.IndexOf()

Searches for the specified substring and returns the zero-based index of the first occurrence within the section of the source string that extends from the specified index to the end of the string using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
source The string to search.
value The string to locate within source.
startIndex The zero-based starting index of the search.
options A value that defines how source and value should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, and System.Globalization.CompareOptions.IgnoreKanaType.

Returns

The zero-based index of the first occurrence of value, if found, within the section of source that extends from startIndex to the end of source, using the specified comparison options; otherwise, -1. Returns startIndex if value is an ignorable character.

System.Globalization.CompareInfo.IndexOf()

Searches for the specified substring and returns the zero-based index of the first occurrence within the section of the source string that starts at the specified index and contains the specified number of elements.

Parameters

NameDescriptionDefault
source The string to search.
value The string to locate within source.
startIndex The zero-based starting index of the search.
count The number of elements in the section to search.

Returns

The zero-based index of the first occurrence of value, if found, within the section of source that starts at startIndex and contains the number of elements specified by count; otherwise, -1. Returns startIndex if value is an ignorable character.

System.Globalization.CompareInfo.IndexOf()

Searches for the specified substring and returns the zero-based index of the first occurrence within the section of the source string that starts at the specified index and contains the specified number of elements using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
source The string to search.
value The string to locate within source.
startIndex The zero-based starting index of the search.
count The number of elements in the section to search.
options A value that defines how source and value should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, and System.Globalization.CompareOptions.IgnoreKanaType.

Returns

The zero-based index of the first occurrence of value, if found, within the section of source that starts at startIndex and contains the number of elements specified by count, using the specified comparison options; otherwise, -1. Returns startIndex if value is an ignorable character.

System.Globalization.CompareInfo.IsPrefix()

Determines whether a read-only span of characters starts with a specific prefix.

Parameters

NameDescriptionDefault
source The read-only span of characters to search within.
prefix The prefix to attempt to match at the start of source.
options An optional combination of System.Globalization.CompareOptions enumeration values to use during the match. The default value is System.Globalization.CompareOptions.None.

Returns

true if prefix occurs at the start of source; otherwise, false.

System.Globalization.CompareInfo.IsPrefix()

Determines whether a string starts with a specific prefix.

Parameters

NameDescriptionDefault
source The read-only span of characters to search within.
prefix The read-only span of characters containing the prefix to attempt to match at the start of source.
options The System.Globalization.CompareOptions to use during the match.
matchLength When this method returns, contains the number of characters of source that matched the desired prefix. This may be different than the length of prefix if a linguistic comparison is performed. Set to 0 if the prefix did not match.

Returns

true if prefix occurs at the start of source; otherwise, false.

System.Globalization.CompareInfo.IsPrefix()

Determines whether the specified source string starts with the specified prefix.

Parameters

NameDescriptionDefault
source The string to search in.
prefix The string to compare with the beginning of source.

Returns

true if the length of prefix is less than or equal to the length of source and source starts with prefix; otherwise, false.

System.Globalization.CompareInfo.IsPrefix()

Determines whether the specified source string starts with the specified prefix using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
source The string to search in.
prefix The string to compare with the beginning of source.
options A value that defines how source and prefix should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, and System.Globalization.CompareOptions.IgnoreKanaType.

Returns

true if the length of prefix is less than or equal to the length of source and source starts with prefix; otherwise, false.

System.Globalization.CompareInfo.IsSortable()

Indicates whether a specified Unicode character is sortable.

Parameters

NameDescriptionDefault
ch A Unicode character.

Returns

true if the ch parameter is sortable; otherwise, false.

System.Globalization.CompareInfo.IsSortable()

Indicates whether a specified Unicode read-only span of characters is sortable.

Parameters

NameDescriptionDefault
text A read-only span of characters of zero or more Unicode characters.

Returns

true if text is non-empty and contains only sortable Unicode characters; otherwise, false.

System.Globalization.CompareInfo.IsSortable()

Indicates whether a specified Unicode string is sortable.

Parameters

NameDescriptionDefault
text A string of zero or more Unicode characters.

Returns

true if the str parameter is not an empty string ("") and all the Unicode characters in str are sortable; otherwise, false.

System.Globalization.CompareInfo.IsSortable()

Indicates whether a specified System.Text.Rune is sortable.

Parameters

NameDescriptionDefault
value A Unicode scalar value.

Returns

true if value is a sortable Unicode scalar value; otherwise, false.

System.Globalization.CompareInfo.IsSuffix()

Determines whether a read-only span of characters ends with a specific suffix.

Parameters

NameDescriptionDefault
source The read-only span of characters to search within.
suffix The suffix to attempt to match at the end of source.
options An optional combination of System.Globalization.CompareOptions enumeration values to use during the match. The default value is System.Globalization.CompareOptions.None.

Returns

true if suffix occurs at the end of source; otherwise, false.

System.Globalization.CompareInfo.IsSuffix()

Determines whether a string ends with a specific suffix.

Parameters

NameDescriptionDefault
source The read-only span of characters to search within.
suffix The read-only span of characters containing the suffix to attempt to match at the end of source.
options The System.Globalization.CompareOptions to use during the match.
matchLength When this method returns, contains the number of characters of source that matched the desired suffix. This may be different than the length of suffix if a linguistic comparison is performed. Set to 0 if the suffix did not match.

Returns

true if suffix occurs at the end of source; otherwise, false.

System.Globalization.CompareInfo.IsSuffix()

Determines whether the specified source string ends with the specified suffix.

Parameters

NameDescriptionDefault
source The string to search in.
suffix The string to compare with the end of source.

Returns

true if the length of suffix is less than or equal to the length of source and source ends with suffix; otherwise, false.

System.Globalization.CompareInfo.IsSuffix()

Determines whether the specified source string ends with the specified suffix using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
source The string to search in.
suffix The string to compare with the end of source.
options A value that defines how source and suffix should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal used by itself, or the bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, and System.Globalization.CompareOptions.IgnoreKanaType.

Returns

true if the length of suffix is less than or equal to the length of source and source ends with suffix; otherwise, false.

System.Globalization.CompareInfo.LastIndexOf()

Searches for the last occurrence of a substring within the specified read-only span of characters.

Parameters

NameDescriptionDefault
source The read-only span of characters to search within.
value The substring to locate within source.
options An optional combination of System.Globalization.CompareOptions enumeration values to use during the search. The default value is System.Globalization.CompareOptions.None.

Returns

The zero-based index into source where the substring value last appears; or a negative value if value cannot be found within source.

System.Globalization.CompareInfo.LastIndexOf()

Searches for the last occurrence of a substring within a source string.

Parameters

NameDescriptionDefault
source The read-only span of characters to search within.
value The read-only span of characters containing the substring to locate within source.
options The System.Globalization.CompareOptions to use during the search.
matchLength When this method returns, contains the number of characters of source that matched the desired value. This may be different than the length of value if a linguistic comparison is performed. Set to 0 if value is not found within source.

Returns

The zero-based index into source where the substring value last appears; or a negative number if value cannot be found within source.

System.Globalization.CompareInfo.LastIndexOf()

Searches for the last occurrence of a System.Text.Rune within the specified read-only span of characters.

Parameters

NameDescriptionDefault
source The read-only span of characters to search within.
value The System.Text.Rune to locate within source.
options An optional combination of System.Globalization.CompareOptions enumeration values to use during the search. The default value is System.Globalization.CompareOptions.None.

Returns

The zero-based index into source where value last appears; or a negative value if value cannot be found within source.

System.Globalization.CompareInfo.LastIndexOf()

Searches for the specified character and returns the zero-based index of the last occurrence within the entire source string.

Parameters

NameDescriptionDefault
source The string to search.
value The character to locate within source.

Returns

The zero-based index of the last occurrence of value, if found, within source; otherwise, -1.

System.Globalization.CompareInfo.LastIndexOf()

Searches for the specified character and returns the zero-based index of the last occurrence within the entire source string using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
source The string to search.
value The character to locate within source.
options A value that defines how source and value should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, and System.Globalization.CompareOptions.IgnoreKanaType.

Returns

The zero-based index of the last occurrence of value, if found, within source, using the specified comparison options; otherwise, -1.

System.Globalization.CompareInfo.LastIndexOf()

Searches for the specified character and returns the zero-based index of the last occurrence within the section of the source string that extends from the beginning of the string to the specified index.

Parameters

NameDescriptionDefault
source The string to search.
value The character to locate within source.
startIndex The zero-based starting index of the backward search.

Returns

The zero-based index of the last occurrence of value, if found, within the section of source that extends from the beginning of source to startIndex; otherwise, -1. Returns startIndex if value is an ignorable character.

System.Globalization.CompareInfo.LastIndexOf()

Searches for the specified character and returns the zero-based index of the last occurrence within the section of the source string that extends from the beginning of the string to the specified index using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
source The string to search.
value The character to locate within source.
startIndex The zero-based starting index of the backward search.
options A value that defines how source and value should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, and System.Globalization.CompareOptions.IgnoreKanaType.

Returns

The zero-based index of the last occurrence of value, if found, within the section of source that extends from the beginning of source to startIndex, using the specified comparison options; otherwise, -1. Returns startIndex if value is an ignorable character.

System.Globalization.CompareInfo.LastIndexOf()

Searches for the specified character and returns the zero-based index of the last occurrence within the section of the source string that contains the specified number of elements and ends at the specified index.

Parameters

NameDescriptionDefault
source The string to search.
value The character to locate within source.
startIndex The zero-based starting index of the backward search.
count The number of elements in the section to search.

Returns

The zero-based index of the last occurrence of value, if found, within the section of source that contains the number of elements specified by count and that ends at startIndex; otherwise, -1. Returns startIndex if value is an ignorable character.

System.Globalization.CompareInfo.LastIndexOf()

Searches for the specified character and returns the zero-based index of the last occurrence within the section of the source string that contains the specified number of elements and ends at the specified index using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
source The string to search.
value The character to locate within source.
startIndex The zero-based starting index of the backward search.
count The number of elements in the section to search.
options A value that defines how source and value should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, and System.Globalization.CompareOptions.IgnoreKanaType.

Returns

The zero-based index of the last occurrence of value, if found, within the section of source that contains the number of elements specified by count and that ends at startIndex, using the specified comparison options; otherwise, -1. Returns startIndex if value is an ignorable character.

System.Globalization.CompareInfo.LastIndexOf()

Searches for the specified substring and returns the zero-based index of the last occurrence within the entire source string.

Parameters

NameDescriptionDefault
source The string to search.
value The string to locate within source.

Returns

The zero-based index of the last occurrence of value, if found, within source; otherwise, -1.

System.Globalization.CompareInfo.LastIndexOf()

Searches for the specified substring and returns the zero-based index of the last occurrence within the entire source string using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
source The string to search.
value The string to locate within source.
options A value that defines how source and value should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, and System.Globalization.CompareOptions.IgnoreKanaType.

Returns

The zero-based index of the last occurrence of value, if found, within source, using the specified comparison options; otherwise, -1.

System.Globalization.CompareInfo.LastIndexOf()

Searches for the specified substring and returns the zero-based index of the last occurrence within the section of the source string that extends from the beginning of the string to the specified index.

Parameters

NameDescriptionDefault
source The string to search.
value The string to locate within source.
startIndex The zero-based starting index of the backward search.

Returns

The zero-based index of the last occurrence of value, if found, within the section of source that extends from the beginning of source to startIndex; otherwise, -1. Returns startIndex if value is an ignorable character.

System.Globalization.CompareInfo.LastIndexOf()

Searches for the specified substring and returns the zero-based index of the last occurrence within the section of the source string that extends from the beginning of the string to the specified index using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
source The string to search.
value The string to locate within source.
startIndex The zero-based starting index of the backward search.
options A value that defines how source and value should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, and System.Globalization.CompareOptions.IgnoreKanaType.

Returns

The zero-based index of the last occurrence of value, if found, within the section of source that extends from the beginning of source to startIndex, using the specified comparison options; otherwise, -1. Returns startIndex if value is an ignorable character.

System.Globalization.CompareInfo.LastIndexOf()

Searches for the specified substring and returns the zero-based index of the last occurrence within the section of the source string that contains the specified number of elements and ends at the specified index.

Parameters

NameDescriptionDefault
source The string to search.
value The string to locate within source.
startIndex The zero-based starting index of the backward search.
count The number of elements in the section to search.

Returns

The zero-based index of the last occurrence of value, if found, within the section of source that contains the number of elements specified by count and that ends at startIndex; otherwise, -1. Returns startIndex if value is an ignorable character.

System.Globalization.CompareInfo.LastIndexOf()

Searches for the specified substring and returns the zero-based index of the last occurrence within the section of the source string that contains the specified number of elements and ends at the specified index using the specified System.Globalization.CompareOptions value.

Parameters

NameDescriptionDefault
source The string to search.
value The string to locate within source.
startIndex The zero-based starting index of the backward search.
count The number of elements in the section to search.
options A value that defines how source and value should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, and System.Globalization.CompareOptions.IgnoreKanaType.

Returns

The zero-based index of the last occurrence of value, if found, within the section of source that contains the number of elements specified by count and that ends at startIndex, using the specified comparison options; otherwise, -1. Returns startIndex if value is an ignorable character.

System.Globalization.CompareInfo.System#Runtime#Serialization#IDeserializationCallback#OnDeserialization()

Runs when the entire object graph has been deserialized.

Parameters

NameDescriptionDefault
sender The object that initiated the callback.

System.Globalization.CompareInfo.ToString

Returns a string that represents the current System.Globalization.CompareInfo object.

Returns

A string that represents the current System.Globalization.CompareInfo object.

System.Globalization.CompareInfo.LCID

Gets the properly formed culture identifier for the current System.Globalization.CompareInfo.

Returns

The properly formed culture identifier for the current System.Globalization.CompareInfo.

System.Globalization.CompareInfo.Name

Gets the name of the culture used for sorting operations by this System.Globalization.CompareInfo object.

Returns

The name of a culture.

System.Globalization.CompareInfo.Version

Gets information about the version of Unicode used for comparing and sorting strings.

Returns

An object that contains information about the Unicode version used for comparing and sorting strings.

System.Globalization.CompareOptions

Defines the string comparison options to use with System.Globalization.CompareInfo.

System.Globalization.CompareOptions.IgnoreCase

Indicates that the string comparison must ignore case.

System.Globalization.CompareOptions.IgnoreKanaType

Indicates that the string comparison must ignore the Kana type. Kana type refers to Japanese hiragana and katakana characters, which represent phonetic sounds in the Japanese language. Hiragana is used for native Japanese expressions and words, while katakana is used for words borrowed from other languages, such as "computer" or "Internet". A phonetic sound can be expressed in both hiragana and katakana. If this value is selected, the hiragana character for one sound is considered equal to the katakana character for the same sound.

System.Globalization.CompareOptions.IgnoreNonSpace

Indicates that the string comparison must ignore nonspacing combining characters, such as diacritics. The Unicode Standard defines combining characters as characters that are combined with base characters to produce a new character. Nonspacing combining characters do not occupy a spacing position by themselves when rendered.

System.Globalization.CompareOptions.IgnoreSymbols

Indicates that the string comparison must ignore symbols, such as white-space characters, punctuation, currency symbols, the percent sign, mathematical symbols, the ampersand, and so on.

System.Globalization.CompareOptions.IgnoreWidth

Indicates that the string comparison must ignore the character width. For example, Japanese katakana characters can be written as full-width or half-width. If this value is selected, the katakana characters written as full-width are considered equal to the same characters written as half-width.

System.Globalization.CompareOptions.None

Indicates the default option settings for string comparisons.

System.Globalization.CompareOptions.Ordinal

Indicates that the string comparison must use successive Unicode UTF-16 encoded values of the string (code unit by code unit comparison), leading to a fast comparison but one that is culture-insensitive. A string starting with a code unit XXXX16 comes before a string starting with YYYY16, if XXXX16 is less than YYYY16. This value cannot be combined with other System.Globalization.CompareOptions values and must be used alone.

System.Globalization.CompareOptions.OrdinalIgnoreCase

String comparison must ignore case, then perform an ordinal comparison. This technique is equivalent to converting the string to uppercase using the invariant culture and then performing an ordinal comparison on the result.

System.Globalization.CompareOptions.StringSort

Indicates that the string comparison must use the string sort algorithm. In a string sort, the hyphen and the apostrophe, as well as other nonalphanumeric symbols, come before alphanumeric characters.

System.Globalization.CultureInfo

Provides information about a specific culture (called a locale for unmanaged code development). The information includes the names for the culture, the writing system, the calendar used, the sort order of strings, and formatting for dates and numbers.

System.Globalization.CultureInfo.#ctor()

Initializes a new instance of the System.Globalization.CultureInfo class based on the culture specified by the culture identifier.

Parameters

NameDescriptionDefault
culture A predefined System.Globalization.CultureInfo identifier, System.Globalization.CultureInfo.LCID property of an existing System.Globalization.CultureInfo object, or Windows-only culture identifier.

System.Globalization.CultureInfo.#ctor()

Initializes a new instance of the System.Globalization.CultureInfo class based on the culture specified by the culture identifier and on a value that specifies whether to use the user-selected culture settings from Windows.

Parameters

NameDescriptionDefault
culture A predefined System.Globalization.CultureInfo identifier, System.Globalization.CultureInfo.LCID property of an existing System.Globalization.CultureInfo object, or Windows-only culture identifier.
useUserOverride true to use the user-selected culture settings (Windows only); false to use the default culture settings.

System.Globalization.CultureInfo.#ctor()

Initializes a new instance of the System.Globalization.CultureInfo class based on the culture specified by name.

Parameters

NameDescriptionDefault
name A predefined System.Globalization.CultureInfo name, System.Globalization.CultureInfo.Name of an existing System.Globalization.CultureInfo, or Windows-only culture name. name is not case-sensitive.

System.Globalization.CultureInfo.#ctor()

Initializes a new instance of the System.Globalization.CultureInfo class based on the culture specified by name and on a value that specifies whether to use the user-selected culture settings from Windows.

Parameters

NameDescriptionDefault
name A predefined System.Globalization.CultureInfo name, System.Globalization.CultureInfo.Name of an existing System.Globalization.CultureInfo, or Windows-only culture name. name is not case-sensitive.
useUserOverride true to use the user-selected culture settings (Windows only); false to use the default culture settings.

System.Globalization.CultureInfo.ClearCachedData

Refreshes cached culture-related information.

System.Globalization.CultureInfo.Clone

Creates a copy of the current System.Globalization.CultureInfo.

Returns

A copy of the current System.Globalization.CultureInfo.

System.Globalization.CultureInfo.CreateSpecificCulture()

Creates a System.Globalization.CultureInfo that represents the specific culture that is associated with the specified name.

Parameters

NameDescriptionDefault
name A predefined System.Globalization.CultureInfo name or the name of an existing System.Globalization.CultureInfo object. name is not case-sensitive.

Returns

A System.Globalization.CultureInfo object that represents: The invariant culture, if name is an empty string (""). -or- The specific culture associated with name, if name is a neutral culture. -or- The culture specified by name, if name is already a specific culture.

System.Globalization.CultureInfo.Equals()

Determines whether the specified object is the same culture as the current System.Globalization.CultureInfo.

Parameters

NameDescriptionDefault
value The object to compare with the current System.Globalization.CultureInfo.

Returns

true if value is the same culture as the current System.Globalization.CultureInfo; otherwise, false.

System.Globalization.CultureInfo.GetConsoleFallbackUICulture

Gets an alternate user interface culture suitable for console applications when the default graphic user interface culture is unsuitable.

Returns

An alternate culture that is used to read and display text on the console.

System.Globalization.CultureInfo.GetCultureInfo()

Retrieves a cached, read-only instance of a culture by using the specified culture identifier.

Parameters

NameDescriptionDefault
culture A locale identifier (LCID).

Returns

A read-only System.Globalization.CultureInfo object.

System.Globalization.CultureInfo.GetCultureInfo()

Retrieves a cached, read-only instance of a culture using the specified culture name.

Parameters

NameDescriptionDefault
name The name of a culture. name is not case-sensitive.

Returns

A read-only System.Globalization.CultureInfo object.

System.Globalization.CultureInfo.GetCultureInfo()

Retrieves a cached, read-only instance of a culture.

Parameters

NameDescriptionDefault
name The name of a culture. It is not case-sensitive.
predefinedOnly true if requesting to create an instance of a culture that is known by the platform. false if it is ok to retreive a made-up culture even if the platform does not carry data for it.

Returns

A read-only instance of a culture.

System.Globalization.CultureInfo.GetCultureInfo()

Retrieves a cached, read-only instance of a culture. Parameters specify a culture that is initialized with the System.Globalization.TextInfo and System.Globalization.CompareInfo objects specified by another culture.

Parameters

NameDescriptionDefault
name The name of a culture. name is not case-sensitive.
altName The name of a culture that supplies the System.Globalization.TextInfo and System.Globalization.CompareInfo objects used to initialize name. altName is not case-sensitive.

Returns

A read-only System.Globalization.CultureInfo object.

System.Globalization.CultureInfo.GetCultureInfoByIetfLanguageTag()

Deprecated. Retrieves a read-only System.Globalization.CultureInfo object having linguistic characteristics that are identified by the specified RFC 4646 language tag.

Parameters

NameDescriptionDefault
name The name of a language as specified by the RFC 4646 standard.

Returns

A read-only System.Globalization.CultureInfo object.

System.Globalization.CultureInfo.GetCultures()

Gets the list of supported cultures filtered by the specified System.Globalization.CultureTypes parameter.

Parameters

NameDescriptionDefault
types A bitwise combination of the enumeration values that filter the cultures to retrieve.

Returns

An array that contains the cultures specified by the types parameter. The array of cultures is unsorted.

System.Globalization.CultureInfo.GetFormat()

Gets an object that defines how to format the specified type.

Parameters

NameDescriptionDefault
formatType The System.Type for which to get a formatting object. This method only supports the System.Globalization.NumberFormatInfo and System.Globalization.DateTimeFormatInfo types.

Returns

The value of the System.Globalization.CultureInfo.NumberFormat property, which is a System.Globalization.NumberFormatInfo containing the default number format information for the current System.Globalization.CultureInfo, if formatType is the System.Type object for the System.Globalization.NumberFormatInfo class. -or- The value of the System.Globalization.CultureInfo.DateTimeFormat property, which is a System.Globalization.DateTimeFormatInfo containing the default date and time format information for the current System.Globalization.CultureInfo, if formatType is the System.Type object for the System.Globalization.DateTimeFormatInfo class. -or- null, if formatType is any other object.

System.Globalization.CultureInfo.GetHashCode

Serves as a hash function for the current System.Globalization.CultureInfo, suitable for hashing algorithms and data structures, such as a hash table.

Returns

A hash code for the current System.Globalization.CultureInfo.

System.Globalization.CultureInfo.ReadOnly()

Returns a read-only wrapper around the specified System.Globalization.CultureInfo object.

Parameters

NameDescriptionDefault
ci The System.Globalization.CultureInfo object to wrap.

Returns

A read-only System.Globalization.CultureInfo wrapper around ci.

System.Globalization.CultureInfo.ToString

Returns a string containing the name of the current System.Globalization.CultureInfo in the format languagecode2-country/regioncode2.

Returns

A string containing the name of the current System.Globalization.CultureInfo.

System.Globalization.CultureInfo.Calendar

Gets the default calendar used by the culture.

Returns

A System.Globalization.Calendar that represents the default calendar used by the culture.

System.Globalization.CultureInfo.CompareInfo

Gets the System.Globalization.CompareInfo that defines how to compare strings for the culture.

Returns

The System.Globalization.CompareInfo that defines how to compare strings for the culture.

System.Globalization.CultureInfo.CultureTypes

Gets the culture types that pertain to the current System.Globalization.CultureInfo object.

Returns

A bitwise combination of one or more System.Globalization.CultureTypes values. There is no default value.

System.Globalization.CultureInfo.CurrentCulture

Gets or sets the System.Globalization.CultureInfo object that represents the culture used by the current thread and task-based asynchronous operations.

Returns

The culture used by the current thread and task-based asynchronous operations.

System.Globalization.CultureInfo.CurrentUICulture

Gets or sets the System.Globalization.CultureInfo object that represents the current user interface culture used by the Resource Manager to look up culture-specific resources at run time.

Returns

The culture used by the Resource Manager to look up culture-specific resources at run time.

System.Globalization.CultureInfo.DateTimeFormat

Gets or sets a System.Globalization.DateTimeFormatInfo that defines the culturally appropriate format of displaying dates and times.

Returns

A System.Globalization.DateTimeFormatInfo that defines the culturally appropriate format of displaying dates and times.

System.Globalization.CultureInfo.DefaultThreadCurrentCulture

Gets or sets the default culture for threads in the current application domain.

Returns

The default culture for threads in the current application domain, or null if the current system culture is the default thread culture in the application domain.

System.Globalization.CultureInfo.DefaultThreadCurrentUICulture

Gets or sets the default UI culture for threads in the current application domain.

Returns

The default UI culture for threads in the current application domain, or null if the current system UI culture is the default thread UI culture in the application domain.

System.Globalization.CultureInfo.DisplayName

Gets the full localized culture name.

Returns

The full localized culture name in the format languagefull [country/regionfull], where languagefull is the full name of the language and country/regionfull is the full name of the country/region.

System.Globalization.CultureInfo.EnglishName

Gets the culture name in the format languagefull [country/regionfull] in English.

Returns

The culture name in the format languagefull [country/regionfull] in English, where languagefull is the full name of the language and country/regionfull is the full name of the country/region.

System.Globalization.CultureInfo.IetfLanguageTag

Deprecated. Gets the RFC 4646 standard identification for a language.

Returns

A string that is the RFC 4646 standard identification for a language.

System.Globalization.CultureInfo.InstalledUICulture

Gets the System.Globalization.CultureInfo that represents the culture installed with the operating system.

Returns

The System.Globalization.CultureInfo that represents the culture installed with the operating system.

System.Globalization.CultureInfo.InvariantCulture

Gets the System.Globalization.CultureInfo object that is culture-independent (invariant).

Returns

The object that is culture-independent (invariant).

System.Globalization.CultureInfo.IsNeutralCulture

Gets a value indicating whether the current System.Globalization.CultureInfo represents a neutral culture.

Returns

true if the current System.Globalization.CultureInfo represents a neutral culture; otherwise, false.

System.Globalization.CultureInfo.IsReadOnly

Gets a value indicating whether the current System.Globalization.CultureInfo is read-only.

Returns

true if the current System.Globalization.CultureInfo is read-only; otherwise, false. The default is false.

System.Globalization.CultureInfo.KeyboardLayoutId

Gets the active input locale identifier.

Returns

A 32-bit signed number that specifies an input locale identifier.

System.Globalization.CultureInfo.LCID

Gets the culture identifier for the current System.Globalization.CultureInfo.

Returns

The culture identifier for the current System.Globalization.CultureInfo.

System.Globalization.CultureInfo.Name

Gets the culture name in the format languagecode2-country/regioncode2.

Returns

The culture name in the format languagecode2-country/regioncode2, if the current System.Globalization.CultureInfo is culture-dependent; or an empty string, if it's an invariant culture. languagecode2 is a lowercase two-letter code as defined in ISO 639-1, or, if no two-letter code is available, a three-letter code as defined in ISO 639-3. country/regioncode2 contains a value defined in ISO 3166 and usually consists of two uppercase letters, or a BCP-47 language tag.

System.Globalization.CultureInfo.NativeName

Gets the culture name, consisting of the language, the country/region, and the optional script, that the culture is set to display.

Returns

The culture name, consisting of the full name of the language, the full name of the country/region, and the optional script. The format is discussed in the description of the System.Globalization.CultureInfo class.

System.Globalization.CultureInfo.NumberFormat

Gets or sets a System.Globalization.NumberFormatInfo that defines the culturally appropriate format of displaying numbers, currency, and percentage.

Returns

A System.Globalization.NumberFormatInfo that defines the culturally appropriate format of displaying numbers, currency, and percentage.

System.Globalization.CultureInfo.OptionalCalendars

Gets the list of calendars that can be used by the culture.

Returns

An array of type System.Globalization.Calendar that represents the calendars that can be used by the culture represented by the current System.Globalization.CultureInfo.

System.Globalization.CultureInfo.Parent

Gets the System.Globalization.CultureInfo that represents the parent culture of the current System.Globalization.CultureInfo.

Returns

The System.Globalization.CultureInfo that represents the parent culture of the current System.Globalization.CultureInfo.

System.Globalization.CultureInfo.TextInfo

Gets the System.Globalization.TextInfo that defines the writing system associated with the culture.

Returns

The System.Globalization.TextInfo that defines the writing system associated with the culture.

System.Globalization.CultureInfo.ThreeLetterISOLanguageName

Gets the ISO 639-2 three-letter code for the language of the current System.Globalization.CultureInfo.

Returns

The ISO 639-2 three-letter code for the language of the current System.Globalization.CultureInfo.

System.Globalization.CultureInfo.ThreeLetterWindowsLanguageName

Gets the three-letter code for the language as defined in the Windows API.

Returns

The three-letter code for the language as defined in the Windows API.

System.Globalization.CultureInfo.TwoLetterISOLanguageName

Gets the ISO 639-1 two-letter or ISO 639-3 three-letter code for the language of the current System.Globalization.CultureInfo.

Returns

The ISO 639-1 two-letter code for the language of the current System.Globalization.CultureInfo. If no two-letter code is available, the three-letter code from ISO 639-3 is used.

System.Globalization.CultureInfo.UseUserOverride

Gets a value indicating whether the current System.Globalization.CultureInfo object uses the user-selected culture settings.

Returns

true if the current System.Globalization.CultureInfo uses the user-selected culture settings; otherwise, false.

System.Globalization.CultureNotFoundException

The exception that is thrown when a method attempts to construct a culture that is not available.

System.Globalization.CultureNotFoundException.#ctor

Initializes a new instance of the System.Globalization.CultureNotFoundException class with its message string set to a system-supplied message.

System.Globalization.CultureNotFoundException.#ctor()

Initializes a new instance of the System.Globalization.CultureNotFoundException class using the specified serialization data and context.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.Globalization.CultureNotFoundException.#ctor()

Initializes a new instance of the System.Globalization.CultureNotFoundException class with the specified error message.

Parameters

NameDescriptionDefault
message The error message to display with this exception.

System.Globalization.CultureNotFoundException.#ctor()

Initializes a new instance of the System.Globalization.CultureNotFoundException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message to display with this exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.

System.Globalization.CultureNotFoundException.#ctor()

Initializes a new instance of the System.Globalization.CultureNotFoundException class with a specified error message, the invalid Culture ID, and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message to display with this exception.
invalidCultureId The Culture ID that cannot be found.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.

System.Globalization.CultureNotFoundException.#ctor()

Initializes a new instance of the System.Globalization.CultureNotFoundException class with a specified error message, the invalid Culture ID, and the name of the parameter that is the cause this exception.

Parameters

NameDescriptionDefault
paramName The name of the parameter that is the cause the current exception.
invalidCultureId The Culture ID that cannot be found.
message The error message to display with this exception.

System.Globalization.CultureNotFoundException.#ctor()

Initializes a new instance of the System.Globalization.CultureNotFoundException class with a specified error message and the name of the parameter that is the cause this exception.

Parameters

NameDescriptionDefault
paramName The name of the parameter that is the cause of the current exception.
message The error message to display with this exception.

System.Globalization.CultureNotFoundException.#ctor()

Initializes a new instance of the System.Globalization.CultureNotFoundException class with a specified error message, the invalid Culture Name, and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message to display with this exception.
invalidCultureName The Culture Name that cannot be found.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.

System.Globalization.CultureNotFoundException.#ctor()

Initializes a new instance of the System.Globalization.CultureNotFoundException class with a specified error message, the invalid Culture Name, and the name of the parameter that is the cause this exception.

Parameters

NameDescriptionDefault
paramName The name of the parameter that is the cause the current exception.
invalidCultureName The Culture Name that cannot be found.
message The error message to display with this exception.

System.Globalization.CultureNotFoundException.GetObjectData()

Sets the System.Runtime.Serialization.SerializationInfo object with the parameter name and additional exception information.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.Globalization.CultureNotFoundException.InvalidCultureId

Gets the culture identifier that cannot be found.

Returns

The invalid culture identifier.

System.Globalization.CultureNotFoundException.InvalidCultureName

Gets the culture name that cannot be found.

Returns

The invalid culture name.

System.Globalization.CultureNotFoundException.Message

Gets the error message that explains the reason for the exception.

Returns

A text string describing the details of the exception.

System.Globalization.CultureTypes

Defines the types of culture lists that can be retrieved using the System.Globalization.CultureInfo.GetCultures() method.

System.Globalization.CultureTypes.AllCultures

All cultures that are recognized by .NET, including neutral and specific cultures and custom cultures created by the user. On .NET Framework 4 and later versions and .NET Core running on Windows, it includes the culture data available from the Windows operating system. On .NET Core running on Linux and macOS, it includes culture data defined in the ICU libraries. System.Globalization.CultureTypes.AllCultures is a composite field that includes the System.Globalization.CultureTypes.NeutralCultures, System.Globalization.CultureTypes.SpecificCultures, and System.Globalization.CultureTypes.InstalledWin32Cultures values.

System.Globalization.CultureTypes.FrameworkCultures

This member is deprecated; using this value with System.Globalization.CultureInfo.GetCultures() returns neutral and specific cultures shipped with the .NET Framework 2.0.

System.Globalization.CultureTypes.InstalledWin32Cultures

This member is deprecated. All cultures that are installed in the Windows operating system.

System.Globalization.CultureTypes.NeutralCultures

Cultures that are associated with a language but are not specific to a country/region.

System.Globalization.CultureTypes.ReplacementCultures

This member is deprecated. Custom cultures created by the user that replace cultures shipped with the .NET Framework.

System.Globalization.CultureTypes.SpecificCultures

Cultures that are specific to a country/region.

System.Globalization.CultureTypes.UserCustomCulture

This member is deprecated. Custom cultures created by the user.

System.Globalization.CultureTypes.WindowsOnlyCultures

This member is deprecated and is ignored.

System.Globalization.DateTimeFormatInfo

Provides culture-specific information about the format of date and time values.

System.Globalization.DateTimeFormatInfo.#ctor

Initializes a new writable instance of the System.Globalization.DateTimeFormatInfo class that is culture-independent (invariant).

System.Globalization.DateTimeFormatInfo.Clone

Creates a shallow copy of the System.Globalization.DateTimeFormatInfo.

Returns

System.Globalization.DateTimeFormatInfo.GetAbbreviatedDayName()

Returns the culture-specific abbreviated name of the specified day of the week based on the culture associated with the current System.Globalization.DateTimeFormatInfo object.

Parameters

NameDescriptionDefault
dayofweek A System.DayOfWeek value.

Returns

The culture-specific abbreviated name of the day of the week represented by dayofweek.

System.Globalization.DateTimeFormatInfo.GetAbbreviatedEraName()

Returns the string containing the abbreviated name of the specified era, if an abbreviation exists.

Parameters

NameDescriptionDefault
era The integer representing the era.

Returns

A string containing the abbreviated name of the specified era, if an abbreviation exists. -or- A string containing the full name of the era, if an abbreviation does not exist.

System.Globalization.DateTimeFormatInfo.GetAbbreviatedMonthName()

Returns the culture-specific abbreviated name of the specified month based on the culture associated with the current System.Globalization.DateTimeFormatInfo object.

Parameters

NameDescriptionDefault
month An integer from 1 through 13 representing the name of the month to retrieve.

Returns

The culture-specific abbreviated name of the month represented by month.

System.Globalization.DateTimeFormatInfo.GetAllDateTimePatterns

Returns all the standard patterns in which date and time values can be formatted.

Returns

An array that contains the standard patterns in which date and time values can be formatted.

System.Globalization.DateTimeFormatInfo.GetAllDateTimePatterns()

Returns all the patterns in which date and time values can be formatted using the specified standard format string.

Parameters

NameDescriptionDefault
format A standard format string.

Returns

An array containing the standard patterns in which date and time values can be formatted using the specified format string.

System.Globalization.DateTimeFormatInfo.GetDayName()

Returns the culture-specific full name of the specified day of the week based on the culture associated with the current System.Globalization.DateTimeFormatInfo object.

Parameters

NameDescriptionDefault
dayofweek A System.DayOfWeek value.

Returns

The culture-specific full name of the day of the week represented by dayofweek.

System.Globalization.DateTimeFormatInfo.GetEra()

Returns the integer representing the specified era.

Parameters

NameDescriptionDefault
eraName The string containing the name of the era.

Returns

The integer representing the era, if eraName is valid; otherwise, -1.

System.Globalization.DateTimeFormatInfo.GetEraName()

Returns the string containing the name of the specified era.

Parameters

NameDescriptionDefault
era The integer representing the era.

Returns

A string containing the name of the era.

System.Globalization.DateTimeFormatInfo.GetFormat()

Returns an object of the specified type that provides a date and time formatting service.

Parameters

NameDescriptionDefault
formatType The type of the required formatting service.

Returns

The current object, if formatType is the same as the type of the current System.Globalization.DateTimeFormatInfo; otherwise, null.

System.Globalization.DateTimeFormatInfo.GetInstance()

Returns the System.Globalization.DateTimeFormatInfo object associated with the specified System.IFormatProvider.

Parameters

NameDescriptionDefault
provider The System.IFormatProvider that gets the System.Globalization.DateTimeFormatInfo object. -or- null to get System.Globalization.DateTimeFormatInfo.CurrentInfo.

Returns

System.Globalization.DateTimeFormatInfo.GetMonthName()

Returns the culture-specific full name of the specified month based on the culture associated with the current System.Globalization.DateTimeFormatInfo object.

Parameters

NameDescriptionDefault
month An integer from 1 through 13 representing the name of the month to retrieve.

Returns

The culture-specific full name of the month represented by month.

System.Globalization.DateTimeFormatInfo.GetShortestDayName()

Obtains the shortest abbreviated day name for a specified day of the week associated with the current System.Globalization.DateTimeFormatInfo object.

Parameters

NameDescriptionDefault
dayOfWeek One of the System.DayOfWeek values.

Returns

The abbreviated name of the week that corresponds to the dayOfWeek parameter.

System.Globalization.DateTimeFormatInfo.ReadOnly()

Returns a read-only System.Globalization.DateTimeFormatInfo wrapper.

Parameters

NameDescriptionDefault
dtfi The System.Globalization.DateTimeFormatInfo object to wrap.

Returns

System.Globalization.DateTimeFormatInfo.SetAllDateTimePatterns()

Sets the custom date and time format strings that correspond to a specified standard format string.

Parameters

NameDescriptionDefault
patterns An array of custom format strings.
format The standard format string associated with the custom format strings specified in the patterns parameter.

System.Globalization.DateTimeFormatInfo.AbbreviatedDayNames

Gets or sets a one-dimensional array of type System.String containing the culture-specific abbreviated names of the days of the week.

Returns

A one-dimensional array of type System.String containing the culture-specific abbreviated names of the days of the week. The array for System.Globalization.DateTimeFormatInfo.InvariantInfo contains "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", and "Sat".

System.Globalization.DateTimeFormatInfo.AbbreviatedMonthGenitiveNames

Gets or sets a string array of abbreviated month names associated with the current System.Globalization.DateTimeFormatInfo object.

Returns

An array of abbreviated month names.

System.Globalization.DateTimeFormatInfo.AbbreviatedMonthNames

Gets or sets a one-dimensional string array that contains the culture-specific abbreviated names of the months.

Returns

A one-dimensional string array with 13 elements that contains the culture-specific abbreviated names of the months. For 12-month calendars, the 13th element of the array is an empty string. The array for System.Globalization.DateTimeFormatInfo.InvariantInfo contains "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec", and "".

System.Globalization.DateTimeFormatInfo.AMDesignator

Gets or sets the string designator for hours that are "ante meridiem" (before noon).

Returns

The string designator for hours that are ante meridiem. The default for System.Globalization.DateTimeFormatInfo.InvariantInfo is "AM".

System.Globalization.DateTimeFormatInfo.Calendar

Gets or sets the calendar to use for the current culture.

Returns

The calendar to use for the current culture. The default for System.Globalization.DateTimeFormatInfo.InvariantInfo is a System.Globalization.GregorianCalendar object.

System.Globalization.DateTimeFormatInfo.CalendarWeekRule

Gets or sets a value that specifies which rule is used to determine the first calendar week of the year.

Returns

A value that determines the first calendar week of the year. The default for System.Globalization.DateTimeFormatInfo.InvariantInfo is System.Globalization.CalendarWeekRule.FirstDay.

System.Globalization.DateTimeFormatInfo.CurrentInfo

Gets a read-only System.Globalization.DateTimeFormatInfo object that formats values based on the current culture.

Returns

A read-only System.Globalization.DateTimeFormatInfo object based on the System.Globalization.CultureInfo object for the current thread.

System.Globalization.DateTimeFormatInfo.DateSeparator

Gets or sets the string that separates the components of a date, that is, the year, month, and day.

Returns

The string that separates the components of a date, that is, the year, month, and day. The default for System.Globalization.DateTimeFormatInfo.InvariantInfo is "/".

System.Globalization.DateTimeFormatInfo.DayNames

Gets or sets a one-dimensional string array that contains the culture-specific full names of the days of the week.

Returns

A one-dimensional string array that contains the culture-specific full names of the days of the week. The array for System.Globalization.DateTimeFormatInfo.InvariantInfo contains "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", and "Saturday".

System.Globalization.DateTimeFormatInfo.FirstDayOfWeek

Gets or sets the first day of the week.

Returns

An enumeration value that represents the first day of the week. The default for System.Globalization.DateTimeFormatInfo.InvariantInfo is System.DayOfWeek.Sunday.

System.Globalization.DateTimeFormatInfo.FullDateTimePattern

Gets or sets the custom format string for a long date and long time value.

Returns

The custom format string for a long date and long time value.

System.Globalization.DateTimeFormatInfo.InvariantInfo

Gets the default read-only System.Globalization.DateTimeFormatInfo object that is culture-independent (invariant).

Returns

A read-only object that is culture-independent (invariant).

System.Globalization.DateTimeFormatInfo.IsReadOnly

Gets a value indicating whether the System.Globalization.DateTimeFormatInfo object is read-only.

Returns

true if the System.Globalization.DateTimeFormatInfo object is read-only; otherwise, false.

System.Globalization.DateTimeFormatInfo.LongDatePattern

Gets or sets the custom format string for a long date value.

Returns

The custom format string for a long date value.

System.Globalization.DateTimeFormatInfo.LongTimePattern

Gets or sets the custom format string for a long time value.

Returns

The format pattern for a long time value.

System.Globalization.DateTimeFormatInfo.MonthDayPattern

Gets or sets the custom format string for a month and day value.

Returns

The custom format string for a month and day value.

System.Globalization.DateTimeFormatInfo.MonthGenitiveNames

Gets or sets a string array of month names associated with the current System.Globalization.DateTimeFormatInfo object.

Returns

A string array of month names.

System.Globalization.DateTimeFormatInfo.MonthNames

Gets or sets a one-dimensional array of type System.String containing the culture-specific full names of the months.

Returns

A one-dimensional array of type System.String containing the culture-specific full names of the months. In a 12-month calendar, the 13th element of the array is an empty string. The array for System.Globalization.DateTimeFormatInfo.InvariantInfo contains "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December", and "".

System.Globalization.DateTimeFormatInfo.NativeCalendarName

Gets the native name of the calendar associated with the current System.Globalization.DateTimeFormatInfo object.

Returns

The native name of the calendar used in the culture associated with the current System.Globalization.DateTimeFormatInfo object if that name is available, or the empty string ("") if the native calendar name is not available.

System.Globalization.DateTimeFormatInfo.PMDesignator

Gets or sets the string designator for hours that are "post meridiem" (after noon).

Returns

The string designator for hours that are "post meridiem" (after noon). The default for System.Globalization.DateTimeFormatInfo.InvariantInfo is "PM".

System.Globalization.DateTimeFormatInfo.RFC1123Pattern

Gets the custom format string for a time value that is based on the Internet Engineering Task Force (IETF) Request for Comments (RFC) 1123 specification.

Returns

The custom format string for a time value that is based on the IETF RFC 1123 specification.

System.Globalization.DateTimeFormatInfo.ShortDatePattern

Gets or sets the custom format string for a short date value.

Returns

The custom format string for a short date value.

System.Globalization.DateTimeFormatInfo.ShortestDayNames

Gets or sets a string array of the shortest unique abbreviated day names associated with the current System.Globalization.DateTimeFormatInfo object.

Returns

A string array of day names.

System.Globalization.DateTimeFormatInfo.ShortTimePattern

Gets or sets the custom format string for a short time value.

Returns

The custom format string for a short time value.

System.Globalization.DateTimeFormatInfo.SortableDateTimePattern

Gets the custom format string for a sortable date and time value.

Returns

The custom format string for a sortable date and time value.

System.Globalization.DateTimeFormatInfo.TimeSeparator

Gets or sets the string that separates the components of time, that is, the hour, minutes, and seconds.

Returns

The string that separates the components of time. The default for System.Globalization.DateTimeFormatInfo.InvariantInfo is ":".

System.Globalization.DateTimeFormatInfo.UniversalSortableDateTimePattern

Gets the custom format string for a universal, sortable date and time string, as defined by ISO 8601.

Returns

The custom format string for a universal, sortable date and time string.

System.Globalization.DateTimeFormatInfo.YearMonthPattern

Gets or sets the custom format string for a year and month value.

Returns

The custom format string for a year and month value.

System.Globalization.DateTimeStyles

Defines the formatting options that customize string parsing for some date and time parsing methods.

System.Globalization.DateTimeStyles.AdjustToUniversal

Date and time are returned as a Coordinated Universal Time (UTC). If the input string denotes a local time, through a time zone specifier or System.Globalization.DateTimeStyles.AssumeLocal, the date and time are converted from the local time to UTC. If the input string denotes a UTC time, through a time zone specifier or System.Globalization.DateTimeStyles.AssumeUniversal, no conversion occurs. If the input string does not denote a local or UTC time, no conversion occurs and the resulting System.DateTime.Kind property is System.DateTimeKind.Unspecified. This value cannot be used with System.Globalization.DateTimeStyles.RoundtripKind.

System.Globalization.DateTimeStyles.AllowInnerWhite

Extra white-space characters in the middle of the string must be ignored during parsing, except if they occur in the System.Globalization.DateTimeFormatInfo format patterns.

System.Globalization.DateTimeStyles.AllowLeadingWhite

Leading white-space characters must be ignored during parsing, except if they occur in the System.Globalization.DateTimeFormatInfo format patterns.

System.Globalization.DateTimeStyles.AllowTrailingWhite

Trailing white-space characters must be ignored during parsing, except if they occur in the System.Globalization.DateTimeFormatInfo format patterns.

System.Globalization.DateTimeStyles.AllowWhiteSpaces

Extra white-space characters anywhere in the string must be ignored during parsing, except if they occur in the System.Globalization.DateTimeFormatInfo format patterns. This value is a combination of the System.Globalization.DateTimeStyles.AllowLeadingWhite, System.Globalization.DateTimeStyles.AllowTrailingWhite, and System.Globalization.DateTimeStyles.AllowInnerWhite values.

System.Globalization.DateTimeStyles.AssumeLocal

If no time zone is specified in the parsed string, the string is assumed to denote a local time. This value cannot be used with System.Globalization.DateTimeStyles.AssumeUniversal or System.Globalization.DateTimeStyles.RoundtripKind.

System.Globalization.DateTimeStyles.AssumeUniversal

If no time zone is specified in the parsed string, the string is assumed to denote a UTC. This value cannot be used with System.Globalization.DateTimeStyles.AssumeLocal or System.Globalization.DateTimeStyles.RoundtripKind.

System.Globalization.DateTimeStyles.NoCurrentDateDefault

If the parsed string contains only the time and not the date, the parsing methods assume the Gregorian date with year = 1, month = 1, and day = 1. If this value is not used, the current date is assumed.

System.Globalization.DateTimeStyles.None

Default formatting options must be used. This value represents the default style for the System.DateTime.Parse(), System.DateTime.ParseExact(), and System.DateTime.TryParse() methods.

System.Globalization.DateTimeStyles.RoundtripKind

The System.DateTimeKind field of a date is preserved when a System.DateTime object is converted to a string using the "o" or "r" standard format specifier, and the string is then converted back to a System.DateTime object.

System.Globalization.DaylightTime

Defines the period of daylight saving time.

System.Globalization.DaylightTime.#ctor()

Initializes a new instance of the System.Globalization.DaylightTime class with the specified start, end, and time difference information.

Parameters

NameDescriptionDefault
start The object that represents the date and time when daylight saving time begins. The value must be in local time.
end The object that represents the date and time when daylight saving time ends. The value must be in local time.
delta The object that represents the difference between standard time and daylight saving time, in ticks.

System.Globalization.DaylightTime.Delta

Gets the time interval that represents the difference between standard time and daylight saving time.

Returns

The time interval that represents the difference between standard time and daylight saving time.

System.Globalization.DaylightTime.End

Gets the object that represents the date and time when the daylight saving period ends.

Returns

The object that represents the date and time when the daylight saving period ends. The value is in local time.

System.Globalization.DaylightTime.Start

Gets the object that represents the date and time when the daylight saving period begins.

Returns

The object that represents the date and time when the daylight saving period begins. The value is in local time.

System.Globalization.DigitShapes

Specifies the culture-specific display of digits.

System.Globalization.DigitShapes.Context

The digit shape depends on the previous text in the same output. European digits follow Latin scripts; Arabic-Indic digits follow Arabic text; and Thai digits follow Thai text.

System.Globalization.DigitShapes.NativeNational

The digit shape is the native equivalent of the digits from 0 through 9. ASCII digits from 0 through 9 are replaced by equivalent native national digits.

System.Globalization.DigitShapes.None

The digit shape is not changed. Full Unicode compatibility is maintained.

System.Globalization.EastAsianLunisolarCalendar

Represents a calendar that divides time into months, days, years, and eras, and has dates that are based on cycles of the sun and the moon.

System.Globalization.EastAsianLunisolarCalendar.AddMonths()

Calculates the date that is the specified number of months away from the specified date.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add months.
months The number of months to add.

Returns

A new System.DateTime that results from adding the specified number of months to the time parameter.

System.Globalization.EastAsianLunisolarCalendar.AddYears()

Calculates the date that is the specified number of years away from the specified date.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add years.
years The number of years to add.

Returns

A new System.DateTime that results from adding the specified number of years to the time parameter.

System.Globalization.EastAsianLunisolarCalendar.GetCelestialStem()

Calculates the celestial stem of the specified year in the sexagenary (60-year) cycle.

Parameters

NameDescriptionDefault
sexagenaryYear An integer from 1 through 60 that represents a year in the sexagenary cycle.

Returns

A number from 1 through 10.

System.Globalization.EastAsianLunisolarCalendar.GetDayOfMonth()

Calculates the day of the month in the specified date.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 through 31 that represents the day of the month specified in the time parameter.

System.Globalization.EastAsianLunisolarCalendar.GetDayOfWeek()

Calculates the day of the week in the specified date.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

One of the System.DayOfWeek values that represents the day of the week specified in the time parameter.

System.Globalization.EastAsianLunisolarCalendar.GetDayOfYear()

Calculates the day of the year in the specified date.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 through 354 in a common year, or 1 through 384 in a leap year, that represents the day of the year specified in the time parameter.

System.Globalization.EastAsianLunisolarCalendar.GetDaysInMonth()

Calculates the number of days in the specified month of the specified year and era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 through 12 in a common year, or 1 through 13 in a leap year, that represents the month.
era An integer that represents the era.

Returns

The number of days in the specified month of the specified year and era.

System.Globalization.EastAsianLunisolarCalendar.GetDaysInYear()

Calculates the number of days in the specified year and era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of days in the specified year and era.

System.Globalization.EastAsianLunisolarCalendar.GetLeapMonth()

Calculates the leap month for the specified year and era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

A positive integer from 1 through 13 that indicates the leap month in the specified year and era. -or- Zero if this calendar does not support a leap month, or if the year and era parameters do not specify a leap year.

System.Globalization.EastAsianLunisolarCalendar.GetMonth()

Returns the month in the specified date.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 13 that represents the month specified in the time parameter.

System.Globalization.EastAsianLunisolarCalendar.GetMonthsInYear()

Calculates the number of months in the specified year and era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of months in the specified year in the specified era. The return value is 12 months in a common year or 13 months in a leap year.

System.Globalization.EastAsianLunisolarCalendar.GetSexagenaryYear()

Calculates the year in the sexagenary (60-year) cycle that corresponds to the specified date.

Parameters

NameDescriptionDefault
time A System.DateTime to read.

Returns

A number from 1 through 60 in the sexagenary cycle that corresponds to the date parameter.

System.Globalization.EastAsianLunisolarCalendar.GetTerrestrialBranch()

Calculates the terrestrial branch of the specified year in the sexagenary (60-year) cycle.

Parameters

NameDescriptionDefault
sexagenaryYear An integer from 1 through 60 that represents a year in the sexagenary cycle.

Returns

An integer from 1 through 12.

System.Globalization.EastAsianLunisolarCalendar.GetYear()

Returns the year in the specified date.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the year in the specified System.DateTime.

System.Globalization.EastAsianLunisolarCalendar.IsLeapDay()

Determines whether the specified date in the specified era is a leap day.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 through 13 that represents the month.
day An integer from 1 through 31 that represents the day.
era An integer that represents the era.

Returns

true if the specified day is a leap day; otherwise, false.

System.Globalization.EastAsianLunisolarCalendar.IsLeapMonth()

Determines whether the specified month in the specified year and era is a leap month.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 through 13 that represents the month.
era An integer that represents the era.

Returns

true if the month parameter is a leap month; otherwise, false.

System.Globalization.EastAsianLunisolarCalendar.IsLeapYear()

Determines whether the specified year in the specified era is a leap year.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

true if the specified year is a leap year; otherwise, false.

System.Globalization.EastAsianLunisolarCalendar.ToDateTime()

Returns a System.DateTime that is set to the specified date, time, and era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 through 13 that represents the month.
day An integer from 1 through 31 that represents the day.
hour An integer from 0 through 23 that represents the hour.
minute An integer from 0 through 59 that represents the minute.
second An integer from 0 through 59 that represents the second.
millisecond An integer from 0 through 999 that represents the millisecond.
era An integer that represents the era.

Returns

A System.DateTime that is set to the specified date, time, and era.

System.Globalization.EastAsianLunisolarCalendar.ToFourDigitYear()

Converts the specified year to a four-digit year.

Parameters

NameDescriptionDefault
year A two-digit or four-digit integer that represents the year to convert.

Returns

An integer that contains the four-digit representation of the year parameter.

System.Globalization.EastAsianLunisolarCalendar.AlgorithmType

Gets a value indicating whether the current calendar is solar-based, lunar-based, or a combination of both.

Returns

System.Globalization.EastAsianLunisolarCalendar.TwoDigitYearMax

Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.

Returns

The last year of a 100-year range that can be represented by a 2-digit year.

System.Globalization.GlobalizationExtensions

Provides globalization-related extension methods.

System.Globalization.GlobalizationExtensions.GetStringComparer()

Returns a System.StringComparer object based on the culture-sensitive string comparison rules of a specified System.Globalization.CompareInfo object.

Parameters

NameDescriptionDefault
compareInfo An object that supports culture-sensitive string comparison.
options A value that defines how strings should be compared. options is either the enumeration value System.Globalization.CompareOptions.Ordinal, the enumeration value System.Globalization.CompareOptions.OrdinalIgnoreCase, or a bitwise combination of one or more of the following values: System.Globalization.CompareOptions.IgnoreCase, System.Globalization.CompareOptions.IgnoreSymbols, System.Globalization.CompareOptions.IgnoreNonSpace, System.Globalization.CompareOptions.IgnoreWidth, System.Globalization.CompareOptions.IgnoreKanaType, and System.Globalization.CompareOptions.StringSort.

Returns

An object that can be used to perform string comparisons.

System.Globalization.GregorianCalendar

Represents the Gregorian calendar.

System.Globalization.GregorianCalendar.ADEra

Represents the current era. This field is constant.

System.Globalization.GregorianCalendar.#ctor

Initializes a new instance of the System.Globalization.GregorianCalendar class using the default System.Globalization.GregorianCalendarTypes value.

System.Globalization.GregorianCalendar.#ctor()

Initializes a new instance of the System.Globalization.GregorianCalendar class using the specified System.Globalization.GregorianCalendarTypes value.

Parameters

NameDescriptionDefault
type The System.Globalization.GregorianCalendarTypes value that denotes which language version of the calendar to create.

System.Globalization.GregorianCalendar.AddMonths()

Returns a System.DateTime that is the specified number of months away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add months.
months The number of months to add.

Returns

The System.DateTime that results from adding the specified number of months to the specified System.DateTime.

System.Globalization.GregorianCalendar.AddYears()

Returns a System.DateTime that is the specified number of years away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add years.
years The number of years to add.

Returns

The System.DateTime that results from adding the specified number of years to the specified System.DateTime.

System.Globalization.GregorianCalendar.GetDayOfMonth()

Returns the day of the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 31 that represents the day of the month in time.

System.Globalization.GregorianCalendar.GetDayOfWeek()

Returns the day of the week in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

A System.DayOfWeek value that represents the day of the week in time.

System.Globalization.GregorianCalendar.GetDayOfYear()

Returns the day of the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 366 that represents the day of the year in time.

System.Globalization.GregorianCalendar.GetDaysInMonth()

Returns the number of days in the specified month in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
era An integer that represents the era.

Returns

The number of days in the specified month in the specified year in the specified era.

System.Globalization.GregorianCalendar.GetDaysInYear()

Returns the number of days in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of days in the specified year in the specified era.

System.Globalization.GregorianCalendar.GetEra()

Returns the era in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the era in time.

System.Globalization.GregorianCalendar.GetLeapMonth()

Calculates the leap month for a specified year and era.

Parameters

NameDescriptionDefault
year A year.
era An era. Specify either System.Globalization.GregorianCalendar.ADEra or GregorianCalendar.Eras[Calendar.CurrentEra].

Returns

Always 0 because the Gregorian calendar does not recognize leap months.

System.Globalization.GregorianCalendar.GetMonth()

Returns the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 12 that represents the month in time.

System.Globalization.GregorianCalendar.GetMonthsInYear()

Returns the number of months in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of months in the specified year in the specified era.

System.Globalization.GregorianCalendar.GetYear()

Returns the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the year in time.

System.Globalization.GregorianCalendar.IsLeapDay()

Determines whether the specified date in the specified era is a leap day.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
day An integer from 1 to 31 that represents the day.
era An integer that represents the era.

Returns

true if the specified day is a leap day; otherwise, false.

System.Globalization.GregorianCalendar.IsLeapMonth()

Determines whether the specified month in the specified year in the specified era is a leap month.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
era An integer that represents the era.

Returns

This method always returns false, unless overridden by a derived class.

System.Globalization.GregorianCalendar.IsLeapYear()

Determines whether the specified year in the specified era is a leap year.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

true if the specified year is a leap year; otherwise, false.

System.Globalization.GregorianCalendar.ToDateTime()

Returns a System.DateTime that is set to the specified date and time in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
day An integer from 1 to 31 that represents the day.
hour An integer from 0 to 23 that represents the hour.
minute An integer from 0 to 59 that represents the minute.
second An integer from 0 to 59 that represents the second.
millisecond An integer from 0 to 999 that represents the millisecond.
era An integer that represents the era.

Returns

The System.DateTime that is set to the specified date and time in the current era.

System.Globalization.GregorianCalendar.ToFourDigitYear()

Converts the specified year to a four-digit year by using the System.Globalization.GregorianCalendar.TwoDigitYearMax property to determine the appropriate century.

Parameters

NameDescriptionDefault
year A two-digit or four-digit integer that represents the year to convert.

Returns

An integer that contains the four-digit representation of year.

System.Globalization.GregorianCalendar.AlgorithmType

Gets a value that indicates whether the current calendar is solar-based, lunar-based, or a combination of both.

Returns

System.Globalization.GregorianCalendar.CalendarType

Gets or sets the System.Globalization.GregorianCalendarTypes value that denotes the language version of the current System.Globalization.GregorianCalendar.

Returns

A System.Globalization.GregorianCalendarTypes value that denotes the language version of the current System.Globalization.GregorianCalendar.

System.Globalization.GregorianCalendar.Eras

Gets the list of eras in the System.Globalization.GregorianCalendar.

Returns

An array of integers that represents the eras in the System.Globalization.GregorianCalendar.

System.Globalization.GregorianCalendar.MaxSupportedDateTime

Gets the latest date and time supported by the System.Globalization.GregorianCalendar type.

Returns

The latest date and time supported by the System.Globalization.GregorianCalendar type, which is the last moment of December 31, 9999 C.E. and is equivalent to DateTime.MaxValue.

System.Globalization.GregorianCalendar.MinSupportedDateTime

Gets the earliest date and time supported by the System.Globalization.GregorianCalendar type.

Returns

The earliest date and time supported by the System.Globalization.GregorianCalendar type, which is the first moment of January 1, 0001 C.E. and is equivalent to DateTime.MinValue.

System.Globalization.GregorianCalendar.TwoDigitYearMax

Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.

Returns

The last year of a 100-year range that can be represented by a 2-digit year.

System.Globalization.GregorianCalendarTypes

Defines the different language versions of the Gregorian calendar.

System.Globalization.GregorianCalendarTypes.Arabic

Refers to the Arabic version of the Gregorian calendar.

System.Globalization.GregorianCalendarTypes.Localized

Refers to the localized version of the Gregorian calendar, based on the language of the System.Globalization.CultureInfo that uses the System.Globalization.DateTimeFormatInfo.

System.Globalization.GregorianCalendarTypes.MiddleEastFrench

Refers to the Middle East French version of the Gregorian calendar.

System.Globalization.GregorianCalendarTypes.TransliteratedEnglish

Refers to the transliterated English version of the Gregorian calendar.

System.Globalization.GregorianCalendarTypes.TransliteratedFrench

Refers to the transliterated French version of the Gregorian calendar.

System.Globalization.GregorianCalendarTypes.USEnglish

Refers to the U.S. English version of the Gregorian calendar.

System.Globalization.HebrewCalendar

Represents the Hebrew calendar.

System.Globalization.HebrewCalendar.HebrewEra

Represents the current era. This field is constant.

System.Globalization.HebrewCalendar.#ctor

Initializes a new instance of the System.Globalization.HebrewCalendar class.

System.Globalization.HebrewCalendar.AddMonths()

Returns a System.DateTime that is the specified number of months away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add months.
months The number of months to add.

Returns

The System.DateTime that results from adding the specified number of months to the specified System.DateTime.

System.Globalization.HebrewCalendar.AddYears()

Returns a System.DateTime that is the specified number of years away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add years.
years The number of years to add.

Returns

The System.DateTime that results from adding the specified number of years to the specified System.DateTime.

System.Globalization.HebrewCalendar.GetDayOfMonth()

Returns the day of the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 30 that represents the day of the month in the specified System.DateTime.

System.Globalization.HebrewCalendar.GetDayOfWeek()

Returns the day of the week in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

A System.DayOfWeek value that represents the day of the week in the specified System.DateTime.

System.Globalization.HebrewCalendar.GetDayOfYear()

Returns the day of the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 385 that represents the day of the year in the specified System.DateTime.

System.Globalization.HebrewCalendar.GetDaysInMonth()

Returns the number of days in the specified month in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 13 that represents the month.
era An integer that represents the era. Specify either System.Globalization.HebrewCalendar.HebrewEra or Calendar.Eras[Calendar.CurrentEra].

Returns

The number of days in the specified month in the specified year in the specified era.

System.Globalization.HebrewCalendar.GetDaysInYear()

Returns the number of days in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era. Specify either System.Globalization.HebrewCalendar.HebrewEra or HebrewCalendar.Eras[Calendar.CurrentEra].

Returns

The number of days in the specified year in the specified era.

System.Globalization.HebrewCalendar.GetEra()

Returns the era in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the era in the specified System.DateTime. The return value is always System.Globalization.HebrewCalendar.HebrewEra.

System.Globalization.HebrewCalendar.GetLeapMonth()

Calculates the leap month for a specified year and era.

Parameters

NameDescriptionDefault
year A year.
era An era. Specify either System.Globalization.HebrewCalendar.HebrewEra or HebrewCalendar.Eras[Calendar.CurrentEra].

Returns

A positive integer that indicates the leap month in the specified year and era. The return value is 7 if the year and era parameters specify a leap year, or 0 if the year is not a leap year.

System.Globalization.HebrewCalendar.GetMonth()

Returns the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 13 that represents the month in the specified System.DateTime.

System.Globalization.HebrewCalendar.GetMonthsInYear()

Returns the number of months in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era. Specify either System.Globalization.HebrewCalendar.HebrewEra or HebrewCalendar.Eras[Calendar.CurrentEra].

Returns

The number of months in the specified year in the specified era. The return value is either 12 in a common year, or 13 in a leap year.

System.Globalization.HebrewCalendar.GetYear()

Returns the year in the specified System.DateTime value.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the year in the specified System.DateTime value.

System.Globalization.HebrewCalendar.IsLeapDay()

Determines whether the specified date in the specified era is a leap day.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 13 that represents the month.
day An integer from 1 to 30 that represents the day.
era An integer that represents the era. Specify either System.Globalization.HebrewCalendar.HebrewEra or HebrewCalendar.Eras[Calendar.CurrentEra].

Returns

true if the specified day is a leap day; otherwise, false.

System.Globalization.HebrewCalendar.IsLeapMonth()

Determines whether the specified month in the specified year in the specified era is a leap month.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 13 that represents the month.
era An integer that represents the era. Specify either System.Globalization.HebrewCalendar.HebrewEra or HebrewCalendar.Eras[Calendar.CurrentEra].

Returns

true if the specified month is a leap month; otherwise, false.

System.Globalization.HebrewCalendar.IsLeapYear()

Determines whether the specified year in the specified era is a leap year.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era. Specify either System.Globalization.HebrewCalendar.HebrewEra or HebrewCalendar.Eras[Calendar.CurrentEra].

Returns

true if the specified year is a leap year; otherwise, false.

System.Globalization.HebrewCalendar.ToDateTime()

Returns a System.DateTime that is set to the specified date and time in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 13 that represents the month.
day An integer from 1 to 30 that represents the day.
hour An integer from 0 to 23 that represents the hour.
minute An integer from 0 to 59 that represents the minute.
second An integer from 0 to 59 that represents the second.
millisecond An integer from 0 to 999 that represents the millisecond.
era An integer that represents the era. Specify either System.Globalization.HebrewCalendar.HebrewEra or HebrewCalendar.Eras[Calendar.CurrentEra].

Returns

The System.DateTime that is set to the specified date and time in the current era.

System.Globalization.HebrewCalendar.ToFourDigitYear()

Converts the specified year to a 4-digit year by using the System.Globalization.HebrewCalendar.TwoDigitYearMax property to determine the appropriate century.

Parameters

NameDescriptionDefault
year A 2-digit year from 0 through 99, or a 4-digit Hebrew calendar year from 5343 through 5999.

Returns

If the year parameter is a 2-digit year, the return value is the corresponding 4-digit year. If the year parameter is a 4-digit year, the return value is the unchanged year parameter.

System.Globalization.HebrewCalendar.AlgorithmType

Gets a value that indicates whether the current calendar is solar-based, lunar-based, or a combination of both.

Returns

System.Globalization.HebrewCalendar.Eras

Gets the list of eras in the System.Globalization.HebrewCalendar.

Returns

An array of integers that represents the eras in the System.Globalization.HebrewCalendar type. The return value is always an array containing one element equal to System.Globalization.HebrewCalendar.HebrewEra.

System.Globalization.HebrewCalendar.MaxSupportedDateTime

Gets the latest date and time supported by the System.Globalization.HebrewCalendar type.

Returns

The latest date and time supported by the System.Globalization.HebrewCalendar type, which is equivalent to the last moment of September, 29, 2239 C.E. in the Gregorian calendar.

System.Globalization.HebrewCalendar.MinSupportedDateTime

Gets the earliest date and time supported by the System.Globalization.HebrewCalendar type.

Returns

The earliest date and time supported by the System.Globalization.HebrewCalendar type, which is equivalent to the first moment of January, 1, 1583 C.E. in the Gregorian calendar.

System.Globalization.HebrewCalendar.TwoDigitYearMax

Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.

Returns

The last year of a 100-year range that can be represented by a 2-digit year.

System.Globalization.HijriCalendar

Represents the Hijri calendar.

System.Globalization.HijriCalendar.HijriEra

Represents the current era. This field is constant.

System.Globalization.HijriCalendar.#ctor

Initializes a new instance of the System.Globalization.HijriCalendar class.

System.Globalization.HijriCalendar.AddMonths()

Returns a System.DateTime that is the specified number of months away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to add months to.
months The number of months to add.

Returns

The System.DateTime that results from adding the specified number of months to the specified System.DateTime.

System.Globalization.HijriCalendar.AddYears()

Returns a System.DateTime that is the specified number of years away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to add years to.
years The number of years to add.

Returns

The System.DateTime that results from adding the specified number of years to the specified System.DateTime.

System.Globalization.HijriCalendar.GetDayOfMonth()

Returns the day of the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 30 that represents the day of the month in the specified System.DateTime.

System.Globalization.HijriCalendar.GetDayOfWeek()

Returns the day of the week in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

A System.DayOfWeek value that represents the day of the week in the specified System.DateTime.

System.Globalization.HijriCalendar.GetDayOfYear()

Returns the day of the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 355 that represents the day of the year in the specified System.DateTime.

System.Globalization.HijriCalendar.GetDaysInMonth()

Returns the number of days in the specified month of the specified year and era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
era An integer that represents the era.

Returns

The number of days in the specified month in the specified year in the specified era.

System.Globalization.HijriCalendar.GetDaysInYear()

Returns the number of days in the specified year and era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of days in the specified year and era. The number of days is 354 in a common year or 355 in a leap year.

System.Globalization.HijriCalendar.GetEra()

Returns the era in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the era in the specified System.DateTime.

System.Globalization.HijriCalendar.GetLeapMonth()

Calculates the leap month for a specified year and era.

Parameters

NameDescriptionDefault
year A year.
era An era. Specify System.Globalization.Calendar.CurrentEra or System.Globalization.HijriCalendar.HijriEra.

Returns

Always 0 because the System.Globalization.HijriCalendar type does not support the notion of a leap month.

System.Globalization.HijriCalendar.GetMonth()

Returns the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 12 that represents the month in the specified System.DateTime.

System.Globalization.HijriCalendar.GetMonthsInYear()

Returns the number of months in the specified year and era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of months in the specified year and era.

System.Globalization.HijriCalendar.GetYear()

Returns the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the year in the specified System.DateTime.

System.Globalization.HijriCalendar.IsLeapDay()

Determines whether the specified date is a leap day.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
day An integer from 1 to 30 that represents the day.
era An integer that represents the era.

Returns

true if the specified day is a leap day; otherwise, false.

System.Globalization.HijriCalendar.IsLeapMonth()

Determines whether the specified month in the specified year and era is a leap month.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
era An integer that represents the era.

Returns

This method always returns false.

System.Globalization.HijriCalendar.IsLeapYear()

Determines whether the specified year in the specified era is a leap year.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

true if the specified year is a leap year; otherwise, false.

System.Globalization.HijriCalendar.ToDateTime()

Returns a System.DateTime that is set to the specified date, time, and era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
day An integer from 1 to 30 that represents the day.
hour An integer from 0 to 23 that represents the hour.
minute An integer from 0 to 59 that represents the minute.
second An integer from 0 to 59 that represents the second.
millisecond An integer from 0 to 999 that represents the millisecond.
era An integer that represents the era.

Returns

The System.DateTime that is set to the specified date and time in the current era.

System.Globalization.HijriCalendar.ToFourDigitYear()

Converts the specified year to a four-digit year by using the System.Globalization.HijriCalendar.TwoDigitYearMax property to determine the appropriate century.

Parameters

NameDescriptionDefault
year A two-digit or four-digit integer that represents the year to convert.

Returns

An integer that contains the four-digit representation of year.

System.Globalization.HijriCalendar.AlgorithmType

Gets a value that indicates whether the current calendar is solar-based, lunar-based, or a combination of both.

Returns

System.Globalization.HijriCalendar.DaysInYearBeforeMinSupportedYear

Gets the number of days in the year that precedes the year that is specified by the System.Globalization.HijriCalendar.MinSupportedDateTime property.

Returns

The number of days in the year that precedes the year specified by System.Globalization.HijriCalendar.MinSupportedDateTime.

System.Globalization.HijriCalendar.Eras

Gets the list of eras in the System.Globalization.HijriCalendar.

Returns

An array of integers that represents the eras in the System.Globalization.HijriCalendar.

System.Globalization.HijriCalendar.HijriAdjustment

Gets or sets the number of days to add or subtract from the calendar to accommodate the variances in the start and the end of Ramadan and to accommodate the date difference between countries/regions.

Returns

An integer from -2 to 2 that represents the number of days to add or subtract from the calendar.

System.Globalization.HijriCalendar.MaxSupportedDateTime

Gets the latest date and time supported by this calendar.

Returns

The latest date and time supported by the System.Globalization.HijriCalendar type, which is equivalent to the last moment of December 31, 9999 C.E. in the Gregorian calendar.

System.Globalization.HijriCalendar.MinSupportedDateTime

Gets the earliest date and time supported by this calendar.

Returns

The earliest date and time supported by the System.Globalization.HijriCalendar type, which is equivalent to the first moment of July 18, 622 C.E. in the Gregorian calendar.

System.Globalization.HijriCalendar.TwoDigitYearMax

Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.

Returns

The last year of a 100-year range that can be represented by a 2-digit year.

System.Globalization.IdnMapping

Supports the use of non-ASCII characters for Internet domain names. This class cannot be inherited.

System.Globalization.IdnMapping.#ctor

Initializes a new instance of the System.Globalization.IdnMapping class.

System.Globalization.IdnMapping.Equals()

Indicates whether a specified object and the current System.Globalization.IdnMapping object are equal.

Parameters

NameDescriptionDefault
obj The object to compare to the current object.

Returns

true if the object specified by the obj parameter is derived from System.Globalization.IdnMapping and its System.Globalization.IdnMapping.AllowUnassigned and System.Globalization.IdnMapping.UseStd3AsciiRules properties are equal; otherwise, false.

System.Globalization.IdnMapping.GetAscii()

Encodes a string of domain name labels that consist of Unicode characters to a string of displayable Unicode characters in the US-ASCII character range. The string is formatted according to the IDNA standard.

Parameters

NameDescriptionDefault
unicode The string to convert, which consists of one or more domain name labels delimited with label separators.

Returns

The equivalent of the string specified by the unicode parameter, consisting of displayable Unicode characters in the US-ASCII character range (U+0020 to U+007E) and formatted according to the IDNA standard.

System.Globalization.IdnMapping.GetAscii()

Encodes a substring of domain name labels that include Unicode characters outside the US-ASCII character range. The substring is converted to a string of displayable Unicode characters in the US-ASCII character range and is formatted according to the IDNA standard.

Parameters

NameDescriptionDefault
unicode The string to convert, which consists of one or more domain name labels delimited with label separators.
index A zero-based offset into unicode that specifies the start of the substring to convert. The conversion operation continues to the end of the unicode string.

Returns

The equivalent of the substring specified by the unicode and index parameters, consisting of displayable Unicode characters in the US-ASCII character range (U+0020 to U+007E) and formatted according to the IDNA standard.

System.Globalization.IdnMapping.GetAscii()

Encodes the specified number of characters in a substring of domain name labels that include Unicode characters outside the US-ASCII character range. The substring is converted to a string of displayable Unicode characters in the US-ASCII character range and is formatted according to the IDNA standard.

Parameters

NameDescriptionDefault
unicode The string to convert, which consists of one or more domain name labels delimited with label separators.
index A zero-based offset into unicode that specifies the start of the substring.
count The number of characters to convert in the substring that starts at the position specified by index in the unicode string.

Returns

The equivalent of the substring specified by the unicode, index, and count parameters, consisting of displayable Unicode characters in the US-ASCII character range (U+0020 to U+007E) and formatted according to the IDNA standard.

System.Globalization.IdnMapping.GetHashCode

Returns a hash code for this System.Globalization.IdnMapping object.

Returns

One of four 32-bit signed constants derived from the properties of an System.Globalization.IdnMapping object. The return value has no special meaning and is not suitable for use in a hash code algorithm.

System.Globalization.IdnMapping.GetUnicode()

Decodes a string of one or more domain name labels, encoded according to the IDNA standard, to a string of Unicode characters.

Parameters

NameDescriptionDefault
ascii The string to decode, which consists of one or more labels in the US-ASCII character range (U+0020 to U+007E) encoded according to the IDNA standard.

Returns

The Unicode equivalent of the IDNA substring specified by the ascii parameter.

System.Globalization.IdnMapping.GetUnicode()

Decodes a substring of one or more domain name labels, encoded according to the IDNA standard, to a string of Unicode characters.

Parameters

NameDescriptionDefault
ascii The string to decode, which consists of one or more labels in the US-ASCII character range (U+0020 to U+007E) encoded according to the IDNA standard.
index A zero-based offset into ascii that specifies the start of the substring to decode. The decoding operation continues to the end of the ascii string.

Returns

The Unicode equivalent of the IDNA substring specified by the ascii and index parameters.

System.Globalization.IdnMapping.GetUnicode()

Decodes a substring of a specified length that contains one or more domain name labels, encoded according to the IDNA standard, to a string of Unicode characters.

Parameters

NameDescriptionDefault
ascii The string to decode, which consists of one or more labels in the US-ASCII character range (U+0020 to U+007E) encoded according to the IDNA standard.
index A zero-based offset into ascii that specifies the start of the substring.
count The number of characters to convert in the substring that starts at the position specified by index in the ascii string.

Returns

The Unicode equivalent of the IDNA substring specified by the ascii, index, and count parameters.

System.Globalization.IdnMapping.AllowUnassigned

Gets or sets a value that indicates whether unassigned Unicode code points are used in operations performed by members of the current System.Globalization.IdnMapping object.

Returns

true if unassigned code points are used in operations; otherwise, false.

System.Globalization.IdnMapping.UseStd3AsciiRules

Gets or sets a value that indicates whether standard or relaxed naming conventions are used in operations performed by members of the current System.Globalization.IdnMapping object.

Returns

true if standard naming conventions are used in operations; otherwise, false.

System.Globalization.ISOWeek

Provides static members to support the ISO week date that is part of the ISO 8601 date and time standard issued by the International Organization for Standardization (ISO).

System.Globalization.ISOWeek.GetWeekOfYear()

Calculates the ISO week number of a given Gregorian date.

Parameters

NameDescriptionDefault
date A date in the Gregorian calendar.

Returns

A number between 1 and 53 representing the ISO week number of the given Gregorian date.

System.Globalization.ISOWeek.GetWeeksInYear()

calculates the number of weeks in a given ISO week-numbering year.

Parameters

NameDescriptionDefault
year An ISO week-numbering year (also called an ISO year informally).

Returns

The number of ISO weeks in the year. Returns either 52 or 53.

System.Globalization.ISOWeek.GetYear()

Calculates the ISO week-numbering year (also called ISO year informally) mapped to the input Gregorian date.

Parameters

NameDescriptionDefault
date A date in the Gregorian calendar.

Returns

The ISO week-numbering year, between 1 and 9999

System.Globalization.ISOWeek.GetYearEnd()

Calculates the Gregorian date at which the week-numbering year will end.

Parameters

NameDescriptionDefault
year An ISO week-numbering year (also called an ISO year informally).

Returns

The Gregorian date at which the week-numbering year will end.

System.Globalization.ISOWeek.GetYearStart()

Calculates the Gregorian date at which the week-numbering year will start.

Parameters

NameDescriptionDefault
year An ISO week-numbering year (also called an ISO year informally).

Returns

The Gregorian date at which the week-numbering year will start.

System.Globalization.ISOWeek.ToDateTime()

Maps the ISO week date represented by a specified ISO year, week number, and day of week to the equivalent Gregorian date.

Parameters

NameDescriptionDefault
year An ISO week-numbering year (also called an ISO year informally).
week The ISO week number in the given ISO week-numbering year.
dayOfWeek The day of week inside the given ISO week.

Returns

The Gregorian date equivalent to the input ISO week date.

System.Globalization.JapaneseCalendar

Represents the Japanese calendar.

System.Globalization.JapaneseCalendar.#ctor

Initializes a new instance of the System.Globalization.JapaneseCalendar class.

System.Globalization.JapaneseCalendar.AddMonths()

Returns a System.DateTime that is the specified number of months away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add months.
months The number of months to add.

Returns

The System.DateTime that results from adding the specified number of months to the specified System.DateTime.

System.Globalization.JapaneseCalendar.AddYears()

Returns a System.DateTime that is the specified number of years away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add years.
years The number of years to add.

Returns

The System.DateTime that results from adding the specified number of years to the specified System.DateTime.

System.Globalization.JapaneseCalendar.GetDayOfMonth()

Returns the day of the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 31 that represents the day of the month in the specified System.DateTime.

System.Globalization.JapaneseCalendar.GetDayOfWeek()

Returns the day of the week in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

A System.DayOfWeek value that represents the day of the week in the specified System.DateTime.

System.Globalization.JapaneseCalendar.GetDayOfYear()

Returns the day of the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 366 that represents the day of the year in the specified System.DateTime.

System.Globalization.JapaneseCalendar.GetDaysInMonth()

Returns the number of days in the specified month in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
era An integer that represents the era.

Returns

The number of days in the specified month in the specified year in the specified era.

System.Globalization.JapaneseCalendar.GetDaysInYear()

Returns the number of days in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of days in the specified year in the specified era.

System.Globalization.JapaneseCalendar.GetEra()

Returns the era in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the era in the specified System.DateTime.

System.Globalization.JapaneseCalendar.GetLeapMonth()

Calculates the leap month for a specified year and era.

Parameters

NameDescriptionDefault
year A year.
era An era.

Returns

The return value is always 0 because the System.Globalization.JapaneseCalendar type does not support the notion of a leap month.

System.Globalization.JapaneseCalendar.GetMonth()

Returns the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 12 that represents the month in the specified System.DateTime.

System.Globalization.JapaneseCalendar.GetMonthsInYear()

Returns the number of months in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The return value is always 12.

System.Globalization.JapaneseCalendar.GetWeekOfYear()

Returns the week of the year that includes the date in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.
rule One of the System.Globalization.CalendarWeekRule values that defines a calendar week.
firstDayOfWeek One of the System.DayOfWeek values that represents the first day of the week.

Returns

A 1-based integer that represents the week of the year that includes the date in the time parameter.

System.Globalization.JapaneseCalendar.GetYear()

Returns the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the year in the specified System.DateTime.

System.Globalization.JapaneseCalendar.IsLeapDay()

Determines whether the specified date in the specified era is a leap day.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
day An integer from 1 to 31 that represents the day.
era An integer that represents the era.

Returns

true, if the specified day is a leap day; otherwise, false.

System.Globalization.JapaneseCalendar.IsLeapMonth()

Determines whether the specified month in the specified year in the specified era is a leap month.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
era An integer that represents the era.

Returns

This method always returns false, unless overridden by a derived class.

System.Globalization.JapaneseCalendar.IsLeapYear()

Determines whether the specified year in the specified era is a leap year.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

true, if the specified year is a leap year; otherwise, false.

System.Globalization.JapaneseCalendar.ToDateTime()

Returns a System.DateTime that is set to the specified date and time in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
day An integer from 1 to 31 that represents the day.
hour An integer from 0 to 23 that represents the hour.
minute An integer from 0 to 59 that represents the minute.
second An integer from 0 to 59 that represents the second.
millisecond An integer from 0 to 999 that represents the millisecond.
era An integer that represents the era.

Returns

The System.DateTime that is set to the specified date and time in the current era.

System.Globalization.JapaneseCalendar.ToFourDigitYear()

Converts the specified year to a four-digit year by using the System.Globalization.JapaneseCalendar.TwoDigitYearMax property to determine the appropriate century.

Parameters

NameDescriptionDefault
year An integer (usually two digits) that represents the year to convert.

Returns

An integer that contains the four-digit representation of year.

System.Globalization.JapaneseCalendar.AlgorithmType

Gets a value that indicates whether the current calendar is solar-based, lunar-based, or a combination of both.

Returns

System.Globalization.JapaneseCalendar.Eras

Gets the list of eras in the System.Globalization.JapaneseCalendar.

Returns

An array of integers that represents the eras in the System.Globalization.JapaneseCalendar.

System.Globalization.JapaneseCalendar.MaxSupportedDateTime

Gets the latest date and time supported by the current System.Globalization.JapaneseCalendar object.

Returns

The latest date and time supported by the System.Globalization.JapaneseCalendar type, which is equivalent to the last moment of December 31, 9999 C.E. in the Gregorian calendar.

System.Globalization.JapaneseCalendar.MinSupportedDateTime

Gets the earliest date and time supported by the current System.Globalization.JapaneseCalendar object.

Returns

The earliest date and time supported by the System.Globalization.JapaneseCalendar type, which is equivalent to the first moment of September 8, 1868 C.E. in the Gregorian calendar.

System.Globalization.JapaneseCalendar.TwoDigitYearMax

Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.

Returns

The last year of a 100-year range that can be represented by a 2-digit year.

System.Globalization.JapaneseLunisolarCalendar

Represents time in divisions, such as months, days, and years. Years are calculated as for the Japanese calendar, while days and months are calculated using the lunisolar calendar.

System.Globalization.JapaneseLunisolarCalendar.JapaneseEra

Specifies the current era.

System.Globalization.JapaneseLunisolarCalendar.#ctor

Initializes a new instance of the System.Globalization.JapaneseLunisolarCalendar class.

System.Globalization.JapaneseLunisolarCalendar.GetEra()

Retrieves the era that corresponds to the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the era specified in the time parameter.

System.Globalization.JapaneseLunisolarCalendar.DaysInYearBeforeMinSupportedYear

Gets the number of days in the year that precedes the year that is specified by the System.Globalization.JapaneseLunisolarCalendar.MinSupportedDateTime property.

Returns

The number of days in the year that precedes the year specified by System.Globalization.JapaneseLunisolarCalendar.MinSupportedDateTime.

System.Globalization.JapaneseLunisolarCalendar.Eras

Gets the eras that are relevant to the System.Globalization.JapaneseLunisolarCalendar object.

Returns

An array of 32-bit signed integers that specify the relevant eras.

System.Globalization.JapaneseLunisolarCalendar.MaxSupportedDateTime

Gets the maximum date and time supported by the System.Globalization.JapaneseLunisolarCalendar class.

Returns

The latest date and time supported by the System.Globalization.JapaneseLunisolarCalendar class, which is equivalent to the last moment of January 22, 2050 C.E. in the Gregorian calendar.

System.Globalization.JapaneseLunisolarCalendar.MinSupportedDateTime

Gets the minimum date and time supported by the System.Globalization.JapaneseLunisolarCalendar class.

Returns

The earliest date and time supported by the System.Globalization.JapaneseLunisolarCalendar class, which is equivalent to the first moment of January 28, 1960 C.E. in the Gregorian calendar.

System.Globalization.JulianCalendar

Represents the Julian calendar.

System.Globalization.JulianCalendar.JulianEra

Represents the current era. This field is constant.

System.Globalization.JulianCalendar.#ctor

Initializes a new instance of the System.Globalization.JulianCalendar class.

System.Globalization.JulianCalendar.AddMonths()

Returns a System.DateTime that is the specified number of months away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add months.
months The number of months to add.

Returns

The System.DateTime that results from adding the specified number of months to the specified System.DateTime.

System.Globalization.JulianCalendar.AddYears()

Returns a System.DateTime that is the specified number of years away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add years.
years The number of years to add.

Returns

The System.DateTime that results from adding the specified number of years to the specified System.DateTime.

System.Globalization.JulianCalendar.GetDayOfMonth()

Returns the day of the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 31 that represents the day of the month in time.

System.Globalization.JulianCalendar.GetDayOfWeek()

Returns the day of the week in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

A System.DayOfWeek value that represents the day of the week in time.

System.Globalization.JulianCalendar.GetDayOfYear()

Returns the day of the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 366 that represents the day of the year in time.

System.Globalization.JulianCalendar.GetDaysInMonth()

Returns the number of days in the specified month in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
era An integer that represents the era.

Returns

The number of days in the specified month in the specified year in the specified era.

System.Globalization.JulianCalendar.GetDaysInYear()

Returns the number of days in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of days in the specified year in the specified era.

System.Globalization.JulianCalendar.GetEra()

Returns the era in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the era in time.

System.Globalization.JulianCalendar.GetLeapMonth()

Calculates the leap month for a specified year and era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

A positive integer that indicates the leap month in the specified year and era. Alternatively, this method returns zero if the calendar does not support a leap month, or if year and era do not specify a leap year.

System.Globalization.JulianCalendar.GetMonth()

Returns the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 12 that represents the month in time.

System.Globalization.JulianCalendar.GetMonthsInYear()

Returns the number of months in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of months in the specified year in the specified era.

System.Globalization.JulianCalendar.GetYear()

Returns the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the year in time.

System.Globalization.JulianCalendar.IsLeapDay()

Determines whether the specified date in the specified era is a leap day.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
day An integer from 1 to 31 that represents the day.
era An integer that represents the era.

Returns

true if the specified day is a leap day; otherwise, false.

System.Globalization.JulianCalendar.IsLeapMonth()

Determines whether the specified month in the specified year in the specified era is a leap month.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
era An integer that represents the era.

Returns

This method always returns false, unless overridden by a derived class.

System.Globalization.JulianCalendar.IsLeapYear()

Determines whether the specified year in the specified era is a leap year.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

true if the specified year is a leap year; otherwise, false.

System.Globalization.JulianCalendar.ToDateTime()

Returns a System.DateTime that is set to the specified date and time in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
day An integer from 1 to 31 that represents the day.
hour An integer from 0 to 23 that represents the hour.
minute An integer from 0 to 59 that represents the minute.
second An integer from 0 to 59 that represents the second.
millisecond An integer from 0 to 999 that represents the millisecond.
era An integer that represents the era.

Returns

The System.DateTime that is set to the specified date and time in the current era.

System.Globalization.JulianCalendar.ToFourDigitYear()

Converts the specified year to a four-digit year by using the System.Globalization.JulianCalendar.TwoDigitYearMax property to determine the appropriate century.

Parameters

NameDescriptionDefault
year A two-digit or four-digit integer that represents the year to convert.

Returns

An integer that contains the four-digit representation of year.

System.Globalization.JulianCalendar.AlgorithmType

Gets a value that indicates whether the current calendar is solar-based, lunar-based, or a combination of both.

Returns

System.Globalization.JulianCalendar.Eras

Gets the list of eras in the System.Globalization.JulianCalendar.

Returns

An array of integers that represents the eras in the System.Globalization.JulianCalendar.

System.Globalization.JulianCalendar.MaxSupportedDateTime

Gets the latest date and time supported by the System.Globalization.JulianCalendar class.

Returns

The latest date and time supported by the System.Globalization.JulianCalendar class, which is equivalent to the last moment of December 31, 9999 C.E. in the Gregorian calendar.

System.Globalization.JulianCalendar.MinSupportedDateTime

Gets the earliest date and time supported by the System.Globalization.JulianCalendar class.

Returns

The earliest date and time supported by the System.Globalization.JulianCalendar class, which is equivalent to the first moment of January 1, 0001 C.E. in the Gregorian calendar.

System.Globalization.JulianCalendar.TwoDigitYearMax

Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.

Returns

The last year of a 100-year range that can be represented by a 2-digit year.

System.Globalization.KoreanCalendar

Represents the Korean calendar.

System.Globalization.KoreanCalendar.KoreanEra

Represents the current era. This field is constant.

System.Globalization.KoreanCalendar.#ctor

Initializes a new instance of the System.Globalization.KoreanCalendar class.

System.Globalization.KoreanCalendar.AddMonths()

Returns a System.DateTime that is the specified number of months away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add months.
months The number of months to add.

Returns

The System.DateTime that results from adding the specified number of months to the specified System.DateTime.

System.Globalization.KoreanCalendar.AddYears()

Returns a System.DateTime that is the specified number of years away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add years.
years The number of years to add.

Returns

The System.DateTime that results from adding the specified number of years to the specified System.DateTime.

System.Globalization.KoreanCalendar.GetDayOfMonth()

Returns the day of the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 31 that represents the day of the month in the specified System.DateTime.

System.Globalization.KoreanCalendar.GetDayOfWeek()

Returns the day of the week in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

A System.DayOfWeek value that represents the day of the week in the specified System.DateTime.

System.Globalization.KoreanCalendar.GetDayOfYear()

Returns the day of the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 366 that represents the day of the year in the specified System.DateTime.

System.Globalization.KoreanCalendar.GetDaysInMonth()

Returns the number of days in the specified month in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
era An integer that represents the era.

Returns

The number of days in the specified month in the specified year in the specified era.

System.Globalization.KoreanCalendar.GetDaysInYear()

Returns the number of days in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of days in the specified year in the specified era.

System.Globalization.KoreanCalendar.GetEra()

Returns the era in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the era in the specified System.DateTime.

System.Globalization.KoreanCalendar.GetLeapMonth()

Calculates the leap month for a specified year and era.

Parameters

NameDescriptionDefault
year A year.
era An era.

Returns

The return value is always 0 because the System.Globalization.KoreanCalendar class does not support the notion of a leap month.

System.Globalization.KoreanCalendar.GetMonth()

Returns the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 12 that represents the month in the specified System.DateTime.

System.Globalization.KoreanCalendar.GetMonthsInYear()

Returns the number of months in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of months in the specified year in the specified era.

System.Globalization.KoreanCalendar.GetWeekOfYear()

Returns the week of the year that includes the date in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.
rule One of the System.Globalization.CalendarWeekRule values that defines a calendar week.
firstDayOfWeek One of the System.DayOfWeek values that represents the first day of the week.

Returns

A 1-based integer that represents the week of the year that includes the date in the time parameter.

System.Globalization.KoreanCalendar.GetYear()

Returns the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the year in the specified System.DateTime.

System.Globalization.KoreanCalendar.IsLeapDay()

Determines whether the specified date in the specified era is a leap day.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
day An integer from 1 to 31 that represents the day.
era An integer that represents the era.

Returns

true if the specified day is a leap day; otherwise, false.

System.Globalization.KoreanCalendar.IsLeapMonth()

Determines whether the specified month in the specified year in the specified era is a leap month.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
era An integer that represents the era.

Returns

This method always returns false, unless overridden by a derived class.

System.Globalization.KoreanCalendar.IsLeapYear()

Determines whether the specified year in the specified era is a leap year.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

true if the specified year is a leap year; otherwise, false.

System.Globalization.KoreanCalendar.ToDateTime()

Returns a System.DateTime that is set to the specified date and time in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
day An integer from 1 to 31 that represents the day.
hour An integer from 0 to 23 that represents the hour.
minute An integer from 0 to 59 that represents the minute.
second An integer from 0 to 59 that represents the second.
millisecond An integer from 0 to 999 that represents the millisecond.
era An integer that represents the era.

Returns

The System.DateTime that is set to the specified date and time in the current era.

System.Globalization.KoreanCalendar.ToFourDigitYear()

Converts the specified year to a four-digit year by using the System.Globalization.KoreanCalendar.TwoDigitYearMax property to determine the appropriate century.

Parameters

NameDescriptionDefault
year A two-digit or four-digit integer that represents the year to convert.

Returns

An integer that contains the four-digit representation of year.

System.Globalization.KoreanCalendar.AlgorithmType

Gets a value indicating whether the current calendar is solar-based, lunar-based, or a combination of both.

Returns

System.Globalization.KoreanCalendar.Eras

Gets the list of eras in the System.Globalization.KoreanCalendar.

Returns

An array of integers that represents the eras in the System.Globalization.KoreanCalendar.

System.Globalization.KoreanCalendar.MaxSupportedDateTime

Gets the latest date and time supported by the System.Globalization.KoreanCalendar class.

Returns

The latest date and time supported by the System.Globalization.KoreanCalendar class, which is equivalent to the last moment of December 31, 9999 C.E. in the Gregorian calendar.

System.Globalization.KoreanCalendar.MinSupportedDateTime

Gets the earliest date and time supported by the System.Globalization.KoreanCalendar class.

Returns

The earliest date and time supported by the System.Globalization.KoreanCalendar class, which is equivalent to the first moment of January 1, 0001 C.E. in the Gregorian calendar.

System.Globalization.KoreanCalendar.TwoDigitYearMax

Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.

Returns

The last year of a 100-year range that can be represented by a 2-digit year.

System.Globalization.KoreanLunisolarCalendar

Represents time in divisions, such as months, days, and years. Years are calculated using the Gregorian calendar, while days and months are calculated using the lunisolar calendar.

System.Globalization.KoreanLunisolarCalendar.GregorianEra

Specifies the Gregorian era that corresponds to the current System.Globalization.KoreanLunisolarCalendar object.

System.Globalization.KoreanLunisolarCalendar.#ctor

Initializes a new instance of the System.Globalization.KoreanLunisolarCalendar class.

System.Globalization.KoreanLunisolarCalendar.GetEra()

Retrieves the era that corresponds to the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the era specified by the time parameter. The return value for a System.Globalization.KoreanLunisolarCalendar object is always the System.Globalization.KoreanLunisolarCalendar.GregorianEra value.

System.Globalization.KoreanLunisolarCalendar.DaysInYearBeforeMinSupportedYear

Gets the number of days in the year that precedes the year specified by the System.Globalization.KoreanLunisolarCalendar.MinSupportedDateTime property.

Returns

The number of days in the year that precedes the year specified by System.Globalization.KoreanLunisolarCalendar.MinSupportedDateTime.

System.Globalization.KoreanLunisolarCalendar.Eras

Gets the eras that correspond to the range of dates and times supported by the current System.Globalization.KoreanLunisolarCalendar object.

Returns

An array of 32-bit signed integers that specify the relevant eras. The return value for a System.Globalization.KoreanLunisolarCalendar object is always an array containing one element equal to the System.Globalization.KoreanLunisolarCalendar.GregorianEra value.

System.Globalization.KoreanLunisolarCalendar.MaxSupportedDateTime

Gets the maximum date and time supported by the System.Globalization.KoreanLunisolarCalendar class.

Returns

The latest date and time supported by the System.Globalization.KoreanLunisolarCalendar class, which is equivalent to the last moment of February 10, 2051 C.E. in the Gregorian calendar.

System.Globalization.KoreanLunisolarCalendar.MinSupportedDateTime

Gets the minimum date and time supported by the System.Globalization.KoreanLunisolarCalendar class.

Returns

The earliest date and time supported by the System.Globalization.KoreanLunisolarCalendar class.

System.Globalization.NumberFormatInfo

Provides culture-specific information for formatting and parsing numeric values.

System.Globalization.NumberFormatInfo.#ctor

Initializes a new writable instance of the System.Globalization.NumberFormatInfo class that is culture-independent (invariant).

System.Globalization.NumberFormatInfo.Clone

Creates a shallow copy of the System.Globalization.NumberFormatInfo object.

Returns

A new object copied from the original System.Globalization.NumberFormatInfo object.

System.Globalization.NumberFormatInfo.GetFormat()

Gets an object of the specified type that provides a number formatting service.

Parameters

NameDescriptionDefault
formatType The System.Type of the required formatting service.

Returns

The current System.Globalization.NumberFormatInfo, if formatType is the same as the type of the current System.Globalization.NumberFormatInfo; otherwise, null.

System.Globalization.NumberFormatInfo.GetInstance()

Gets the System.Globalization.NumberFormatInfo associated with the specified System.IFormatProvider.

Parameters

NameDescriptionDefault
formatProvider The System.IFormatProvider used to get the System.Globalization.NumberFormatInfo. -or- null to get System.Globalization.NumberFormatInfo.CurrentInfo.

Returns

System.Globalization.NumberFormatInfo.ReadOnly()

Returns a read-only System.Globalization.NumberFormatInfo wrapper.

Parameters

NameDescriptionDefault
nfi The System.Globalization.NumberFormatInfo to wrap.

Returns

A read-only System.Globalization.NumberFormatInfo wrapper around nfi.

System.Globalization.NumberFormatInfo.CurrencyDecimalDigits

Gets or sets the number of decimal places to use in currency values.

Returns

The number of decimal places to use in currency values. The default for System.Globalization.NumberFormatInfo.InvariantInfo is 2.

System.Globalization.NumberFormatInfo.CurrencyDecimalSeparator

Gets or sets the string to use as the decimal separator in currency values.

Returns

The string to use as the decimal separator in currency values. The default for System.Globalization.NumberFormatInfo.InvariantInfo is ".".

System.Globalization.NumberFormatInfo.CurrencyGroupSeparator

Gets or sets the string that separates groups of digits to the left of the decimal in currency values.

Returns

The string that separates groups of digits to the left of the decimal in currency values. The default for System.Globalization.NumberFormatInfo.InvariantInfo is ",".

System.Globalization.NumberFormatInfo.CurrencyGroupSizes

Gets or sets the number of digits in each group to the left of the decimal in currency values.

Returns

The number of digits in each group to the left of the decimal in currency values. The default for System.Globalization.NumberFormatInfo.InvariantInfo is a one-dimensional array with only one element, which is set to 3.

System.Globalization.NumberFormatInfo.CurrencyNegativePattern

Gets or sets the format pattern for negative currency values.

Returns

The format pattern for negative currency values. The default for System.Globalization.NumberFormatInfo.InvariantInfo is 0, which represents "($n)", where "$" is the System.Globalization.NumberFormatInfo.CurrencySymbol and n is a number.

System.Globalization.NumberFormatInfo.CurrencyPositivePattern

Gets or sets the format pattern for positive currency values.

Returns

The format pattern for positive currency values. The default for System.Globalization.NumberFormatInfo.InvariantInfo is 0, which represents "$n", where "$" is the System.Globalization.NumberFormatInfo.CurrencySymbol and n is a number.

System.Globalization.NumberFormatInfo.CurrencySymbol

Gets or sets the string to use as the currency symbol.

Returns

The string to use as the currency symbol. The default for System.Globalization.NumberFormatInfo.InvariantInfo is "¤".

System.Globalization.NumberFormatInfo.CurrentInfo

Gets a read-only System.Globalization.NumberFormatInfo that formats values based on the current culture.

Returns

A read-only System.Globalization.NumberFormatInfo based on the culture of the current thread.

System.Globalization.NumberFormatInfo.DigitSubstitution

Gets or sets a value that specifies how the graphical user interface displays the shape of a digit.

Returns

One of the enumeration values that specifies the culture-specific digit shape.

System.Globalization.NumberFormatInfo.InvariantInfo

Gets a read-only System.Globalization.NumberFormatInfo object that is culture-independent (invariant).

Returns

A read-only object that is culture-independent (invariant).

System.Globalization.NumberFormatInfo.IsReadOnly

Gets a value that indicates whether this System.Globalization.NumberFormatInfo object is read-only.

Returns

true if the System.Globalization.NumberFormatInfo is read-only; otherwise, false.

System.Globalization.NumberFormatInfo.NaNSymbol

Gets or sets the string that represents the IEEE NaN (not a number) value.

Returns

The string that represents the IEEE NaN (not a number) value. The default for System.Globalization.NumberFormatInfo.InvariantInfo is "NaN".

System.Globalization.NumberFormatInfo.NativeDigits

Gets or sets a string array of native digits equivalent to the Western digits 0 through 9.

Returns

A string array that contains the native equivalent of the Western digits 0 through 9. The default is an array having the elements "0", "1", "2", "3", "4", "5", "6", "7", "8", and "9".

System.Globalization.NumberFormatInfo.NegativeInfinitySymbol

Gets or sets the string that represents negative infinity.

Returns

The string that represents negative infinity. The default for System.Globalization.NumberFormatInfo.InvariantInfo is "-Infinity".

System.Globalization.NumberFormatInfo.NegativeSign

Gets or sets the string that denotes that the associated number is negative.

Returns

The string that denotes that the associated number is negative. The default for System.Globalization.NumberFormatInfo.InvariantInfo is "-".

System.Globalization.NumberFormatInfo.NumberDecimalDigits

Gets or sets the number of decimal places to use in numeric values.

Returns

The number of decimal places to use in numeric values. The default for System.Globalization.NumberFormatInfo.InvariantInfo is 2.

System.Globalization.NumberFormatInfo.NumberDecimalSeparator

Gets or sets the string to use as the decimal separator in numeric values.

Returns

The string to use as the decimal separator in numeric values. The default for System.Globalization.NumberFormatInfo.InvariantInfo is ".".

System.Globalization.NumberFormatInfo.NumberGroupSeparator

Gets or sets the string that separates groups of digits to the left of the decimal in numeric values.

Returns

The string that separates groups of digits to the left of the decimal in numeric values. The default for System.Globalization.NumberFormatInfo.InvariantInfo is ",".

System.Globalization.NumberFormatInfo.NumberGroupSizes

Gets or sets the number of digits in each group to the left of the decimal in numeric values.

Returns

The number of digits in each group to the left of the decimal in numeric values. The default for System.Globalization.NumberFormatInfo.InvariantInfo is a one-dimensional array with only one element, which is set to 3.

System.Globalization.NumberFormatInfo.NumberNegativePattern

Gets or sets the format pattern for negative numeric values.

Returns

The format pattern for negative numeric values.

System.Globalization.NumberFormatInfo.PercentDecimalDigits

Gets or sets the number of decimal places to use in percent values.

Returns

The number of decimal places to use in percent values. The default for System.Globalization.NumberFormatInfo.InvariantInfo is 2.

System.Globalization.NumberFormatInfo.PercentDecimalSeparator

Gets or sets the string to use as the decimal separator in percent values.

Returns

The string to use as the decimal separator in percent values. The default for System.Globalization.NumberFormatInfo.InvariantInfo is ".".

System.Globalization.NumberFormatInfo.PercentGroupSeparator

Gets or sets the string that separates groups of digits to the left of the decimal in percent values.

Returns

The string that separates groups of digits to the left of the decimal in percent values. The default for System.Globalization.NumberFormatInfo.InvariantInfo is ",".

System.Globalization.NumberFormatInfo.PercentGroupSizes

Gets or sets the number of digits in each group to the left of the decimal in percent values.

Returns

The number of digits in each group to the left of the decimal in percent values. The default for System.Globalization.NumberFormatInfo.InvariantInfo is a one-dimensional array with only one element, which is set to 3.

System.Globalization.NumberFormatInfo.PercentNegativePattern

Gets or sets the format pattern for negative percent values.

Returns

The format pattern for negative percent values. The default for System.Globalization.NumberFormatInfo.InvariantInfo is 0, which represents "-n %", where "%" is the System.Globalization.NumberFormatInfo.PercentSymbol and n is a number.

System.Globalization.NumberFormatInfo.PercentPositivePattern

Gets or sets the format pattern for positive percent values.

Returns

The format pattern for positive percent values. The default for System.Globalization.NumberFormatInfo.InvariantInfo is 0, which represents "n %", where "%" is the System.Globalization.NumberFormatInfo.PercentSymbol and n is a number.

System.Globalization.NumberFormatInfo.PercentSymbol

Gets or sets the string to use as the percent symbol.

Returns

The string to use as the percent symbol. The default for System.Globalization.NumberFormatInfo.InvariantInfo is "%".

System.Globalization.NumberFormatInfo.PerMilleSymbol

Gets or sets the string to use as the per mille symbol.

Returns

The string to use as the per mille symbol. The default for System.Globalization.NumberFormatInfo.InvariantInfo is "‰", which is the Unicode character U+2030.

System.Globalization.NumberFormatInfo.PositiveInfinitySymbol

Gets or sets the string that represents positive infinity.

Returns

The string that represents positive infinity. The default for System.Globalization.NumberFormatInfo.InvariantInfo is "Infinity".

System.Globalization.NumberFormatInfo.PositiveSign

Gets or sets the string that denotes that the associated number is positive.

Returns

The string that denotes that the associated number is positive. The default for System.Globalization.NumberFormatInfo.InvariantInfo is "+".

System.Globalization.NumberStyles

Determines the styles permitted in numeric string arguments that are passed to the Parse and TryParse methods of the integral and floating-point numeric types.

System.Globalization.NumberStyles.AllowBinarySpecifier

Indicates that the numeric string represents a binary value. Valid binary values include the numeric digits 0 and 1. Strings that are parsed using this style do not employ a prefix; 0b cannot be used. A string that is parsed with the System.Globalization.NumberStyles.AllowBinarySpecifier style will always be interpreted as a binary value. The only flags that can be combined with System.Globalization.NumberStyles.AllowBinarySpecifier are System.Globalization.NumberStyles.AllowLeadingWhite and System.Globalization.NumberStyles.AllowTrailingWhite. The System.Globalization.NumberStyles enumeration includes a composite style, System.Globalization.NumberStyles.BinaryNumber, that consists of these three flags.

System.Globalization.NumberStyles.AllowCurrencySymbol

Indicates that the numeric string can contain a currency symbol. Valid currency symbols are determined by the System.Globalization.NumberFormatInfo.CurrencySymbol property.

System.Globalization.NumberStyles.AllowDecimalPoint

Indicates that the numeric string can have a decimal point. If the System.Globalization.NumberStyles value includes the System.Globalization.NumberStyles.AllowCurrencySymbol flag and the parsed string includes a currency symbol, the decimal separator character is determined by the System.Globalization.NumberFormatInfo.CurrencyDecimalSeparator property. Otherwise, the decimal separator character is determined by the System.Globalization.NumberFormatInfo.NumberDecimalSeparator property.

System.Globalization.NumberStyles.AllowExponent

Indicates that the numeric string can be in exponential notation. The System.Globalization.NumberStyles.AllowExponent flag allows the parsed string to contain an exponent that begins with the "E" or "e" character and that is followed by an optional positive or negative sign and an integer. In other words, it successfully parses strings in the form nnnExx, nnnE+xx, and nnnE-xx. It does not allow a decimal separator or sign in the significand or mantissa; to allow these elements in the string to be parsed, use the System.Globalization.NumberStyles.AllowDecimalPoint and System.Globalization.NumberStyles.AllowLeadingSign flags, or use a composite style that includes these individual flags.

System.Globalization.NumberStyles.AllowHexSpecifier

Indicates that the numeric string represents a hexadecimal value. Valid hexadecimal values include the numeric digits 0-9 and the hexadecimal digits A-F and a-f. Strings that are parsed using this style cannot be prefixed with "0x" or "&h". A string that is parsed with the System.Globalization.NumberStyles.AllowHexSpecifier style will always be interpreted as a hexadecimal value. The only flags that can be combined with System.Globalization.NumberStyles.AllowHexSpecifier are System.Globalization.NumberStyles.AllowLeadingWhite and System.Globalization.NumberStyles.AllowTrailingWhite. The System.Globalization.NumberStyles enumeration includes a composite style, System.Globalization.NumberStyles.HexNumber, that consists of these three flags.

System.Globalization.NumberStyles.AllowLeadingSign

Indicates that the numeric string can have a leading sign. Valid leading sign characters are determined by the System.Globalization.NumberFormatInfo.PositiveSign and System.Globalization.NumberFormatInfo.NegativeSign properties.

System.Globalization.NumberStyles.AllowLeadingWhite

Indicates that leading white-space characters can be present in the parsed string. Valid white-space characters have the Unicode values U+0009, U+000A, U+000B, U+000C, U+000D, and U+0020. Note that this is a subset of the characters for which the System.Char.IsWhiteSpace() method returns true.

System.Globalization.NumberStyles.AllowParentheses

Indicates that the numeric string can have one pair of parentheses enclosing the number. The parentheses indicate that the string to be parsed represents a negative number.

System.Globalization.NumberStyles.AllowThousands

Indicates that the numeric string can have group separators, such as symbols that separate hundreds from thousands. If the System.Globalization.NumberStyles value includes the System.Globalization.NumberStyles.AllowCurrencySymbol flag and the string to be parsed includes a currency symbol, the valid group separator character is determined by the System.Globalization.NumberFormatInfo.CurrencyGroupSeparator property, and the number of digits in each group is determined by the System.Globalization.NumberFormatInfo.CurrencyGroupSizes property. Otherwise, the valid group separator character is determined by the System.Globalization.NumberFormatInfo.NumberGroupSeparator property, and the number of digits in each group is determined by the System.Globalization.NumberFormatInfo.NumberGroupSizes property.

System.Globalization.NumberStyles.AllowTrailingSign

Indicates that the numeric string can have a trailing sign. Valid trailing sign characters are determined by the System.Globalization.NumberFormatInfo.PositiveSign and System.Globalization.NumberFormatInfo.NegativeSign properties.

System.Globalization.NumberStyles.AllowTrailingWhite

Indicates that trailing white-space characters can be present in the parsed string. Valid white-space characters have the Unicode values U+0009, U+000A, U+000B, U+000C, U+000D, and U+0020. Note that this is a subset of the characters for which the System.Char.IsWhiteSpace() method returns true.

System.Globalization.NumberStyles.Any

Indicates that all styles except System.Globalization.NumberStyles.AllowHexSpecifier are used. This is a composite number style.

System.Globalization.NumberStyles.BinaryNumber

System.Globalization.NumberStyles.Currency

Indicates that all styles except System.Globalization.NumberStyles.AllowExponent and System.Globalization.NumberStyles.AllowHexSpecifier are used. This is a composite number style.

System.Globalization.NumberStyles.Float

System.Globalization.NumberStyles.HexNumber

System.Globalization.NumberStyles.Integer

System.Globalization.NumberStyles.None

Indicates that no style elements, such as leading or trailing white space, thousands separators, or a decimal separator, can be present in the parsed string. The string to be parsed must consist of integral decimal digits only.

System.Globalization.NumberStyles.Number

System.Globalization.PersianCalendar

Represents the Persian calendar.

System.Globalization.PersianCalendar.PersianEra

Represents the current era. This field is constant.

System.Globalization.PersianCalendar.#ctor

Initializes a new instance of the System.Globalization.PersianCalendar class.

System.Globalization.PersianCalendar.AddMonths()

Returns a System.DateTime object that is offset the specified number of months from the specified System.DateTime object.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add months.
months The positive or negative number of months to add.

Returns

A System.DateTime object that represents the date yielded by adding the number of months specified by the months parameter to the date specified by the time parameter.

System.Globalization.PersianCalendar.AddYears()

Returns a System.DateTime object that is offset the specified number of years from the specified System.DateTime object.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add years.
years The positive or negative number of years to add.

Returns

The System.DateTime object that results from adding the specified number of years to the specified System.DateTime object.

System.Globalization.PersianCalendar.GetDayOfMonth()

Returns the day of the month in the specified System.DateTime object.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 through 31 that represents the day of the month in the specified System.DateTime object.

System.Globalization.PersianCalendar.GetDayOfWeek()

Returns the day of the week in the specified System.DateTime object.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

A System.DayOfWeek value that represents the day of the week in the specified System.DateTime object.

System.Globalization.PersianCalendar.GetDayOfYear()

Returns the day of the year in the specified System.DateTime object.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 through 366 that represents the day of the year in the specified System.DateTime object.

System.Globalization.PersianCalendar.GetDaysInMonth()

Returns the number of days in the specified month of the specified year and era.

Parameters

NameDescriptionDefault
year An integer from 1 through 9378 that represents the year.
month An integer that represents the month, and ranges from 1 through 12 if year is not 9378, or 1 through 10 if year is 9378.
era An integer from 0 through 1 that represents the era.

Returns

The number of days in the specified month of the specified year and era.

System.Globalization.PersianCalendar.GetDaysInYear()

Returns the number of days in the specified year of the specified era.

Parameters

NameDescriptionDefault
year An integer from 1 through 9378 that represents the year.
era An integer from 0 through 1 that represents the era.

Returns

The number of days in the specified year and era. The number of days is 365 in a common year or 366 in a leap year.

System.Globalization.PersianCalendar.GetEra()

Returns the era in the specified System.DateTime object.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

System.Globalization.PersianCalendar.GetLeapMonth()

Returns the leap month for a specified year and era.

Parameters

NameDescriptionDefault
year An integer from 1 through 9378 that represents the year to convert.
era An integer from 0 through 1 that represents the era.

Returns

The return value is always 0.

System.Globalization.PersianCalendar.GetMonth()

Returns the month in the specified System.DateTime object.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 through 12 that represents the month in the specified System.DateTime object.

System.Globalization.PersianCalendar.GetMonthsInYear()

Returns the number of months in the specified year of the specified era.

Parameters

NameDescriptionDefault
year An integer from 1 through 9378 that represents the year.
era An integer from 0 through 1 that represents the era.

Returns

Returns 10 if the year parameter is 9378; otherwise, always returns 12.

System.Globalization.PersianCalendar.GetYear()

Returns the year in the specified System.DateTime object.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 through 9378 that represents the year in the specified System.DateTime.

System.Globalization.PersianCalendar.IsLeapDay()

Determines whether the specified date is a leap day.

Parameters

NameDescriptionDefault
year An integer from 1 through 9378 that represents the year.
month An integer that represents the month and ranges from 1 through 12 if year is not 9378, or 1 through 10 if year is 9378.
day An integer from 1 through 31 that represents the day.
era An integer from 0 through 1 that represents the era.

Returns

true if the specified day is a leap day; otherwise, false.

System.Globalization.PersianCalendar.IsLeapMonth()

Determines whether the specified month in the specified year and era is a leap month.

Parameters

NameDescriptionDefault
year An integer from 1 through 9378 that represents the year.
month An integer that represents the month and ranges from 1 through 12 if year is not 9378, or 1 through 10 if year is 9378.
era An integer from 0 through 1 that represents the era.

Returns

Always returns false because the System.Globalization.PersianCalendar class does not support the notion of a leap month.

System.Globalization.PersianCalendar.IsLeapYear()

Determines whether the specified year in the specified era is a leap year.

Parameters

NameDescriptionDefault
year An integer from 1 through 9378 that represents the year.
era An integer from 0 through 1 that represents the era.

Returns

true if the specified year is a leap year; otherwise, false.

System.Globalization.PersianCalendar.ToDateTime()

Returns a System.DateTime object that is set to the specified date, time, and era.

Parameters

NameDescriptionDefault
year An integer from 1 through 9378 that represents the year.
month An integer from 1 through 12 that represents the month.
day An integer from 1 through 31 that represents the day.
hour An integer from 0 through 23 that represents the hour.
minute An integer from 0 through 59 that represents the minute.
second An integer from 0 through 59 that represents the second.
millisecond An integer from 0 through 999 that represents the millisecond.
era An integer from 0 through 1 that represents the era.

Returns

A System.DateTime object that is set to the specified date and time in the current era.

System.Globalization.PersianCalendar.ToFourDigitYear()

Converts the specified year to a four-digit year representation.

Parameters

NameDescriptionDefault
year An integer from 1 through 9378 that represents the year to convert.

Returns

An integer that contains the four-digit representation of year.

System.Globalization.PersianCalendar.AlgorithmType

Gets a value indicating whether the current calendar is solar-based, lunar-based, or lunisolar-based.

Returns

System.Globalization.PersianCalendar.Eras

Gets the list of eras in a System.Globalization.PersianCalendar object.

Returns

An array of integers that represents the eras in a System.Globalization.PersianCalendar object. The array consists of a single element having a value of System.Globalization.PersianCalendar.PersianEra.

System.Globalization.PersianCalendar.MaxSupportedDateTime

Gets the latest date and time supported by the System.Globalization.PersianCalendar class.

Returns

The latest date and time supported by the System.Globalization.PersianCalendar class.

System.Globalization.PersianCalendar.MinSupportedDateTime

Gets the earliest date and time supported by the System.Globalization.PersianCalendar class.

Returns

The earliest date and time supported by the System.Globalization.PersianCalendar class.

System.Globalization.PersianCalendar.TwoDigitYearMax

Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.

Returns

The last year of a 100-year range that can be represented by a 2-digit year.

System.Globalization.RegionInfo

Contains information about the country/region.

System.Globalization.RegionInfo.#ctor()

Initializes a new instance of the System.Globalization.RegionInfo class based on the country/region associated with the specified culture identifier.

Parameters

NameDescriptionDefault
culture A culture identifier.

System.Globalization.RegionInfo.#ctor()

Initializes a new instance of the System.Globalization.RegionInfo class based on the country/region or specific culture, specified by name.

Parameters

NameDescriptionDefault
name A string that contains a two-letter code defined in ISO 3166 for country/region. -or- A string that contains the culture name for a specific culture, custom culture, or Windows-only culture. If the culture name is not in RFC 4646 format, your application should specify the entire culture name instead of just the country/region.

System.Globalization.RegionInfo.Equals()

Determines whether the specified object is the same instance as the current System.Globalization.RegionInfo.

Parameters

NameDescriptionDefault
value The object to compare with the current System.Globalization.RegionInfo.

Returns

true if the value parameter is a System.Globalization.RegionInfo object and its System.Globalization.RegionInfo.Name property is the same as the System.Globalization.RegionInfo.Name property of the current System.Globalization.RegionInfo object; otherwise, false.

System.Globalization.RegionInfo.GetHashCode

Serves as a hash function for the current System.Globalization.RegionInfo, suitable for hashing algorithms and data structures, such as a hash table.

Returns

A hash code for the current System.Globalization.RegionInfo.

System.Globalization.RegionInfo.ToString

Returns a string containing the culture name or ISO 3166 two-letter country/region codes specified for the current System.Globalization.RegionInfo.

Returns

A string containing the culture name or ISO 3166 two-letter country/region codes defined for the current System.Globalization.RegionInfo.

System.Globalization.RegionInfo.CurrencyEnglishName

Gets the name, in English, of the currency used in the country/region.

Returns

The name, in English, of the currency used in the country/region.

System.Globalization.RegionInfo.CurrencyNativeName

Gets the name of the currency used in the country/region, formatted in the native language of the country/region.

Returns

The native name of the currency used in the country/region, formatted in the language associated with the ISO 3166 country/region code.

System.Globalization.RegionInfo.CurrencySymbol

Gets the currency symbol associated with the country/region.

Returns

The currency symbol associated with the country/region.

System.Globalization.RegionInfo.CurrentRegion

Gets the System.Globalization.RegionInfo that represents the country/region used by the current thread.

Returns

The System.Globalization.RegionInfo that represents the country/region used by the current thread.

System.Globalization.RegionInfo.DisplayName

Gets the full name of the country/region in the language of the localized version of .NET.

Returns

The full name of the country/region in the language of the localized version of .NET.

System.Globalization.RegionInfo.EnglishName

Gets the full name of the country/region in English.

Returns

The full name of the country/region in English.

System.Globalization.RegionInfo.GeoId

Gets a unique identification number for a geographical region, country, city, or location.

Returns

A 32-bit signed number that uniquely identifies a geographical location.

System.Globalization.RegionInfo.IsMetric

Gets a value indicating whether the country/region uses the metric system for measurements.

Returns

true if the country/region uses the metric system for measurements; otherwise, false.

System.Globalization.RegionInfo.ISOCurrencySymbol

Gets the three-character ISO 4217 currency symbol associated with the country/region.

Returns

The three-character ISO 4217 currency symbol associated with the country/region.

System.Globalization.RegionInfo.Name

Gets the name or ISO 3166 two-letter country/region code for the current System.Globalization.RegionInfo object.

Returns

The value specified by the name parameter of the System.Globalization.RegionInfo.#ctor() constructor. The return value is in uppercase. -or- The two-letter code defined in ISO 3166 for the country/region specified by the culture parameter of the System.Globalization.RegionInfo.#ctor() constructor. The return value is in uppercase.

System.Globalization.RegionInfo.NativeName

Gets the name of a country/region formatted in the native language of the country/region.

Returns

The native name of the country/region formatted in the language associated with the ISO 3166 country/region code.

System.Globalization.RegionInfo.ThreeLetterISORegionName

Gets the three-letter code defined in ISO 3166 for the country/region.

Returns

The three-letter code defined in ISO 3166 for the country/region.

System.Globalization.RegionInfo.ThreeLetterWindowsRegionName

Gets the three-letter code assigned by Windows to the country/region represented by this System.Globalization.RegionInfo.

Returns

The three-letter code assigned by Windows to the country/region represented by this System.Globalization.RegionInfo.

System.Globalization.RegionInfo.TwoLetterISORegionName

Gets the two-letter code defined in ISO 3166 for the country/region.

Returns

The two-letter code defined in ISO 3166 for the country/region.

System.Globalization.SortKey

Represents the result of mapping a string to its sort key.

System.Globalization.SortKey.Compare()

Compares two sort keys.

Parameters

NameDescriptionDefault
sortkey1 The first sort key to compare.
sortkey2 The second sort key to compare.

Returns

A signed integer that indicates the relationship between sortkey1 and sortkey2. Value Condition Less than zerosortkey1 is less than sortkey2. Zerosortkey1 is equal to sortkey2. Greater than zerosortkey1 is greater than sortkey2.

System.Globalization.SortKey.Equals()

Determines whether the specified object is equal to the current System.Globalization.SortKey object.

Parameters

NameDescriptionDefault
value The object to compare with the current System.Globalization.SortKey object.

Returns

true if the value parameter is equal to the current System.Globalization.SortKey object; otherwise, false.

System.Globalization.SortKey.GetHashCode

Serves as a hash function for the current System.Globalization.SortKey object that is suitable for hashing algorithms and data structures such as a hash table.

Returns

A hash code for the current System.Globalization.SortKey object.

System.Globalization.SortKey.ToString

Returns a string that represents the current System.Globalization.SortKey object.

Returns

A string that represents the current System.Globalization.SortKey object.

System.Globalization.SortKey.KeyData

Gets the byte array representing the current System.Globalization.SortKey object.

Returns

A byte array representing the current System.Globalization.SortKey object.

System.Globalization.SortKey.OriginalString

Gets the original string used to create the current System.Globalization.SortKey object.

Returns

The original string used to create the current System.Globalization.SortKey object.

System.Globalization.SortVersion

Provides information about the version of Unicode used to compare and order strings.

System.Globalization.SortVersion.#ctor()

Creates a new instance of the System.Globalization.SortVersion class.

Parameters

NameDescriptionDefault
fullVersion A version number.
sortId A sort ID.

System.Globalization.SortVersion.Equals()

Returns a value that indicates whether this System.Globalization.SortVersion instance is equal to a specified System.Globalization.SortVersion object.

Parameters

NameDescriptionDefault
other The object to compare with this instance.

Returns

true if other represents the same version as this instance; otherwise, false.

System.Globalization.SortVersion.Equals()

Returns a value that indicates whether this System.Globalization.SortVersion instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance.

Returns

true if obj is a System.Globalization.SortVersion object that represents the same version as this instance; otherwise, false.

System.Globalization.SortVersion.GetHashCode

Returns a hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Globalization.SortVersion.op_Equality()

Indicates whether two System.Globalization.SortVersion instances are equal.

Parameters

NameDescriptionDefault
left The first instance to compare.
right The second instance to compare.

Returns

true if the values of left and right are equal; otherwise, false.

System.Globalization.SortVersion.op_Inequality()

Indicates whether two System.Globalization.SortVersion instances are not equal.

Parameters

NameDescriptionDefault
left The first instance to compare.
right The second instance to compare.

Returns

true if the values of left and right are not equal; otherwise, false.

System.Globalization.SortVersion.FullVersion

Gets the full version number of the System.Globalization.SortVersion object.

Returns

The version number of this System.Globalization.SortVersion object.

System.Globalization.SortVersion.SortId

Gets a globally unique identifier for this System.Globalization.SortVersion object.

Returns

A globally unique identifier for this System.Globalization.SortVersion object.

System.Globalization.StringInfo

Provides functionality to split a string into text elements and to iterate through those text elements.

System.Globalization.StringInfo.#ctor

Initializes a new instance of the System.Globalization.StringInfo class.

System.Globalization.StringInfo.#ctor()

Initializes a new instance of the System.Globalization.StringInfo class to a specified string.

Parameters

NameDescriptionDefault
value A string to initialize this System.Globalization.StringInfo object.

System.Globalization.StringInfo.Equals()

Indicates whether the current System.Globalization.StringInfo object is equal to a specified object.

Parameters

NameDescriptionDefault
value An object.

Returns

true if the value parameter is a System.Globalization.StringInfo object and its System.Globalization.StringInfo.String property equals the System.Globalization.StringInfo.String property of this System.Globalization.StringInfo object; otherwise, false.

System.Globalization.StringInfo.GetHashCode

Calculates a hash code for the value of the current System.Globalization.StringInfo object.

Returns

A 32-bit signed integer hash code based on the string value of this System.Globalization.StringInfo object.

System.Globalization.StringInfo.GetNextTextElement()

Gets the first text element in a specified string.

Parameters

NameDescriptionDefault
str The string from which to get the text element.

Returns

A string containing the first text element in the specified string.

System.Globalization.StringInfo.GetNextTextElement()

Gets the text element at the specified index of the specified string.

Parameters

NameDescriptionDefault
str The string from which to get the text element.
index The zero-based index at which the text element starts.

Returns

A string containing the text element at the specified index of the specified string.

System.Globalization.StringInfo.GetNextTextElementLength()

Returns the length of the first text element (extended grapheme cluster) that occurs in the input span.

Parameters

NameDescriptionDefault
str The input span to analyze.

Returns

The length (in chars) of the substring corresponding to the first text element within str, or 0 if str is empty.

System.Globalization.StringInfo.GetNextTextElementLength()

Returns the length of the first text element (extended grapheme cluster) that occurs in the input string.

Parameters

NameDescriptionDefault
str The input string to analyze.

Returns

The length (in chars) of the substring corresponding to the first text element within str, or 0 if str is empty.

System.Globalization.StringInfo.GetNextTextElementLength()

Returns the length of the first text element (extended grapheme cluster) that occurs in the input string starting at the specified index.

Parameters

NameDescriptionDefault
str The input string to analyze.
index The char offset in str at which to begin analysis.

Returns

The length (in chars) of the substring corresponding to the first text element within str starting at index index, or 0 if index corresponds to the end of str.

System.Globalization.StringInfo.GetTextElementEnumerator()

Returns an enumerator that iterates through the text elements of the entire string.

Parameters

NameDescriptionDefault
str The string to iterate through.

Returns

System.Globalization.StringInfo.GetTextElementEnumerator()

Returns an enumerator that iterates through the text elements of the string, starting at the specified index.

Parameters

NameDescriptionDefault
str The string to iterate through.
index The zero-based index at which to start iterating.

Returns

A System.Globalization.TextElementEnumerator for the string starting at index.

System.Globalization.StringInfo.ParseCombiningCharacters()

Returns the indexes of each base character, high surrogate, or control character within the specified string.

Parameters

NameDescriptionDefault
str The string to search.

Returns

An array of integers that contains the zero-based indexes of each base character, high surrogate, or control character within the specified string.

System.Globalization.StringInfo.SubstringByTextElements()

Retrieves a substring of text elements from the current System.Globalization.StringInfo object starting from a specified text element and continuing through the last text element.

Parameters

NameDescriptionDefault
startingTextElement The zero-based index of a text element in this System.Globalization.StringInfo object.

Returns

A substring of text elements in this System.Globalization.StringInfo object, starting from the text element index specified by the startingTextElement parameter and continuing through the last text element in this object.

System.Globalization.StringInfo.SubstringByTextElements()

Retrieves a substring of text elements from the current System.Globalization.StringInfo object starting from a specified text element and continuing through the specified number of text elements.

Parameters

NameDescriptionDefault
startingTextElement The zero-based index of a text element in this System.Globalization.StringInfo object.
lengthInTextElements The number of text elements to retrieve.

Returns

A substring of text elements in this System.Globalization.StringInfo object. The substring consists of the number of text elements specified by the lengthInTextElements parameter and starts from the text element index specified by the startingTextElement parameter.

System.Globalization.StringInfo.LengthInTextElements

Gets the number of text elements in the current System.Globalization.StringInfo object.

Returns

The number of base characters, surrogate pairs, and combining character sequences in this System.Globalization.StringInfo object.

System.Globalization.StringInfo.String

Gets or sets the value of the current System.Globalization.StringInfo object.

Returns

The string that is the value of the current System.Globalization.StringInfo object.

System.Globalization.TaiwanCalendar

the Taiwan calendar.

System.Globalization.TaiwanCalendar.#ctor

Initializes a new instance of the System.Globalization.TaiwanCalendar class.

System.Globalization.TaiwanCalendar.AddMonths()

Returns a System.DateTime that is the specified number of months away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add months.
months The number of months to add.

Returns

The System.DateTime that results from adding the specified number of months to the specified System.DateTime.

System.Globalization.TaiwanCalendar.AddYears()

Returns a System.DateTime that is the specified number of years away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add years.
years The number of years to add.

Returns

The System.DateTime that results from adding the specified number of years to the specified System.DateTime.

System.Globalization.TaiwanCalendar.GetDayOfMonth()

Returns the day of the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 31 that represents the day of the month in the specified System.DateTime.

System.Globalization.TaiwanCalendar.GetDayOfWeek()

Returns the day of the week in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

A System.DayOfWeek value that represents the day of the week in the specified System.DateTime.

System.Globalization.TaiwanCalendar.GetDayOfYear()

Returns the day of the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 366 that represents the day of the year in the specified System.DateTime.

System.Globalization.TaiwanCalendar.GetDaysInMonth()

Returns the number of days in the specified month in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
era An integer that represents the era.

Returns

The number of days in the specified month in the specified year in the specified era.

System.Globalization.TaiwanCalendar.GetDaysInYear()

Returns the number of days in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of days in the specified year in the specified era.

System.Globalization.TaiwanCalendar.GetEra()

Returns the era in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the era in the specified System.DateTime.

System.Globalization.TaiwanCalendar.GetLeapMonth()

Calculates the leap month for a specified year and era.

Parameters

NameDescriptionDefault
year A year.
era An era.

Returns

The return value is always 0 because the System.Globalization.TaiwanCalendar class does not support the notion of a leap month.

System.Globalization.TaiwanCalendar.GetMonth()

Returns the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 12 that represents the month in the specified System.DateTime.

System.Globalization.TaiwanCalendar.GetMonthsInYear()

Returns the number of months in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of months in the specified year in the specified era.

System.Globalization.TaiwanCalendar.GetWeekOfYear()

Returns the week of the year that includes the date in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.
rule One of the System.Globalization.CalendarWeekRule values that defines a calendar week.
firstDayOfWeek One of the System.DayOfWeek values that represents the first day of the week.

Returns

A positive integer that represents the week of the year that includes the date in the time parameter.

System.Globalization.TaiwanCalendar.GetYear()

Returns the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the year in the specified System.DateTime.

System.Globalization.TaiwanCalendar.IsLeapDay()

Determines whether the specified date in the specified era is a leap day.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
day An integer from 1 to 31 that represents the day.
era An integer that represents the era.

Returns

true if the specified day is a leap day; otherwise, false.

System.Globalization.TaiwanCalendar.IsLeapMonth()

Determines whether the specified month in the specified year in the specified era is a leap month.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
era An integer that represents the era.

Returns

This method always returns false, unless overridden by a derived class.

System.Globalization.TaiwanCalendar.IsLeapYear()

Determines whether the specified year in the specified era is a leap year.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

true if the specified year is a leap year; otherwise, false.

System.Globalization.TaiwanCalendar.ToDateTime()

Returns a System.DateTime that is set to the specified date and time in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
day An integer from 1 to 31 that represents the day.
hour An integer from 0 to 23 that represents the hour.
minute An integer from 0 to 59 that represents the minute.
second An integer from 0 to 59 that represents the second.
millisecond An integer from 0 to 999 that represents the millisecond.
era An integer that represents the era.

Returns

The System.DateTime that is set to the specified date and time in the current era.

System.Globalization.TaiwanCalendar.ToFourDigitYear()

Converts the specified year to a four-digit year by using the System.Globalization.TaiwanCalendar.TwoDigitYearMax property to determine the appropriate century.

Parameters

NameDescriptionDefault
year A two-digit or four-digit integer that represents the year to convert.

Returns

An integer that contains the four-digit representation of year.

System.Globalization.TaiwanCalendar.AlgorithmType

Gets a value that indicates whether the current calendar is solar-based, lunar-based, or a combination of both.

Returns

System.Globalization.TaiwanCalendar.Eras

Gets the list of eras in the System.Globalization.TaiwanCalendar.

Returns

An array that consists of a single element for which the value is always the current era.

System.Globalization.TaiwanCalendar.MaxSupportedDateTime

Gets the latest date and time supported by the System.Globalization.TaiwanCalendar class.

Returns

The latest date and time supported by the System.Globalization.TaiwanCalendar class, which is equivalent to the last moment of December 31, 9999 C.E. in the Gregorian calendar.

System.Globalization.TaiwanCalendar.MinSupportedDateTime

Gets the earliest date and time supported by the System.Globalization.TaiwanCalendar class.

Returns

The earliest date and time supported by the System.Globalization.TaiwanCalendar class, which is equivalent to the first moment of January 1, 1912 C.E. in the Gregorian calendar.

System.Globalization.TaiwanCalendar.TwoDigitYearMax

Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.

Returns

The last year of a 100-year range that can be represented by a 2-digit year.

System.Globalization.TaiwanLunisolarCalendar

Represents the Taiwan lunisolar calendar. As for the Taiwan calendar, years are calculated using the Gregorian calendar, while days and months are calculated using the lunisolar calendar.

System.Globalization.TaiwanLunisolarCalendar.#ctor

Initializes a new instance of the System.Globalization.TaiwanLunisolarCalendar class.

System.Globalization.TaiwanLunisolarCalendar.GetEra()

Retrieves the era that corresponds to the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the era specified in the time parameter.

System.Globalization.TaiwanLunisolarCalendar.DaysInYearBeforeMinSupportedYear

Gets the number of days in the year that precedes the year specified by the System.Globalization.TaiwanLunisolarCalendar.MinSupportedDateTime property.

Returns

The number of days in the year that precedes the year specified by System.Globalization.TaiwanLunisolarCalendar.MinSupportedDateTime.

System.Globalization.TaiwanLunisolarCalendar.Eras

Gets the eras that are relevant to the current System.Globalization.TaiwanLunisolarCalendar object.

Returns

An array that consists of a single element having a value that is always the current era.

System.Globalization.TaiwanLunisolarCalendar.MaxSupportedDateTime

Gets the maximum date and time supported by the System.Globalization.TaiwanLunisolarCalendar class.

Returns

The latest date and time supported by the System.Globalization.TaiwanLunisolarCalendar class, which is equivalent to the last moment of February 10, 2051 C.E. in the Gregorian calendar.

System.Globalization.TaiwanLunisolarCalendar.MinSupportedDateTime

Gets the minimum date and time supported by the System.Globalization.TaiwanLunisolarCalendar class.

Returns

The earliest date and time supported by the System.Globalization.TaiwanLunisolarCalendar class, which is equivalent to the first moment of February 18, 1912 C.E. in the Gregorian calendar.

System.Globalization.TextElementEnumerator

Enumerates the text elements of a string.

System.Globalization.TextElementEnumerator.GetTextElement

Gets the current text element in the string.

Returns

A new string containing the current text element in the string being read.

System.Globalization.TextElementEnumerator.MoveNext

Advances the enumerator to the next text element of the string.

Returns

true if the enumerator was successfully advanced to the next text element; false if the enumerator has passed the end of the string.

System.Globalization.TextElementEnumerator.Reset

Sets the enumerator to its initial position, which is before the first text element in the string.

System.Globalization.TextElementEnumerator.Current

Gets the current text element in the string.

Returns

An object containing the current text element in the string.

System.Globalization.TextElementEnumerator.ElementIndex

Gets the index of the text element that the enumerator is currently positioned over.

Returns

The index of the text element that the enumerator is currently positioned over.

System.Globalization.TextInfo

Defines text properties and behaviors, such as casing, that are specific to a writing system.

System.Globalization.TextInfo.Clone

Creates a new object that is a copy of the current System.Globalization.TextInfo object.

Returns

A new instance of System.Object that is the memberwise clone of the current System.Globalization.TextInfo object.

System.Globalization.TextInfo.Equals()

Determines whether the specified object represents the same writing system as the current System.Globalization.TextInfo object.

Parameters

NameDescriptionDefault
obj The object to compare with the current System.Globalization.TextInfo.

Returns

true if obj represents the same writing system as the current System.Globalization.TextInfo; otherwise, false.

System.Globalization.TextInfo.GetHashCode

Serves as a hash function for the current System.Globalization.TextInfo, suitable for hashing algorithms and data structures, such as a hash table.

Returns

A hash code for the current System.Globalization.TextInfo.

System.Globalization.TextInfo.ReadOnly()

Returns a read-only version of the specified System.Globalization.TextInfo object.

Parameters

NameDescriptionDefault
textInfo A System.Globalization.TextInfo object.

Returns

The System.Globalization.TextInfo object specified by the textInfo parameter, if textInfo is read-only. -or- A read-only memberwise clone of the System.Globalization.TextInfo object specified by textInfo, if textInfo is not read-only.

System.Globalization.TextInfo.System#Runtime#Serialization#IDeserializationCallback#OnDeserialization()

Raises the deserialization event when deserialization is complete.

Parameters

NameDescriptionDefault
sender The source of the deserialization event.

System.Globalization.TextInfo.ToLower()

Converts the specified character to lowercase.

Parameters

NameDescriptionDefault
c The character to convert to lowercase.

Returns

The specified character converted to lowercase.

System.Globalization.TextInfo.ToLower()

Converts the specified string to lowercase.

Parameters

NameDescriptionDefault
str The string to convert to lowercase.

Returns

The specified string converted to lowercase.

System.Globalization.TextInfo.ToString

Returns a string that represents the current System.Globalization.TextInfo.

Returns

A string that represents the current System.Globalization.TextInfo.

System.Globalization.TextInfo.ToTitleCase()

Converts the specified string to title case (except for words that are entirely in uppercase, which are considered to be acronyms).

Parameters

NameDescriptionDefault
str The string to convert to title case.

Returns

The specified string converted to title case.

System.Globalization.TextInfo.ToUpper()

Converts the specified character to uppercase.

Parameters

NameDescriptionDefault
c The character to convert to uppercase.

Returns

The specified character converted to uppercase.

System.Globalization.TextInfo.ToUpper()

Converts the specified string to uppercase.

Parameters

NameDescriptionDefault
str The string to convert to uppercase.

Returns

The specified string converted to uppercase.

System.Globalization.TextInfo.ANSICodePage

Gets the American National Standards Institute (ANSI) code page used by the writing system represented by the current System.Globalization.TextInfo.

Returns

The ANSI code page used by the writing system represented by the current System.Globalization.TextInfo.

System.Globalization.TextInfo.CultureName

Gets the name of the culture associated with the current System.Globalization.TextInfo object.

Returns

The name of a culture.

System.Globalization.TextInfo.EBCDICCodePage

Gets the Extended Binary Coded Decimal Interchange Code (EBCDIC) code page used by the writing system represented by the current System.Globalization.TextInfo.

Returns

The EBCDIC code page used by the writing system represented by the current System.Globalization.TextInfo.

System.Globalization.TextInfo.IsReadOnly

Gets a value indicating whether the current System.Globalization.TextInfo object is read-only.

Returns

true if the current System.Globalization.TextInfo object is read-only; otherwise, false.

System.Globalization.TextInfo.IsRightToLeft

Gets a value indicating whether the current System.Globalization.TextInfo object represents a writing system where text flows from right to left.

Returns

true if text flows from right to left; otherwise, false.

System.Globalization.TextInfo.LCID

Gets the culture identifier for the culture associated with the current System.Globalization.TextInfo object.

Returns

A number that identifies the culture from which the current System.Globalization.TextInfo object was created.

System.Globalization.TextInfo.ListSeparator

Gets or sets the string that separates items in a list.

Returns

The string that separates items in a list.

System.Globalization.TextInfo.MacCodePage

Gets the Macintosh code page used by the writing system represented by the current System.Globalization.TextInfo.

Returns

The Macintosh code page used by the writing system represented by the current System.Globalization.TextInfo.

System.Globalization.TextInfo.OEMCodePage

Gets the original equipment manufacturer (OEM) code page used by the writing system represented by the current System.Globalization.TextInfo.

Returns

The OEM code page used by the writing system represented by the current System.Globalization.TextInfo.

System.Globalization.ThaiBuddhistCalendar

Represents the Thai Buddhist calendar.

System.Globalization.ThaiBuddhistCalendar.ThaiBuddhistEra

Represents the current era. This field is constant.

System.Globalization.ThaiBuddhistCalendar.#ctor

Initializes a new instance of the System.Globalization.ThaiBuddhistCalendar class.

System.Globalization.ThaiBuddhistCalendar.AddMonths()

Returns a System.DateTime that is the specified number of months away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add months.
months The number of months to add.

Returns

The System.DateTime that results from adding the specified number of months to the specified System.DateTime.

System.Globalization.ThaiBuddhistCalendar.AddYears()

Returns a System.DateTime that is the specified number of years away from the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to which to add years.
years The number of years to add.

Returns

The System.DateTime that results from adding the specified number of years to the specified System.DateTime.

System.Globalization.ThaiBuddhistCalendar.GetDayOfMonth()

Returns the day of the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 31 that represents the day of the month in the specified System.DateTime.

System.Globalization.ThaiBuddhistCalendar.GetDayOfWeek()

Returns the day of the week in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

A System.DayOfWeek value that represents the day of the week in the specified System.DateTime.

System.Globalization.ThaiBuddhistCalendar.GetDayOfYear()

Returns the day of the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 366 that represents the day of the year in the specified System.DateTime.

System.Globalization.ThaiBuddhistCalendar.GetDaysInMonth()

Returns the number of days in the specified month in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
era An integer that represents the era.

Returns

The number of days in the specified month in the specified year in the specified era.

System.Globalization.ThaiBuddhistCalendar.GetDaysInYear()

Returns the number of days in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of days in the specified year in the specified era.

System.Globalization.ThaiBuddhistCalendar.GetEra()

Returns the era in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the era in the specified System.DateTime.

System.Globalization.ThaiBuddhistCalendar.GetLeapMonth()

Calculates the leap month for a specified year and era.

Parameters

NameDescriptionDefault
year A year.
era An era.

Returns

The return value is always 0 because the System.Globalization.ThaiBuddhistCalendar class does not support the notion of a leap month.

System.Globalization.ThaiBuddhistCalendar.GetMonth()

Returns the month in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer from 1 to 12 that represents the month in the specified System.DateTime.

System.Globalization.ThaiBuddhistCalendar.GetMonthsInYear()

Returns the number of months in the specified year in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

The number of months in the specified year in the specified era.

System.Globalization.ThaiBuddhistCalendar.GetWeekOfYear()

Returns the week of the year that includes the date in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.
rule One of the System.Globalization.CalendarWeekRule values that defines a calendar week.
firstDayOfWeek One of the System.DayOfWeek values that represents the first day of the week.

Returns

A 1-based positive integer that represents the week of the year that includes the date in the time parameter.

System.Globalization.ThaiBuddhistCalendar.GetYear()

Returns the year in the specified System.DateTime.

Parameters

NameDescriptionDefault
time The System.DateTime to read.

Returns

An integer that represents the year in the specified System.DateTime.

System.Globalization.ThaiBuddhistCalendar.IsLeapDay()

Determines whether the specified date in the specified era is a leap day.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
day An integer from 1 to 31 that represents the day.
era An integer that represents the era.

Returns

true if the specified day is a leap day; otherwise, false.

System.Globalization.ThaiBuddhistCalendar.IsLeapMonth()

Determines whether the specified month in the specified year in the specified era is a leap month.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
era An integer that represents the era.

Returns

This method always returns false, unless overridden by a derived class.

System.Globalization.ThaiBuddhistCalendar.IsLeapYear()

Determines whether the specified year in the specified era is a leap year.

Parameters

NameDescriptionDefault
year An integer that represents the year.
era An integer that represents the era.

Returns

true if the specified year is a leap year; otherwise, false.

System.Globalization.ThaiBuddhistCalendar.ToDateTime()

Returns a System.DateTime that is set to the specified date and time in the specified era.

Parameters

NameDescriptionDefault
year An integer that represents the year.
month An integer from 1 to 12 that represents the month.
day An integer from 1 to 31 that represents the day.
hour An integer from 0 to 23 that represents the hour.
minute An integer from 0 to 59 that represents the minute.
second An integer from 0 to 59 that represents the second.
millisecond An integer from 0 to 999 that represents the millisecond.
era An integer that represents the era.

Returns

The System.DateTime that is set to the specified date and time in the current era.

System.Globalization.ThaiBuddhistCalendar.ToFourDigitYear()

Converts the specified year to a four-digit year by using the System.Globalization.ThaiBuddhistCalendar.TwoDigitYearMax property to determine the appropriate century.

Parameters

NameDescriptionDefault
year A two-digit or four-digit integer that represents the year to convert.

Returns

An integer that contains the four-digit representation of year.

System.Globalization.ThaiBuddhistCalendar.AlgorithmType

Gets a value indicating whether the current calendar is solar-based, lunar-based, or a combination of both.

Returns

System.Globalization.ThaiBuddhistCalendar.Eras

Gets the list of eras in the System.Globalization.ThaiBuddhistCalendar class.

Returns

An array that consists of a single element having a value that is always the current era.

System.Globalization.ThaiBuddhistCalendar.MaxSupportedDateTime

Gets the latest date and time supported by the System.Globalization.ThaiBuddhistCalendar class.

Returns

The latest date and time supported by the System.Globalization.ThaiBuddhistCalendar class, which is equivalent to the last moment of December 31, 9999 C.E. in the Gregorian calendar.

System.Globalization.ThaiBuddhistCalendar.MinSupportedDateTime

Gets the earliest date and time supported by the System.Globalization.ThaiBuddhistCalendar class.

Returns

The earliest date and time supported by the System.Globalization.ThaiBuddhistCalendar class, which is equivalent to the first moment of January 1, 0001 C.E. in the Gregorian calendar.

System.Globalization.ThaiBuddhistCalendar.TwoDigitYearMax

Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.

Returns

The last year of a 100-year range that can be represented by a 2-digit year.

System.Globalization.TimeSpanStyles

Defines the formatting options that customize string parsing for the System.TimeSpan.ParseExact and System.TimeSpan.TryParseExact methods.

System.Globalization.TimeSpanStyles.AssumeNegative

Indicates that input is always interpreted as a negative time interval.

System.Globalization.TimeSpanStyles.None

Indicates that input is interpreted as a negative time interval only if a negative sign is present.

System.Globalization.UmAlQuraCalendar

Represents the Saudi Hijri (Um Al Qura) calendar.

System.Globalization.UmAlQuraCalendar.UmAlQuraEra

Represents the current era. This field is constant.

System.Globalization.UmAlQuraCalendar.#ctor

Initializes a new instance of the System.Globalization.UmAlQuraCalendar class.

System.Globalization.UmAlQuraCalendar.AddMonths()

Calculates a date that is a specified number of months away from a specified initial date.

Parameters

NameDescriptionDefault
time The date to which to add months. The System.Globalization.UmAlQuraCalendar class supports only dates from 04/30/1900 00.00.00 (Gregorian date) through 11/16/2077 23:59:59 (Gregorian date).
months The positive or negative number of months to add.

Returns

The date yielded by adding the number of months specified by the months parameter to the date specified by the time parameter.

System.Globalization.UmAlQuraCalendar.AddYears()

Calculates a date that is a specified number of years away from a specified initial date.

Parameters

NameDescriptionDefault
time The date to which to add years. The System.Globalization.UmAlQuraCalendar class supports only dates from 04/30/1900 00.00.00 (Gregorian date) through 11/16/2077 23:59:59 (Gregorian date).
years The positive or negative number of years to add.

Returns

The date yielded by adding the number of years specified by the years parameter to the date specified by the time parameter.

System.Globalization.UmAlQuraCalendar.GetDayOfMonth()

Calculates the day of the month on which a specified date occurs.

Parameters

NameDescriptionDefault
time The date value to read. The System.Globalization.UmAlQuraCalendar class supports only dates from 04/30/1900 00.00.00 (Gregorian date) through 11/16/2077 23:59:59 (Gregorian date).

Returns

An integer from 1 through 30 that represents the day of the month specified by the time parameter.

System.Globalization.UmAlQuraCalendar.GetDayOfWeek()

Calculates the day of the week on which a specified date occurs.

Parameters

NameDescriptionDefault
time The date value to read. The System.Globalization.UmAlQuraCalendar class supports only dates from 04/30/1900 00.00.00 (Gregorian date) through 11/16/2077 23:59:59 (Gregorian date).

Returns

A System.DayOfWeek value that represents the day of the week specified by the time parameter.

System.Globalization.UmAlQuraCalendar.GetDayOfYear()

Calculates the day of the year on which a specified date occurs.

Parameters

NameDescriptionDefault
time The date value to read. The System.Globalization.UmAlQuraCalendar class supports only dates from 04/30/1900 00.00.00 (Gregorian date) through 11/16/2077 23:59:59 (Gregorian date).

Returns

An integer from 1 through 355 that represents the day of the year specified by the time parameter.

System.Globalization.UmAlQuraCalendar.GetDaysInMonth()

Calculates the number of days in the specified month of the specified year and era.

Parameters

NameDescriptionDefault
year A year.
month An integer from 1 through 12 that represents a month.
era An era. Specify UmAlQuraCalendar.Eras[UmAlQuraCalendar.CurrentEra] or System.Globalization.UmAlQuraCalendar.UmAlQuraEra.

Returns

The number of days in the specified month in the specified year and era. The return value is 29 in a common year and 30 in a leap year.

System.Globalization.UmAlQuraCalendar.GetDaysInYear()

Calculates the number of days in the specified year of the specified era.

Parameters

NameDescriptionDefault
year A year.
era An era. Specify UmAlQuraCalendar.Eras[UmAlQuraCalendar.CurrentEra] or System.Globalization.UmAlQuraCalendar.UmAlQuraEra.

Returns

The number of days in the specified year and era. The number of days is 354 in a common year or 355 in a leap year.

System.Globalization.UmAlQuraCalendar.GetEra()

Calculates the era in which a specified date occurs.

Parameters

NameDescriptionDefault
time The date value to read.

Returns

System.Globalization.UmAlQuraCalendar.GetLeapMonth()

Calculates the leap month for a specified year and era.

Parameters

NameDescriptionDefault
year A year.
era An era. Specify UmAlQuraCalendar.Eras[UmAlQuraCalendar.CurrentEra] or System.Globalization.UmAlQuraCalendar.UmAlQuraEra.

Returns

Always 0 because the System.Globalization.UmAlQuraCalendar class does not support leap months.

System.Globalization.UmAlQuraCalendar.GetMonth()

Calculates the month in which a specified date occurs.

Parameters

NameDescriptionDefault
time The date value to read. The System.Globalization.UmAlQuraCalendar class supports only dates from 04/30/1900 00.00.00 (Gregorian date) through 11/16/2077 23:59:59 (Gregorian date).

Returns

An integer from 1 through 12 that represents the month in the date specified by the time parameter.

System.Globalization.UmAlQuraCalendar.GetMonthsInYear()

Calculates the number of months in the specified year of the specified era.

Parameters

NameDescriptionDefault
year A year.
era An era. Specify UmAlQuaraCalendar.Eras[UmAlQuraCalendar.CurrentEra] or System.Globalization.UmAlQuraCalendar.UmAlQuraEra.

Returns

Always 12.

System.Globalization.UmAlQuraCalendar.GetYear()

Calculates the year of a date represented by a specified System.DateTime.

Parameters

NameDescriptionDefault
time The date value to read. The System.Globalization.UmAlQuraCalendar class supports only dates from 04/30/1900 00.00.00 (Gregorian date) through 11/16/2077 23:59:59 (Gregorian date).

Returns

An integer that represents the year specified by the time parameter.

System.Globalization.UmAlQuraCalendar.IsLeapDay()

Determines whether the specified date is a leap day.

Parameters

NameDescriptionDefault
year A year.
month An integer from 1 through 12 that represents a month.
day An integer from 1 through 30 that represents a day.
era An era. Specify UmAlQuraCalendar.Eras[UmAlQuraCalendar.CurrentEra] or System.Globalization.UmAlQuraCalendar.UmAlQuraEra.

Returns

true if the specified day is a leap day; otherwise, false. The return value is always false because the System.Globalization.UmAlQuraCalendar class does not support leap days.

System.Globalization.UmAlQuraCalendar.IsLeapMonth()

Determines whether the specified month in the specified year and era is a leap month.

Parameters

NameDescriptionDefault
year A year.
month An integer from 1 through 12 that represents a month.
era An era. Specify UmAlQuraCalendar.Eras[UmAlQuraCalendar.CurrentEra] or System.Globalization.UmAlQuraCalendar.UmAlQuraEra.

Returns

Always false because the System.Globalization.UmAlQuraCalendar class does not support leap months.

System.Globalization.UmAlQuraCalendar.IsLeapYear()

Determines whether the specified year in the specified era is a leap year.

Parameters

NameDescriptionDefault
year A year.
era An era. Specify UmAlQuraCalendar.Eras[UmAlQuraCalendar.CurrentEra] or System.Globalization.UmAlQuraCalendar.UmAlQuraEra.

Returns

true if the specified year is a leap year; otherwise, false.

System.Globalization.UmAlQuraCalendar.ToDateTime()

Returns a System.DateTime that is set to the specified date, time, and era.

Parameters

NameDescriptionDefault
year A year.
month An integer from 1 through 12 that represents a month.
day An integer from 1 through 29 that represents a day.
hour An integer from 0 through 23 that represents an hour.
minute An integer from 0 through 59 that represents a minute.
second An integer from 0 through 59 that represents a second.
millisecond An integer from 0 through 999 that represents a millisecond.
era An era. Specify UmAlQuraCalendar.Eras[UmAlQuraCalendar.CurrentEra] or System.Globalization.UmAlQuraCalendar.UmAlQuraEra.

Returns

The System.DateTime that is set to the specified date and time in the current era.

System.Globalization.UmAlQuraCalendar.ToFourDigitYear()

Converts the specified year to a four-digit year by using the System.Globalization.UmAlQuraCalendar.TwoDigitYearMax property to determine the appropriate century.

Parameters

NameDescriptionDefault
year A 2-digit year from 0 through 99, or a 4-digit Um Al Qura calendar year from 1318 through 1450.

Returns

If the year parameter is a 2-digit year, the return value is the corresponding 4-digit year. If the year parameter is a 4-digit year, the return value is the unchanged year parameter.

System.Globalization.UmAlQuraCalendar.AlgorithmType

Gets a value indicating whether the current calendar is solar-based, lunar-based, or a combination of both.

Returns

System.Globalization.UmAlQuraCalendar.DaysInYearBeforeMinSupportedYear

Gets the number of days in the year that precedes the year that is specified by the System.Globalization.UmAlQuraCalendar.MinSupportedDateTime property.

Returns

The number of days in the year that precedes the year specified by System.Globalization.UmAlQuraCalendar.MinSupportedDateTime.

System.Globalization.UmAlQuraCalendar.Eras

Gets a list of the eras that are supported by the current System.Globalization.UmAlQuraCalendar.

Returns

An array that consists of a single element having a value that is System.Globalization.UmAlQuraCalendar.UmAlQuraEra.

System.Globalization.UmAlQuraCalendar.MaxSupportedDateTime

Gets the latest date and time supported by this calendar.

Returns

The latest date and time supported by the System.Globalization.UmAlQuraCalendar class, which is equivalent to the last moment of November 16, 2077 C.E. in the Gregorian calendar.

System.Globalization.UmAlQuraCalendar.MinSupportedDateTime

Gets the earliest date and time supported by this calendar.

Returns

The earliest date and time supported by the System.Globalization.UmAlQuraCalendar class, which is equivalent to the first moment of April 30, 1900 C.E. in the Gregorian calendar.

System.Globalization.UmAlQuraCalendar.TwoDigitYearMax

Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.

Returns

The last year of a 100-year range that can be represented by a 2-digit year.

System.Globalization.UnicodeCategory

Defines the Unicode category of a character.

System.Globalization.UnicodeCategory.ClosePunctuation

Closing character of one of the paired punctuation marks, such as parentheses, square brackets, and braces. Signified by the Unicode designation "Pe" (punctuation, close). The value is 21.

System.Globalization.UnicodeCategory.ConnectorPunctuation

Connector punctuation character that connects two characters. Signified by the Unicode designation "Pc" (punctuation, connector). The value is 18.

System.Globalization.UnicodeCategory.Control

Control code character, with a Unicode value of U+007F or in the range U+0000 through U+001F or U+0080 through U+009F. Signified by the Unicode designation "Cc" (other, control). The value is 14.

System.Globalization.UnicodeCategory.CurrencySymbol

Currency symbol character. Signified by the Unicode designation "Sc" (symbol, currency). The value is 26.

System.Globalization.UnicodeCategory.DashPunctuation

Dash or hyphen character. Signified by the Unicode designation "Pd" (punctuation, dash). The value is 19.

System.Globalization.UnicodeCategory.DecimalDigitNumber

Decimal digit character, that is, a character representing an integer in the range 0 through 9. Signified by the Unicode designation "Nd" (number, decimal digit). The value is 8.

System.Globalization.UnicodeCategory.EnclosingMark

Enclosing mark character, which is a nonspacing combining character that surrounds all previous characters up to and including a base character. Signified by the Unicode designation "Me" (mark, enclosing). The value is 7.

System.Globalization.UnicodeCategory.FinalQuotePunctuation

Closing or final quotation mark character. Signified by the Unicode designation "Pf" (punctuation, final quote). The value is 23.

System.Globalization.UnicodeCategory.Format

Format character that affects the layout of text or the operation of text processes, but is not normally rendered. Signified by the Unicode designation "Cf" (other, format). The value is 15.

System.Globalization.UnicodeCategory.InitialQuotePunctuation

Opening or initial quotation mark character. Signified by the Unicode designation "Pi" (punctuation, initial quote). The value is 22.

System.Globalization.UnicodeCategory.LetterNumber

Number represented by a letter, instead of a decimal digit, for example, the Roman numeral for five, which is "V". The indicator is signified by the Unicode designation "Nl" (number, letter). The value is 9.

System.Globalization.UnicodeCategory.LineSeparator

Character that is used to separate lines of text. Signified by the Unicode designation "Zl" (separator, line). The value is 12.

System.Globalization.UnicodeCategory.LowercaseLetter

Lowercase letter. Signified by the Unicode designation "Ll" (letter, lowercase). The value is 1.

System.Globalization.UnicodeCategory.MathSymbol

Mathematical symbol character, such as "+" or "= ". Signified by the Unicode designation "Sm" (symbol, math). The value is 25.

System.Globalization.UnicodeCategory.ModifierLetter

Modifier letter character, which is free-standing spacing character that indicates modifications of a preceding letter. Signified by the Unicode designation "Lm" (letter, modifier). The value is 3.

System.Globalization.UnicodeCategory.ModifierSymbol

Modifier symbol character, which indicates modifications of surrounding characters. For example, the fraction slash indicates that the number to the left is the numerator and the number to the right is the denominator. The indicator is signified by the Unicode designation "Sk" (symbol, modifier). The value is 27.

System.Globalization.UnicodeCategory.NonSpacingMark

Nonspacing character that indicates modifications of a base character. Signified by the Unicode designation "Mn" (mark, nonspacing). The value is 5.

System.Globalization.UnicodeCategory.OpenPunctuation

Opening character of one of the paired punctuation marks, such as parentheses, square brackets, and braces. Signified by the Unicode designation "Ps" (punctuation, open). The value is 20.

System.Globalization.UnicodeCategory.OtherLetter

Letter that is not an uppercase letter, a lowercase letter, a titlecase letter, or a modifier letter. Signified by the Unicode designation "Lo" (letter, other). The value is 4.

System.Globalization.UnicodeCategory.OtherNotAssigned

Character that is not assigned to any Unicode category. Signified by the Unicode designation "Cn" (other, not assigned). The value is 29.

System.Globalization.UnicodeCategory.OtherNumber

Number that is neither a decimal digit nor a letter number, for example, the fraction 1/2. The indicator is signified by the Unicode designation "No" (number, other). The value is 10.

System.Globalization.UnicodeCategory.OtherPunctuation

Punctuation character that is not a connector, a dash, open punctuation, close punctuation, an initial quote, or a final quote. Signified by the Unicode designation "Po" (punctuation, other). The value is 24.

System.Globalization.UnicodeCategory.OtherSymbol

Symbol character that is not a mathematical symbol, a currency symbol or a modifier symbol. Signified by the Unicode designation "So" (symbol, other). The value is 28.

System.Globalization.UnicodeCategory.ParagraphSeparator

Character used to separate paragraphs. Signified by the Unicode designation "Zp" (separator, paragraph). The value is 13.

System.Globalization.UnicodeCategory.PrivateUse

Private-use character, with a Unicode value in the range U+E000 through U+F8FF. Signified by the Unicode designation "Co" (other, private use). The value is 17.

System.Globalization.UnicodeCategory.SpaceSeparator

Space character, which has no glyph but is not a control or format character. Signified by the Unicode designation "Zs" (separator, space). The value is 11.

System.Globalization.UnicodeCategory.SpacingCombiningMark

Spacing character that indicates modifications of a base character and affects the width of the glyph for that base character. Signified by the Unicode designation "Mc" (mark, spacing combining). The value is 6.

System.Globalization.UnicodeCategory.Surrogate

High surrogate or a low surrogate character. Surrogate code values are in the range U+D800 through U+DFFF. Signified by the Unicode designation "Cs" (other, surrogate). The value is 16.

System.Globalization.UnicodeCategory.TitlecaseLetter

Titlecase letter. Signified by the Unicode designation "Lt" (letter, titlecase). The value is 2.

System.Globalization.UnicodeCategory.UppercaseLetter

Uppercase letter. Signified by the Unicode designation "Lu" (letter, uppercase). The value is 0.

System.GopherStyleUriParser

A customizable parser based on the Gopher scheme.

System.GopherStyleUriParser.#ctor

Creates a customizable parser based on the Gopher scheme.

System.Guid

Represents a globally unique identifier (GUID).

System.Guid.Empty

A read-only instance of the System.Guid structure whose value is all zeros.

System.Guid.#ctor()

Initializes a new instance of the System.Guid structure by using the specified array of bytes.

Parameters

NameDescriptionDefault
b A 16-element byte array containing values with which to initialize the GUID.

System.Guid.#ctor()

Initializes a new instance of the System.Guid structure by using the specified integers and bytes.

Parameters

NameDescriptionDefault
a The first 4 bytes of the GUID.
b The next 2 bytes of the GUID.
c The next 2 bytes of the GUID.
d The next byte of the GUID.
e The next byte of the GUID.
f The next byte of the GUID.
g The next byte of the GUID.
h The next byte of the GUID.
i The next byte of the GUID.
j The next byte of the GUID.
k The next byte of the GUID.

System.Guid.#ctor()

Initializes a new instance of the System.Guid structure by using the specified integers and byte array.

Parameters

NameDescriptionDefault
a The first 4 bytes of the GUID.
b The next 2 bytes of the GUID.
c The next 2 bytes of the GUID.
d The remaining 8 bytes of the GUID.

System.Guid.#ctor()

Initializes a new instance of the System.Guid structure by using the value represented by the specified read-only span of bytes.

Parameters

NameDescriptionDefault
b A read-only span containing the bytes representing the GUID. The span must be exactly 16 bytes long.

System.Guid.#ctor()

Parameters

NameDescriptionDefault
b
bigEndian

System.Guid.#ctor()

Initializes a new instance of the System.Guid structure by using the value represented by the specified string.

Parameters

NameDescriptionDefault
g A string that contains a GUID in one of the following formats ("d" represents a hexadecimal digit whose case is ignored): 32 contiguous hexadecimal digits: dddddddddddddddddddddddddddddddd -or- Groups of 8, 4, 4, 4, and 12 hexadecimal digits with hyphens between the groups. The entire GUID can optionally be enclosed in matching braces or parentheses: dddddddd-dddd-dddd-dddd-dddddddddddd -or- {dddddddd-dddd-dddd-dddd-dddddddddddd} -or- (dddddddd-dddd-dddd-dddd-dddddddddddd) -or- Groups of 8, 4, and 4 hexadecimal digits, and a subset of eight groups of 2 hexadecimal digits, with each group prefixed by "0x" or "0X", and separated by commas. The entire GUID, as well as the subset, is enclosed in matching braces: {0xdddddddd, 0xdddd, 0xdddd,{0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd}} All braces, commas, and "0x" prefixes are required. All embedded spaces are ignored. All leading zeros in a group are ignored. The hexadecimal digits shown in a group are the maximum number of meaningful hexadecimal digits that can appear in that group. You can specify from 1 to the number of hexadecimal digits shown for a group. The specified digits are assumed to be the low-order digits of the group.

System.Guid.#ctor()

Initializes a new instance of the System.Guid structure by using the specified unsigned integers and bytes.

Parameters

NameDescriptionDefault
a The first 4 bytes of the GUID.
b The next 2 bytes of the GUID.
c The next 2 bytes of the GUID.
d The next byte of the GUID.
e The next byte of the GUID.
f The next byte of the GUID.
g The next byte of the GUID.
h The next byte of the GUID.
i The next byte of the GUID.
j The next byte of the GUID.
k The next byte of the GUID.

System.Guid.CompareTo()

Compares this instance to a specified System.Guid object and returns an indication of their relative values.

Parameters

NameDescriptionDefault
value An object to compare to this instance.

Returns

A signed number indicating the relative values of this instance and value. Return value Description A negative integer This instance is less than value. Zero This instance is equal to value. A positive integer This instance is greater than value.

System.Guid.CompareTo()

Compares this instance to a specified object and returns an indication of their relative values.

Parameters

NameDescriptionDefault
value An object to compare, or null.

Returns

A signed number indicating the relative values of this instance and value. Return value Description A negative integer This instance is less than value. Zero This instance is equal to value. A positive integer This instance is greater than value, or value is null.

System.Guid.Equals()

Returns a value indicating whether this instance and a specified System.Guid object represent the same value.

Parameters

NameDescriptionDefault
g An object to compare to this instance.

Returns

true if g is equal to this instance; otherwise, false.

System.Guid.Equals()

Returns a value that indicates whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
o The object to compare with this instance.

Returns

true if o is a System.Guid that has the same value as this instance; otherwise, false.

System.Guid.GetHashCode

Returns the hash code for this instance.

Returns

The hash code for this instance.

System.Guid.NewGuid

Initializes a new instance of the System.Guid structure.

Returns

A new GUID object.

System.Guid.op_Equality()

Indicates whether the values of two specified System.Guid objects are equal.

Parameters

NameDescriptionDefault
a The first object to compare.
b The second object to compare.

Returns

true if a and b are equal; otherwise, false.

System.Guid.op_GreaterThan()

Compares two values to determine which is greater.

Parameters

NameDescriptionDefault
left The value to compare with
right
.
right The value to compare with
left
.

Returns

true
if
left
is greater than
right
; otherwise,
false
.

System.Guid.op_GreaterThanOrEqual()

Compares two values to determine which is greater or equal.

Parameters

NameDescriptionDefault
left The value to compare with
right
.
right The value to compare with
left
.

Returns

true
if
left
is greater than or equal to
right
; otherwise,
false
.

System.Guid.op_Inequality()

Indicates whether the values of two specified System.Guid objects are not equal.

Parameters

NameDescriptionDefault
a The first object to compare.
b The second object to compare.

Returns

true if a and b are not equal; otherwise, false.

System.Guid.op_LessThan()

Compares two values to determine which is less.

Parameters

NameDescriptionDefault
left The value to compare with
right
.
right The value to compare with
left
.

Returns

true
if
left
is less than
right
; otherwise,
false
.

System.Guid.op_LessThanOrEqual()

Compares two values to determine which is less or equal.

Parameters

NameDescriptionDefault
left The value to compare with
right
.
right The value to compare with
left
.

Returns

true
if
left
is less than or equal to
right
; otherwise,
false
.

System.Guid.Parse()

Converts a read-only character span that represents a GUID to the equivalent System.Guid structure.

Parameters

NameDescriptionDefault
input A read-only span containing the bytes representing a GUID.

Returns

A structure that contains the value that was parsed.

System.Guid.Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.

Returns

The result of parsing
s
.

System.Guid.Parse()

Converts the string representation of a GUID to the equivalent System.Guid structure.

Parameters

NameDescriptionDefault
input The string to convert.

Returns

A structure that contains the value that was parsed.

System.Guid.Parse()

Parses a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about
s
.

Returns

The result of parsing
s
.

System.Guid.ParseExact()

Converts the character span representation of a GUID to the equivalent System.Guid structure, provided that the string is in the specified format.

Parameters

NameDescriptionDefault
input A read-only span containing the characters representing the GUID to convert.
format A read-only span of characters representing one of the following specifiers that indicates the exact format to use when interpreting input: "N", "D", "B", "P", or "X".

Returns

A structure that contains the value that was parsed.

System.Guid.ParseExact()

Converts the string representation of a GUID to the equivalent System.Guid structure, provided that the string is in the specified format.

Parameters

NameDescriptionDefault
input The GUID to convert.
format One of the following specifiers that indicates the exact format to use when interpreting input: "N", "D", "B", "P", or "X".

Returns

A structure that contains the value that was parsed.

System.Guid.System#ISpanFormattable#TryFormat()

Tries to format the value of the current instance into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span in which to write this instance's value formatted as a span of characters.
charsWritten When this method returns, contains the number of characters that were written in destination.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for destination.
provider An optional object that supplies culture-specific formatting information for destination.

Returns

true if the formatting was successful; otherwise, false.

System.Guid.System#IUtf8SpanFormattable#TryFormat()

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

Parameters

NameDescriptionDefault
utf8Destination The span in which to write this instance's value formatted as a span of bytes.
bytesWritten When this method returns, contains the number of bytes that were written in utf8Destination.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for utf8Destination.
provider An optional object that supplies culture-specific formatting information for utf8Destination.

Returns

true if the formatting was successful; otherwise, false.

System.Guid.ToByteArray

Returns a 16-element byte array that contains the value of this instance.

Returns

A 16-element byte array.

System.Guid.ToByteArray()

Parameters

NameDescriptionDefault
bigEndian

System.Guid.ToString

Returns a string representation of the value of this instance in registry format.

Returns

The value of this System.Guid, formatted by using the "D" format specifier as follows: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx where the value of the GUID is represented as a series of lowercase hexadecimal digits in groups of 8, 4, 4, 4, and 12 digits and separated by hyphens. An example of a return value is "382c74c3-721d-4f34-80e5-57657b6cbc27". To convert the hexadecimal digits from a through f to uppercase, call the System.String.ToUpper method on the returned string.

System.Guid.ToString()

Returns a string representation of the value of this System.Guid instance, according to the provided format specifier.

Parameters

NameDescriptionDefault
format A single format specifier that indicates how to format the value of this System.Guid. The format parameter can be "N", "D", "B", "P", or "X". If format is null or an empty string (""), "D" is used.

Returns

The value of this System.Guid, represented as a series of lowercase hexadecimal digits in the specified format.

System.Guid.ToString()

Returns a string representation of the value of this instance of the System.Guid class, according to the provided format specifier and culture-specific format information.

Parameters

NameDescriptionDefault
format A single format specifier that indicates how to format the value of this System.Guid. The format parameter can be "N", "D", "B", "P", or "X". If format is null or an empty string (""), "D" is used.
provider (Reserved) An object that supplies culture-specific formatting information.

Returns

The value of this System.Guid, represented as a series of lowercase hexadecimal digits in the specified format.

System.Guid.TryFormat()

Parameters

NameDescriptionDefault
utf8Destination
bytesWritten
format

System.Guid.TryFormat()

Tries to format the current GUID instance into the provided character span.

Parameters

NameDescriptionDefault
destination The span in which to write the GUID as a span of characters.
charsWritten When this method returns, contains the number of characters written into the span.
format A read-only span containing the character representing one of the following specifiers that indicates the exact format to use when interpreting input: "N", "D", "B", "P", or "X".

Returns

true if the formatting operation was successful; false otherwise.

System.Guid.TryParse()

Converts the specified read-only span of characters containing the representation of a GUID to the equivalent System.Guid structure.

Parameters

NameDescriptionDefault
input A span containing the characters representing the GUID to convert.
result When this method returns, contains the parsed value. If the method returns true, result contains a valid System.Guid. If the method returns false, result equals System.Guid.Empty.

Returns

true if the parse operation was successful; otherwise, false.

System.Guid.TryParse()

Tries to parse a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
, or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Guid.TryParse()

Converts the string representation of a GUID to the equivalent System.Guid structure.

Parameters

NameDescriptionDefault
input A string containing the GUID to convert.
result When this method returns, contains the parsed value. If the method returns true, result contains a valid System.Guid. If the method returns false, result equals System.Guid.Empty.

Returns

true if the parse operation was successful; otherwise, false.

System.Guid.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Guid.TryParseExact()

Converts span of characters representing the GUID to the equivalent System.Guid structure, provided that the string is in the specified format.

Parameters

NameDescriptionDefault
input A read-only span containing the characters representing the GUID to convert.
format A read-only span containing a character representing one of the following specifiers that indicates the exact format to use when interpreting input: "N", "D", "B", "P", or "X".
result When this method returns, contains the parsed value. If the method returns true, result contains a valid System.Guid. If the method returns false, result equals System.Guid.Empty.

Returns

true if the parse operation was successful; otherwise, false.

System.Guid.TryParseExact()

Converts the string representation of a GUID to the equivalent System.Guid structure, provided that the string is in the specified format.

Parameters

NameDescriptionDefault
input The GUID to convert.
format One of the following specifiers that indicates the exact format to use when interpreting input: "N", "D", "B", "P", or "X".
result When this method returns, contains the parsed value. If the method returns true, result contains a valid System.Guid. If the method returns false, result equals System.Guid.Empty.

Returns

true if the parse operation was successful; otherwise, false.

System.Guid.TryWriteBytes()

Tries to write the current GUID instance into a span of bytes.

Parameters

NameDescriptionDefault
destination When this method returns, the GUID as a span of bytes.

Returns

true if the GUID is successfully written to the specified span; false otherwise.

System.Guid.TryWriteBytes()

Parameters

NameDescriptionDefault
destination
bigEndian
bytesWritten

System.Half

Represents a half-precision floating-point number.

System.Half.Abs()

Computes the absolute of a value.

Parameters

NameDescriptionDefault
value The value for which to get its absolute.

Returns

The absolute of
value
.

System.Half.Acos()

Computes the arc-cosine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose arc-cosine is to be computed.

Returns

The arc-cosine of
x
.

System.Half.Acosh()

Computes the hyperbolic arc-cosine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic arc-cosine is to be computed.

Returns

The hyperbolic arc-cosine of
x
.

System.Half.AcosPi()

Computes the arc-cosine of a value and divides the result by
pi
.

Parameters

NameDescriptionDefault
x The value whose arc-cosine is to be computed.

Returns

The arc-cosine of
x
, divided by
pi
.

System.Half.Asin()

Computes the arc-sine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose arc-sine is to be computed.

Returns

The arc-sine of
x
.

System.Half.Asinh()

Computes the hyperbolic arc-sine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic arc-sine is to be computed.

Returns

The hyperbolic arc-sine of
x
.

System.Half.AsinPi()

Computes the arc-sine of a value and divides the result by
pi
.

Parameters

NameDescriptionDefault
x The value whose arc-sine is to be computed.

Returns

The arc-sine of
x
, divided by
pi
.

System.Half.Atan()

Computes the arc-tangent of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose arc-tangent is to be computed.

Returns

The arc-tangent of
x
.

System.Half.Atan2()

Computes the arc-tangent of the quotient of two values.

Parameters

NameDescriptionDefault
y The y-coordinate of a point.
x The x-coordinate of a point.

Returns

The arc-tangent of
y
divided-by
x
.

System.Half.Atan2Pi()

Computes the arc-tangent for the quotient of two values and divides the result by
pi
.

Parameters

NameDescriptionDefault
y The y-coordinate of a point.
x The x-coordinate of a point.

Returns

The arc-tangent of
y
divided-by
x
, divided by
pi
.

System.Half.Atanh()

Computes the hyperbolic arc-tangent of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic arc-tangent is to be computed.

Returns

The hyperbolic arc-tangent of
x
.

System.Half.AtanPi()

Computes the arc-tangent of a value and divides the result by pi.

Parameters

NameDescriptionDefault
x The value whose arc-tangent is to be computed.

Returns

The arc-tangent of
x
, divided by
pi
.

System.Half.BitDecrement()

Decrements a value to the smallest value that compares less than a given value.

Parameters

NameDescriptionDefault
x The value to be bitwise decremented.

Returns

The smallest value that compares less than
x
.

System.Half.BitIncrement()

Increments a value to the smallest value that compares greater than a given value.

Parameters

NameDescriptionDefault
x The value to be bitwise incremented.

Returns

The smallest value that compares greater than
x
.

System.Half.Cbrt()

Computes the cube-root of a value.

Parameters

NameDescriptionDefault
x The value whose cube-root is to be computed.

Returns

The cube-root of
x
.

System.Half.Ceiling()

Computes the ceiling of a value.

Parameters

NameDescriptionDefault
x The value whose ceiling is to be computed.

Returns

The ceiling of
x
.

System.Half.Clamp()

Clamps a value to an inclusive minimum and maximum value.

Parameters

NameDescriptionDefault
value The value to clamp.
min The inclusive minimum to which
value
should clamp.
max The inclusive maximum to which
value
should clamp.

Returns

The result of clamping
value
to the inclusive range of
min
and
max
.

System.Half.CompareTo()

Compares this instance to a specified half-precision floating-point number and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified half-precision floating-point number.

Parameters

NameDescriptionDefault
other A half-precision floating-point number to compare.

Returns

A value less than zero if this is less than other, zero if this is equal to other, or a value greater than zero if this is greater than other.

System.Half.CompareTo()

Compares this instance to a specified object and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified object.

Parameters

NameDescriptionDefault
obj An object to compare, or null.

Returns

A value less than zero if this instance is less than obj, or this instance is not a number (NaN) and obj is a number. -or- Zero if this instance is equal to obj, or this instance and obj are both not a number (NaN), System.Half.PositiveInfinity, or System.Half.NegativeInfinity. -or- A value greater than zero if this instance is greater than obj, or this instance is a number and obj is not a number (NaN), or obj is null.

System.Half.CopySign()

Copies the sign of a value to the sign of another value.

Parameters

NameDescriptionDefault
value The value whose magnitude is used in the result.
sign The value whose sign is used in the result.

Returns

A value with the magnitude of
value
and the sign of
sign
.

System.Half.Cos()

Computes the cosine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose cosine is to be computed.

Returns

The cosine of
x
.

System.Half.Cosh()

Computes the hyperbolic cosine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic cosine is to be computed.

Returns

The hyperbolic cosine of
x
.

System.Half.CosPi()

Computes the cosine of a value that has been multipled by
pi
.

Parameters

NameDescriptionDefault
x The value, in half-revolutions, whose cosine is to be computed.

Returns

The cosine of
x
multiplied-by
pi
.

System.Half.CreateChecked``1()

Creates an instance of the current type from a value, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
.

System.Half.CreateSaturating``1()

Creates an instance of the current type from a value, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value which is used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, saturating if
value
falls outside the representable range of
TSelf
.

System.Half.CreateTruncating``1()

Creates an instance of the current type from a value, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value which is used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, truncating if
value
falls outside the representable range of
TSelf
.

System.Half.DegreesToRadians()

Converts a given value from degrees to radians.

Parameters

NameDescriptionDefault
degrees The value to convert to radians.

Returns

The value of
degrees
converted to radians.

System.Half.Equals()

Compares this instance for equality with other.

Parameters

NameDescriptionDefault
other A half-precision floating point number to compare to this instance.

Returns

true if the current object is equal to other; otherwise, false.

System.Half.Equals()

Returns a value that indicates whether this instance is equal to the specified obj.

Parameters

NameDescriptionDefault
obj The object to compare to this instance.

Returns

true if obj is an instance of System.Half and equals the value of this instance; otherwise, false.

System.Half.Exp()

Computes
E
raised to a given power.

Parameters

NameDescriptionDefault
x The power to which
E
is raised.

Returns

E
raised to the power of
x
.

System.Half.Exp10()

Computes
10
raised to a given power.

Parameters

NameDescriptionDefault
x The power to which
10
is raised.

Returns

10x

System.Half.Exp10M1()

Computes
10
raised to a given power and subtracts one.

Parameters

NameDescriptionDefault
x The power to which
10
is raised.

Returns

10x - 1

System.Half.Exp2()

Computes
2
raised to a given power.

Parameters

NameDescriptionDefault
x The power to which
2
is raised.

Returns

2x

System.Half.Exp2M1()

Computes
2
raised to a given power and subtracts one.

Parameters

NameDescriptionDefault
x The power to which
2
is raised.

Returns

2x - 1

System.Half.ExpM1()

Computes
E
raised to a given power and subtracts one.

Parameters

NameDescriptionDefault
x The power to which
E
is raised.

Returns

Ex - 1

System.Half.Floor()

Computes the floor of a value.

Parameters

NameDescriptionDefault
x The value whose floor is to be computed.

Returns

The floor of
x
.

System.Half.FusedMultiplyAdd()

Computes the fused multiply-add of three values.

Parameters

NameDescriptionDefault
left The value which
right
multiplies.
right The value which multiplies
left
.
addend The value that is added to the product of
left
and
right
.

Returns

The result of
left
times
right
plus
addend
computed as one ternary operation.

System.Half.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Half.Hypot()

Computes the hypotenuse given two values representing the lengths of the shorter sides in a right-angled triangle.

Parameters

NameDescriptionDefault
x The value to square and add to
y
.
y The value to square and add to
x
.

Returns

The square root of
x
-squared plus
y
-squared.

System.Half.Ieee754Remainder()

Computes the remainder of two values as specified by IEEE 754.

Parameters

NameDescriptionDefault
left The value which
right
divides.
right The value which divides
left
.

Returns

The remainder of
left
divided-by
right
as specified by IEEE 754.

System.Half.ILogB()

Computes the integer logarithm of a value.

Parameters

NameDescriptionDefault
x The value whose integer logarithm is to be computed.

Returns

The integer logarithm of
x
.

System.Half.IsEvenInteger()

Determines if a value represents an even integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an even integer; otherwise,
false
.

System.Half.IsFinite()

Determines whether the specified value is finite (zero, subnormal, or normal).

Parameters

NameDescriptionDefault
value A System.Half floating-point number.

Returns

true if the specified value is finite (zero, subnormal or normal); otherwise, false.

System.Half.IsInfinity()

Returns a value indicating whether the specified number evaluates to positive infinity.

Parameters

NameDescriptionDefault
value A System.Half floating-point number.

Returns

true if value evaluates to System.Half.PositiveInfinity; otherwise false.

System.Half.IsInteger()

Determines if a value represents an integral value.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an integer; otherwise,
false
.

System.Half.IsNaN()

Determines whether the specified value is not a number.

Parameters

NameDescriptionDefault
value A System.Half floating-point number.

Returns

true if value evaluates to not a number System.Half.NaN; otherwise false.

System.Half.IsNegative()

Determines whether the specified value is negative.

Parameters

NameDescriptionDefault
value A System.Half floating-point number.

Returns

true if negative; false otherwise.

System.Half.IsNegativeInfinity()

Determines whether the specified value is negative infinity.

Parameters

NameDescriptionDefault
value A System.Half floating-point number.

Returns

true if value evaluates to System.Half.NegativeInfinity; otherwise false.

System.Half.IsNormal()

Determines whether the specified value is normal.

Parameters

NameDescriptionDefault
value A System.Half floating-point number.

Returns

true if value is normal; false otherwise.

System.Half.IsOddInteger()

Determines if a value represents an odd integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an odd integer; otherwise,
false
.

System.Half.IsPositive()

Determines if a value is positive.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is positive; otherwise,
false
.

System.Half.IsPositiveInfinity()

Determines whether the specified value is positive infinity.

Parameters

NameDescriptionDefault
value A System.Half floating-point number.

Returns

true if value evaluates to System.Half.PositiveInfinity; otherwise false.

System.Half.IsPow2()

Determines if a value is a power of two.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is a power of two; otherwise,
false
.

System.Half.IsRealNumber()

Determines if a value represents a real number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is a real number; otherwise,
false
.

System.Half.IsSubnormal()

Determines whether the specified value is subnormal.

Parameters

NameDescriptionDefault
value A System.Half floating-point number.

Returns

true if value is subnormal; falsefalse.

System.Half.Lerp()

Performs a linear interpolation between two values based on the given weight.

Parameters

NameDescriptionDefault
value1 The first value, which is intended to be the lower bound.
value2 The second value, which is intended to be the upper bound.
amount A value, intended to be between 0 and 1, that indicates the weight of the interpolation.

Returns

The interpolated value.

System.Half.Log()

Computes the natural (
base-E
logarithm of a value.

Parameters

NameDescriptionDefault
x The value whose natural logarithm is to be computed.

Returns

The natural logarithm of
x
.

System.Half.Log()

Computes the logarithm of a value in the specified base.

Parameters

NameDescriptionDefault
x The value whose logarithm is to be computed.
newBase The base in which the logarithm is to be computed.

Returns

The base-
newBase
logarithm of
x
.

System.Half.Log10()

Computes the base-10 logarithm of a value.

Parameters

NameDescriptionDefault
x The value whose base-10 logarithm is to be computed.

Returns

The base-10 logarithm of
x
.

System.Half.Log10P1()

Computes the base-10 logarithm of a value plus one.

Parameters

NameDescriptionDefault
x The value to which one is added before computing the base-10 logarithm.

Returns

log10(x + 1)

System.Half.Log2()

Computes the log2 of a value.

Parameters

NameDescriptionDefault
value The value whose log2 is to be computed.

Returns

The log2 of
value
.

System.Half.Log2P1()

Computes the base-2 logarithm of a value plus one.

Parameters

NameDescriptionDefault
x The value to which one is added before computing the base-2 logarithm.

Returns

log2(x + 1)

System.Half.LogP1()

Computes the natural (
base-E
) logarithm of a value plus one.

Parameters

NameDescriptionDefault
x The value to which one is added before computing the natural logarithm.

Returns

loge(x + 1)

System.Half.Max()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Half.MaxMagnitude()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Half.MaxMagnitudeNumber()

Compares two values to compute which has the greater magnitude and returning the other value if an input is
NaN
.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Half.MaxNumber()

Compares two values to compute which is greater and returning the other value if an input is
NaN
.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Half.Min()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Half.MinMagnitude()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Half.MinMagnitudeNumber()

Compares two values to compute which has the lesser magnitude and returning the other value if an input is
NaN
.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Half.MinNumber()

Compares two values to compute which is lesser and returning the other value if an input is
NaN
.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Half.op_Addition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which
right
is added.
right The value which is added to
left
.

Returns

The sum of
left
and
right
.

System.Half.op_CheckedExplicit()

Parameters

NameDescriptionDefault
value

System.Half.op_Decrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing
value
.

System.Half.op_Division()

Divides two values together to compute their quotient.

Parameters

NameDescriptionDefault
left The value which
right
divides.
right The value which divides
left
.

Returns

The quotient of
left
divided-by
right
.

System.Half.op_Equality()

Returns a value that indicates whether two specified values are equal.

Parameters

NameDescriptionDefault
left The first value to compare.
right The second value to compare.

Returns

true
if
left
and
right
are equal; otherwise,
false
.

System.Half.op_Explicit()

Explicitly converts a System.Char value to its nearest representable half-precision floating-point value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable half-precision floating-point value.

System.Half.op_Explicit()

Explicitly converts a System.Decimal value to its nearest representable half-precision floating-point value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable half-precision floating-point value.

System.Half.op_Explicit()

An explicit operator to convert a System.Double value to a System.Half.

Parameters

NameDescriptionDefault
value The double-precision floating point value to convert to System.Half.

Returns

The System.Half representation of the specified double-precision floating point value.

System.Half.op_Explicit()

Explicitly converts a half-precision floating-point value to its nearest representable System.Byte value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable System.Byte value.

System.Half.op_Explicit()

Explicitly converts a half-precision floating-point value to its nearest representable System.Char value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable System.Char value.

System.Half.op_Explicit()

Explicitly converts a half-precision floating-point value to its nearest representable System.Decimal value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable System.Decimal value.

System.Half.op_Explicit()

An explicit operator to convert a System.Half value to a System.Double.

Parameters

NameDescriptionDefault
value The half-precision floating point value to convert to System.Double.

Returns

The System.Double representation of the specified half-precision floating point value.

System.Half.op_Explicit()

Explicitly converts a half-precision floating-point value to its nearest representable System.Int128.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a 128-bit signed integer.

System.Half.op_Explicit()

Explicitly converts a half-precision floating-point value to its nearest representable System.Int16 value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable System.Int16 value.

System.Half.op_Explicit()

Explicitly converts a half-precision floating-point value to its nearest representable System.Int32 value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable System.Int32 value.

System.Half.op_Explicit()

Explicitly converts a half-precision floating-point value to its nearest representable System.Int64 value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable System.Int64 value.

System.Half.op_Explicit()

Explicitly converts a half-precision floating-point value to its nearest representable System.IntPtr value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable System.IntPtr value.

System.Half.op_Explicit()

Explicitly converts a half-precision floating-point value to its nearest representable System.SByte value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable System.SByte value.

System.Half.op_Explicit()

An explicit operator to convert a System.Half value to a System.Single.

Parameters

NameDescriptionDefault
value The half-precision floating point value to convert to System.Single.

Returns

The System.Single representation of the specified half-precision floating point value.

System.Half.op_Explicit()

Explicitly converts a half-precision floating-point value to its nearest representable System.UInt128.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a 128-bit unsigned integer.

System.Half.op_Explicit()

Explicitly converts a half-precision floating-point value to its nearest representable System.UInt16 value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable System.UInt16 value.

System.Half.op_Explicit()

Explicitly converts a half-precision floating-point value to its nearest representable System.UInt32 value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable System.UInt32 value.

System.Half.op_Explicit()

Explicitly converts a half-precision floating-point value to its nearest representable System.UInt64 value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable System.UInt64 value.

System.Half.op_Explicit()

Explicitly converts a half-precision floating-point value to its nearest representable System.UIntPtr value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable System.UIntPtr value.

System.Half.op_Explicit()

Explicitly converts a System.Int16 value to its nearest representable half-precision floating-point value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable half-precision floating-point value.

System.Half.op_Explicit()

Explicitly converts a System.Int32 value to its nearest representable half-precision floating-point value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable half-precision floating-point value.

System.Half.op_Explicit()

Explicitly converts a System.Int64 value to its nearest representable half-precision floating-point value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable half-precision floating-point value.

System.Half.op_Explicit()

Explicitly converts a System.IntPtr value to its nearest representable half-precision floating-point value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable half-precision floating-point value.

System.Half.op_Explicit()

An explicit operator to convert a System.Single value to a System.Half.

Parameters

NameDescriptionDefault
value The single-precision floating point value to convert to System.Half.

Returns

The System.Half representation of the specified single-precision floating point value.

System.Half.op_Explicit()

Explicitly converts a System.UInt16 value to its nearest representable half-precision floating-point value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable half-precision floating-point value.

System.Half.op_Explicit()

Explicitly converts a System.UInt32 value to its nearest representable half-precision floating-point value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable half-precision floating-point value.

System.Half.op_Explicit()

Explicitly converts a System.UInt64 value to its nearest representable half-precision floating-point value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable half-precision floating-point value.

System.Half.op_Explicit()

Explicitly converts a System.UIntPtr value to its nearest representable half-precision floating-point value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable half-precision floating-point value.

System.Half.op_GreaterThan()

Returns a value that indicates whether a specified value is greater than another specified value.

Parameters

NameDescriptionDefault
left The first value to compare.
right The second value to compare.

Returns

true
if
left
is greater than
right
; otherwise,
false
.

System.Half.op_GreaterThanOrEqual()

Returns a value that indicates whether
left
is greater than or equal to
right
.

Parameters

NameDescriptionDefault
left The first value to compare.
right The second value to compare.

Returns

true
if
left
is greater than or equal to
right
; otherwise,
false
.

System.Half.op_Implicit()

Implicitly converts a System.Byte value to its nearest representable half-precision floating-point value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable half-precision floating-point value.

System.Half.op_Implicit()

Implicitly converts a System.SByte value to its nearest representable half-precision floating-point value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to its nearest representable half-precision floating-point value.

System.Half.op_Increment()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing
value
.

System.Half.op_Inequality()

Returns a value that indicates whether two specified values are not equal.

Parameters

NameDescriptionDefault
left The first value to compare.
right The second value to compare.

Returns

true
if
left
and
right
are not equal; otherwise,
false
.

System.Half.op_LessThan()

Returns a value that indicates whether a specified value is less than another specified value.

Parameters

NameDescriptionDefault
left The first value to compare.
right The second value to compare.

Returns

true
if
left
is less than
right
; otherwise,
false
.

System.Half.op_LessThanOrEqual()

Returns a value that indicates whether a specified value is less than or equal to another specified value.

Parameters

NameDescriptionDefault
left The first value to compare.
right The second value to compare.

Returns

true
if
left
is less than or equal to
right
; otherwise,
false
.

System.Half.op_Modulus()

Divides two values together to compute their modulus or remainder.

Parameters

NameDescriptionDefault
left The value which
right
divides.
right The value which divides
left
.

Returns

The modulus or remainder of
left
divided-by
right
.

System.Half.op_Multiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value which
right
multiplies.
right The value which multiplies
left
.

Returns

The product of
left
multiplied-by
right
.

System.Half.op_Subtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which
right
is subtracted.
right The value which is subtracted from
left
.

Returns

The difference of
right
subtracted from
left
.

System.Half.op_UnaryNegation()

Computes the unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of
value
.

System.Half.op_UnaryPlus()

Computes the unary plus of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary plus.

Returns

The unary plus of
value
.

System.Half.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.Half.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.Half.Parse()

Converts the string representation of a number in a specified style and culture-specific format to its single-precision floating-point number equivalent.

Parameters

NameDescriptionDefault
s Converts the string representation of a number to its half-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s.
provider An object that supplies culture-specific formatting information about s.

Returns

A half-precision floating-point number equivalent to the numeric value or symbol specified in s.

System.Half.Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.

Returns

The result of parsing
s
.

System.Half.Parse()

Converts the string representation of a number to its half-precision floating-point number equivalent.

Parameters

NameDescriptionDefault
s A string that contains a number to convert.

Returns

A half-precision floating-point number equivalent to the numeric value or symbol specified in s.

System.Half.Parse()

Converts the string representation of a number in a specified style to its single-precision floating-point number equivalent.

Parameters

NameDescriptionDefault
s A string that contains a number to convert.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s.

Returns

A half-precision floating-point number equivalent to the numeric value or symbol specified in s.

System.Half.Parse()

Converts the string representation of a number in a specified style and culture-specific format to its single-precision floating-point number equivalent.

Parameters

NameDescriptionDefault
s A string that contains a number to convert.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s.
provider An object that supplies culture-specific formatting information about s.

Returns

A half-precision floating-point number equivalent to the numeric value or symbol specified in s.

System.Half.Parse()

Converts the string representation of a number in a specified culture-specific format to its single-precision floating-point number equivalent.

Parameters

NameDescriptionDefault
s A string that contains a number to convert.
provider An object that supplies culture-specific formatting information about s.

Returns

A half-precision floating-point number equivalent to the numeric value or symbol specified in s.

System.Half.Pow()

Computes a value raised to a given power.

Parameters

NameDescriptionDefault
x The value which is raised to the power of
x
.
y The power to which
x
is raised.

Returns

x
raised to the power of
y
.

System.Half.RadiansToDegrees()

Converts a given value from radians to degrees.

Parameters

NameDescriptionDefault
radians The value to convert to degrees.

Returns

The value of
radians
converted to degrees.

System.Half.ReciprocalEstimate()

Computes an estimate of the reciprocal of a value.

Parameters

NameDescriptionDefault
x The value whose estimate of the reciprocal is to be computed.

Returns

An estimate of the reciprocal of
x
.

System.Half.ReciprocalSqrtEstimate()

Computes an estimate of the reciprocal square root of a value.

Parameters

NameDescriptionDefault
x The value whose estimate of the reciprocal square root is to be computed.

Returns

An estimate of the reciprocal square root of
x
.

System.Half.RootN()

Computes the n-th root of a value.

Parameters

NameDescriptionDefault
x The value whose
n
-th root is to be computed.
n The degree of the root to be computed.

Returns

The
n
-th root of
x
.

System.Half.Round()

Rounds a value to the nearest integer using the default rounding mode ().

Parameters

NameDescriptionDefault
x The value to round.

Returns

The result of rounding
x
to the nearest integer using the default rounding mode.

System.Half.Round()

Rounds a value to a specified number of fractional-digits using the default rounding mode ().

Parameters

NameDescriptionDefault
x The value to round.
digits The number of fractional digits to which
x
should be rounded.

Returns

The result of rounding
x
to
digits
fractional-digits using the default rounding mode.

System.Half.Round()

Rounds a value to a specified number of fractional-digits using the default rounding mode ().

Parameters

NameDescriptionDefault
x The value to round.
digits The number of fractional digits to which
x
should be rounded.
mode The mode under which
x
should be rounded.

Returns

The result of rounding
x
to
digits
fractional-digits using
mode
.

System.Half.Round()

Rounds a value to the nearest integer using the specified rounding mode.

Parameters

NameDescriptionDefault
x The value to round.
mode The mode under which
x
should be rounded.

Returns

The result of rounding
x
to the nearest integer using
mode
.

System.Half.ScaleB()

Computes the product of a value and its base-radix raised to the specified power.

Parameters

NameDescriptionDefault
x The value which base-radix raised to the power of
n
multiplies.
n The value to which base-radix is raised before multipliying
x
.

Returns

The product of
x
and base-radix raised to the power of
n
.

System.Half.Sign()

Computes the sign of a value.

Parameters

NameDescriptionDefault
value The value whose sign is to be computed.

Returns

A positive value if
value
is positive, if
value
is zero, and a negative value if
value
is negative.

System.Half.Sin()

Computes the sine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose sine is to be computed.

Returns

The sine of
x
.

System.Half.SinCos()

Computes the sine and cosine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose sine and cosine are to be computed.

Returns

The sine and cosine of
x
.

System.Half.SinCosPi()

Computes the sine and cosine of a value that has been multiplied by
pi
.

Parameters

NameDescriptionDefault
x The value, in half-revolutions, that is multipled by
pi
before computing its sine and cosine.

Returns

The sine and cosine of
x
multiplied-by
pi
.

System.Half.Sinh()

Computes the hyperbolic sine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic sine is to be computed.

Returns

The hyperbolic sine of
x
.

System.Half.SinPi()

Computes the sine of a value that has been multiplied by
pi
.

Parameters

NameDescriptionDefault
x The value, in half-revolutions, that is multipled by
pi
before computing its sine.

Returns

The sine of
x
multiplied-by
pi
.

System.Half.Sqrt()

Computes the square-root of a value.

Parameters

NameDescriptionDefault
x The value whose square-root is to be computed.

Returns

The square-root of
x
.

System.Half.System#Numerics#IBitwiseOperators{System#Half@System#Half@System#Half}#op_BitwiseAnd()

Computes the bitwise-and of two values.

Parameters

NameDescriptionDefault
left The value to and with right.
right The value to and with left.

Returns

The bitwise-and of left and right.

System.Half.System#Numerics#IBitwiseOperators{System#Half@System#Half@System#Half}#op_BitwiseOr()

Computes the bitwise-or of two values.

Parameters

NameDescriptionDefault
left The value to or with right.
right The value to or with left.

Returns

The bitwise-or of left and right.

System.Half.System#Numerics#IBitwiseOperators{System#Half@System#Half@System#Half}#op_ExclusiveOr()

Computes the exclusive-or of two values.

Parameters

NameDescriptionDefault
left The value to xor with right.
right The value to xor with left.

Returns

The exclusive-or of left and right.

System.Half.System#Numerics#IBitwiseOperators{System#Half@System#Half@System#Half}#op_OnesComplement()

Computes the ones-complement representation of a given value.

Parameters

NameDescriptionDefault
value The value for which to compute the ones-complement.

Returns

The ones-complement of value.

System.Half.System#Numerics#IFloatingPoint<System#Half>#GetExponentByteCount

Gets the number of bytes that will be written as part of .

Returns

The number of bytes that will be written as part of .

System.Half.System#Numerics#IFloatingPoint<System#Half>#GetExponentShortestBitLength

Gets the length, in bits, of the shortest two's complement representation of the current exponent.

Returns

The length, in bits, of the shortest two's complement representation of the current exponent.

System.Half.System#Numerics#IFloatingPoint<System#Half>#GetSignificandBitLength

Gets the length, in bits, of the current significand.

Returns

The length, in bits, of the current significand.

System.Half.System#Numerics#IFloatingPoint<System#Half>#GetSignificandByteCount

Gets the number of bytes that will be written as part of .

Returns

The number of bytes that will be written as part of .

System.Half.System#Numerics#IFloatingPoint<System#Half>#TryWriteExponentBigEndian()

Tries to write the current exponent, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current exponent should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the exponent was succesfully written to
destination
; otherwise,
false
.

System.Half.System#Numerics#IFloatingPoint<System#Half>#TryWriteExponentLittleEndian()

Tries to write the current exponent, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current exponent should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the exponent was succesfully written to
destination
; otherwise,
false
.

System.Half.System#Numerics#IFloatingPoint<System#Half>#TryWriteSignificandBigEndian()

Tries to write the current significand, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current significand should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the significand was succesfully written to
destination
; otherwise,
false
.

System.Half.System#Numerics#IFloatingPoint<System#Half>#TryWriteSignificandLittleEndian()

Tries to write the current significand, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current significand should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the significand was succesfully written to
destination
; otherwise,
false
.

System.Half.System#Numerics#INumberBase{System#Half}#IsCanonical()

Determines if a value is in its canonical representation.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is in its canonical representation; otherwise, false.

System.Half.System#Numerics#INumberBase{System#Half}#IsComplexNumber()

Determines if a value represents a complex number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a complex number; otherwise, false.

System.Half.System#Numerics#INumberBase{System#Half}#IsImaginaryNumber()

Determines if a value represents a pure imaginary number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a pure imaginary number; otherwise, false.

System.Half.System#Numerics#INumberBase{System#Half}#IsZero()

Determines if a value is zero.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is zero; otherwise, false.

System.Half.System#Numerics#INumberBase{System#Half}#TryConvertFromChecked``1()

Parameters

NameDescriptionDefault
value
result

System.Half.System#Numerics#INumberBase{System#Half}#TryConvertFromSaturating``1()

Parameters

NameDescriptionDefault
value
result

System.Half.System#Numerics#INumberBase{System#Half}#TryConvertFromTruncating``1()

Parameters

NameDescriptionDefault
value
result

System.Half.System#Numerics#INumberBase{System#Half}#TryConvertToChecked``1()

Tries to convert an instance of the the current type to another type, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Half.System#Numerics#INumberBase{System#Half}#TryConvertToSaturating``1()

Tries to convert an instance of the the current type to another type, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Half.System#Numerics#INumberBase{System#Half}#TryConvertToTruncating``1()

Tries to convert an instance of the the current type to another type, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Half.Tan()

Computes the tangent of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose tangent is to be computed.

Returns

The tangent of
x
.

System.Half.Tanh()

Computes the hyperbolic tangent of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic tangent is to be computed.

Returns

The hyperbolic tangent of
x
.

System.Half.TanPi()

Computes the tangent of a value that has been multipled by
pi
.

Parameters

NameDescriptionDefault
x The value, in half-revolutions, that is multipled by
pi
before computing its tangent.

Returns

The tangent of
x
multiplied-by
pi
.

System.Half.ToString

Converts the numeric value of this instance to its equivalent string representation.

Returns

The string representation of the value of this instance.

System.Half.ToString()

Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

The string representation of the value of this instance as specified by provider.

System.Half.ToString()

Converts the numeric value of this instance to its equivalent string representation, using the specified format.

Parameters

NameDescriptionDefault
format A numeric format string.

Returns

The string representation of the value of this instance as specified by format.

System.Half.ToString()

Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information.

Parameters

NameDescriptionDefault
format A numeric format string.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of the value of this instance as specified by provider.

System.Half.Truncate()

Truncates a value.

Parameters

NameDescriptionDefault
x The value to truncate.

Returns

The truncation of
x
.

System.Half.TryFormat()

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

Parameters

NameDescriptionDefault
utf8Destination The span in which to write this instance's value formatted as a span of bytes.
bytesWritten When this method returns, contains the number of bytes that were written in
utf8Destination
.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for
utf8Destination
.
provider An optional object that supplies culture-specific formatting information for
utf8Destination
.

Returns

true
if the formatting was successful; otherwise,
false
.

System.Half.TryFormat()

Tries to format the value of the current System.Half instance into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span in which to write this instance's value formatted as a span of characters.
charsWritten When this method returns, contains the number of characters that were written in destination.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for destination.
provider An optional object that supplies culture-specific formatting information for destination.

Returns

true if the formatting was successful, otherwise, false.

System.Half.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.Half.TryParse()

Tries to convert a UTF-8 character span containing the string representation of a number to its half-precision floating-point number equivalent.

Parameters

NameDescriptionDefault
utf8Text A read-only UTF-8 character span that contains the number to convert.
result When this method returns, contains a half-precision floating-point number equivalent of the numeric value or symbol contained in utf8Text if the conversion succeeded or zero if the conversion failed. The conversion fails if the utf8Text is System.ReadOnlySpan`1.Empty or is not in a valid format. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if utf8Text was converted successfully; otherwise, false.

System.Half.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.Half.TryParse()

Converts the span representation of a number to its half-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A read-only span that contains a number to convert.
style A bitwise combination of enumeration values that indicates the permitted format of s.
provider An object that supplies culture-specific formatting information about s.
result When this method returns, contains the half-precision floating-point number equivalent to the numeric value or symbol contained in s, if the conversion succeeded, or a default System.Half value if the conversion failed. The conversion fails if s is not a number in a valid format. If s is a valid number less than System.Half.MinValue, result contains System.Half.NegativeInfinity. If s is a valid number greater than System.Half.MaxValue, result contains System.Half.PositiveInfinity. This parameter is treated as uninitialized.

Returns

true if the conversion was successful; otherwise, false.

System.Half.TryParse()

Converts the span representation of a number to its half-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A read-only span that contains a number to convert.
result When this method returns, contains the half-precision floating-point number equivalent to the numeric value or symbol contained in s, if the conversion succeeded, or a default System.Half value if the conversion failed. The conversion fails if the s parameter is null or System.String.Empty or is not a number in a valid format. If s is a valid number less than System.Half.MinValue, result contains System.Half.NegativeInfinity. If s is a valid number greater than System.Half.MaxValue, result contains System.Half.PositiveInfinity. This parameter is treated as uninitialized.

Returns

true if s was converted successfully, false otherwise.

System.Half.TryParse()

Tries to parse a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
, or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Half.TryParse()

Converts the string representation of a number to its half-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A string that contains a number to convert.
style A bitwise combination of enumeration values that indicates the permitted format of s.
provider An object that supplies culture-specific formatting information about s.
result When this method returns, contains the half-precision floating-point number equivalent to the numeric value or symbol contained in s, if the conversion succeeded, or a default System.Half value if the conversion failed. The conversion fails if s is null or System.String.Empty or is not a number in a valid format. If s is a valid number less than System.Half.MinValue, result contains System.Half.NegativeInfinity. If s is a valid number greater than System.Half.MaxValue, result contains System.Half.PositiveInfinity. This parameter is treated as uninitialized.

Returns

true if the conversion was successful; otherwise, false.

System.Half.TryParse()

Converts the string representation of a number to its half-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A string that contains a number to convert.
result When this method returns, contains the half-precision floating-point number equivalent to the numeric value or symbol contained in s, if the conversion succeeded, or a default System.Half value if the conversion failed. The conversion fails if s is null or System.String.Empty or is not a number in a valid format. If s is a valid number less than System.Half.MinValue, result contains System.Half.NegativeInfinity. If s is a valid number greater than System.Half.MaxValue, result contains System.Half.PositiveInfinity. This parameter is treated as uninitialized.

Returns

true if the conversion was successful; otherwise, false.

System.Half.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Half.E

Gets the mathematical constant
e
.

System.Half.Epsilon

Represents the smallest positive System.Half value that is greater than zero.

Returns

5.9604645E-08

System.Half.MaxValue

Represents the largest possible value of .

Returns

65504

System.Half.MinValue

Represents the smallest possible value of .

Returns

-65504

System.Half.MultiplicativeIdentity

Gets the multiplicative identity of the current type.

System.Half.NaN

Represents not a number.

Returns

NaN.

System.Half.NegativeInfinity

Represents negative infinity.

Returns

-Infinity.

System.Half.NegativeOne

Gets the value
-1
for the type.

System.Half.NegativeZero

Gets a value that represents negative
zero
.

System.Half.One

Gets the value
1
for the type.

System.Half.Pi

Gets the mathematical constant
pi
.

System.Half.PositiveInfinity

Represents positive infinity.

Returns

Infinity.

System.Half.System#Numerics#IAdditiveIdentity{System#Half@System#Half}#AdditiveIdentity

Gets the additive identity of the current type.

System.Half.System#Numerics#IBinaryNumber{System#Half}#AllBitsSet

Gets an instance of the binary type in which all bits are set.

System.Half.System#Numerics#INumberBase{System#Half}#Radix

Gets the radix, or base, for the type.

System.Half.Tau

Gets the mathematical constant
tau
.

System.Half.Zero

Gets the value
0
for the type.

System.HashCode

Combines the hash code for multiple values into a single hash code.

System.HashCode.Add``1()

Adds a single value to the hash code.

Parameters

NameDescriptionDefault
value The value to add to the hash code.

System.HashCode.Add``1()

Adds a single value to the hash code, specifying the type that provides the hash code function.

Parameters

NameDescriptionDefault
value The value to add to the hash code.
comparer The System.Collections.Generic.IEqualityComparer`1 to use to calculate the hash code. This value can be a null reference (Nothing in Visual Basic), which will use the default equality comparer for .

System.HashCode.AddBytes()

Adds a span of bytes to the hash code.

Parameters

NameDescriptionDefault
value The span to add.

System.HashCode.Combine``1()

Diffuses the hash code returned by the specified value.

Parameters

NameDescriptionDefault
value1 The value to add to the hash code.

Returns

The hash code that represents the single value.

System.HashCode.Combine``2()

Combines two values into a hash code.

Parameters

NameDescriptionDefault
value1 The first value to combine into the hash code.
value2 The second value to combine into the hash code.

Returns

The hash code that represents the two values.

System.HashCode.Combine``3()

Combines three values into a hash code.

Parameters

NameDescriptionDefault
value1 The first value to combine into the hash code.
value2 The second value to combine into the hash code.
value3 The third value to combine into the hash code.

Returns

The hash code that represents the three values.

System.HashCode.Combine``4()

Combines four values into a hash code.

Parameters

NameDescriptionDefault
value1 The first value to combine into the hash code.
value2 The second value to combine into the hash code.
value3 The third value to combine into the hash code.
value4 The fourth value to combine into the hash code.

Returns

The hash code that represents the four values.

System.HashCode.Combine``5()

Combines five values into a hash code.

Parameters

NameDescriptionDefault
value1 The first value to combine into the hash code.
value2 The second value to combine into the hash code.
value3 The third value to combine into the hash code.
value4 The fourth value to combine into the hash code.
value5 The fifth value to combine into the hash code.

Returns

The hash code that represents the five values.

System.HashCode.Combine``6()

Combines six values into a hash code.

Parameters

NameDescriptionDefault
value1 The first value to combine into the hash code.
value2 The second value to combine into the hash code.
value3 The third value to combine into the hash code.
value4 The fourth value to combine into the hash code.
value5 The fifth value to combine into the hash code.
value6 The sixth value to combine into the hash code.

Returns

The hash code that represents the six values.

System.HashCode.Combine``7()

Combines seven values into a hash code.

Parameters

NameDescriptionDefault
value1 The first value to combine into the hash code.
value2 The second value to combine into the hash code.
value3 The third value to combine into the hash code.
value4 The fourth value to combine into the hash code.
value5 The fifth value to combine into the hash code.
value6 The sixth value to combine into the hash code.
value7 The seventh value to combine into the hash code.

Returns

The hash code that represents the seven values.

System.HashCode.Combine``8()

Combines eight values into a hash code.

Parameters

NameDescriptionDefault
value1 The first value to combine into the hash code.
value2 The second value to combine into the hash code.
value3 The third value to combine into the hash code.
value4 The fourth value to combine into the hash code.
value5 The fifth value to combine into the hash code.
value6 The sixth value to combine into the hash code.
value7 The seventh value to combine into the hash code.
value8 The eighth value to combine into the hash code.

Returns

The hash code that represents the eight values.

System.HashCode.Equals()

This method is not supported and should not be called.

Parameters

NameDescriptionDefault
obj Ignored.

Returns

This method will always throw a System.NotSupportedException.

System.HashCode.GetHashCode

This method is not supported and should not be called.

Returns

This method will always throw a System.NotSupportedException.

System.HashCode.ToHashCode

Calculates the final hash code after consecutive System.HashCode.Add invocations.

Returns

The calculated hash code.

System.HttpStyleUriParser

A customizable parser based on the HTTP scheme.

System.HttpStyleUriParser.#ctor

Create a customizable parser based on the HTTP scheme.

System.IAsyncDisposable

Provides a mechanism for releasing unmanaged resources asynchronously.

System.IAsyncDisposable.DisposeAsync

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

Returns

A task that represents the asynchronous dispose operation.

System.IAsyncResult

Represents the status of an asynchronous operation.

System.IAsyncResult.AsyncState

Gets a user-defined object that qualifies or contains information about an asynchronous operation.

Returns

A user-defined object that qualifies or contains information about an asynchronous operation.

System.IAsyncResult.AsyncWaitHandle

Gets a System.Threading.WaitHandle that is used to wait for an asynchronous operation to complete.

Returns

A System.Threading.WaitHandle that is used to wait for an asynchronous operation to complete.

System.IAsyncResult.CompletedSynchronously

Gets a value that indicates whether the asynchronous operation completed synchronously.

Returns

true if the asynchronous operation completed synchronously; otherwise, false.

System.IAsyncResult.IsCompleted

Gets a value that indicates whether the asynchronous operation has completed.

Returns

true if the operation is complete; otherwise, false.

System.ICloneable

Supports cloning, which creates a new instance of a class with the same value as an existing instance.

System.ICloneable.Clone

Creates a new object that is a copy of the current instance.

Returns

A new object that is a copy of this instance.

System.IComparable

Defines a generalized type-specific comparison method that a value type or class implements to order or sort its instances.

System.IComparable.CompareTo()

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance.

Returns

A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes obj in the sort order. Zero This instance occurs in the same position in the sort order as obj. Greater than zero This instance follows obj in the sort order.

System.IComparable`1

Defines a generalized comparison method that a value type or class implements to create a type-specific comparison method for ordering or sorting its instances.

System.IComparable`1.CompareTo()

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Parameters

NameDescriptionDefault
other An object to compare with this instance.

Returns

A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes other in the sort order. Zero This instance occurs in the same position in the sort order as other. Greater than zero This instance follows other in the sort order.

System.IConvertible

Defines methods that convert the value of the implementing reference or value type to a common language runtime type that has an equivalent value.

System.IConvertible.GetTypeCode

Returns the System.TypeCode for this instance.

Returns

The enumerated constant that is the System.TypeCode of the class or value type that implements this interface.

System.IConvertible.ToBoolean()

Converts the value of this instance to an equivalent Boolean value using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

A Boolean value equivalent to the value of this instance.

System.IConvertible.ToByte()

Converts the value of this instance to an equivalent 8-bit unsigned integer using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

An 8-bit unsigned integer equivalent to the value of this instance.

System.IConvertible.ToChar()

Converts the value of this instance to an equivalent Unicode character using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

A Unicode character equivalent to the value of this instance.

System.IConvertible.ToDateTime()

Converts the value of this instance to an equivalent System.DateTime using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

A System.DateTime instance equivalent to the value of this instance.

System.IConvertible.ToDecimal()

Converts the value of this instance to an equivalent System.Decimal number using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

A System.Decimal number equivalent to the value of this instance.

System.IConvertible.ToDouble()

Converts the value of this instance to an equivalent double-precision floating-point number using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

A double-precision floating-point number equivalent to the value of this instance.

System.IConvertible.ToInt16()

Converts the value of this instance to an equivalent 16-bit signed integer using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

An 16-bit signed integer equivalent to the value of this instance.

System.IConvertible.ToInt32()

Converts the value of this instance to an equivalent 32-bit signed integer using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

An 32-bit signed integer equivalent to the value of this instance.

System.IConvertible.ToInt64()

Converts the value of this instance to an equivalent 64-bit signed integer using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

An 64-bit signed integer equivalent to the value of this instance.

System.IConvertible.ToSByte()

Converts the value of this instance to an equivalent 8-bit signed integer using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

An 8-bit signed integer equivalent to the value of this instance.

System.IConvertible.ToSingle()

Converts the value of this instance to an equivalent single-precision floating-point number using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

A single-precision floating-point number equivalent to the value of this instance.

System.IConvertible.ToString()

Converts the value of this instance to an equivalent System.String using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

A System.String instance equivalent to the value of this instance.

System.IConvertible.ToType()

Converts the value of this instance to an System.Object of the specified System.Type that has an equivalent value, using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
conversionType The System.Type to which the value of this instance is converted.
provider An System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

An System.Object instance of type conversionType whose value is equivalent to the value of this instance.

System.IConvertible.ToUInt16()

Converts the value of this instance to an equivalent 16-bit unsigned integer using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

An 16-bit unsigned integer equivalent to the value of this instance.

System.IConvertible.ToUInt32()

Converts the value of this instance to an equivalent 32-bit unsigned integer using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

An 32-bit unsigned integer equivalent to the value of this instance.

System.IConvertible.ToUInt64()

Converts the value of this instance to an equivalent 64-bit unsigned integer using the specified culture-specific formatting information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

An 64-bit unsigned integer equivalent to the value of this instance.

System.ICustomFormatter

Defines a method that supports custom formatting of the value of an object.

System.ICustomFormatter.Format()

Converts the value of a specified object to an equivalent string representation using specified format and culture-specific formatting information.

Parameters

NameDescriptionDefault
format A format string containing formatting specifications.
arg An object to format.
formatProvider An object that supplies format information about the current instance.

Returns

The string representation of the value of arg, formatted as specified by format and formatProvider.

System.IDisposable

Provides a mechanism for releasing unmanaged resources.

System.IDisposable.Dispose

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

System.IEquatable`1

Defines a generalized method that a value type or class implements to create a type-specific method for determining equality of instances.

System.IEquatable`1.Equals()

Indicates whether the current object is equal to another object of the same type.

Parameters

NameDescriptionDefault
other An object to compare with this object.

Returns

true if the current object is equal to the other parameter; otherwise, false.

System.IFormatProvider

Provides a mechanism for retrieving an object to control formatting.

System.IFormatProvider.GetFormat()

Returns an object that provides formatting services for the specified type.

Parameters

NameDescriptionDefault
formatType An object that specifies the type of format object to return.

Returns

An instance of the object specified by formatType, if the System.IFormatProvider implementation can supply that type of object; otherwise, null.

System.IFormattable

Provides functionality to format the value of an object into a string representation.

System.IFormattable.ToString()

Formats the value of the current instance using the specified format.

Parameters

NameDescriptionDefault
format The format to use. -or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the System.IFormattable implementation.
formatProvider The provider to use to format the value. -or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Returns

The value of the current instance in the specified format.

System.Index

Represents a type that can be used to index a collection either from the beginning or the end.

System.Index.#ctor()

Initializes a new System.Index with a specified index position and a value that indicates if the index is from the beginning or the end of a collection.

Parameters

NameDescriptionDefault
value The index value. It has to be greater then or equal to zero.
fromEnd true to index from the end of the collection, or false to index from the beginning of the collection.

System.Index.Equals()

Returns a value that indicates whether the current object is equal to another System.Index object.

Parameters

NameDescriptionDefault
other The object to compare with this instance.

Returns

true if the current Index object is equal to other; false otherwise.

System.Index.Equals()

Indicates whether the current Index object is equal to a specified object.

Parameters

NameDescriptionDefault
value An object to compare with this instance.

Returns

true if value is of type System.Index and is equal to the current instance; false otherwise.

System.Index.FromEnd()

Creates an System.Index from the end of a collection at a specified index position.

Parameters

NameDescriptionDefault
value The index value from the end of a collection.

Returns

The index value.

System.Index.FromStart()

Creates an System.Index from the specified index at the start of a collection.

Parameters

NameDescriptionDefault
value The index position from the start of a collection.

Returns

The index value.

System.Index.GetHashCode

Returns the hash code for this instance.

Returns

The hash code.

System.Index.GetOffset()

Calculates the offset from the start of the collection using the specified collection length.

Parameters

NameDescriptionDefault
length The length of the collection that the Index will be used with. Must be a positive value.

Returns

The offset.

System.Index.op_Implicit()

Converts an integer number to an System.Index.

Parameters

NameDescriptionDefault
value The integer to convert.

Returns

An index representing the integer.

System.Index.ToString

Returns the string representation of the current System.Index instance.

Returns

The string representation of the System.Index.

System.Index.End

Gets an System.Index that points beyond the last element.

Returns

An index that points beyond the last element.

System.Index.IsFromEnd

Gets a value that indicates whether the index is from the start or the end.

Returns

true if the Index is from the end; otherwise, false.

System.Index.Start

Gets an System.Index that points to the first element of a collection.

Returns

An instance that points to the first element of a collection.

System.Index.Value

Gets the index value.

Returns

The index value.

System.IndexOutOfRangeException

The exception that is thrown when an attempt is made to access an element of an array or collection with an index that is outside its bounds.

System.IndexOutOfRangeException.#ctor

Initializes a new instance of the System.IndexOutOfRangeException class.

System.IndexOutOfRangeException.#ctor()

Initializes a new instance of the System.IndexOutOfRangeException class with a specified error message.

Parameters

NameDescriptionDefault
message The message that describes the error.

System.IndexOutOfRangeException.#ctor()

Initializes a new instance of the System.IndexOutOfRangeException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.InsufficientExecutionStackException

The exception that is thrown when there is insufficient execution stack available to allow most methods to execute.

System.InsufficientExecutionStackException.#ctor

Initializes a new instance of the System.InsufficientExecutionStackException class.

System.InsufficientExecutionStackException.#ctor()

Initializes a new instance of the System.InsufficientExecutionStackException class with a specified error message.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.

System.InsufficientExecutionStackException.#ctor()

Initializes a new instance of the System.InsufficientExecutionStackException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the inner parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.InsufficientMemoryException

The exception that is thrown when a check for sufficient available memory fails. This class cannot be inherited.

System.InsufficientMemoryException.#ctor

Initializes a new instance of the System.InsufficientMemoryException class with a system-supplied message that describes the error.

System.InsufficientMemoryException.#ctor()

Initializes a new instance of the System.InsufficientMemoryException class with a specified message that describes the error.

Parameters

NameDescriptionDefault
message The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture.

System.InsufficientMemoryException.#ctor()

Initializes a new instance of the System.InsufficientMemoryException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.Int128

Represents a 128-bit signed integer.

System.Int128.#ctor()

Initializes a new instance of the System.Int128 struct.

Parameters

NameDescriptionDefault
upper The upper 64-bits of the 128-bit value.
lower The lower 64-bits of the 128-bit value.

System.Int128.Abs()

Computes the absolute of a value.

Parameters

NameDescriptionDefault
value The value for which to get its absolute.

Returns

The absolute of
value
.

System.Int128.Clamp()

Clamps a value to an inclusive minimum and maximum value.

Parameters

NameDescriptionDefault
value The value to clamp.
min The inclusive minimum to which
value
should clamp.
max The inclusive maximum to which
value
should clamp.

Returns

The result of clamping
value
to the inclusive range of
min
and
max
.

System.Int128.CompareTo()

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Parameters

NameDescriptionDefault
value An object to compare with this instance.

Returns

A value that indicates the relative order of the objects being compared. The return value has these meanings:ValueMeaningLess than zeroThis instance precedes
value
in the sort order.ZeroThis instance occurs in the same position in the sort order as
value
.Greater than zeroThis instance follows
value
in the sort order.

System.Int128.CompareTo()

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Parameters

NameDescriptionDefault
value An object to compare with this instance.

Returns

A value that indicates the relative order of the objects being compared. The return value has these meanings:ValueMeaningLess than zeroThis instance precedes
value
in the sort order.ZeroThis instance occurs in the same position in the sort order as
value
.Greater than zeroThis instance follows
value
in the sort order.

System.Int128.CopySign()

Copies the sign of a value to the sign of another value.

Parameters

NameDescriptionDefault
value The value whose magnitude is used in the result.
sign The value whose sign is used in the result.

Returns

A value with the magnitude of
value
and the sign of
sign
.

System.Int128.CreateChecked``1()

Creates an instance of the current type from a value, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
.

System.Int128.CreateSaturating``1()

Creates an instance of the current type from a value, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value which is used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, saturating if
value
falls outside the representable range of
TSelf
.

System.Int128.CreateTruncating``1()

Creates an instance of the current type from a value, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value which is used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, truncating if
value
falls outside the representable range of
TSelf
.

System.Int128.DivRem()

Computes the quotient and remainder of two values.

Parameters

NameDescriptionDefault
left The value which
right
divides.
right The value which divides
left
.

Returns

The quotient and remainder of
left
divided-by
right
.

System.Int128.Equals()

Indicates whether the current object is equal to another object of the same type.

Parameters

NameDescriptionDefault
other An object to compare with this object.

Returns

true
if the current object is equal to the
other
parameter; otherwise,
false
.

System.Int128.Equals()

Determines whether the specified object is equal to the current object.

Parameters

NameDescriptionDefault
obj The object to compare with the current object.

Returns

true
if the specified object is equal to the current object; otherwise,
false
.

System.Int128.GetHashCode

Serves as the default hash function.

Returns

A hash code for the current object.

System.Int128.IsEvenInteger()

Determines if a value represents an even integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an even integer; otherwise,
false
.

System.Int128.IsNegative()

Determines if a value is negative.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is negative; otherwise,
false
.

System.Int128.IsOddInteger()

Determines if a value represents an odd integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an odd integer; otherwise,
false
.

System.Int128.IsPositive()

Determines if a value is positive.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is positive; otherwise,
false
.

System.Int128.IsPow2()

Determines if a value is a power of two.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is a power of two; otherwise,
false
.

System.Int128.LeadingZeroCount()

Computes the number of leading zeros in a value.

Parameters

NameDescriptionDefault
value The value whose leading zeroes are to be counted.

Returns

The number of leading zeros in
value
.

System.Int128.Log2()

Computes the log2 of a value.

Parameters

NameDescriptionDefault
value The value whose log2 is to be computed.

Returns

The log2 of
value
.

System.Int128.Max()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Int128.MaxMagnitude()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Int128.Min()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Int128.MinMagnitude()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Int128.op_Addition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which
right
is added.
right The value which is added to
left
.

Returns

The sum of
left
and
right
.

System.Int128.op_BitwiseAnd()

Computes the bitwise-and of two values.

Parameters

NameDescriptionDefault
left The value to
and
with
right
.
right The value to
and
with
left
.

Returns

The bitwise-and of
left
and
right
.

System.Int128.op_BitwiseOr()

Computes the bitwise-or of two values.

Parameters

NameDescriptionDefault
left The value to
or
with
right
.
right The value to
or
with
left
.

Returns

The bitwise-or of
left
and
right
.

System.Int128.op_CheckedAddition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which
right
is added.
right The value which is added to
left
.

Returns

The sum of
left
and
right
.

System.Int128.op_CheckedDecrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing
value
.

System.Int128.op_CheckedDivision()

Divides two values together to compute their quotient.

Parameters

NameDescriptionDefault
left The value which
right
divides.
right The value which divides
left
.

Returns

The quotient of
left
divided-by
right
.

System.Int128.op_CheckedExplicit()

Parameters

NameDescriptionDefault
value

System.Int128.op_CheckedExplicit()

Parameters

NameDescriptionDefault
value

System.Int128.op_CheckedExplicit()

Parameters

NameDescriptionDefault
value

System.Int128.op_CheckedIncrement()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing
value
.

System.Int128.op_CheckedMultiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value which
right
multiplies.
right The value which multiplies
left
.

Returns

The product of
left
multiplied-by
right
.

System.Int128.op_CheckedSubtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which
right
is subtracted.
right The value which is subtracted from
left
.

Returns

The difference of
right
subtracted from
left
.

System.Int128.op_CheckedUnaryNegation()

Computes the unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of
value
.

System.Int128.op_Decrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing
value
.

System.Int128.op_Division()

Divides two values together to compute their quotient.

Parameters

NameDescriptionDefault
left The value which
right
divides.
right The value which divides
left
.

Returns

The quotient of
left
divided-by
right
.

System.Int128.op_Equality()

Compares two values to determine equality.

Parameters

NameDescriptionDefault
left The value to compare with
right
.
right The value to compare with
left
.

Returns

true
if
left
is equal to
right
; otherwise,
false
.

System.Int128.op_ExclusiveOr()

Computes the exclusive-or of two values.

Parameters

NameDescriptionDefault
left The value to xor with
right
.
right The value to xor with
left
.

Returns

The exclusive-or of
left
and
right
.

System.Int128.op_Explicit()

Explicitly converts a System.Decimal value to a 128-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a 128-bit signed integer.

System.Int128.op_Explicit()

Explicitly converts a System.Double value to a 128-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a 128-bit signed integer.

System.Int128.op_Explicit()

Explicitly converts a 128-bit signed integer to a System.Byte value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a System.Byte.

System.Int128.op_Explicit()

Explicitly converts a 128-bit signed integer to a System.Char value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a System.Char.

System.Int128.op_Explicit()

Explicitly converts a 128-bit signed integer to a System.Decimal value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a System.Decimal.

System.Int128.op_Explicit()

Explicitly converts a 128-bit signed integer to a System.Double value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a System.Double.

System.Int128.op_Explicit()

Explicitly converts a 128-bit signed integer to a System.Half value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a System.Half.

System.Int128.op_Explicit()

Explicitly converts a 128-bit signed integer to a System.Int16 value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a System.Int16.

System.Int128.op_Explicit()

Explicitly converts a 128-bit signed integer to a System.Int32 value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a System.Int32.

System.Int128.op_Explicit()

Explicitly converts a 128-bit signed integer to a System.Int64 value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a System.Int64.

System.Int128.op_Explicit()

Explicitly converts a 128-bit signed integer to a System.IntPtr value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a System.IntPtr.

System.Int128.op_Explicit()

Explicitly converts a 128-bit signed integer to a System.SByte value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a System.SByte.

System.Int128.op_Explicit()

Explicitly converts a 128-bit signed integer to a System.Single value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a System.Single.

System.Int128.op_Explicit()

Explicitly converts a 128-bit signed integer to a System.UInt128 value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a System.UInt128.

System.Int128.op_Explicit()

Explicitly converts a 128-bit signed integer to a System.UInt16 value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a System.UInt16.

System.Int128.op_Explicit()

Explicitly converts a 128-bit signed integer to a System.UInt32 value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a System.UInt32.

System.Int128.op_Explicit()

Explicitly converts a 128-bit signed integer to a System.UInt64 value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a System.UInt64.

System.Int128.op_Explicit()

Explicitly converts a 128-bit signed integer to a System.UIntPtr value.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a System.UIntPtr.

System.Int128.op_Explicit()

Explicitly converts a System.Single value to a 128-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a 128-bit signed integer.

System.Int128.op_GreaterThan()

Compares two values to determine which is greater.

Parameters

NameDescriptionDefault
left The value to compare with
right
.
right The value to compare with
left
.

Returns

true
if
left
is greater than
right
; otherwise,
false
.

System.Int128.op_GreaterThanOrEqual()

Compares two values to determine which is greater or equal.

Parameters

NameDescriptionDefault
left The value to compare with
right
.
right The value to compare with
left
.

Returns

true
if
left
is greater than or equal to
right
; otherwise,
false
.

System.Int128.op_Implicit()

Implicitly converts a System.Byte value to a 128-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a 128-bit signed integer.

System.Int128.op_Implicit()

Implicitly converts a System.Char value to a 128-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a 128-bit signed integer.

System.Int128.op_Implicit()

Implicitly converts a System.Int16 value to a 128-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a 128-bit signed integer.

System.Int128.op_Implicit()

Implicitly converts a System.Int32 value to a 128-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a 128-bit signed integer.

System.Int128.op_Implicit()

Implicitly converts a System.Int64 value to a 128-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a 128-bit signed integer.

System.Int128.op_Implicit()

Implicitly converts a System.IntPtr value to a 128-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a 128-bit signed integer.

System.Int128.op_Implicit()

Implicitly converts a System.SByte value to a 128-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a 128-bit signed integer.

System.Int128.op_Implicit()

Implicitly converts a System.UInt16 value to a 128-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a 128-bit signed integer.

System.Int128.op_Implicit()

Implicitly converts a System.UInt32 value to a 128-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a 128-bit signed integer.

System.Int128.op_Implicit()

Implicitly converts a System.UInt64 value to a 128-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a 128-bit signed integer.

System.Int128.op_Implicit()

Implicitly converts a System.UIntPtr value to a 128-bit signed integer.

Parameters

NameDescriptionDefault
value The value to convert.

Returns

value converted to a 128-bit signed integer.

System.Int128.op_Increment()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing
value
.

System.Int128.op_Inequality()

Compares two values to determine inequality.

Parameters

NameDescriptionDefault
left The value to compare with
right
.
right The value to compare with
left
.

Returns

true
if
left
is not equal to
right
; otherwise,
false
.

System.Int128.op_LeftShift()

Shifts a value left by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted left by
shiftAmount
.
shiftAmount The amount by which
value
is shifted left.

Returns

The result of shifting
value
left by
shiftAmount
.

System.Int128.op_LessThan()

Compares two values to determine which is less.

Parameters

NameDescriptionDefault
left The value to compare with
right
.
right The value to compare with
left
.

Returns

true
if
left
is less than
right
; otherwise,
false
.

System.Int128.op_LessThanOrEqual()

Compares two values to determine which is less or equal.

Parameters

NameDescriptionDefault
left The value to compare with
right
.
right The value to compare with
left
.

Returns

true
if
left
is less than or equal to
right
; otherwise,
false
.

System.Int128.op_Modulus()

Divides two values together to compute their modulus or remainder.

Parameters

NameDescriptionDefault
left The value which
right
divides.
right The value which divides
left
.

Returns

The modulus or remainder of
left
divided-by
right
.

System.Int128.op_Multiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value which
right
multiplies.
right The value which multiplies
left
.

Returns

The product of
left
multiplied-by
right
.

System.Int128.op_OnesComplement()

Computes the ones-complement representation of a given value.

Parameters

NameDescriptionDefault
value The value for which to compute the ones-complement.

Returns

The ones-complement of
value
.

System.Int128.op_RightShift()

Shifts a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted right by
shiftAmount
.
shiftAmount The amount by which
value
is shifted right.

Returns

The result of shifting
value
right by
shiftAmount
.

System.Int128.op_Subtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which
right
is subtracted.
right The value which is subtracted from
left
.

Returns

The difference of
right
subtracted from
left
.

System.Int128.op_UnaryNegation()

Computes the unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of
value
.

System.Int128.op_UnaryPlus()

Computes the unary plus of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary plus.

Returns

The unary plus of
value
.

System.Int128.op_UnsignedRightShift()

Shifts a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted right by
shiftAmount
.
shiftAmount The amount by which
value
is shifted right.

Returns

The result of shifting
value
right by
shiftAmount
.

System.Int128.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.Int128.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.Int128.Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
style A bitwise combination of number styles that can be present in s.
provider An object that provides culture-specific formatting information about s.

Returns

The result of parsing s.

System.Int128.Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.

Returns

The result of parsing
s
.

System.Int128.Parse()

Parses a string into a value.

Parameters

NameDescriptionDefault
s A string containing a number to parse.

Returns

The result of parsing s.

System.Int128.Parse()

Parses a string into a value.

Parameters

NameDescriptionDefault
s A string containing a number to parse.
style A bitwise combination of number styles that can be present in s.

Returns

The result of parsing s.

System.Int128.Parse()

Parses a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
style A bitwise combination of number styles that can be present in s.
provider An object that provides culture-specific formatting information about s.

Returns

The result of parsing s.

System.Int128.Parse()

Parses a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about s.

Returns

The result of parsing s.

System.Int128.PopCount()

Computes the number of bits that are set in a value.

Parameters

NameDescriptionDefault
value The value whose set bits are to be counted.

Returns

The number of set bits in
value
.

System.Int128.RotateLeft()

Rotates a value left by a given amount.

Parameters

NameDescriptionDefault
value The value which is rotated left by
rotateAmount
.
rotateAmount The amount by which
value
is rotated left.

Returns

The result of rotating
value
left by
rotateAmount
.

System.Int128.RotateRight()

Rotates a value right by a given amount.

Parameters

NameDescriptionDefault
value The value which is rotated right by
rotateAmount
.
rotateAmount The amount by which
value
is rotated right.

Returns

The result of rotating
value
right by
rotateAmount
.

System.Int128.Sign()

Computes the sign of a value.

Parameters

NameDescriptionDefault
value The value whose sign is to be computed.

Returns

A positive value if
value
is positive, if
value
is zero, and a negative value if
value
is negative.

System.Int128.System#Numerics#IBinaryInteger<System#Int128>#GetByteCount

Gets the number of bytes that will be written as part of .

Returns

The number of bytes that will be written as part of .

System.Int128.System#Numerics#IBinaryInteger<System#Int128>#GetShortestBitLength

Gets the length, in bits, of the shortest two's complement representation of the current value.

Returns

The length, in bits, of the shortest two's complement representation of the current value.

System.Int128.System#Numerics#IBinaryInteger{System#Int128}#TryReadBigEndian()

Parameters

NameDescriptionDefault
source
isUnsigned
value

System.Int128.System#Numerics#IBinaryInteger{System#Int128}#TryReadLittleEndian()

Parameters

NameDescriptionDefault
source
isUnsigned
value

System.Int128.System#Numerics#IBinaryInteger<System#Int128>#TryWriteBigEndian()

Tries to write the current value, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the value was succesfully written to
destination
; otherwise,
false
.

System.Int128.System#Numerics#IBinaryInteger<System#Int128>#TryWriteLittleEndian()

Tries to write the current value, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the value was succesfully written to
destination
; otherwise,
false
.

System.Int128.System#Numerics#INumber{System#Int128}#MaxNumber()

Compares two values to compute which is greater and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Int128.System#Numerics#INumber{System#Int128}#MinNumber()

Compares two values to compute which is lesser and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Int128.System#Numerics#INumberBase{System#Int128}#IsCanonical()

Determines if a value is in its canonical representation.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is in its canonical representation; otherwise, false.

System.Int128.System#Numerics#INumberBase{System#Int128}#IsComplexNumber()

Determines if a value represents a complex number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a complex number; otherwise, false.

System.Int128.System#Numerics#INumberBase{System#Int128}#IsFinite()

Determines if a value is finite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is finite; otherwise, false.

System.Int128.System#Numerics#INumberBase{System#Int128}#IsImaginaryNumber()

Determines if a value represents a pure imaginary number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a pure imaginary number; otherwise, false.

System.Int128.System#Numerics#INumberBase{System#Int128}#IsInfinity()

Determines if a value is infinite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is infinite; otherwise, false.

System.Int128.System#Numerics#INumberBase{System#Int128}#IsInteger()

Determines if a value represents an integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is an integer; otherwise, false.

System.Int128.System#Numerics#INumberBase{System#Int128}#IsNaN()

Determines if a value is NaN.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is NaN; otherwise, false.

System.Int128.System#Numerics#INumberBase{System#Int128}#IsNegativeInfinity()

Determines if a value is negative infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is negative infinity; otherwise, false.

System.Int128.System#Numerics#INumberBase{System#Int128}#IsNormal()

Determines if a value is normal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is normal; otherwise, false.

System.Int128.System#Numerics#INumberBase{System#Int128}#IsPositiveInfinity()

Determines if a value is positive infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is positive infinity; otherwise, false.

System.Int128.System#Numerics#INumberBase{System#Int128}#IsRealNumber()

Determines if a value represents a real number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a real number; otherwise, false.

System.Int128.System#Numerics#INumberBase{System#Int128}#IsSubnormal()

Determines if a value is subnormal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is subnormal; otherwise, false.

System.Int128.System#Numerics#INumberBase{System#Int128}#IsZero()

Determines if a value is zero.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is zero; otherwise, false.

System.Int128.System#Numerics#INumberBase{System#Int128}#MaxMagnitudeNumber()

Compares two values to compute which has the greater magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Int128.System#Numerics#INumberBase{System#Int128}#MinMagnitudeNumber()

Compares two values to compute which has the lesser magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Int128.System#Numerics#INumberBase{System#Int128}#TryConvertFromChecked``1()

Parameters

NameDescriptionDefault
value
result

System.Int128.System#Numerics#INumberBase{System#Int128}#TryConvertFromSaturating``1()

Parameters

NameDescriptionDefault
value
result

System.Int128.System#Numerics#INumberBase{System#Int128}#TryConvertFromTruncating``1()

Parameters

NameDescriptionDefault
value
result

System.Int128.System#Numerics#INumberBase{System#Int128}#TryConvertToChecked``1()

Tries to convert an instance of the the current type to another type, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Int128.System#Numerics#INumberBase{System#Int128}#TryConvertToSaturating``1()

Tries to convert an instance of the the current type to another type, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Int128.System#Numerics#INumberBase{System#Int128}#TryConvertToTruncating``1()

Tries to convert an instance of the the current type to another type, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Int128.ToString

Returns a string that represents the current object.

Returns

A string that represents the current object.

System.Int128.ToString()

Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

The string representation of the value of this instance as specified by provider.

System.Int128.ToString()

Converts the numeric value of this instance to its equivalent string representation, using the specified format.

Parameters

NameDescriptionDefault
format The format to use, or a null reference to use the default format defined for the type of the System.IFormattable implementation.

Returns

The string representation of the value of this instance as specified by format.

System.Int128.ToString()

Formats the value of the current instance using the specified format.

Parameters

NameDescriptionDefault
format The format to use, or a null reference to use the default format defined for the type of the System.IFormattable implementation.
provider An object that supplies culture-specific formatting information.

Returns

The value of the current instance in the specified format.

System.Int128.TrailingZeroCount()

Computes the number of trailing zeros in a value.

Parameters

NameDescriptionDefault
value The value whose trailing zeroes are to be counted.

Returns

The number of trailing zeros in
value
.

System.Int128.TryFormat()

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

Parameters

NameDescriptionDefault
utf8Destination The span in which to write this instance's value formatted as a span of bytes.
bytesWritten When this method returns, contains the number of bytes that were written in
utf8Destination
.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for
utf8Destination
.
provider An optional object that supplies culture-specific formatting information for
utf8Destination
.

Returns

true
if the formatting was successful; otherwise,
false
.

System.Int128.TryFormat()

Tries to format the value of the current instance into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span in which to write this instance's value formatted as a span of characters.
charsWritten When this method returns, contains the number of characters that were written in destination.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for destination.
provider An optional object that supplies culture-specific formatting information for destination.

Returns

true if the formatting was successful; otherwise, false.

System.Int128.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.Int128.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.Int128.TryParse()

Tries to convert a UTF-8 character span containing the string representation of a number to its 128-bit signed integer equivalent.

Parameters

NameDescriptionDefault
utf8Text A span containing the UTF-8 characters representing the number to convert.
result When this method returns, contains the 128-bit signed integer value equivalent to the number contained in utf8Text if the conversion succeeded, or zero if the conversion failed. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if utf8Text was converted successfully; otherwise, false.

System.Int128.TryParse()

Tries to parse a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
style A bitwise combination of number styles that can be present in s.
provider An object that provides culture-specific formatting information about s.
result When this method returns, contains the result of successfully parsing s or an undefined value on failure.

Returns

true if s was successfully parsed; otherwise, false.

System.Int128.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Int128.TryParse()

Tries to parse a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
result When this method returns, contains the result of successfully parsing s or an undefined value on failure.

Returns

true if s was successfully parsed; otherwise, false.

System.Int128.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
style A bitwise combination of number styles that can be present in s.
provider An object that provides culture-specific formatting information about s.
result When this method returns, contains the result of successfully parsing s or an undefined value on failure.

Returns

true if s was successfully parsed; otherwise, false.

System.Int128.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Int128.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
result When this method returns, contains the result of successfully parsing s or an undefined value on failure.

Returns

true if s was successfully parsed; otherwise, false.

System.Int128.MaxValue

Gets the maximum value of the current type.

System.Int128.MinValue

Gets the minimum value of the current type.

System.Int128.NegativeOne

Gets the value
-1
for the type.

System.Int128.One

Gets the value
1
for the type.

System.Int128.System#Numerics#IAdditiveIdentity{System#Int128@System#Int128}#AdditiveIdentity

Gets the additive identity of the current type.

System.Int128.System#Numerics#IBinaryNumber{System#Int128}#AllBitsSet

Gets an instance of the binary type in which all bits are set.

System.Int128.System#Numerics#IMultiplicativeIdentity{System#Int128@System#Int128}#MultiplicativeIdentity

Gets the multiplicative identity of the current type.

System.Int128.System#Numerics#INumberBase{System#Int128}#Radix

Gets the radix, or base, for the type.

System.Int128.Zero

Gets the value
0
for the type.

System.Int16

Represents a 16-bit signed integer.

System.Int16.MaxValue

Represents the largest possible value of an System.Int16. This field is constant.

System.Int16.MinValue

Represents the smallest possible value of System.Int16. This field is constant.

System.Int16.Abs()

Computes the absolute of a value.

Parameters

NameDescriptionDefault
value The value for which to get its absolute.

Returns

The absolute of
value
.

System.Int16.Clamp()

Clamps a value to an inclusive minimum and maximum value.

Parameters

NameDescriptionDefault
value The value to clamp.
min The inclusive minimum to which
value
should clamp.
max The inclusive maximum to which
value
should clamp.

Returns

The result of clamping
value
to the inclusive range of
min
and
max
.

System.Int16.CompareTo()

Compares this instance to a specified 16-bit signed integer and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified 16-bit signed integer.

Parameters

NameDescriptionDefault
value An integer to compare.

Returns

A signed number indicating the relative values of this instance and value. Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value.

System.Int16.CompareTo()

Compares this instance to a specified object and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the object.

Parameters

NameDescriptionDefault
value An object to compare, or null.

Returns

A signed number indicating the relative values of this instance and value. Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value, or value is null.

System.Int16.CopySign()

Copies the sign of a value to the sign of another value.

Parameters

NameDescriptionDefault
value The value whose magnitude is used in the result.
sign The value whose sign is used in the result.

Returns

A value with the magnitude of
value
and the sign of
sign
.

System.Int16.CreateChecked``1()

Creates an instance of the current type from a value, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
.

System.Int16.CreateSaturating``1()

Creates an instance of the current type from a value, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, saturating if
value
falls outside the representable range of
TSelf
.

System.Int16.CreateTruncating``1()

Creates an instance of the current type from a value, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, truncating if
value
falls outside the representable range of
TSelf
.

System.Int16.DivRem()

Computes the quotient and remainder of two values.

Parameters

NameDescriptionDefault
left The value which
right
divides.
right The value which divides
left
.

Returns

The quotient and remainder of
left
divided-by
right
.

System.Int16.Equals()

Returns a value indicating whether this instance is equal to a specified System.Int16 value.

Parameters

NameDescriptionDefault
obj An System.Int16 value to compare to this instance.

Returns

true if obj has the same value as this instance; otherwise, false.

System.Int16.Equals()

Returns a value indicating whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare to this instance.

Returns

true if obj is an instance of System.Int16 and equals the value of this instance; otherwise, false.

System.Int16.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Int16.GetTypeCode

Returns the System.TypeCode for value type System.Int16.

Returns

The enumerated constant, System.TypeCode.Int16.

System.Int16.IsEvenInteger()

Determines if a value represents an even integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an even integer; otherwise,
false
.

System.Int16.IsNegative()

Determines if a value is negative.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is negative; otherwise,
false
.

System.Int16.IsOddInteger()

Determines if a value represents an odd integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an odd integer; otherwise,
false
.

System.Int16.IsPositive()

Determines if a value is positive.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is positive; otherwise,
false
.

System.Int16.IsPow2()

Determines if a value is a power of two.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is a power of two; otherwise,
false
.

System.Int16.LeadingZeroCount()

Computes the number of leading zeros in a value.

Parameters

NameDescriptionDefault
value The value whose leading zeroes are to be counted.

Returns

The number of leading zeros in
value
.

System.Int16.Log2()

Computes the log2 of a value.

Parameters

NameDescriptionDefault
value The value whose log2 is to be computed.

Returns

The log2 of
value
.

System.Int16.Max()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Int16.MaxMagnitude()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Int16.Min()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Int16.MinMagnitude()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Int16.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.Int16.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.Int16.Parse()

Converts the span representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent.

Parameters

NameDescriptionDefault
s A span containing the characters representing the number to convert.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider An System.IFormatProvider that supplies culture-specific formatting information about s.

Returns

A 16-bit signed integer equivalent to the number specified in s.

System.Int16.Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.

Returns

The result of parsing
s
.

System.Int16.Parse()

Converts the string representation of a number to its 16-bit signed integer equivalent.

Parameters

NameDescriptionDefault
s A string containing a number to convert.

Returns

A 16-bit signed integer equivalent to the number contained in s.

System.Int16.Parse()

Converts the string representation of a number in a specified style to its 16-bit signed integer equivalent.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
style A bitwise combination of the enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.

Returns

A 16-bit signed integer equivalent to the number specified in s.

System.Int16.Parse()

Converts the string representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider An System.IFormatProvider that supplies culture-specific formatting information about s.

Returns

A 16-bit signed integer equivalent to the number specified in s.

System.Int16.Parse()

Converts the string representation of a number in a specified culture-specific format to its 16-bit signed integer equivalent.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
provider An System.IFormatProvider that supplies culture-specific formatting information about s.

Returns

A 16-bit signed integer equivalent to the number specified in s.

System.Int16.PopCount()

Computes the number of bits that are set in a value.

Parameters

NameDescriptionDefault
value The value whose set bits are to be counted.

Returns

The number of set bits in
value
.

System.Int16.RotateLeft()

Rotates a value left by a given amount.

Parameters

NameDescriptionDefault
value The value which is rotated left by
rotateAmount
.
rotateAmount The amount by which
value
is rotated left.

Returns

The result of rotating
value
left by
rotateAmount
.

System.Int16.RotateRight()

Rotates a value right by a given amount.

Parameters

NameDescriptionDefault
value The value which is rotated right by
rotateAmount
.
rotateAmount The amount by which
value
is rotated right.

Returns

The result of rotating
value
right by
rotateAmount
.

System.Int16.Sign()

Computes the sign of a value.

Parameters

NameDescriptionDefault
value The value whose sign is to be computed.

Returns

A positive value if
value
is positive, if
value
is zero, and a negative value if
value
is negative.

System.Int16.System#IConvertible#ToBoolean()

For a description of this member, see System.IConvertible.ToBoolean().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

true if the value of the current instance is not zero; otherwise, false.

System.Int16.System#IConvertible#ToByte()

For a description of this member, see System.IConvertible.ToByte().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Byte.

System.Int16.System#IConvertible#ToChar()

For a description of this member, see System.IConvertible.ToChar().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Char.

System.Int16.System#IConvertible#ToDateTime()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

This conversion is not supported. No value is returned.

System.Int16.System#IConvertible#ToDecimal()

For a description of this member, see System.IConvertible.ToDecimal().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Decimal.

System.Int16.System#IConvertible#ToDouble()

For a description of this member, see System.IConvertible.ToDouble().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Double.

System.Int16.System#IConvertible#ToInt16()

For a description of this member, see System.IConvertible.ToInt16().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, unchanged.

System.Int16.System#IConvertible#ToInt32()

For a description of this member, see System.IConvertible.ToInt32().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.Int32.

System.Int16.System#IConvertible#ToInt64()

For a description of this member, see System.IConvertible.ToInt64().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.Int64.

System.Int16.System#IConvertible#ToSByte()

For a description of this member, see System.IConvertible.ToSByte().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.SByte.

System.Int16.System#IConvertible#ToSingle()

For a description of this member, see System.IConvertible.ToSingle().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Single.

System.Int16.System#IConvertible#ToType()

For a description of this member, see System.IConvertible.ToType().

Parameters

NameDescriptionDefault
type The type to which to convert this System.Int16 value.
provider An System.IFormatProvider implementation that supplies information about the format of the returned value.

Returns

The value of the current instance, converted to type.

System.Int16.System#IConvertible#ToUInt16()

For a description of this member, see System.IConvertible.ToUInt16().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, unchanged.

System.Int16.System#IConvertible#ToUInt32()

For a description of this member, see System.IConvertible.ToUInt32().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt32.

System.Int16.System#IConvertible#ToUInt64()

For a description of this member, see System.IConvertible.ToUInt64().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt64.

System.Int16.System#Numerics#IAdditionOperators{System#Int16@System#Int16@System#Int16}#op_Addition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which right is added.
right The value that's added to left.

Returns

The sum of left and right.

System.Int16.System#Numerics#IAdditionOperators{System#Int16@System#Int16@System#Int16}#op_CheckedAddition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which right is added.
right The value that's added to left.

Returns

The sum of left and right.

System.Int16.System#Numerics#IBinaryInteger<System#Int16>#GetByteCount

Gets the number of bytes that will be written as part of .

Returns

The number of bytes that will be written as part of .

System.Int16.System#Numerics#IBinaryInteger<System#Int16>#GetShortestBitLength

Gets the length, in bits, of the shortest two's complement representation of the current value.

Returns

The length, in bits, of the shortest two's complement representation of the current value.

System.Int16.System#Numerics#IBinaryInteger{System#Int16}#TryReadBigEndian()

Parameters

NameDescriptionDefault
source
isUnsigned
value

System.Int16.System#Numerics#IBinaryInteger{System#Int16}#TryReadLittleEndian()

Parameters

NameDescriptionDefault
source
isUnsigned
value

System.Int16.System#Numerics#IBinaryInteger<System#Int16>#TryWriteBigEndian()

Tries to write the current value, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the value was succesfully written to
destination
; otherwise,
false
.

System.Int16.System#Numerics#IBinaryInteger<System#Int16>#TryWriteLittleEndian()

Tries to write the current value, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the value was succesfully written to
destination
; otherwise,
false
.

System.Int16.System#Numerics#IBitwiseOperators{System#Int16@System#Int16@System#Int16}#op_BitwiseAnd()

Computes the bitwise-and of two values.

Parameters

NameDescriptionDefault
left The value to and with right.
right The value to and with left.

Returns

The bitwise-and of left and right.

System.Int16.System#Numerics#IBitwiseOperators{System#Int16@System#Int16@System#Int16}#op_BitwiseOr()

Computes the bitwise-or of two values.

Parameters

NameDescriptionDefault
left The value to or with right.
right The value to or with left.

Returns

The bitwise-or of left and right.

System.Int16.System#Numerics#IBitwiseOperators{System#Int16@System#Int16@System#Int16}#op_ExclusiveOr()

Computes the exclusive-or of two values.

Parameters

NameDescriptionDefault
left The value to xor with right.
right The value to xor with left.

Returns

The exclusive-or of left and right.

System.Int16.System#Numerics#IBitwiseOperators{System#Int16@System#Int16@System#Int16}#op_OnesComplement()

Computes the ones-complement representation of a given value.

Parameters

NameDescriptionDefault
value The value for which to compute the ones-complement.

Returns

The ones-complement of value.

System.Int16.System#Numerics#IComparisonOperators{System#Int16@System#Int16@System#Boolean}#op_GreaterThan()

Compares two values to determine which is greater.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is greater than right; otherwise, false.

System.Int16.System#Numerics#IComparisonOperators{System#Int16@System#Int16@System#Boolean}#op_GreaterThanOrEqual()

Compares two values to determine which is greater or equal.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is greater than or equal to right; otherwise, false.

System.Int16.System#Numerics#IComparisonOperators{System#Int16@System#Int16@System#Boolean}#op_LessThan()

Compares two values to determine which is less.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is less than right; otherwise, false.

System.Int16.System#Numerics#IComparisonOperators{System#Int16@System#Int16@System#Boolean}#op_LessThanOrEqual()

Compares two values to determine which is less or equal.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is less than or equal to right; otherwise, false.

System.Int16.System#Numerics#IDecrementOperators{System#Int16}#op_CheckedDecrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing value.

System.Int16.System#Numerics#IDecrementOperators{System#Int16}#op_Decrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing value.

System.Int16.System#Numerics#IDivisionOperators{System#Int16@System#Int16@System#Int16}#op_Division()

Divides one value by another to compute their quotient.

Parameters

NameDescriptionDefault
left The value that right divides.
right The value that divides left.

Returns

The quotient of left divided by right.

System.Int16.System#Numerics#IEqualityOperators{System#Int16@System#Int16@System#Boolean}#op_Equality()

Compares two values to determine equality.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is equal to right; otherwise, false.

System.Int16.System#Numerics#IEqualityOperators{System#Int16@System#Int16@System#Boolean}#op_Inequality()

Compares two values to determine inequality.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is not equal to right; otherwise, false.

System.Int16.System#Numerics#IIncrementOperators{System#Int16}#op_CheckedIncrement()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing value.

System.Int16.System#Numerics#IIncrementOperators{System#Int16}#op_Increment()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing value.

System.Int16.System#Numerics#IModulusOperators{System#Int16@System#Int16@System#Int16}#op_Modulus()

Divides two values together to compute their modulus or remainder.

Parameters

NameDescriptionDefault
left The value that right divides.
right The value that divides left.

Returns

The modulus or remainder of left divided by right.

System.Int16.System#Numerics#IMultiplyOperators{System#Int16@System#Int16@System#Int16}#op_CheckedMultiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value that right multiplies.
right The value that multiplies left.

Returns

The product of left multiplied by right.

System.Int16.System#Numerics#IMultiplyOperators{System#Int16@System#Int16@System#Int16}#op_Multiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value that right multiplies.
right The value that multiplies left.

Returns

The product of left multiplied by right.

System.Int16.System#Numerics#INumber{System#Int16}#MaxNumber()

Compares two values to compute which is greater and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Int16.System#Numerics#INumber{System#Int16}#MinNumber()

Compares two values to compute which is lesser and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Int16.System#Numerics#INumberBase{System#Int16}#IsCanonical()

Determines if a value is in its canonical representation.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is in its canonical representation; otherwise, false.

System.Int16.System#Numerics#INumberBase{System#Int16}#IsComplexNumber()

Determines if a value represents a complex number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a complex number; otherwise, false.

System.Int16.System#Numerics#INumberBase{System#Int16}#IsFinite()

Determines if a value is finite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is finite; otherwise, false.

System.Int16.System#Numerics#INumberBase{System#Int16}#IsImaginaryNumber()

Determines if a value represents a pure imaginary number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a pure imaginary number; otherwise, false.

System.Int16.System#Numerics#INumberBase{System#Int16}#IsInfinity()

Determines if a value is infinite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is infinite; otherwise, false.

System.Int16.System#Numerics#INumberBase{System#Int16}#IsInteger()

Determines if a value represents an integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is an integer; otherwise, false.

System.Int16.System#Numerics#INumberBase{System#Int16}#IsNaN()

Determines if a value is NaN.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is NaN; otherwise, false.

System.Int16.System#Numerics#INumberBase{System#Int16}#IsNegativeInfinity()

Determines if a value is negative infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is negative infinity; otherwise, false.

System.Int16.System#Numerics#INumberBase{System#Int16}#IsNormal()

Determines if a value is normal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is normal; otherwise, false.

System.Int16.System#Numerics#INumberBase{System#Int16}#IsPositiveInfinity()

Determines if a value is positive infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is positive infinity; otherwise, false.

System.Int16.System#Numerics#INumberBase{System#Int16}#IsRealNumber()

Determines if a value represents a real number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a real number; otherwise, false.

System.Int16.System#Numerics#INumberBase{System#Int16}#IsSubnormal()

Determines if a value is subnormal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is subnormal; otherwise, false.

System.Int16.System#Numerics#INumberBase{System#Int16}#IsZero()

Determines if a value is zero.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is zero; otherwise, false.

System.Int16.System#Numerics#INumberBase{System#Int16}#MaxMagnitudeNumber()

Compares two values to compute which has the greater magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Int16.System#Numerics#INumberBase{System#Int16}#MinMagnitudeNumber()

Compares two values to compute which has the lesser magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Int16.System#Numerics#INumberBase{System#Int16}#TryConvertFromChecked``1()

Parameters

NameDescriptionDefault
value
result

System.Int16.System#Numerics#INumberBase{System#Int16}#TryConvertFromSaturating``1()

Parameters

NameDescriptionDefault
value
result

System.Int16.System#Numerics#INumberBase{System#Int16}#TryConvertFromTruncating``1()

Parameters

NameDescriptionDefault
value
result

System.Int16.System#Numerics#INumberBase{System#Int16}#TryConvertToChecked``1()

Tries to convert an instance of the the current type to another type, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Int16.System#Numerics#INumberBase{System#Int16}#TryConvertToSaturating``1()

Tries to convert an instance of the the current type to another type, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Int16.System#Numerics#INumberBase{System#Int16}#TryConvertToTruncating``1()

Tries to convert an instance of the the current type to another type, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Int16.System#Numerics#IShiftOperators{System#Int16@System#Int32@System#Int16}#op_LeftShift()

Shifts a value left by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted left by shiftAmount.
shiftAmount The amount by which value is shifted left.

Returns

The result of shifting value left by shiftAmount.

System.Int16.System#Numerics#IShiftOperators{System#Int16@System#Int32@System#Int16}#op_RightShift()

Shifts a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted right by shiftAmount.
shiftAmount The amount by which value is shifted right.

Returns

The result of shifting value right by shiftAmount.

System.Int16.System#Numerics#IShiftOperators{System#Int16@System#Int32@System#Int16}#op_UnsignedRightShift()

Shifts a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted right by shiftAmount.
shiftAmount The amount by which value is shifted right.

Returns

The result of shifting value right by shiftAmount.

System.Int16.System#Numerics#ISubtractionOperators{System#Int16@System#Int16@System#Int16}#op_CheckedSubtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which right is subtracted.
right The value that's subtracted from left.

Returns

The value of right subtracted from left.

System.Int16.System#Numerics#ISubtractionOperators{System#Int16@System#Int16@System#Int16}#op_Subtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which right is subtracted.
right The value that's subtracted from left.

Returns

The value of right subtracted from left.

System.Int16.System#Numerics#IUnaryNegationOperators{System#Int16@System#Int16}#op_CheckedUnaryNegation()

Computes the checked unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of value.

System.Int16.System#Numerics#IUnaryNegationOperators{System#Int16@System#Int16}#op_UnaryNegation()

Computes the unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of value.

System.Int16.System#Numerics#IUnaryPlusOperators{System#Int16@System#Int16}#op_UnaryPlus()

Computes the unary plus of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary plus.

Returns

The unary plus of value.

System.Int16.ToString

Converts the numeric value of this instance to its equivalent string representation.

Returns

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

System.Int16.ToString()

Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider that supplies culture-specific formatting information.

Returns

The string representation of the value of this instance as specified by provider.

System.Int16.ToString()

Converts the numeric value of this instance to its equivalent string representation, using the specified format.

Parameters

NameDescriptionDefault
format A numeric format string.

Returns

The string representation of the value of this instance as specified by format.

System.Int16.ToString()

Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific formatting information.

Parameters

NameDescriptionDefault
format A numeric format string.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of the value of this instance as specified by format and provider.

System.Int16.TrailingZeroCount()

Computes the number of trailing zeros in a value.

Parameters

NameDescriptionDefault
value The value whose trailing zeroes are to be counted.

Returns

The number of trailing zeros in
value
.

System.Int16.TryFormat()

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

Parameters

NameDescriptionDefault
utf8Destination The span in which to write this instance's value formatted as a span of bytes.
bytesWritten When this method returns, contains the number of bytes that were written in
utf8Destination
.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for
utf8Destination
.
provider An optional object that supplies culture-specific formatting information for
utf8Destination
.

Returns

true
if the formatting was successful; otherwise,
false
.

System.Int16.TryFormat()

Tries to format the value of the current short number instance into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span in which to write this instance's value formatted as a span of characters.
charsWritten When this method returns, contains the number of characters that were written in destination.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for destination.
provider An optional object that supplies culture-specific formatting information for destination.

Returns

true if the formatting was successful; otherwise, false.

System.Int16.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.Int16.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.Int16.TryParse()

Tries to convert a UTF-8 character span containing the string representation of a number to its 16-bit signed integer equivalent.

Parameters

NameDescriptionDefault
utf8Text A span containing the UTF-8 characters representing the number to convert.
result When this method returns, contains the 16-bit signed integer value equivalent to the number contained in utf8Text if the conversion succeeded, or zero if the conversion failed. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if utf8Text was converted successfully; otherwise, false.

System.Int16.TryParse()

Converts the span representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A span containing the characters representing the number to convert. The span is interpreted using the style specified by style.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider An object that supplies culture-specific formatting information about s.
result When this method returns, contains the 16-bit signed integer 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 or System.String.Empty, is not in a format compliant with style, or represents a number less than Int16.MinValue or greater than Int16.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Int16.TryParse()

Tries to parse a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
, or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Int16.TryParse()

Converts the span representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A span containing the characters that represent the number to convert.
result When this method returns, contains the 16-bit signed integer 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 or System.String.Empty, is not in a format compliant with style, or represents a number less than Int16.MinValue or greater than Int16.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Int16.TryParse()

Converts the string representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A string containing a number to convert. The string is interpreted using the style specified by style.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider An object that supplies culture-specific formatting information about s.
result When this method returns, contains the 16-bit signed integer 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 or System.String.Empty, is not in a format compliant with style, or represents a number less than Int16.MinValue or greater than Int16.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Int16.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Int16.TryParse()

Converts the string representation of a number to its 16-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
result When this method returns, contains the 16-bit signed integer 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 or System.String.Empty, is not of the correct format, or represents a number less than Int16.MinValue or greater than Int16.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Int16.System#Numerics#IAdditiveIdentity{System#Int16@System#Int16}#AdditiveIdentity

Gets the additive identity of the current type.

System.Int16.System#Numerics#IBinaryNumber{System#Int16}#AllBitsSet

Gets an instance of the binary type in which all bits are set.

System.Int16.System#Numerics#IMinMaxValue{System#Int16}#MaxValue

Gets the maximum value of the current type.

System.Int16.System#Numerics#IMinMaxValue{System#Int16}#MinValue

Gets the minimum value of the current type.

System.Int16.System#Numerics#IMultiplicativeIdentity{System#Int16@System#Int16}#MultiplicativeIdentity

Gets the multiplicative identity of the current type.

System.Int16.System#Numerics#INumberBase{System#Int16}#One

Gets the value 1 for the type.

System.Int16.System#Numerics#INumberBase{System#Int16}#Radix

Gets the radix, or base, for the type.

System.Int16.System#Numerics#INumberBase{System#Int16}#Zero

Gets the value 0 for the type.

System.Int16.System#Numerics#ISignedNumber{System#Int16}#NegativeOne

Gets the value -1 for the type.

System.Int32

Represents a 32-bit signed integer.

System.Int32.MaxValue

Represents the largest possible value of an System.Int32. This field is constant.

System.Int32.MinValue

Represents the smallest possible value of System.Int32. This field is constant.

System.Int32.Abs()

Computes the absolute of a value.

Parameters

NameDescriptionDefault
value The value for which to get its absolute.

Returns

The absolute of
value
.

System.Int32.Clamp()

Clamps a value to an inclusive minimum and maximum value.

Parameters

NameDescriptionDefault
value The value to clamp.
min The inclusive minimum to which
value
should clamp.
max The inclusive maximum to which
value
should clamp.

Returns

The result of clamping
value
to the inclusive range of
min
and
max
.

System.Int32.CompareTo()

Compares this instance to a specified 32-bit signed integer and returns an indication of their relative values.

Parameters

NameDescriptionDefault
value An integer to compare.

Returns

A signed number indicating the relative values of this instance and value. Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value.

System.Int32.CompareTo()

Compares this instance to a specified object and returns an indication of their relative values.

Parameters

NameDescriptionDefault
value An object to compare, or null.

Returns

A signed number indicating the relative values of this instance and value. Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value, or value is null.

System.Int32.CopySign()

Copies the sign of a value to the sign of another value.

Parameters

NameDescriptionDefault
value The value whose magnitude is used in the result.
sign The value whose sign is used in the result.

Returns

A value with the magnitude of
value
and the sign of
sign
.

System.Int32.CreateChecked``1()

Creates an instance of the current type from a value, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
.

System.Int32.CreateSaturating``1()

Creates an instance of the current type from a value, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, saturating if
value
falls outside the representable range of
TSelf
.

System.Int32.CreateTruncating``1()

Creates an instance of the current type from a value, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, truncating if
value
falls outside the representable range of
TSelf
.

System.Int32.DivRem()

Computes the quotient and remainder of two values.

Parameters

NameDescriptionDefault
left The value which
right
divides.
right The value which divides
left
.

Returns

The quotient and remainder of
left
divided-by
right
.

System.Int32.Equals()

Returns a value indicating whether this instance is equal to a specified System.Int32 value.

Parameters

NameDescriptionDefault
obj An System.Int32 value to compare to this instance.

Returns

true if obj has the same value as this instance; otherwise, false.

System.Int32.Equals()

Returns a value indicating whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance.

Returns

true if obj is an instance of System.Int32 and equals the value of this instance; otherwise, false.

System.Int32.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Int32.GetTypeCode

Returns the System.TypeCode for value type System.Int32.

Returns

The enumerated constant, System.TypeCode.Int32.

System.Int32.IsEvenInteger()

Determines if a value represents an even integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an even integer; otherwise,
false
.

System.Int32.IsNegative()

Determines if a value is negative.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is negative; otherwise,
false
.

System.Int32.IsOddInteger()

Determines if a value represents an odd integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an odd integer; otherwise,
false
.

System.Int32.IsPositive()

Determines if a value is positive.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is positive; otherwise,
false
.

System.Int32.IsPow2()

Determines if a value is a power of two.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is a power of two; otherwise,
false
.

System.Int32.LeadingZeroCount()

Computes the number of leading zeros in a value.

Parameters

NameDescriptionDefault
value The value whose leading zeroes are to be counted.

Returns

The number of leading zeros in
value
.

System.Int32.Log2()

Computes the log2 of a value.

Parameters

NameDescriptionDefault
value The value whose log2 is to be computed.

Returns

The log2 of
value
.

System.Int32.Max()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Int32.MaxMagnitude()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Int32.Min()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Int32.MinMagnitude()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Int32.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.Int32.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.Int32.Parse()

Converts the span representation of a number in a specified style and culture-specific format to its 32-bit signed integer equivalent.

Parameters

NameDescriptionDefault
s A span containing the characters representing the number to convert.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider An object that supplies culture-specific information about the format of s.

Returns

A 32-bit signed integer equivalent to the number specified in s.

System.Int32.Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.

Returns

The result of parsing
s
.

System.Int32.Parse()

Converts the string representation of a number to its 32-bit signed integer equivalent.

Parameters

NameDescriptionDefault
s A string containing a number to convert.

Returns

A 32-bit signed integer equivalent to the number contained in s.

System.Int32.Parse()

Converts the string representation of a number in a specified style to its 32-bit signed integer equivalent.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
style A bitwise combination of the enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.

Returns

A 32-bit signed integer equivalent to the number specified in s.

System.Int32.Parse()

Converts the string representation of a number in a specified style and culture-specific format to its 32-bit signed integer equivalent.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider An object that supplies culture-specific information about the format of s.

Returns

A 32-bit signed integer equivalent to the number specified in s.

System.Int32.Parse()

Converts the string representation of a number in a specified culture-specific format to its 32-bit signed integer equivalent.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
provider An object that supplies culture-specific formatting information about s.

Returns

A 32-bit signed integer equivalent to the number specified in s.

System.Int32.PopCount()

Computes the number of bits that are set in a value.

Parameters

NameDescriptionDefault
value The value whose set bits are to be counted.

Returns

The number of set bits in
value
.

System.Int32.RotateLeft()

Rotates a value left by a given amount.

Parameters

NameDescriptionDefault
value The value which is rotated left by
rotateAmount
.
rotateAmount The amount by which
value
is rotated left.

Returns

The result of rotating
value
left by
rotateAmount
.

System.Int32.RotateRight()

Rotates a value right by a given amount.

Parameters

NameDescriptionDefault
value The value which is rotated right by
rotateAmount
.
rotateAmount The amount by which
value
is rotated right.

Returns

The result of rotating
value
right by
rotateAmount
.

System.Int32.Sign()

Computes the sign of a value.

Parameters

NameDescriptionDefault
value The value whose sign is to be computed.

Returns

A positive value if
value
is positive, if
value
is zero, and a negative value if
value
is negative.

System.Int32.System#IConvertible#ToBoolean()

For a description of this member, see System.IConvertible.ToBoolean().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

true if the value of the current instance is not zero; otherwise, false.

System.Int32.System#IConvertible#ToByte()

For a description of this member, see System.IConvertible.ToByte().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Byte.

System.Int32.System#IConvertible#ToChar()

For a description of this member, see System.IConvertible.ToChar().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Char.

System.Int32.System#IConvertible#ToDateTime()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

This conversion is not supported. No value is returned.

System.Int32.System#IConvertible#ToDecimal()

For a description of this member, see System.IConvertible.ToDecimal().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Decimal.

System.Int32.System#IConvertible#ToDouble()

For a description of this member, see System.IConvertible.ToDouble().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Double.

System.Int32.System#IConvertible#ToInt16()

For a description of this member, see System.IConvertible.ToInt16().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.Int16.

System.Int32.System#IConvertible#ToInt32()

For a description of this member, see System.IConvertible.ToInt32().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, unchanged.

System.Int32.System#IConvertible#ToInt64()

For a description of this member, see System.IConvertible.ToInt64().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.Int64.

System.Int32.System#IConvertible#ToSByte()

For a description of this member, see System.IConvertible.ToSByte().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.SByte.

System.Int32.System#IConvertible#ToSingle()

For a description of this member, see System.IConvertible.ToSingle().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Single.

System.Int32.System#IConvertible#ToType()

For a description of this member, see System.IConvertible.ToType().

Parameters

NameDescriptionDefault
type The type to which to convert this System.Int32 value.
provider An object that provides information about the format of the returned value.

Returns

The value of the current instance, converted to type.

System.Int32.System#IConvertible#ToUInt16()

For a description of this member, see System.IConvertible.ToUInt16().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt16.

System.Int32.System#IConvertible#ToUInt32()

For a description of this member, see System.IConvertible.ToUInt32().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt32.

System.Int32.System#IConvertible#ToUInt64()

For a description of this member, see System.IConvertible.ToUInt64().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt64.

System.Int32.System#Numerics#IAdditionOperators{System#Int32@System#Int32@System#Int32}#op_Addition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which right is added.
right The value that's added to left.

Returns

The sum of left and right.

System.Int32.System#Numerics#IAdditionOperators{System#Int32@System#Int32@System#Int32}#op_CheckedAddition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which right is added.
right The value that's added to left.

Returns

The sum of left and right.

System.Int32.System#Numerics#IBinaryInteger<System#Int32>#GetByteCount

Gets the number of bytes that will be written as part of .

Returns

The number of bytes that will be written as part of .

System.Int32.System#Numerics#IBinaryInteger<System#Int32>#GetShortestBitLength

Gets the length, in bits, of the shortest two's complement representation of the current value.

Returns

The length, in bits, of the shortest two's complement representation of the current value.

System.Int32.System#Numerics#IBinaryInteger{System#Int32}#TryReadBigEndian()

Parameters

NameDescriptionDefault
source
isUnsigned
value

System.Int32.System#Numerics#IBinaryInteger{System#Int32}#TryReadLittleEndian()

Parameters

NameDescriptionDefault
source
isUnsigned
value

System.Int32.System#Numerics#IBinaryInteger<System#Int32>#TryWriteBigEndian()

Tries to write the current value, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the value was succesfully written to
destination
; otherwise,
false
.

System.Int32.System#Numerics#IBinaryInteger<System#Int32>#TryWriteLittleEndian()

Tries to write the current value, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the value was succesfully written to
destination
; otherwise,
false
.

System.Int32.System#Numerics#IBitwiseOperators{System#Int32@System#Int32@System#Int32}#op_BitwiseAnd()

Computes the bitwise-and of two values.

Parameters

NameDescriptionDefault
left The value to and with right.
right The value to and with left.

Returns

The bitwise-and of left and right.

System.Int32.System#Numerics#IBitwiseOperators{System#Int32@System#Int32@System#Int32}#op_BitwiseOr()

Computes the bitwise-or of two values.

Parameters

NameDescriptionDefault
left The value to or with right.
right The value to or with left.

Returns

The bitwise-or of left and right.

System.Int32.System#Numerics#IBitwiseOperators{System#Int32@System#Int32@System#Int32}#op_ExclusiveOr()

Computes the exclusive-or of two values.

Parameters

NameDescriptionDefault
left The value to xor with right.
right The value to xor with left.

Returns

The exclusive-or of left and right.

System.Int32.System#Numerics#IBitwiseOperators{System#Int32@System#Int32@System#Int32}#op_OnesComplement()

Computes the ones-complement representation of a given value.

Parameters

NameDescriptionDefault
value The value for which to compute the ones-complement.

Returns

The ones-complement of value.

System.Int32.System#Numerics#IComparisonOperators{System#Int32@System#Int32@System#Boolean}#op_GreaterThan()

Compares two values to determine which is greater.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is greater than right; otherwise, false.

System.Int32.System#Numerics#IComparisonOperators{System#Int32@System#Int32@System#Boolean}#op_GreaterThanOrEqual()

Compares two values to determine which is greater or equal.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is greater than or equal to right; otherwise, false.

System.Int32.System#Numerics#IComparisonOperators{System#Int32@System#Int32@System#Boolean}#op_LessThan()

Compares two values to determine which is less.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is less than right; otherwise, false.

System.Int32.System#Numerics#IComparisonOperators{System#Int32@System#Int32@System#Boolean}#op_LessThanOrEqual()

Compares two values to determine which is less or equal.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is less than or equal to right; otherwise, false.

System.Int32.System#Numerics#IDecrementOperators{System#Int32}#op_CheckedDecrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing value.

System.Int32.System#Numerics#IDecrementOperators{System#Int32}#op_Decrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing value.

System.Int32.System#Numerics#IDivisionOperators{System#Int32@System#Int32@System#Int32}#op_Division()

Divides one value by another to compute their quotient.

Parameters

NameDescriptionDefault
left The value that right divides.
right The value that divides left.

Returns

The quotient of left divided by right.

System.Int32.System#Numerics#IEqualityOperators{System#Int32@System#Int32@System#Boolean}#op_Equality()

Compares two values to determine equality.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is equal to right; otherwise, false.

System.Int32.System#Numerics#IEqualityOperators{System#Int32@System#Int32@System#Boolean}#op_Inequality()

Compares two values to determine inequality.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is not equal to right; otherwise, false.

System.Int32.System#Numerics#IIncrementOperators{System#Int32}#op_CheckedIncrement()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing value.

System.Int32.System#Numerics#IIncrementOperators{System#Int32}#op_Increment()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing value.

System.Int32.System#Numerics#IModulusOperators{System#Int32@System#Int32@System#Int32}#op_Modulus()

Divides two values together to compute their modulus or remainder.

Parameters

NameDescriptionDefault
left The value that right divides.
right The value that divides left.

Returns

The modulus or remainder of left divided by right.

System.Int32.System#Numerics#IMultiplyOperators{System#Int32@System#Int32@System#Int32}#op_CheckedMultiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value that right multiplies.
right The value that multiplies left.

Returns

The product of left multiplied by right.

System.Int32.System#Numerics#IMultiplyOperators{System#Int32@System#Int32@System#Int32}#op_Multiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value that right multiplies.
right The value that multiplies left.

Returns

The product of left multiplied by right.

System.Int32.System#Numerics#INumber{System#Int32}#MaxNumber()

Compares two values to compute which is greater and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Int32.System#Numerics#INumber{System#Int32}#MinNumber()

Compares two values to compute which is lesser and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Int32.System#Numerics#INumberBase{System#Int32}#IsCanonical()

Determines if a value is in its canonical representation.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is in its canonical representation; otherwise, false.

System.Int32.System#Numerics#INumberBase{System#Int32}#IsComplexNumber()

Determines if a value represents a complex number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a complex number; otherwise, false.

System.Int32.System#Numerics#INumberBase{System#Int32}#IsFinite()

Determines if a value is finite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is finite; otherwise, false.

System.Int32.System#Numerics#INumberBase{System#Int32}#IsImaginaryNumber()

Determines if a value represents a pure imaginary number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a pure imaginary number; otherwise, false.

System.Int32.System#Numerics#INumberBase{System#Int32}#IsInfinity()

Determines if a value is infinite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is infinite; otherwise, false.

System.Int32.System#Numerics#INumberBase{System#Int32}#IsInteger()

Determines if a value represents an integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is an integer; otherwise, false.

System.Int32.System#Numerics#INumberBase{System#Int32}#IsNaN()

Determines if a value is NaN.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is NaN; otherwise, false.

System.Int32.System#Numerics#INumberBase{System#Int32}#IsNegativeInfinity()

Determines if a value is negative infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is negative infinity; otherwise, false.

System.Int32.System#Numerics#INumberBase{System#Int32}#IsNormal()

Determines if a value is normal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is normal; otherwise, false.

System.Int32.System#Numerics#INumberBase{System#Int32}#IsPositiveInfinity()

Determines if a value is positive infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is positive infinity; otherwise, false.

System.Int32.System#Numerics#INumberBase{System#Int32}#IsRealNumber()

Determines if a value represents a real number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a real number; otherwise, false.

System.Int32.System#Numerics#INumberBase{System#Int32}#IsSubnormal()

Determines if a value is subnormal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is subnormal; otherwise, false.

System.Int32.System#Numerics#INumberBase{System#Int32}#IsZero()

Determines if a value is zero.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is zero; otherwise, false.

System.Int32.System#Numerics#INumberBase{System#Int32}#MaxMagnitudeNumber()

Compares two values to compute which has the greater magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Int32.System#Numerics#INumberBase{System#Int32}#MinMagnitudeNumber()

Compares two values to compute which has the lesser magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Int32.System#Numerics#INumberBase{System#Int32}#TryConvertFromChecked``1()

Parameters

NameDescriptionDefault
value
result

System.Int32.System#Numerics#INumberBase{System#Int32}#TryConvertFromSaturating``1()

Parameters

NameDescriptionDefault
value
result

System.Int32.System#Numerics#INumberBase{System#Int32}#TryConvertFromTruncating``1()

Parameters

NameDescriptionDefault
value
result

System.Int32.System#Numerics#INumberBase{System#Int32}#TryConvertToChecked``1()

Tries to convert an instance of the the current type to another type, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Int32.System#Numerics#INumberBase{System#Int32}#TryConvertToSaturating``1()

Tries to convert an instance of the the current type to another type, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Int32.System#Numerics#INumberBase{System#Int32}#TryConvertToTruncating``1()

Tries to convert an instance of the the current type to another type, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Int32.System#Numerics#IShiftOperators{System#Int32@System#Int32@System#Int32}#op_LeftShift()

Shifts a value left by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted left by shiftAmount.
shiftAmount The amount by which value is shifted left.

Returns

The result of shifting value left by shiftAmount.

System.Int32.System#Numerics#IShiftOperators{System#Int32@System#Int32@System#Int32}#op_RightShift()

Shifts a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted right by shiftAmount.
shiftAmount The amount by which value is shifted right.

Returns

The result of shifting value right by shiftAmount.

System.Int32.System#Numerics#IShiftOperators{System#Int32@System#Int32@System#Int32}#op_UnsignedRightShift()

Shifts a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted right by shiftAmount.
shiftAmount The amount by which value is shifted right.

Returns

The result of shifting value right by shiftAmount.

System.Int32.System#Numerics#ISubtractionOperators{System#Int32@System#Int32@System#Int32}#op_CheckedSubtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which right is subtracted.
right The value that's subtracted from left.

Returns

The value of right subtracted from left.

System.Int32.System#Numerics#ISubtractionOperators{System#Int32@System#Int32@System#Int32}#op_Subtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which right is subtracted.
right The value that's subtracted from left.

Returns

The value of right subtracted from left.

System.Int32.System#Numerics#IUnaryNegationOperators{System#Int32@System#Int32}#op_CheckedUnaryNegation()

Computes the checked unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of value.

System.Int32.System#Numerics#IUnaryNegationOperators{System#Int32@System#Int32}#op_UnaryNegation()

Computes the unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of value.

System.Int32.System#Numerics#IUnaryPlusOperators{System#Int32@System#Int32}#op_UnaryPlus()

Computes the unary plus of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary plus.

Returns

The unary plus of value.

System.Int32.ToString

Converts the numeric value of this instance to its equivalent string representation.

Returns

The string representation of the value of this instance, consisting of a negative sign if the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeroes.

System.Int32.ToString()

Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

The string representation of the value of this instance as specified by provider.

System.Int32.ToString()

Converts the numeric value of this instance to its equivalent string representation, using the specified format.

Parameters

NameDescriptionDefault
format A standard or custom numeric format string.

Returns

The string representation of the value of this instance as specified by format.

System.Int32.ToString()

Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information.

Parameters

NameDescriptionDefault
format A standard or custom numeric format string.
provider An object that supplies culture-specific formatting information.

Returns

The string representation of the value of this instance as specified by format and provider.

System.Int32.TrailingZeroCount()

Computes the number of trailing zeros in a value.

Parameters

NameDescriptionDefault
value The value whose trailing zeroes are to be counted.

Returns

The number of trailing zeros in
value
.

System.Int32.TryFormat()

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

Parameters

NameDescriptionDefault
utf8Destination The span in which to write this instance's value formatted as a span of bytes.
bytesWritten When this method returns, contains the number of bytes that were written in
utf8Destination
.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for
utf8Destination
.
provider An optional object that supplies culture-specific formatting information for
utf8Destination
.

Returns

true
if the formatting was successful; otherwise,
false
.

System.Int32.TryFormat()

Tries to format the value of the current integer number instance into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span in which to write this instance's value formatted as a span of characters.
charsWritten When this method returns, contains the number of characters that were written in destination.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for destination.
provider An optional object that supplies culture-specific formatting information for destination.

Returns

true if the formatting was successful; otherwise, false.

System.Int32.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.Int32.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.Int32.TryParse()

Tries to convert a UTF-8 character span containing the string representation of a number to its 32-bit signed integer equivalent.

Parameters

NameDescriptionDefault
utf8Text A span containing the UTF-8 characters representing the number to convert.
result When this method returns, contains the 32-bit signed integer value equivalent to the number contained in utf8Text if the conversion succeeded, or zero if the conversion failed. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if utf8Text was converted successfully; otherwise, false.

System.Int32.TryParse()

Converts the span representation of a number in a specified style and culture-specific format to its 32-bit signed integer equivalent. A return value indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A span containing the characters that represent the number to convert. The span is interpreted using the style specified by style.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider An object that supplies culture-specific formatting information about s.
result When this method returns, contains the 32-bit signed integer value equivalent of the number contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or System.String.Empty, is not in a format compliant with style, or represents a number less than Int32.MinValue or greater than Int32.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Int32.TryParse()

Tries to parse a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
, or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Int32.TryParse()

Converts the span representation of a number in a specified style and culture-specific format to its 32-bit signed integer equivalent. A return value indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A span containing the characters that represent the number to convert.
result When this method returns, contains the 32-bit signed integer value equivalent of the number contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or System.String.Empty, is not in a format compliant with style, or represents a number less than Int32.MinValue or greater than Int32.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Int32.TryParse()

Converts the string representation of a number in a specified style and culture-specific format to its 32-bit signed integer equivalent. A return value indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A string containing a number to convert. The string is interpreted using the style specified by style.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider An object that supplies culture-specific formatting information about s.
result When this method returns, contains the 32-bit signed integer value equivalent of the number contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or System.String.Empty, is not in a format compliant with style, or represents a number less than Int32.MinValue or greater than Int32.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Int32.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Int32.TryParse()

Converts the string representation of a number to its 32-bit signed integer equivalent. A return value indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
result When this method returns, contains the 32-bit signed integer value equivalent of the number contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or System.String.Empty, is not of the correct format, or represents a number less than Int32.MinValue or greater than Int32.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Int32.System#Numerics#IAdditiveIdentity{System#Int32@System#Int32}#AdditiveIdentity

Gets the additive identity of the current type.

System.Int32.System#Numerics#IBinaryNumber{System#Int32}#AllBitsSet

Gets an instance of the binary type in which all bits are set.

System.Int32.System#Numerics#IMinMaxValue{System#Int32}#MaxValue

Gets the maximum value of the current type.

System.Int32.System#Numerics#IMinMaxValue{System#Int32}#MinValue

Gets the minimum value of the current type.

System.Int32.System#Numerics#IMultiplicativeIdentity{System#Int32@System#Int32}#MultiplicativeIdentity

Gets the multiplicative identity of the current type.

System.Int32.System#Numerics#INumberBase{System#Int32}#One

Gets the value 1 for the type.

System.Int32.System#Numerics#INumberBase{System#Int32}#Radix

Gets the radix, or base, for the type.

System.Int32.System#Numerics#INumberBase{System#Int32}#Zero

Gets the value 0 for the type.

System.Int32.System#Numerics#ISignedNumber{System#Int32}#NegativeOne

Gets the value -1 for the type.

System.Int64

Represents a 64-bit signed integer.

System.Int64.MaxValue

Represents the largest possible value of an System.Int64. This field is constant.

System.Int64.MinValue

Represents the smallest possible value of an System.Int64. This field is constant.

System.Int64.Abs()

Computes the absolute of a value.

Parameters

NameDescriptionDefault
value The value for which to get its absolute.

Returns

The absolute of
value
.

System.Int64.Clamp()

Clamps a value to an inclusive minimum and maximum value.

Parameters

NameDescriptionDefault
value The value to clamp.
min The inclusive minimum to which
value
should clamp.
max The inclusive maximum to which
value
should clamp.

Returns

The result of clamping
value
to the inclusive range of
min
and
max
.

System.Int64.CompareTo()

Compares this instance to a specified 64-bit signed integer and returns an indication of their relative values.

Parameters

NameDescriptionDefault
value An integer to compare.

Returns

A signed number indicating the relative values of this instance and value. Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value.

System.Int64.CompareTo()

Compares this instance to a specified object and returns an indication of their relative values.

Parameters

NameDescriptionDefault
value An object to compare, or null.

Returns

A signed number indicating the relative values of this instance and value. Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value, or value is null.

System.Int64.CopySign()

Copies the sign of a value to the sign of another value.

Parameters

NameDescriptionDefault
value The value whose magnitude is used in the result.
sign The value whose sign is used in the result.

Returns

A value with the magnitude of
value
and the sign of
sign
.

System.Int64.CreateChecked``1()

Creates an instance of the current type from a value, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
.

System.Int64.CreateSaturating``1()

Creates an instance of the current type from a value, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, saturating if
value
falls outside the representable range of
TSelf
.

System.Int64.CreateTruncating``1()

Creates an instance of the current type from a value, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, truncating if
value
falls outside the representable range of
TSelf
.

System.Int64.DivRem()

Computes the quotient and remainder of two values.

Parameters

NameDescriptionDefault
left The value which
right
divides.
right The value which divides
left
.

Returns

The quotient and remainder of
left
divided-by
right
.

System.Int64.Equals()

Returns a value indicating whether this instance is equal to a specified System.Int64 value.

Parameters

NameDescriptionDefault
obj An System.Int64 value to compare to this instance.

Returns

true if obj has the same value as this instance; otherwise, false.

System.Int64.Equals()

Returns a value indicating whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance.

Returns

true if obj is an instance of an System.Int64 and equals the value of this instance; otherwise, false.

System.Int64.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Int64.GetTypeCode

Returns the System.TypeCode for value type System.Int64.

Returns

The enumerated constant, System.TypeCode.Int64.

System.Int64.IsEvenInteger()

Determines if a value represents an even integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an even integer; otherwise,
false
.

System.Int64.IsNegative()

Determines if a value is negative.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is negative; otherwise,
false
.

System.Int64.IsOddInteger()

Determines if a value represents an odd integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an odd integer; otherwise,
false
.

System.Int64.IsPositive()

Determines if a value is positive.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is positive; otherwise,
false
.

System.Int64.IsPow2()

Determines if a value is a power of two.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is a power of two; otherwise,
false
.

System.Int64.LeadingZeroCount()

Computes the number of leading zeros in a value.

Parameters

NameDescriptionDefault
value The value whose leading zeroes are to be counted.

Returns

The number of leading zeros in
value
.

System.Int64.Log2()

Computes the log2 of a value.

Parameters

NameDescriptionDefault
value The value whose log2 is to be computed.

Returns

The log2 of
value
.

System.Int64.Max()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Int64.MaxMagnitude()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.Int64.Min()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Int64.MinMagnitude()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.Int64.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.Int64.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.Int64.Parse()

Converts the span representation of a number in a specified style and culture-specific format to its 64-bit signed integer equivalent.

Parameters

NameDescriptionDefault
s A span containing the characters representing the number to convert.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider An System.IFormatProvider that supplies culture-specific formatting information about s.

Returns

A 64-bit signed integer equivalent to the number specified in s.

System.Int64.Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.

Returns

The result of parsing
s
.

System.Int64.Parse()

Converts the string representation of a number to its 64-bit signed integer equivalent.

Parameters

NameDescriptionDefault
s A string containing a number to convert.

Returns

A 64-bit signed integer equivalent to the number contained in s.

System.Int64.Parse()

Converts the string representation of a number in a specified style to its 64-bit signed integer equivalent.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
style A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s. A typical value to specify is System.Globalization.NumberStyles.Integer.

Returns

A 64-bit signed integer equivalent to the number specified in s.

System.Int64.Parse()

Converts the string representation of a number in a specified style and culture-specific format to its 64-bit signed integer equivalent.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider An System.IFormatProvider that supplies culture-specific formatting information about s.

Returns

A 64-bit signed integer equivalent to the number specified in s.

System.Int64.Parse()

Converts the string representation of a number in a specified culture-specific format to its 64-bit signed integer equivalent.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
provider An object that supplies culture-specific formatting information about s.

Returns

A 64-bit signed integer equivalent to the number specified in s.

System.Int64.PopCount()

Computes the number of bits that are set in a value.

Parameters

NameDescriptionDefault
value The value whose set bits are to be counted.

Returns

The number of set bits in
value
.

System.Int64.RotateLeft()

Rotates a value left by a given amount.

Parameters

NameDescriptionDefault
value The value which is rotated left by
rotateAmount
.
rotateAmount The amount by which
value
is rotated left.

Returns

The result of rotating
value
left by
rotateAmount
.

System.Int64.RotateRight()

Rotates a value right by a given amount.

Parameters

NameDescriptionDefault
value The value which is rotated right by
rotateAmount
.
rotateAmount The amount by which
value
is rotated right.

Returns

The result of rotating
value
right by
rotateAmount
.

System.Int64.Sign()

Computes the sign of a value.

Parameters

NameDescriptionDefault
value The value whose sign is to be computed.

Returns

A positive value if
value
is positive, if
value
is zero, and a negative value if
value
is negative.

System.Int64.System#IConvertible#ToBoolean()

For a description of this member, see System.IConvertible.ToBoolean().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

true if the value of the current instance is not zero; otherwise, false.

System.Int64.System#IConvertible#ToByte()

For a description of this member, see System.IConvertible.ToByte().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Byte.

System.Int64.System#IConvertible#ToChar()

For a description of this member, see System.IConvertible.ToChar().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Char.

System.Int64.System#IConvertible#ToDateTime()

This conversion is not supported. Attempting to use this method throws an System.InvalidCastException.

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

This conversion is not supported. No value is returned.

System.Int64.System#IConvertible#ToDecimal()

For a description of this member, see System.IConvertible.ToDecimal().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Decimal.

System.Int64.System#IConvertible#ToDouble()

For a description of this member, see System.IConvertible.ToDouble().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Double.

System.Int64.System#IConvertible#ToInt16()

For a description of this member, see System.IConvertible.ToInt16().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.Int16.

System.Int64.System#IConvertible#ToInt32()

For a description of this member, see System.IConvertible.ToInt32().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.Int32.

System.Int64.System#IConvertible#ToInt64()

For a description of this member, see System.IConvertible.ToInt64().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, unchanged.

System.Int64.System#IConvertible#ToSByte()

For a description of this member, see System.IConvertible.ToSByte().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to an System.SByte.

System.Int64.System#IConvertible#ToSingle()

For a description of this member, see System.IConvertible.ToSingle().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.Single.

System.Int64.System#IConvertible#ToType()

For a description of this member, see System.IConvertible.ToType().

Parameters

NameDescriptionDefault
type The type to which to convert this System.Int64 value.
provider An System.IFormatProvider implementation that provides information about the format of the returned value.

Returns

The value of the current instance, converted to type.

System.Int64.System#IConvertible#ToUInt16()

For a description of this member, see System.IConvertible.ToUInt16().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt16.

System.Int64.System#IConvertible#ToUInt32()

For a description of this member, see System.IConvertible.ToUInt32().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt32.

System.Int64.System#IConvertible#ToUInt64()

For a description of this member, see System.IConvertible.ToUInt64().

Parameters

NameDescriptionDefault
provider This parameter is ignored.

Returns

The value of the current instance, converted to a System.UInt64.

System.Int64.System#Numerics#IAdditionOperators{System#Int64@System#Int64@System#Int64}#op_Addition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which right is added.
right The value that's added to left.

Returns

The sum of left and right.

System.Int64.System#Numerics#IAdditionOperators{System#Int64@System#Int64@System#Int64}#op_CheckedAddition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which right is added.
right The value that's added to left.

Returns

The sum of left and right.

System.Int64.System#Numerics#IBinaryInteger<System#Int64>#GetByteCount

Gets the number of bytes that will be written as part of .

Returns

The number of bytes that will be written as part of .

System.Int64.System#Numerics#IBinaryInteger<System#Int64>#GetShortestBitLength

Gets the length, in bits, of the shortest two's complement representation of the current value.

Returns

The length, in bits, of the shortest two's complement representation of the current value.

System.Int64.System#Numerics#IBinaryInteger{System#Int64}#TryReadBigEndian()

Parameters

NameDescriptionDefault
source
isUnsigned
value

System.Int64.System#Numerics#IBinaryInteger{System#Int64}#TryReadLittleEndian()

Parameters

NameDescriptionDefault
source
isUnsigned
value

System.Int64.System#Numerics#IBinaryInteger<System#Int64>#TryWriteBigEndian()

Tries to write the current value, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the value was succesfully written to
destination
; otherwise,
false
.

System.Int64.System#Numerics#IBinaryInteger<System#Int64>#TryWriteLittleEndian()

Tries to write the current value, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the value was succesfully written to
destination
; otherwise,
false
.

System.Int64.System#Numerics#IBitwiseOperators{System#Int64@System#Int64@System#Int64}#op_BitwiseAnd()

Computes the bitwise-and of two values.

Parameters

NameDescriptionDefault
left The value to and with right.
right The value to and with left.

Returns

The bitwise-and of left and right.

System.Int64.System#Numerics#IBitwiseOperators{System#Int64@System#Int64@System#Int64}#op_BitwiseOr()

Computes the bitwise-or of two values.

Parameters

NameDescriptionDefault
left The value to or with right.
right The value to or with left.

Returns

The bitwise-or of left and right.

System.Int64.System#Numerics#IBitwiseOperators{System#Int64@System#Int64@System#Int64}#op_ExclusiveOr()

Computes the exclusive-or of two values.

Parameters

NameDescriptionDefault
left The value to xor with right.
right The value to xor with left.

Returns

The exclusive-or of left and right.

System.Int64.System#Numerics#IBitwiseOperators{System#Int64@System#Int64@System#Int64}#op_OnesComplement()

Computes the ones-complement representation of a given value.

Parameters

NameDescriptionDefault
value The value for which to compute the ones-complement.

Returns

The ones-complement of value.

System.Int64.System#Numerics#IComparisonOperators{System#Int64@System#Int64@System#Boolean}#op_GreaterThan()

Compares two values to determine which is greater.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is greater than right; otherwise, false.

System.Int64.System#Numerics#IComparisonOperators{System#Int64@System#Int64@System#Boolean}#op_GreaterThanOrEqual()

Compares two values to determine which is greater or equal.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is greater than or equal to right; otherwise, false.

System.Int64.System#Numerics#IComparisonOperators{System#Int64@System#Int64@System#Boolean}#op_LessThan()

Compares two values to determine which is less.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is less than right; otherwise, false.

System.Int64.System#Numerics#IComparisonOperators{System#Int64@System#Int64@System#Boolean}#op_LessThanOrEqual()

Compares two values to determine which is less or equal.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is less than or equal to right; otherwise, false.

System.Int64.System#Numerics#IDecrementOperators{System#Int64}#op_CheckedDecrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing value.

System.Int64.System#Numerics#IDecrementOperators{System#Int64}#op_Decrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing value.

System.Int64.System#Numerics#IDivisionOperators{System#Int64@System#Int64@System#Int64}#op_Division()

Divides one value by another to compute their quotient.

Parameters

NameDescriptionDefault
left The value that right divides.
right The value that divides left.

Returns

The quotient of left divided by right.

System.Int64.System#Numerics#IEqualityOperators{System#Int64@System#Int64@System#Boolean}#op_Equality()

Compares two values to determine equality.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is equal to right; otherwise, false.

System.Int64.System#Numerics#IEqualityOperators{System#Int64@System#Int64@System#Boolean}#op_Inequality()

Compares two values to determine inequality.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is not equal to right; otherwise, false.

System.Int64.System#Numerics#IIncrementOperators{System#Int64}#op_CheckedIncrement()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing value.

System.Int64.System#Numerics#IIncrementOperators{System#Int64}#op_Increment()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing value.

System.Int64.System#Numerics#IModulusOperators{System#Int64@System#Int64@System#Int64}#op_Modulus()

Divides two values together to compute their modulus or remainder.

Parameters

NameDescriptionDefault
left The value that right divides.
right The value that divides left.

Returns

The modulus or remainder of left divided by right.

System.Int64.System#Numerics#IMultiplyOperators{System#Int64@System#Int64@System#Int64}#op_CheckedMultiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value that right multiplies.
right The value that multiplies left.

Returns

The product of left multiplied by right.

System.Int64.System#Numerics#IMultiplyOperators{System#Int64@System#Int64@System#Int64}#op_Multiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value that right multiplies.
right The value that multiplies left.

Returns

The product of left multiplied by right.

System.Int64.System#Numerics#INumber{System#Int64}#MaxNumber()

Compares two values to compute which is greater and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Int64.System#Numerics#INumber{System#Int64}#MinNumber()

Compares two values to compute which is lesser and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Int64.System#Numerics#INumberBase{System#Int64}#IsCanonical()

Determines if a value is in its canonical representation.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is in its canonical representation; otherwise, false.

System.Int64.System#Numerics#INumberBase{System#Int64}#IsComplexNumber()

Determines if a value represents a complex number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a complex number; otherwise, false.

System.Int64.System#Numerics#INumberBase{System#Int64}#IsFinite()

Determines if a value is finite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is finite; otherwise, false.

System.Int64.System#Numerics#INumberBase{System#Int64}#IsImaginaryNumber()

Determines if a value represents a pure imaginary number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a pure imaginary number; otherwise, false.

System.Int64.System#Numerics#INumberBase{System#Int64}#IsInfinity()

Determines if a value is infinite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is infinite; otherwise, false.

System.Int64.System#Numerics#INumberBase{System#Int64}#IsInteger()

Determines if a value represents an integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is an integer; otherwise, false.

System.Int64.System#Numerics#INumberBase{System#Int64}#IsNaN()

Determines if a value is NaN.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is NaN; otherwise, false.

System.Int64.System#Numerics#INumberBase{System#Int64}#IsNegativeInfinity()

Determines if a value is negative infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is negative infinity; otherwise, false.

System.Int64.System#Numerics#INumberBase{System#Int64}#IsNormal()

Determines if a value is normal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is normal; otherwise, false.

System.Int64.System#Numerics#INumberBase{System#Int64}#IsPositiveInfinity()

Determines if a value is positive infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is positive infinity; otherwise, false.

System.Int64.System#Numerics#INumberBase{System#Int64}#IsRealNumber()

Determines if a value represents a real number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a real number; otherwise, false.

System.Int64.System#Numerics#INumberBase{System#Int64}#IsSubnormal()

Determines if a value is subnormal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is subnormal; otherwise, false.

System.Int64.System#Numerics#INumberBase{System#Int64}#IsZero()

Determines if a value is zero.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is zero; otherwise, false.

System.Int64.System#Numerics#INumberBase{System#Int64}#MaxMagnitudeNumber()

Compares two values to compute which has the greater magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Int64.System#Numerics#INumberBase{System#Int64}#MinMagnitudeNumber()

Compares two values to compute which has the lesser magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Int64.System#Numerics#INumberBase{System#Int64}#TryConvertFromChecked``1()

Parameters

NameDescriptionDefault
value
result

System.Int64.System#Numerics#INumberBase{System#Int64}#TryConvertFromSaturating``1()

Parameters

NameDescriptionDefault
value
result

System.Int64.System#Numerics#INumberBase{System#Int64}#TryConvertFromTruncating``1()

Parameters

NameDescriptionDefault
value
result

System.Int64.System#Numerics#INumberBase{System#Int64}#TryConvertToChecked``1()

Tries to convert an instance of the the current type to another type, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Int64.System#Numerics#INumberBase{System#Int64}#TryConvertToSaturating``1()

Tries to convert an instance of the the current type to another type, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Int64.System#Numerics#INumberBase{System#Int64}#TryConvertToTruncating``1()

Tries to convert an instance of the the current type to another type, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Int64.System#Numerics#IShiftOperators{System#Int64@System#Int32@System#Int64}#op_LeftShift()

Shifts a value left by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted left by shiftAmount.
shiftAmount The amount by which value is shifted left.

Returns

The result of shifting value left by shiftAmount.

System.Int64.System#Numerics#IShiftOperators{System#Int64@System#Int32@System#Int64}#op_RightShift()

Shifts a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted right by shiftAmount.
shiftAmount The amount by which value is shifted right.

Returns

The result of shifting value right by shiftAmount.

System.Int64.System#Numerics#IShiftOperators{System#Int64@System#Int32@System#Int64}#op_UnsignedRightShift()

Shifts a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted right by shiftAmount.
shiftAmount The amount by which value is shifted right.

Returns

The result of shifting value right by shiftAmount.

System.Int64.System#Numerics#ISubtractionOperators{System#Int64@System#Int64@System#Int64}#op_CheckedSubtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which right is subtracted.
right The value that's subtracted from left.

Returns

The value of right subtracted from left.

System.Int64.System#Numerics#ISubtractionOperators{System#Int64@System#Int64@System#Int64}#op_Subtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which right is subtracted.
right The value that's subtracted from left.

Returns

The value of right subtracted from left.

System.Int64.System#Numerics#IUnaryNegationOperators{System#Int64@System#Int64}#op_CheckedUnaryNegation()

Computes the checked unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of value.

System.Int64.System#Numerics#IUnaryNegationOperators{System#Int64@System#Int64}#op_UnaryNegation()

Computes the unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of value.

System.Int64.System#Numerics#IUnaryPlusOperators{System#Int64@System#Int64}#op_UnaryPlus()

Computes the unary plus of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary plus.

Returns

The unary plus of value.

System.Int64.ToString

Converts the numeric value of this instance to its equivalent string representation.

Returns

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

System.Int64.ToString()

Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.

Parameters

NameDescriptionDefault
provider An System.IFormatProvider that supplies culture-specific formatting information.

Returns

The string representation of the value of this instance as specified by provider.

System.Int64.ToString()

Converts the numeric value of this instance to its equivalent string representation, using the specified format.

Parameters

NameDescriptionDefault
format A numeric format string.

Returns

The string representation of the value of this instance as specified by format.

System.Int64.ToString()

Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information.

Parameters

NameDescriptionDefault
format A numeric format string.
provider An object that supplies culture-specific formatting information about this instance.

Returns

The string representation of the value of this instance as specified by format and provider.

System.Int64.TrailingZeroCount()

Computes the number of trailing zeros in a value.

Parameters

NameDescriptionDefault
value The value whose trailing zeroes are to be counted.

Returns

The number of trailing zeros in
value
.

System.Int64.TryFormat()

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

Parameters

NameDescriptionDefault
utf8Destination The span in which to write this instance's value formatted as a span of bytes.
bytesWritten When this method returns, contains the number of bytes that were written in
utf8Destination
.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for
utf8Destination
.
provider An optional object that supplies culture-specific formatting information for
utf8Destination
.

Returns

true
if the formatting was successful; otherwise,
false
.

System.Int64.TryFormat()

Tries to format the value of the current long number instance into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span in which to write this instance's value formatted as a span of characters.
charsWritten When this method returns, contains the number of characters that were written in destination.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for destination.
provider An optional object that supplies culture-specific formatting information for destination.

Returns

true if the formatting was successful; otherwise, false.

System.Int64.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.Int64.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.Int64.TryParse()

Tries to convert a UTF-8 character span containing the string representation of a number to its 64-bit signed integer equivalent.

Parameters

NameDescriptionDefault
utf8Text A span containing the UTF-8 characters representing the number to convert.
result When this method returns, contains the 64-bit signed integer value equivalent to the number contained in utf8Text if the conversion succeeded, or zero if the conversion failed. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if utf8Text was converted successfully; otherwise, false.

System.Int64.TryParse()

Converts the span representation of a number in a specified style and culture-specific format to its 64-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A span containing the characters representing the number to convert. The span is interpreted using the style specified by style.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider An object that supplies culture-specific formatting information about s.
result When this method returns, contains the 64-bit signed integer value equivalent of the number contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or System.String.Empty, is not in a format compliant with style, or represents a number less than Int64.MinValue or greater than Int64.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Int64.TryParse()

Tries to parse a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
, or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Int64.TryParse()

Converts the span representation of a number to its 64-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A span containing the characters representing the number to convert.
result When this method returns, contains the 64-bit signed integer value equivalent of the number contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or System.String.Empty, is not of the correct format, or represents a number less than Int64.MinValue or greater than Int64.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Int64.TryParse()

Converts the string representation of a number in a specified style and culture-specific format to its 64-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A string containing a number to convert. The string is interpreted using the style specified by style.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider An object that supplies culture-specific formatting information about s.
result When this method returns, contains the 64-bit signed integer value equivalent of the number contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or System.String.Empty, is not in a format compliant with style, or represents a number less than Int64.MinValue or greater than Int64.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Int64.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.Int64.TryParse()

Converts the string representation of a number to its 64-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
result When this method returns, contains the 64-bit signed integer value equivalent of the number contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or System.String.Empty, is not of the correct format, or represents a number less than Int64.MinValue or greater than Int64.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.Int64.System#Numerics#IAdditiveIdentity{System#Int64@System#Int64}#AdditiveIdentity

Gets the additive identity of the current type.

System.Int64.System#Numerics#IBinaryNumber{System#Int64}#AllBitsSet

Gets an instance of the binary type in which all bits are set.

System.Int64.System#Numerics#IMinMaxValue{System#Int64}#MaxValue

Gets the maximum value of the current type.

System.Int64.System#Numerics#IMinMaxValue{System#Int64}#MinValue

Gets the minimum value of the current type.

System.Int64.System#Numerics#IMultiplicativeIdentity{System#Int64@System#Int64}#MultiplicativeIdentity

Gets the multiplicative identity of the current type.

System.Int64.System#Numerics#INumberBase{System#Int64}#One

Gets the value 1 for the type.

System.Int64.System#Numerics#INumberBase{System#Int64}#Radix

Gets the radix, or base, for the type.

System.Int64.System#Numerics#INumberBase{System#Int64}#Zero

Gets the value 0 for the type.

System.Int64.System#Numerics#ISignedNumber{System#Int64}#NegativeOne

Gets the value -1 for the type.

System.IntPtr

Represents a signed integer where the bit-width is the same as a pointer.

System.IntPtr.Zero

A read-only field that represents a signed integer that has been initialized to zero.

System.IntPtr.#ctor()

Initializes a new instance of System.IntPtr using the specified 32-bit signed integer.

Parameters

NameDescriptionDefault
value A 32-bit signed integer.

System.IntPtr.#ctor()

Initializes a new instance of System.IntPtr using the specified 64-bit signed integer.

Parameters

NameDescriptionDefault
value A 64-bit signed integer.

System.IntPtr.#ctor()

Initializes a new instance of System.IntPtr using the specified pointer to an unspecified type.

Parameters

NameDescriptionDefault
value A pointer to an unspecified type.

System.IntPtr.Abs()

Computes the absolute of a value.

Parameters

NameDescriptionDefault
value The value for which to get its absolute.

Returns

The absolute of
value
.

System.IntPtr.Add()

Adds an offset to a signed integer.

Parameters

NameDescriptionDefault
pointer The signed integer to add the offset to.
offset The offset to add.

Returns

A new signed integer that reflects the addition of offset to pointer.

System.IntPtr.Clamp()

Clamps a value to an inclusive minimum and maximum value.

Parameters

NameDescriptionDefault
value The value to clamp.
min The inclusive minimum to which
value
should clamp.
max The inclusive maximum to which
value
should clamp.

Returns

The result of clamping
value
to the inclusive range of
min
and
max
.

System.IntPtr.CompareTo()

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Parameters

NameDescriptionDefault
value A signed native integer to compare.

Returns

A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes value in the sort order. Zero This instance occurs in the same position in the sort order as value. Greater than zero This instance follows value in the sort order.

System.IntPtr.CompareTo()

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Parameters

NameDescriptionDefault
value An object to compare, or null.

Returns

A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes value in the sort order. Zero This instance occurs in the same position in the sort order as value. Greater than zero This instance follows value in the sort order.

System.IntPtr.CopySign()

Copies the sign of a value to the sign of another value.

Parameters

NameDescriptionDefault
value The value whose magnitude is used in the result.
sign The value whose sign is used in the result.

Returns

A value with the magnitude of
value
and the sign of
sign
.

System.IntPtr.CreateChecked``1()

Creates an instance of the current type from a value, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
.

System.IntPtr.CreateSaturating``1()

Creates an instance of the current type from a value, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value which is used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, saturating if
value
falls outside the representable range of
TSelf
.

System.IntPtr.CreateTruncating``1()

Creates an instance of the current type from a value, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value which is used to create the instance of
TSelf
.

Returns

An instance of
TSelf
created from
value
, truncating if
value
falls outside the representable range of
TSelf
.

System.IntPtr.DivRem()

Computes the quotient and remainder of two values.

Parameters

NameDescriptionDefault
left The value which
right
divides.
right The value which divides
left
.

Returns

The quotient and remainder of
left
divided-by
right
.

System.IntPtr.Equals()

Indicates whether the current object is equal to another object of the same type.

Parameters

NameDescriptionDefault
other An object to compare with this object.

Returns

true if the current object is equal to other; otherwise, false.

System.IntPtr.Equals()

Returns a value indicating whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance or null.

Returns

true if obj is an instance of System.IntPtr and equals the value of this instance; otherwise, false.

System.IntPtr.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.IntPtr.IsEvenInteger()

Determines if a value represents an even integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an even integer; otherwise,
false
.

System.IntPtr.IsNegative()

Determines if a value is negative.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is negative; otherwise,
false
.

System.IntPtr.IsOddInteger()

Determines if a value represents an odd integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is an odd integer; otherwise,
false
.

System.IntPtr.IsPositive()

Determines if a value is positive.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is positive; otherwise,
false
.

System.IntPtr.IsPow2()

Determines if a value is a power of two.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true
if
value
is a power of two; otherwise,
false
.

System.IntPtr.LeadingZeroCount()

Computes the number of leading zeros in a value.

Parameters

NameDescriptionDefault
value The value whose leading zeroes are to be counted.

Returns

The number of leading zeros in
value
.

System.IntPtr.Log2()

Computes the log2 of a value.

Parameters

NameDescriptionDefault
value The value whose log2 is to be computed.

Returns

The log2 of
value
.

System.IntPtr.Max()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.IntPtr.MaxMagnitude()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is greater than
y
; otherwise,
y
.

System.IntPtr.Min()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.IntPtr.MinMagnitude()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with
y
.
y The value to compare with
x
.

Returns

x
if it is less than
y
; otherwise,
y
.

System.IntPtr.op_Addition()

Adds an offset to a signed integer.

Parameters

NameDescriptionDefault
pointer The signed integer to add the offset to.
offset The offset to add.

Returns

A new signed integer that reflects the addition of offset to pointer.

System.IntPtr.op_Equality()

Determines whether two specified instances of System.IntPtr are equal.

Parameters

NameDescriptionDefault
value1 The first signed integer to compare.
value2 The second signed integer to compare.

Returns

true if value1 equals value2; otherwise, false.

System.IntPtr.op_Explicit()

Converts the value of a 32-bit signed integer to an System.IntPtr.

Parameters

NameDescriptionDefault
value A 32-bit signed integer.

Returns

A new instance of System.IntPtr initialized to value.

System.IntPtr.op_Explicit()

Converts the value of a 64-bit signed integer to an System.IntPtr.

Parameters

NameDescriptionDefault
value A 64-bit signed integer.

Returns

A new instance of System.IntPtr initialized to value.

System.IntPtr.op_Explicit()

Converts the value of the specified System.IntPtr to a 32-bit signed integer.

Parameters

NameDescriptionDefault
value The signed integer to convert.

Returns

The contents of value.

System.IntPtr.op_Explicit()

Converts the value of the specified System.IntPtr to a 64-bit signed integer.

Parameters

NameDescriptionDefault
value The signed integer to convert.

Returns

The contents of value.

System.IntPtr.op_Explicit()

Converts the value of the specified System.IntPtr to a pointer to an unspecified type. This API is not CLS-compliant.

Parameters

NameDescriptionDefault
value The signed integer to convert.

Returns

The contents of value.

System.IntPtr.op_Explicit()

Converts the specified pointer to an unspecified type to an System.IntPtr. This API is not CLS-compliant.

Parameters

NameDescriptionDefault
value A pointer to an unspecified type.

Returns

A new instance of System.IntPtr initialized to value.

System.IntPtr.op_Inequality()

Determines whether two specified instances of System.IntPtr are not equal.

Parameters

NameDescriptionDefault
value1 The first signed integer to compare.
value2 The second signed integer to compare.

Returns

true if value1 does not equal value2; otherwise, false.

System.IntPtr.op_Subtraction()

Subtracts an offset from a signed integer.

Parameters

NameDescriptionDefault
pointer The signed integer to subtract the offset from.
offset The offset to subtract.

Returns

A new signed integer that reflects the subtraction of offset from pointer.

System.IntPtr.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.IntPtr.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.

Returns

The result of parsing
utf8Text
.

System.IntPtr.Parse()

Converts the read-only span of characters representation of a number in a specified style and culture-specific format to its signed native integer equivalent.

Parameters

NameDescriptionDefault
s A read-only span of characters containing a number to convert.
style A bitwise combination of the enumeration values that indicates the style elements that can be present in s.
provider An object that supplies culture-specific formatting information about s.

Returns

A signed native integer equivalent to the number contained in s.

System.IntPtr.Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about s.

Returns

The result of parsing s.

System.IntPtr.Parse()

Converts the string representation of a number to its signed native integer equivalent.

Parameters

NameDescriptionDefault
s A string containing a number to convert.

Returns

A signed native integer equivalent to the number contained in s.

System.IntPtr.Parse()

Converts the string representation of a number in a specified style to its signed native integer equivalent.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
style A bitwise combination of the enumeration values that indicates the style elements that can be present in s.

Returns

A signed native integer equivalent to the number contained in s.

System.IntPtr.Parse()

Converts the string representation of a number in a specified style and culture-specific format to its signed native integer equivalent.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
style A bitwise combination of the enumeration values that indicates the style elements that can be present in s.
provider An object that supplies culture-specific formatting information about s.

Returns

A signed native integer equivalent to the number contained in s.

System.IntPtr.Parse()

Converts the string representation of a number in a specified culture-specific format to its signed native integer equivalent.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
provider An object that supplies culture-specific formatting information about s.

Returns

A signed native integer equivalent to the number contained in s.

System.IntPtr.PopCount()

Computes the number of bits that are set in a value.

Parameters

NameDescriptionDefault
value The value whose set bits are to be counted.

Returns

The number of set bits in
value
.

System.IntPtr.RotateLeft()

Rotates a value left by a given amount.

Parameters

NameDescriptionDefault
value The value which is rotated left by
rotateAmount
.
rotateAmount The amount by which
value
is rotated left.

Returns

The result of rotating
value
left by
rotateAmount
.

System.IntPtr.RotateRight()

Rotates a value right by a given amount.

Parameters

NameDescriptionDefault
value The value which is rotated right by
rotateAmount
.
rotateAmount The amount by which
value
is rotated right.

Returns

The result of rotating
value
right by
rotateAmount
.

System.IntPtr.Sign()

Computes the sign of a value.

Parameters

NameDescriptionDefault
value The value whose sign is to be computed.

Returns

A positive value if
value
is positive, if
value
is zero, and a negative value if
value
is negative.

System.IntPtr.Subtract()

Subtracts an offset from a signed integer.

Parameters

NameDescriptionDefault
pointer The signed integer to subtract the offset from.
offset The offset to subtract.

Returns

A new signed integer that reflects the subtraction of offset from pointer.

System.IntPtr.System#Numerics#IAdditionOperators{System#IntPtr@System#IntPtr@System#IntPtr}#op_Addition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which right is added.
right The value that's added to left.

Returns

The sum of left and right.

System.IntPtr.System#Numerics#IAdditionOperators{System#IntPtr@System#IntPtr@System#IntPtr}#op_CheckedAddition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which right is added.
right The value that's added to left.

Returns

The sum of left and right.

System.IntPtr.System#Numerics#IBinaryInteger<nint>#GetByteCount

Gets the number of bytes that will be written as part of .

Returns

The number of bytes that will be written as part of .

System.IntPtr.System#Numerics#IBinaryInteger<nint>#GetShortestBitLength

Gets the length, in bits, of the shortest two's complement representation of the current value.

Returns

The length, in bits, of the shortest two's complement representation of the current value.

System.IntPtr.System#Numerics#IBinaryInteger{System#IntPtr}#TryReadBigEndian()

Parameters

NameDescriptionDefault
source
isUnsigned
value

System.IntPtr.System#Numerics#IBinaryInteger{System#IntPtr}#TryReadLittleEndian()

Parameters

NameDescriptionDefault
source
isUnsigned
value

System.IntPtr.System#Numerics#IBinaryInteger<nint>#TryWriteBigEndian()

Tries to write the current value, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the value was succesfully written to
destination
; otherwise,
false
.

System.IntPtr.System#Numerics#IBinaryInteger<nint>#TryWriteLittleEndian()

Tries to write the current value, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.
bytesWritten When this method returns, contains the number of bytes written to
destination
.

Returns

true
if the value was succesfully written to
destination
; otherwise,
false
.

System.IntPtr.System#Numerics#IBitwiseOperators{System#IntPtr@System#IntPtr@System#IntPtr}#op_BitwiseAnd()

Computes the bitwise-and of two values.

Parameters

NameDescriptionDefault
left The value to and with right.
right The value to and with left.

Returns

The bitwise-and of left and right.

System.IntPtr.System#Numerics#IBitwiseOperators{System#IntPtr@System#IntPtr@System#IntPtr}#op_BitwiseOr()

Computes the bitwise-or of two values.

Parameters

NameDescriptionDefault
left The value to or with right.
right The value to or with left.

Returns

The bitwise-or of left and right.

System.IntPtr.System#Numerics#IBitwiseOperators{System#IntPtr@System#IntPtr@System#IntPtr}#op_ExclusiveOr()

Computes the exclusive-or of two values.

Parameters

NameDescriptionDefault
left The value to xor with right.
right The value to xor with left.

Returns

The exclusive-or of left and right.

System.IntPtr.System#Numerics#IBitwiseOperators{System#IntPtr@System#IntPtr@System#IntPtr}#op_OnesComplement()

Computes the ones-complement representation of a given value.

Parameters

NameDescriptionDefault
value The value for which to compute the ones-complement.

Returns

The ones-complement of value.

System.IntPtr.System#Numerics#IComparisonOperators{System#IntPtr@System#IntPtr@System#Boolean}#op_GreaterThan()

Compares two values to determine which is greater.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is greater than right; otherwise, false.

System.IntPtr.System#Numerics#IComparisonOperators{System#IntPtr@System#IntPtr@System#Boolean}#op_GreaterThanOrEqual()

Compares two values to determine which is greater or equal.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is greater than or equal to right; otherwise, false.

System.IntPtr.System#Numerics#IComparisonOperators{System#IntPtr@System#IntPtr@System#Boolean}#op_LessThan()

Compares two values to determine which is less.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is less than right; otherwise, false.

System.IntPtr.System#Numerics#IComparisonOperators{System#IntPtr@System#IntPtr@System#Boolean}#op_LessThanOrEqual()

Compares two values to determine which is less or equal.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is less than or equal to right; otherwise, false.

System.IntPtr.System#Numerics#IDecrementOperators{System#IntPtr}#op_CheckedDecrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing value.

System.IntPtr.System#Numerics#IDecrementOperators{System#IntPtr}#op_Decrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing value.

System.IntPtr.System#Numerics#IDivisionOperators{System#IntPtr@System#IntPtr@System#IntPtr}#op_Division()

Divides one value by another to compute their quotient.

Parameters

NameDescriptionDefault
left The value that right divides.
right The value that divides left.

Returns

The quotient of left divided by right.

System.IntPtr.System#Numerics#IIncrementOperators{System#IntPtr}#op_CheckedIncrement()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing value.

System.IntPtr.System#Numerics#IIncrementOperators{System#IntPtr}#op_Increment()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing value.

System.IntPtr.System#Numerics#IModulusOperators{System#IntPtr@System#IntPtr@System#IntPtr}#op_Modulus()

Divides two values together to compute their modulus or remainder.

Parameters

NameDescriptionDefault
left The value that right divides.
right The value that divides left.

Returns

The modulus or remainder of left divided by right.

System.IntPtr.System#Numerics#IMultiplyOperators{System#IntPtr@System#IntPtr@System#IntPtr}#op_CheckedMultiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value that right multiplies.
right The value that multiplies left.

Returns

The product of left multiplied by right.

System.IntPtr.System#Numerics#IMultiplyOperators{System#IntPtr@System#IntPtr@System#IntPtr}#op_Multiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value that right multiplies.
right The value that multiplies left.

Returns

The product of left multiplied by right.

System.IntPtr.System#Numerics#INumber{System#IntPtr}#MaxNumber()

Compares two values to compute which is greater and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.IntPtr.System#Numerics#INumber{System#IntPtr}#MinNumber()

Compares two values to compute which is lesser and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#IsCanonical()

Determines if a value is in its canonical representation.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is in its canonical representation; otherwise, false.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#IsComplexNumber()

Determines if a value represents a complex number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a complex number; otherwise, false.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#IsFinite()

Determines if a value is finite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is finite; otherwise, false.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#IsImaginaryNumber()

Determines if a value represents a pure imaginary number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a pure imaginary number; otherwise, false.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#IsInfinity()

Determines if a value is infinite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is infinite; otherwise, false.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#IsInteger()

Determines if a value represents an integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is an integer; otherwise, false.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#IsNaN()

Determines if a value is NaN.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is NaN; otherwise, false.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#IsNegativeInfinity()

Determines if a value is negative infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is negative infinity; otherwise, false.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#IsNormal()

Determines if a value is normal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is normal; otherwise, false.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#IsPositiveInfinity()

Determines if a value is positive infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is positive infinity; otherwise, false.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#IsRealNumber()

Determines if a value represents a real number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a real number; otherwise, false.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#IsSubnormal()

Determines if a value is subnormal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is subnormal; otherwise, false.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#IsZero()

Determines if a value is zero.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is zero; otherwise, false.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#MaxMagnitudeNumber()

Compares two values to compute which has the greater magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#MinMagnitudeNumber()

Compares two values to compute which has the lesser magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#TryConvertFromChecked``1()

Parameters

NameDescriptionDefault
value
result

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#TryConvertFromSaturating``1()

Parameters

NameDescriptionDefault
value
result

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#TryConvertFromTruncating``1()

Parameters

NameDescriptionDefault
value
result

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#TryConvertToChecked``1()

Tries to convert an instance of the the current type to another type, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#TryConvertToSaturating``1()

Tries to convert an instance of the the current type to another type, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#TryConvertToTruncating``1()

Tries to convert an instance of the the current type to another type, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.IntPtr.System#Numerics#IShiftOperators{System#IntPtr@System#Int32@System#IntPtr}#op_LeftShift()

Shifts a value left by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted left by shiftAmount.
shiftAmount The amount by which value is shifted left.

Returns

The result of shifting value left by shiftAmount.

System.IntPtr.System#Numerics#IShiftOperators{System#IntPtr@System#Int32@System#IntPtr}#op_RightShift()

Shifts a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted right by shiftAmount.
shiftAmount The amount by which value is shifted right.

Returns

The result of shifting value right by shiftAmount.

System.IntPtr.System#Numerics#IShiftOperators{System#IntPtr@System#Int32@System#IntPtr}#op_UnsignedRightShift()

Shifts a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted right by shiftAmount.
shiftAmount The amount by which value is shifted right.

Returns

The result of shifting value right by shiftAmount.

System.IntPtr.System#Numerics#ISubtractionOperators{System#IntPtr@System#IntPtr@System#IntPtr}#op_CheckedSubtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which right is subtracted.
right The value that's subtracted from left.

Returns

The value of right subtracted from left.

System.IntPtr.System#Numerics#ISubtractionOperators{System#IntPtr@System#IntPtr@System#IntPtr}#op_Subtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which right is subtracted.
right The value that's subtracted from left.

Returns

The value of right subtracted from left.

System.IntPtr.System#Numerics#IUnaryNegationOperators{System#IntPtr@System#IntPtr}#op_CheckedUnaryNegation()

Computes the checked unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of value.

System.IntPtr.System#Numerics#IUnaryNegationOperators{System#IntPtr@System#IntPtr}#op_UnaryNegation()

Computes the unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of value.

System.IntPtr.System#Numerics#IUnaryPlusOperators{System#IntPtr@System#IntPtr}#op_UnaryPlus()

Computes the unary plus of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary plus.

Returns

The unary plus of value.

System.IntPtr.System#Runtime#Serialization#ISerializable#GetObjectData()

Populates a System.Runtime.Serialization.SerializationInfo object with the data needed to serialize the current System.IntPtr object.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo object to populate with data.
context The destination for this serialization. (This parameter is not used; specify null.)

System.IntPtr.ToInt32

Converts the value of this instance to a 32-bit signed integer.

Returns

A 32-bit signed integer equal to the value of this instance.

System.IntPtr.ToInt64

Converts the value of this instance to a 64-bit signed integer.

Returns

A 64-bit signed integer equal to the value of this instance.

System.IntPtr.ToPointer

Converts the value of this instance to a pointer to an unspecified type.

Returns

A pointer to System.Void; that is, a pointer to memory containing data of an unspecified type.

System.IntPtr.ToString

Converts the numeric value of the current System.IntPtr object to its equivalent string representation.

Returns

The string representation of the value of this instance.

System.IntPtr.ToString()

Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information.

Parameters

NameDescriptionDefault
provider An object that supplies culture-specific formatting information.

Returns

The string representation of the value of this instance as specified by provider.

System.IntPtr.ToString()

Converts the numeric value of the current System.IntPtr object to its equivalent string representation.

Parameters

NameDescriptionDefault
format A format specification that governs how the current System.IntPtr object is converted.

Returns

The string representation of the value of the current System.IntPtr object.

System.IntPtr.ToString()

Formats the value of the current instance using the specified format.

Parameters

NameDescriptionDefault
format The format to use. -or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the System.IFormattable implementation.
provider An object that supplies culture-specific formatting information.

Returns

The value of the current instance in the specified format.

System.IntPtr.TrailingZeroCount()

Computes the number of trailing zeros in a value.

Parameters

NameDescriptionDefault
value The value whose trailing zeroes are to be counted.

Returns

The number of trailing zeros in
value
.

System.IntPtr.TryFormat()

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

Parameters

NameDescriptionDefault
utf8Destination The span in which to write this instance's value formatted as a span of bytes.
bytesWritten When this method returns, contains the number of bytes that were written in
utf8Destination
.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for
utf8Destination
.
provider An optional object that supplies culture-specific formatting information for
utf8Destination
.

Returns

true
if the formatting was successful; otherwise,
false
.

System.IntPtr.TryFormat()

Tries to format the value of the current instance into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span where this instance's value formatted as a span of characters should be written.
charsWritten When this method returns, contains the number of characters that were written in destination.
format The characters that represent a standard or custom format string that defines the acceptable format for destination.
provider An optional object that supplies culture-specific formatting information for destination.

Returns

true if the formatting was successful; otherwise, false.

System.IntPtr.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in
utf8Text
.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.IntPtr.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about
utf8Text
.
result On return, contains the result of successfully parsing
utf8Text
or an undefined value on failure.

Returns

true
if
utf8Text
was successfully parsed; otherwise,
false
.

System.IntPtr.TryParse()

Tries to convert a UTF-8 character span containing the string representation of a number to its signed integer equivalent.

Parameters

NameDescriptionDefault
utf8Text A span containing the UTF-8 characters representing the number to convert.
result When this method returns, contains the signed integer value equivalent to the number contained in utf8Text if the conversion succeeded, or zero if the conversion failed. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if utf8Text was converted successfully; otherwise, false.

System.IntPtr.TryParse()

Converts the read-only span of characters representation of a number in a specified style and culture-specific format to its signed native integer equivalent. A return value indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A read-only span of characters containing a number to convert. The string is interpreted using the style specified by style.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s.
provider An object that supplies culture-specific formatting information about s.
result When this method returns, contains the signed native integer value equivalent of the number contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is empty, is not of the correct format, or represents a number less than System.IntPtr.MinValue or greater than System.IntPtr.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.IntPtr.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s A read-only span of characters containing a number to convert.
provider An object that provides culture-specific formatting information about s.
result When this method returns, contains the result of successfully parsing s or an undefined value on failure.

Returns

true if s was converted successfully; otherwise, false.

System.IntPtr.TryParse()

Converts the read-only span of characters representation of a number to its signed native integer equivalent. A return value indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A read-only span of characters containing a number to convert.
result When this method returns, contains the signed native integer equivalent of the number contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is empty, is not of the correct format, or represents a number less than System.IntPtr.MinValue or greater than System.IntPtr.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.IntPtr.TryParse()

Converts the string representation of a number in a specified style and culture-specific format to its signed native integer equivalent. A return value indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A string containing a number to convert. The string is interpreted using the style specified by style.
style A bitwise combination of enumeration values that indicates the style elements that can be present in s.
provider An object that supplies culture-specific formatting information about s.
result When this method returns, contains the signed native integer value equivalent of the number contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or empty, is not of the correct format, or represents a number less than System.IntPtr.MinValue or greater than System.IntPtr.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.IntPtr.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about
s
.
result When this method returns, contains the result of successfully parsing
s
or an undefined value on failure.

Returns

true
if
s
was successfully parsed; otherwise,
false
.

System.IntPtr.TryParse()

Converts the string representation of a number to its signed native integer equivalent. A return value indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
s A string containing a number to convert.
result When this method returns, contains the signed native integer value equivalent of the number contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or empty, is not of the correct format, or represents a number less than System.IntPtr.MinValue or greater than System.IntPtr.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.

Returns

true if s was converted successfully; otherwise, false.

System.IntPtr.MaxValue

Gets the largest possible value of .

Returns

x
if it is greater than
y
; otherwise,
y
.

System.IntPtr.MinValue

Gets the smallest possible value of .

Returns

x
if it is less than
y
; otherwise,
y
.

System.IntPtr.Size

Gets the size of this instance.

Returns

The size of a signed integer in the executing process, measured in bytes. The value of this property is 4 in a 32-bit process, and 8 in a 64-bit process. You can define the process type by setting the /platform switch when you compile your code with the C# and Visual Basic compilers.

System.IntPtr.System#Numerics#IAdditiveIdentity{System#IntPtr@System#IntPtr}#AdditiveIdentity

Gets the additive identity of the current type.

System.IntPtr.System#Numerics#IBinaryNumber{System#IntPtr}#AllBitsSet

Gets an instance of the binary type in which all bits are set.

System.IntPtr.System#Numerics#IMinMaxValue{System#IntPtr}#MaxValue

Gets the maximum value of the current type.

System.IntPtr.System#Numerics#IMinMaxValue{System#IntPtr}#MinValue

Gets the minimum value of the current type.

System.IntPtr.System#Numerics#IMultiplicativeIdentity{System#IntPtr@System#IntPtr}#MultiplicativeIdentity

Gets the multiplicative identity of the current type.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#One

Gets the value 1 for the type.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#Radix

Gets the radix, or base, for the type.

System.IntPtr.System#Numerics#INumberBase{System#IntPtr}#Zero

Gets the value 0 for the type.

System.IntPtr.System#Numerics#ISignedNumber{System#IntPtr}#NegativeOne

Gets the value -1 for the type.

System.InvalidCastException

The exception that is thrown for invalid casting or explicit conversion.

System.InvalidCastException.#ctor

Initializes a new instance of the System.InvalidCastException class.

System.InvalidCastException.#ctor()

Initializes a new instance of the System.InvalidCastException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.InvalidCastException.#ctor()

Initializes a new instance of the System.InvalidCastException class with a specified error message.

Parameters

NameDescriptionDefault
message The message that describes the error.

System.InvalidCastException.#ctor()

Initializes a new instance of the System.InvalidCastException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.InvalidCastException.#ctor()

Initializes a new instance of the System.InvalidCastException class with a specified message and error code.

Parameters

NameDescriptionDefault
message The message that indicates the reason the exception occurred.
errorCode The error code (HRESULT) value associated with the exception.

System.InvalidOperationException

The exception that is thrown when a method call is invalid for the object's current state.

System.InvalidOperationException.#ctor

Initializes a new instance of the System.InvalidOperationException class.

System.InvalidOperationException.#ctor()

Initializes a new instance of the System.InvalidOperationException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.InvalidOperationException.#ctor()

Initializes a new instance of the System.InvalidOperationException class with a specified error message.

Parameters

NameDescriptionDefault
message The message that describes the error.

System.InvalidOperationException.#ctor()

Initializes a new instance of the System.InvalidOperationException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.InvalidProgramException

The exception that is thrown when a program contains invalid Microsoft intermediate language (MSIL) or metadata. Generally this indicates a bug in the compiler that generated the program. This exception is also thrown when internal runtime implementation limits have been exceeded by the program.

System.InvalidProgramException.#ctor

Initializes a new instance of the System.InvalidProgramException class with default properties.

System.InvalidProgramException.#ctor()

Initializes a new instance of the System.InvalidProgramException class with a specified error message.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.

System.InvalidProgramException.#ctor()

Initializes a new instance of the System.InvalidProgramException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
inner The exception that is the cause of the current exception. If the inner parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.InvalidTimeZoneException

The exception that is thrown when time zone information is invalid.

System.InvalidTimeZoneException.#ctor

Initializes a new instance of the System.InvalidTimeZoneException class with a system-supplied message.

System.InvalidTimeZoneException.#ctor()

Initializes a new instance of the System.InvalidTimeZoneException class from serialized data.

Parameters

NameDescriptionDefault
info The object that contains the serialized data.
context The stream that contains the serialized data.

System.InvalidTimeZoneException.#ctor()

Initializes a new instance of the System.InvalidTimeZoneException class with the specified message string.

Parameters

NameDescriptionDefault
message A string that describes the exception.

System.InvalidTimeZoneException.#ctor()

Initializes a new instance of the System.InvalidTimeZoneException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message A string that describes the exception.
innerException The exception that is the cause of the current exception.

System.IO.BinaryReader

Reads primitive data types as binary values in a specific encoding.

System.IO.BinaryReader.#ctor()

Initializes a new instance of the System.IO.BinaryReader class based on the specified stream and using UTF-8 encoding.

Parameters

NameDescriptionDefault
input The input stream.

System.IO.BinaryReader.#ctor()

Initializes a new instance of the System.IO.BinaryReader class based on the specified stream and character encoding.

Parameters

NameDescriptionDefault
input The input stream.
encoding The character encoding to use.

System.IO.BinaryReader.#ctor()

Initializes a new instance of the System.IO.BinaryReader class based on the specified stream and character encoding, and optionally leaves the stream open.

Parameters

NameDescriptionDefault
input The input stream.
encoding The character encoding to use.
leaveOpen true to leave the stream open after the System.IO.BinaryReader object is disposed; otherwise, false.

System.IO.BinaryReader.Close

Closes the current reader and the underlying stream.

System.IO.BinaryReader.Dispose

Releases all resources used by the current instance of the System.IO.BinaryReader class.

System.IO.BinaryReader.Dispose()

Releases the unmanaged resources used by the System.IO.BinaryReader class and optionally releases the managed resources.

Parameters

NameDescriptionDefault
disposing true to release both managed and unmanaged resources; false to release only unmanaged resources.

System.IO.BinaryReader.FillBuffer()

Fills the internal buffer with the specified number of bytes read from the stream.

Parameters

NameDescriptionDefault
numBytes The number of bytes to be read.

System.IO.BinaryReader.PeekChar

Returns the next available character and does not advance the byte or character position.

Returns

The next available character, or -1 if no more characters are available or the stream does not support seeking.

System.IO.BinaryReader.Read

Reads characters from the underlying stream and advances the current position of the stream in accordance with the Encoding used and the specific character being read from the stream.

Returns

The next character from the input stream, or -1 if no characters are currently available.

System.IO.BinaryReader.Read()

Reads the specified number of bytes from the stream, starting from a specified point in the byte array.

Parameters

NameDescriptionDefault
buffer The buffer to read data into.
index The starting point in the buffer at which to begin reading into the buffer.
count The number of bytes to read.

Returns

The number of bytes read into buffer. This might be less than the number of bytes requested if that many bytes are not available, or it might be zero if the end of the stream is reached.

System.IO.BinaryReader.Read()

Reads the specified number of characters from the stream, starting from a specified point in the character array.

Parameters

NameDescriptionDefault
buffer The buffer to read data into.
index The starting point in the buffer at which to begin reading into the buffer.
count The number of characters to read.

Returns

The total number of characters read into the buffer. This might be less than the number of characters requested if that many characters are not currently available, or it might be zero if the end of the stream is reached.

System.IO.BinaryReader.Read()

Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Parameters

NameDescriptionDefault
buffer A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source.

Returns

The total number of bytes read into the buffer. This can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.

System.IO.BinaryReader.Read()

Reads, from the current stream, the same number of characters as the length of the provided buffer, writes them in the provided buffer, and advances the current position in accordance with the Encoding used and the specific character being read from the stream.

Parameters

NameDescriptionDefault
buffer A span of characters. When this method returns, the contents of this region are replaced by the characters read from the current source.

Returns

The total number of characters read into the buffer. This might be less than the number of characters requested if that many characters are not currently available, or it might be zero if the end of the stream is reached.

System.IO.BinaryReader.Read7BitEncodedInt

Reads in a 32-bit integer in compressed format.

Returns

A 32-bit integer in compressed format.

System.IO.BinaryReader.Read7BitEncodedInt64

Reads a number 7 bits at a time.

Returns

The number that is read from this binary reader instance.

System.IO.BinaryReader.ReadBoolean

Reads a Boolean value from the current stream and advances the current position of the stream by one byte.

Returns

true if the byte is nonzero; otherwise, false.

System.IO.BinaryReader.ReadByte

Reads the next byte from the current stream and advances the current position of the stream by one byte.

Returns

The next byte read from the current stream.

System.IO.BinaryReader.ReadBytes()

Reads the specified number of bytes from the current stream into a byte array and advances the current position by that number of bytes.

Parameters

NameDescriptionDefault
count The number of bytes to read. This value must be 0 or a non-negative number or an exception will occur.

Returns

A byte array containing data read from the underlying stream. This might be less than the number of bytes requested if the end of the stream is reached.

System.IO.BinaryReader.ReadChar

Reads the next character from the current stream and advances the current position of the stream in accordance with the Encoding used and the specific character being read from the stream.

Returns

A character read from the current stream.

System.IO.BinaryReader.ReadChars()

Reads the specified number of characters from the current stream, returns the data in a character array, and advances the current position in accordance with the Encoding used and the specific character being read from the stream.

Parameters

NameDescriptionDefault
count The number of characters to read.

Returns

A character array containing data read from the underlying stream. This might be less than the number of characters requested if the end of the stream is reached.

System.IO.BinaryReader.ReadDecimal

Reads a decimal value from the current stream and advances the current position of the stream by sixteen bytes.

Returns

A decimal value read from the current stream.

System.IO.BinaryReader.ReadDouble

Reads an 8-byte floating point value from the current stream and advances the current position of the stream by eight bytes.

Returns

An 8-byte floating point value read from the current stream.

System.IO.BinaryReader.ReadHalf

Reads a 2-byte floating point value from the current stream and advances the current position of the stream by two bytes.

Returns

A 2-byte floating point value read from the current stream.

System.IO.BinaryReader.ReadInt16

Reads a 2-byte signed integer from the current stream and advances the current position of the stream by two bytes.

Returns

A 2-byte signed integer read from the current stream.

System.IO.BinaryReader.ReadInt32

Reads a 4-byte signed integer from the current stream and advances the current position of the stream by four bytes.

Returns

A 4-byte signed integer read from the current stream.

System.IO.BinaryReader.ReadInt64

Reads an 8-byte signed integer from the current stream and advances the current position of the stream by eight bytes.

Returns

An 8-byte signed integer read from the current stream.

System.IO.BinaryReader.ReadSByte

Reads a signed byte from this stream and advances the current position of the stream by one byte.

Returns

A signed byte read from the current stream.

System.IO.BinaryReader.ReadSingle

Reads a 4-byte floating point value from the current stream and advances the current position of the stream by four bytes.

Returns

A 4-byte floating point value read from the current stream.

System.IO.BinaryReader.ReadString

Reads a string from the current stream. The string is prefixed with the length, encoded as an integer seven bits at a time.

Returns

The string being read.

System.IO.BinaryReader.ReadUInt16

Reads a 2-byte unsigned integer from the current stream using little-endian encoding and advances the position of the stream by two bytes.

Returns

A 2-byte unsigned integer read from this stream.

System.IO.BinaryReader.ReadUInt32

Reads a 4-byte unsigned integer from the current stream and advances the position of the stream by four bytes.

Returns

A 4-byte unsigned integer read from this stream.

System.IO.BinaryReader.ReadUInt64

Reads an 8-byte unsigned integer from the current stream and advances the position of the stream by eight bytes.

Returns

An 8-byte unsigned integer read from this stream.

System.IO.BinaryReader.BaseStream

Exposes access to the underlying stream of the System.IO.BinaryReader.

Returns

The underlying stream associated with the BinaryReader.

System.IO.BinaryWriter

Writes primitive types in binary to a stream and supports writing strings in a specific encoding.

System.IO.BinaryWriter.Null

Specifies a System.IO.BinaryWriter with no backing store.

System.IO.BinaryWriter.OutStream

Holds the underlying stream.

System.IO.BinaryWriter.#ctor

Initializes a new instance of the System.IO.BinaryWriter class that writes to a stream.

System.IO.BinaryWriter.#ctor()

Initializes a new instance of the System.IO.BinaryWriter class based on the specified stream and using UTF-8 encoding.

Parameters

NameDescriptionDefault
output The output stream.

System.IO.BinaryWriter.#ctor()

Initializes a new instance of the System.IO.BinaryWriter class based on the specified stream and character encoding.

Parameters

NameDescriptionDefault
output The output stream.
encoding The character encoding to use.

System.IO.BinaryWriter.#ctor()

Initializes a new instance of the System.IO.BinaryWriter class based on the specified stream and character encoding, and optionally leaves the stream open.

Parameters

NameDescriptionDefault
output The output stream.
encoding The character encoding to use.
leaveOpen true to leave the stream open after the System.IO.BinaryWriter object is disposed; otherwise, false.

System.IO.BinaryWriter.Close

Closes the current System.IO.BinaryWriter and the underlying stream.

System.IO.BinaryWriter.Dispose

Releases all resources used by the current instance of the System.IO.BinaryWriter class.

System.IO.BinaryWriter.Dispose()

Releases the unmanaged resources used by the System.IO.BinaryWriter and optionally releases the managed resources.

Parameters

NameDescriptionDefault
disposing true to release both managed and unmanaged resources; false to release only unmanaged resources.

System.IO.BinaryWriter.DisposeAsync

Asynchronously releases all resources used by the current instance of the System.IO.BinaryWriter class.

Returns

A task that represents the asynchronous dispose operation.

System.IO.BinaryWriter.Flush

Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.

System.IO.BinaryWriter.Seek()

Sets the position within the current stream.

Parameters

NameDescriptionDefault
offset A byte offset relative to origin.
origin A field of System.IO.SeekOrigin indicating the reference point from which the new position is to be obtained.

Returns

The position with the current stream.

System.IO.BinaryWriter.Write()

Writes a one-byte Boolean value to the current stream, with 0 representing false and 1 representing true.

Parameters

NameDescriptionDefault
value The Boolean value to write (0 or 1).

System.IO.BinaryWriter.Write()

Writes an unsigned byte to the current stream and advances the stream position by one byte.

Parameters

NameDescriptionDefault
value The unsigned byte to write.

System.IO.BinaryWriter.Write()

Writes a byte array to the underlying stream.

Parameters

NameDescriptionDefault
buffer A byte array containing the data to write.

System.IO.BinaryWriter.Write()

Writes a region of a byte array to the current stream.

Parameters

NameDescriptionDefault
buffer A byte array containing the data to write.
index The index of the first byte to read from buffer and to write to the stream.
count The number of bytes to read from buffer and to write to the stream.

System.IO.BinaryWriter.Write()

Writes a Unicode character to the current stream and advances the current position of the stream in accordance with the Encoding used and the specific characters being written to the stream.

Parameters

NameDescriptionDefault
ch The non-surrogate, Unicode character to write.

System.IO.BinaryWriter.Write()

Writes a character array to the current stream and advances the current position of the stream in accordance with the Encoding used and the specific characters being written to the stream.

Parameters

NameDescriptionDefault
chars A character array containing the data to write.

System.IO.BinaryWriter.Write()

Writes a section of a character array to the current stream, and advances the current position of the stream in accordance with the Encoding used and perhaps the specific characters being written to the stream.

Parameters

NameDescriptionDefault
chars A character array containing the data to write.
index The index of the first character to read from chars and to write to the stream.
count The number of characters to read from chars and to write to the stream.

System.IO.BinaryWriter.Write()

Writes a decimal value to the current stream and advances the stream position by sixteen bytes.

Parameters

NameDescriptionDefault
value The decimal value to write.

System.IO.BinaryWriter.Write()

Writes an eight-byte floating-point value to the current stream and advances the stream position by eight bytes.

Parameters

NameDescriptionDefault
value The eight-byte floating-point value to write.

System.IO.BinaryWriter.Write()

Writes an two-byte floating-point value to the current stream and advances the stream position by two bytes.

Parameters

NameDescriptionDefault
value The two-byte floating-point value to write.

System.IO.BinaryWriter.Write()

Writes a two-byte signed integer to the current stream and advances the stream position by two bytes.

Parameters

NameDescriptionDefault
value The two-byte signed integer to write.

System.IO.BinaryWriter.Write()

Writes a four-byte signed integer to the current stream and advances the stream position by four bytes.

Parameters

NameDescriptionDefault
value The four-byte signed integer to write.

System.IO.BinaryWriter.Write()

Writes an eight-byte signed integer to the current stream and advances the stream position by eight bytes.

Parameters

NameDescriptionDefault
value The eight-byte signed integer to write.

System.IO.BinaryWriter.Write()

Writes a span of bytes to the current stream.

Parameters

NameDescriptionDefault
buffer The span of bytes to write.

System.IO.BinaryWriter.Write()

Writes a span of characters to the current stream, and advances the current position of the stream in accordance with the Encoding used and perhaps the specific characters being written to the stream.

Parameters

NameDescriptionDefault
chars A span of chars to write.

System.IO.BinaryWriter.Write()

Writes a signed byte to the current stream and advances the stream position by one byte.

Parameters

NameDescriptionDefault
value The signed byte to write.

System.IO.BinaryWriter.Write()

Writes a four-byte floating-point value to the current stream and advances the stream position by four bytes.

Parameters

NameDescriptionDefault
value The four-byte floating-point value to write.

System.IO.BinaryWriter.Write()

Writes a length-prefixed string to this stream in the current encoding of the System.IO.BinaryWriter, and advances the current position of the stream in accordance with the encoding used and the specific characters being written to the stream.

Parameters

NameDescriptionDefault
value The value to write.

System.IO.BinaryWriter.Write()

Writes a two-byte unsigned integer to the current stream and advances the stream position by two bytes.

Parameters

NameDescriptionDefault
value The two-byte unsigned integer to write.

System.IO.BinaryWriter.Write()

Writes a four-byte unsigned integer to the current stream and advances the stream position by four bytes.

Parameters

NameDescriptionDefault
value The four-byte unsigned integer to write.

System.IO.BinaryWriter.Write()

Writes an eight-byte unsigned integer to the current stream and advances the stream position by eight bytes.

Parameters

NameDescriptionDefault
value The eight-byte unsigned integer to write.

System.IO.BinaryWriter.Write7BitEncodedInt()

Writes a 32-bit integer in a compressed format.

Parameters

NameDescriptionDefault
value The 32-bit integer to be written.

System.IO.BinaryWriter.Write7BitEncodedInt64()

Writes out a number 7 bits at a time.

Parameters

NameDescriptionDefault
value The value to write.

System.IO.BinaryWriter.BaseStream

Gets the underlying stream of the System.IO.BinaryWriter.

Returns

The underlying stream associated with the BinaryWriter.

System.IO.BufferedStream

Adds a buffering layer to read and write operations on another stream. This class cannot be inherited.

System.IO.BufferedStream.#ctor()

Initializes a new instance of the System.IO.BufferedStream class with a default buffer size of 4096 bytes.

Parameters

NameDescriptionDefault
stream The current stream.

System.IO.BufferedStream.#ctor()

Initializes a new instance of the System.IO.BufferedStream class with the specified buffer size.

Parameters

NameDescriptionDefault
stream The current stream.
bufferSize The buffer size in bytes.

System.IO.BufferedStream.BeginRead()

Begins an asynchronous read operation. (Consider using System.IO.BufferedStream.ReadAsync() instead.)

Parameters

NameDescriptionDefault
buffer The buffer to read the data into.
offset The byte offset in buffer at which to begin writing data read from the stream.
count The maximum number of bytes to read.
callback An optional asynchronous callback, to be called when the read is complete.
state A user-provided object that distinguishes this particular asynchronous read request from other requests.

Returns

An object that represents the asynchronous read, which could still be pending.

System.IO.BufferedStream.BeginWrite()

Begins an asynchronous write operation. (Consider using System.IO.BufferedStream.WriteAsync() instead.)

Parameters

NameDescriptionDefault
buffer The buffer containing data to write to the current stream.
offset The zero-based byte offset in buffer at which to begin copying bytes to the current stream.
count The maximum number of bytes to write.
callback The method to be called when the asynchronous write operation is completed.
state A user-provided object that distinguishes this particular asynchronous write request from other requests.

Returns

An object that references the asynchronous write which could still be pending.

System.IO.BufferedStream.CopyTo()

Reads the bytes from the current buffered stream and writes them to another stream.

Parameters

NameDescriptionDefault
destination The stream to which the contents of the current buffered stream will be copied.
bufferSize The size of the buffer. This value must be greater than zero. The default size is 81920.

System.IO.BufferedStream.CopyToAsync()

Asynchronously reads the bytes from the current buffered stream and writes them to another stream, using a specified buffer size and cancellation token.

Parameters

NameDescriptionDefault
destination The stream to which the contents of the current buffered stream will be copied.
bufferSize The size, in bytes, of the buffer. This value must be greater than zero. The default sizer is 81920.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous copy operation.

System.IO.BufferedStream.DisposeAsync

Asynchronously releases the unmanaged resources used by the buffered stream.

Returns

A task that represents the asynchronous dispose operation.

System.IO.BufferedStream.EndRead()

Waits for the pending asynchronous read operation to complete. (Consider using System.IO.BufferedStream.ReadAsync() instead.)

Parameters

NameDescriptionDefault
asyncResult The reference to the pending asynchronous request to wait for.

Returns

The number of bytes read from the stream, between 0 (zero) and the number of bytes you requested. Streams only return 0 only at the end of the stream, otherwise, they should block until at least 1 byte is available.

System.IO.BufferedStream.EndWrite()

Ends an asynchronous write operation and blocks until the I/O operation is complete. (Consider using System.IO.BufferedStream.WriteAsync() instead.)

Parameters

NameDescriptionDefault
asyncResult The pending asynchronous request.

System.IO.BufferedStream.Flush

Clears all buffers for this stream and causes any buffered data to be written to the underlying device.

System.IO.BufferedStream.FlushAsync()

Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.

Parameters

NameDescriptionDefault
cancellationToken The token to monitor for cancellation requests.

Returns

A task that represents the asynchronous flush operation.

System.IO.BufferedStream.Read()

Copies bytes from the current buffered stream to an array.

Parameters

NameDescriptionDefault
buffer
offset The byte offset in the buffer at which to begin reading bytes.
count The number of bytes to be read.

Returns

The total number of bytes read into array. This can be less than the number of bytes requested if that many bytes are not currently available, or 0 if the end of the stream has been reached before any data can be read.

System.IO.BufferedStream.Read()

Copies bytes from the current buffered stream to a byte span and advances the position within the buffered stream by the number of bytes read.

Parameters

NameDescriptionDefault
destination A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source.

Returns

The total number of bytes read into the buffer. This can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.

System.IO.BufferedStream.ReadAsync()

Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The buffer to write the data into.
offset The byte offset in buffer at which to begin writing data from the stream.
count The maximum number of bytes to read.
cancellationToken The token to monitor for cancellation requests.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

System.IO.BufferedStream.ReadAsync()

Asynchronously reads a sequence of bytes from the current buffered stream and advances the position within the buffered stream by the number of bytes read.

Parameters

NameDescriptionDefault
buffer The region of memory to write the data into.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous read operation. The value of its System.Threading.Tasks.ValueTask`1.Result property contains the total number of bytes read into the buffer. The result value can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or it can be 0 (zero) if the end of the stream has been reached.

System.IO.BufferedStream.ReadByte

Reads a byte from the underlying stream and returns the byte cast to an int, or returns -1 if reading from the end of the stream.

Returns

The byte cast to an int, or -1 if reading from the end of the stream.

System.IO.BufferedStream.Seek()

Sets the position within the current buffered stream.

Parameters

NameDescriptionDefault
offset A byte offset relative to origin.
origin A value of type System.IO.SeekOrigin indicating the reference point from which to obtain the new position.

Returns

The new position within the current buffered stream.

System.IO.BufferedStream.SetLength()

Sets the length of the buffered stream.

Parameters

NameDescriptionDefault
value An integer indicating the desired length of the current buffered stream in bytes.

System.IO.BufferedStream.Write()

Copies bytes to the buffered stream and advances the current position within the buffered stream by the number of bytes written.

Parameters

NameDescriptionDefault
buffer
offset The offset in the buffer at which to begin copying bytes to the current buffered stream.
count The number of bytes to be written to the current buffered stream.

System.IO.BufferedStream.Write()

Writes a sequence of bytes to the current buffered stream and advances the current position within this buffered stream by the number of bytes written.

Parameters

NameDescriptionDefault
buffer A region of memory. This method copies the contents of this region to the current buffered stream.

System.IO.BufferedStream.WriteAsync()

Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The buffer to write data from.
offset The zero-based byte offset in buffer from which to begin copying bytes to the stream.
count The maximum number of bytes to write.
cancellationToken The token to monitor for cancellation requests.

Returns

A task that represents the asynchronous write operation.

System.IO.BufferedStream.WriteAsync()

Asynchronously writes a sequence of bytes to the current buffered stream, advances the current position within this buffered stream by the number of bytes written, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The region of memory to write data from.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.BufferedStream.WriteByte()

Writes a byte to the current position in the buffered stream.

Parameters

NameDescriptionDefault
value A byte to write to the stream.

System.IO.BufferedStream.BufferSize

Gets the buffer size in bytes for this buffered stream.

Returns

An integer representing the buffer size in bytes.

System.IO.BufferedStream.CanRead

Gets a value indicating whether the current stream supports reading.

Returns

true if the stream supports reading; false if the stream is closed or was opened with write-only access.

System.IO.BufferedStream.CanSeek

Gets a value indicating whether the current stream supports seeking.

Returns

true if the stream supports seeking; false if the stream is closed or if the stream was constructed from an operating system handle such as a pipe or output to the console.

System.IO.BufferedStream.CanWrite

Gets a value indicating whether the current stream supports writing.

Returns

true if the stream supports writing; false if the stream is closed or was opened with read-only access.

System.IO.BufferedStream.Length

Gets the stream length in bytes.

Returns

The stream length in bytes.

System.IO.BufferedStream.Position

Gets the position within the current stream.

Returns

The position within the current stream.

System.IO.BufferedStream.UnderlyingStream

Gets the underlying System.IO.Stream instance for this buffered stream.

Returns

The underlying stream instance.

System.IO.Directory

Exposes static methods for creating, moving, and enumerating through directories and subdirectories. This class cannot be inherited.

System.IO.Directory.CreateDirectory()

Creates all directories and subdirectories in the specified path unless they already exist.

Parameters

NameDescriptionDefault
path The directory to create.

Returns

An object that represents the directory at the specified path. This object is returned regardless of whether a directory at the specified path already exists.

System.IO.Directory.CreateDirectory()

Creates all directories and subdirectories in the specified path with the specified permissions unless they already exist.

Parameters

NameDescriptionDefault
path The directory to create.
unixCreateMode A bitwise combination of the enumeration values that specifies the Unix file mode used to create directories.

Returns

An object that represents the directory at the specified path. This object is returned regardless of whether a directory at the specified path already exists.

System.IO.Directory.CreateSymbolicLink()

Creates a directory symbolic link identified by path that points to pathToTarget.

Parameters

NameDescriptionDefault
path The path where the symbolic link should be created.
pathToTarget The target directory of the symbolic link.

Returns

A System.IO.DirectoryInfo instance that wraps the newly created directory symbolic link.

System.IO.Directory.CreateTempSubdirectory()

Creates a uniquely named, empty directory in the current user's temporary directory.

Parameters

NameDescriptionDefault
prefix An optional string to add to the beginning of the subdirectory name.

Returns

An object that represents the directory that was created.

System.IO.Directory.Delete()

Deletes an empty directory from a specified path.

Parameters

NameDescriptionDefault
path The name of the empty directory to remove. This directory must be writable and empty.

System.IO.Directory.Delete()

Deletes the specified directory and, if indicated, any subdirectories and files in the directory.

Parameters

NameDescriptionDefault
path The name of the directory to remove.
recursive true to remove directories, subdirectories, and files in path; otherwise, false.

System.IO.Directory.EnumerateDirectories()

Returns an enumerable collection of directory full names in a specified path.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.

Returns

An enumerable collection of the full names (including paths) for the directories in the directory specified by path.

System.IO.Directory.EnumerateDirectories()

Returns an enumerable collection of directory full names that match a search pattern in a specified path.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of directories in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.

Returns

An enumerable collection of the full names (including paths) for the directories in the directory specified by path and that match the specified search pattern.

System.IO.Directory.EnumerateDirectories()

Returns an enumerable collection of the directory full names that match a search pattern in a specified path, and optionally searches subdirectories.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of directories in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
enumerationOptions An object that describes the search and enumeration configuration to use.

Returns

An enumerable collection of the full names (including paths) for the directories in the directory specified by path and that match the specified search pattern and enumeration options.

System.IO.Directory.EnumerateDirectories()

Returns an enumerable collection of directory full names that match a search pattern in a specified path, and optionally searches subdirectories.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of directories in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
searchOption One of the enumeration values that specifies whether the search operation should include only the current directory or should include all subdirectories. The default value is System.IO.SearchOption.TopDirectoryOnly.

Returns

An enumerable collection of the full names (including paths) for the directories in the directory specified by path and that match the specified search pattern and search option.

System.IO.Directory.EnumerateFiles()

Returns an enumerable collection of full file names in a specified path.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.

Returns

An enumerable collection of the full names (including paths) for the files in the directory specified by path.

System.IO.Directory.EnumerateFiles()

Returns an enumerable collection of full file names that match a search pattern in a specified path.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of files in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.

Returns

An enumerable collection of the full names (including paths) for the files in the directory specified by path and that match the specified search pattern.

System.IO.Directory.EnumerateFiles()

Returns an enumerable collection of full file names that match a search pattern and enumeration options in a specified path, and optionally searches subdirectories.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of files in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
enumerationOptions An object that describes the search and enumeration configuration to use.

Returns

An enumerable collection of the full names (including paths) for the files in the directory specified by path and that match the specified search pattern and enumeration options.

System.IO.Directory.EnumerateFiles()

Returns an enumerable collection of full file names that match a search pattern in a specified path, and optionally searches subdirectories.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of files in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
searchOption One of the enumeration values that specifies whether the search operation should include only the current directory or should include all subdirectories. The default value is System.IO.SearchOption.TopDirectoryOnly.

Returns

An enumerable collection of the full names (including paths) for the files in the directory specified by path and that match the specified search pattern and search option.

System.IO.Directory.EnumerateFileSystemEntries()

Returns an enumerable collection of file names and directory names in a specified path.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.

Returns

An enumerable collection of file-system entries in the directory specified by path.

System.IO.Directory.EnumerateFileSystemEntries()

Returns an enumerable collection of file names and directory names that match a search pattern in a specified path.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of file-system entries in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.

Returns

An enumerable collection of file-system entries in the directory specified by path and that match the specified search pattern.

System.IO.Directory.EnumerateFileSystemEntries()

Returns an enumerable collection of file names and directory names that match a search pattern and enumeration options in a specified path.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of subdirectories in path. This parameter can contain a combination of valid literal and wildcard characters, but it doesn't support regular expressions.
enumerationOptions An object that describes the search and enumeration configuration to use.

Returns

An enumerable collection of file-system entries in the directory specified by path, that match the specified search pattern and the specified enumeration options.

System.IO.Directory.EnumerateFileSystemEntries()

Returns an enumerable collection of file names and directory names that match a search pattern in a specified path, and optionally searches subdirectories.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against file-system entries in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
searchOption One of the enumeration values that specifies whether the search operation should include only the current directory or should include all subdirectories. The default value is System.IO.SearchOption.TopDirectoryOnly.

Returns

An enumerable collection of file-system entries in the directory specified by path and that match the specified search pattern and option.

System.IO.Directory.Exists()

Determines whether the given path refers to an existing directory on disk.

Parameters

NameDescriptionDefault
path The path to test.

Returns

true if path refers to an existing directory; false if the directory does not exist or an error occurs when trying to determine if the specified directory exists.

System.IO.Directory.GetCreationTime()

Gets the creation date and time of a directory.

Parameters

NameDescriptionDefault
path The path of the directory.

Returns

A structure that is set to the creation date and time for the specified directory. This value is expressed in local time.

System.IO.Directory.GetCreationTimeUtc()

Gets the creation date and time, in Coordinated Universal Time (UTC) format, of a directory.

Parameters

NameDescriptionDefault
path The path of the directory.

Returns

A structure that is set to the creation date and time for the specified directory. This value is expressed in UTC time.

System.IO.Directory.GetCurrentDirectory

Gets the current working directory of the application.

Returns

A string that contains the absolute path of the current working directory, and does not end with a backslash (\).

System.IO.Directory.GetDirectories()

Returns the names of subdirectories (including their paths) in the specified directory.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.

Returns

An array of the full names (including paths) of subdirectories in the specified path, or an empty array if no directories are found.

System.IO.Directory.GetDirectories()

Returns the names of subdirectories (including their paths) that match the specified search pattern in the specified directory.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of subdirectories in path. This parameter can contain a combination of valid literal and wildcard characters, but it doesn't support regular expressions.

Returns

An array of the full names (including paths) of the subdirectories that match the search pattern in the specified directory, or an empty array if no directories are found.

System.IO.Directory.GetDirectories()

Returns the names of subdirectories (including their paths) that match the specified search pattern and enumeration options in the specified directory.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of subdirectories in path. This parameter can contain a combination of valid literal and wildcard characters, but it doesn't support regular expressions.
enumerationOptions An object that describes the search and enumeration configuration to use.

Returns

An array of the full names (including paths) of the subdirectories that match the search pattern and enumeration options in the specified directory, or an empty array if no directories are found.

System.IO.Directory.GetDirectories()

Returns the names of the subdirectories (including their paths) that match the specified search pattern in the specified directory, and optionally searches subdirectories.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of subdirectories in path. This parameter can contain a combination of valid literal and wildcard characters, but it doesn't support regular expressions.
searchOption One of the enumeration values that specifies whether the search operation should include all subdirectories or only the current directory.

Returns

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.

System.IO.Directory.GetDirectoryRoot()

Returns the volume information, root information, or both for the specified path.

Parameters

NameDescriptionDefault
path The path of a file or directory.

Returns

A string that contains the volume information, root information, or both for the specified path.

System.IO.Directory.GetFiles()

Returns the names of files (including their paths) in the specified directory.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.

Returns

An array of the full names (including paths) for the files in the specified directory, or an empty array if no files are found.

System.IO.Directory.GetFiles()

Returns the names of files (including their paths) that match the specified search pattern in the specified directory.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of files in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.

Returns

An array of the full names (including paths) for the files in the specified directory that match the specified search pattern, or an empty array if no files are found.

System.IO.Directory.GetFiles()

Returns the names of files (including their paths) that match the specified search pattern and enumeration options in the specified directory.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of subdirectories in path. This parameter can contain a combination of valid literal and wildcard characters, but it doesn't support regular expressions.
enumerationOptions An object that describes the search and enumeration configuration to use.

Returns

An array of the full names (including paths) for the files in the specified directory that match the specified search pattern and enumeration options, or an empty array if no files are found.

System.IO.Directory.GetFiles()

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.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of files in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
searchOption One of the enumeration values that specifies whether the search operation should include all subdirectories or only the current directory.

Returns

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.

System.IO.Directory.GetFileSystemEntries()

Returns the names of all files and subdirectories in a specified path.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.

Returns

An array of the names of files and subdirectories in the specified directory, or an empty array if no files or subdirectories are found.

System.IO.Directory.GetFileSystemEntries()

Returns an array of file names and directory names that match a search pattern in a specified path.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of file and directories in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.

Returns

An array of file names and directory names that match the specified search criteria, or an empty array if no files or directories are found.

System.IO.Directory.GetFileSystemEntries()

Returns an array of file names and directory names that match a search pattern and enumeration options in a specified path.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of subdirectories in path. This parameter can contain a combination of valid literal and wildcard characters, but it doesn't support regular expressions.
enumerationOptions An object that describes the search and enumeration configuration to use.

Returns

An array of file names and directory names that match the specified search pattern and enumeration options, or an empty array if no files or directories are found.

System.IO.Directory.GetFileSystemEntries()

Returns an array of all the file names and directory names that match a search pattern in a specified path, and optionally searches subdirectories.

Parameters

NameDescriptionDefault
path The relative or absolute path to the directory to search. This string is not case-sensitive.
searchPattern The search string to match against the names of files and directories in path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
searchOption One of the enumeration values that specifies whether the search operation should include only the current directory or should include all subdirectories. The default value is System.IO.SearchOption.TopDirectoryOnly.

Returns

An array of file the file names and directory names that match the specified search criteria, or an empty array if no files or directories are found.

System.IO.Directory.GetLastAccessTime()

Returns the date and time the specified file or directory was last accessed.

Parameters

NameDescriptionDefault
path The file or directory for which to obtain access date and time information.

Returns

A structure that is set to the date and time the specified file or directory was last accessed. This value is expressed in local time.

System.IO.Directory.GetLastAccessTimeUtc()

Returns the date and time, in Coordinated Universal Time (UTC) format, that the specified file or directory was last accessed.

Parameters

NameDescriptionDefault
path The file or directory for which to obtain access date and time information.

Returns

A structure that is set to the date and time the specified file or directory was last accessed. This value is expressed in UTC time.

System.IO.Directory.GetLastWriteTime()

Returns the date and time the specified file or directory was last written to.

Parameters

NameDescriptionDefault
path The file or directory for which to obtain modification date and time information.

Returns

A structure that is set to the date and time the specified file or directory was last written to. This value is expressed in local time.

System.IO.Directory.GetLastWriteTimeUtc()

Returns the date and time, in Coordinated Universal Time (UTC) format, that the specified file or directory was last written to.

Parameters

NameDescriptionDefault
path The file or directory for which to obtain modification date and time information.

Returns

A structure that is set to the date and time the specified file or directory was last written to. This value is expressed in UTC time.

System.IO.Directory.GetLogicalDrives

Retrieves the names of the logical drives on this computer in the form "<drive letter>:\".

Returns

The logical drives on this computer.

System.IO.Directory.GetParent()

Retrieves the parent directory of the specified path, including both absolute and relative paths.

Parameters

NameDescriptionDefault
path The path for which to retrieve the parent directory.

Returns

The parent directory, or null if path is the root directory, including the root of a UNC server or share name.

System.IO.Directory.Move()

Moves a file or a directory and its contents to a new location.

Parameters

NameDescriptionDefault
sourceDirName The path of the file or directory to move.
destDirName The path to the new location for sourceDirName or its contents. If sourceDirName is a file, then destDirName must also be a file name.

System.IO.Directory.ResolveLinkTarget()

Gets the target of the specified directory link.

Parameters

NameDescriptionDefault
linkPath The path of the directory link.
returnFinalTarget true to follow links to the final target; false to return the immediate next link.

Returns

A System.IO.DirectoryInfo instance if linkPath exists, independently if the target exists or not. null if linkPath is not a link.

System.IO.Directory.SetCreationTime()

Sets the creation date and time for the specified file or directory.

Parameters

NameDescriptionDefault
path The file or directory for which to set the creation date and time information.
creationTime The date and time the file or directory was last written to. This value is expressed in local time.

System.IO.Directory.SetCreationTimeUtc()

Sets the creation date and time, in Coordinated Universal Time (UTC) format, for the specified file or directory.

Parameters

NameDescriptionDefault
path The file or directory for which to set the creation date and time information.
creationTimeUtc The date and time the directory or file was created. This value is expressed in local time.

System.IO.Directory.SetCurrentDirectory()

Sets the application's current working directory to the specified directory.

Parameters

NameDescriptionDefault
path The path to which the current working directory is set.

System.IO.Directory.SetLastAccessTime()

Sets the date and time the specified file or directory was last accessed.

Parameters

NameDescriptionDefault
path The file or directory for which to set the access date and time information.
lastAccessTime An object that contains the value to set for the access date and time of path. This value is expressed in local time.

System.IO.Directory.SetLastAccessTimeUtc()

Sets the date and time, in Coordinated Universal Time (UTC) format, that the specified file or directory was last accessed.

Parameters

NameDescriptionDefault
path The file or directory for which to set the access date and time information.
lastAccessTimeUtc An object that contains the value to set for the access date and time of path. This value is expressed in UTC time.

System.IO.Directory.SetLastWriteTime()

Sets the date and time a directory was last written to.

Parameters

NameDescriptionDefault
path The path of the directory.
lastWriteTime The date and time the directory was last written to. This value is expressed in local time.

System.IO.Directory.SetLastWriteTimeUtc()

Sets the date and time, in Coordinated Universal Time (UTC) format, that a directory was last written to.

Parameters

NameDescriptionDefault
path The path of the directory.
lastWriteTimeUtc The date and time the directory was last written to. This value is expressed in UTC time.

System.IO.DirectoryInfo

Exposes instance methods for creating, moving, and enumerating through directories and subdirectories. This class cannot be inherited.

System.IO.DirectoryInfo.#ctor()

Initializes a new instance of the System.IO.DirectoryInfo class on the specified path.

Parameters

NameDescriptionDefault
path A string specifying the path on which to create the DirectoryInfo.

System.IO.DirectoryInfo.Create

Creates a directory.

System.IO.DirectoryInfo.CreateSubdirectory()

Creates a subdirectory or subdirectories on the specified path. The specified path can be relative to this instance of the System.IO.DirectoryInfo class.

Parameters

NameDescriptionDefault
path The specified path. This cannot be a different disk volume or Universal Naming Convention (UNC) name.

Returns

The last directory specified in path.

System.IO.DirectoryInfo.Delete

Deletes this System.IO.DirectoryInfo if it is empty.

System.IO.DirectoryInfo.Delete()

Deletes this instance of a System.IO.DirectoryInfo, specifying whether to delete subdirectories and files.

Parameters

NameDescriptionDefault
recursive true to delete this directory, its subdirectories, and all files; otherwise, false.

System.IO.DirectoryInfo.EnumerateDirectories

Returns an enumerable collection of directory information in the current directory.

Returns

An enumerable collection of directories in the current directory.

System.IO.DirectoryInfo.EnumerateDirectories()

Returns an enumerable collection of directory information that matches a specified search pattern.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of directories. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.

Returns

An enumerable collection of directories that matches searchPattern.

System.IO.DirectoryInfo.EnumerateDirectories()

Returns an enumerable collection of directory information that matches the specified search pattern and enumeration options.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of directories. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
enumerationOptions An object that describes the search and enumeration configuration to use.

Returns

An enumerable collection of directories that matches searchPattern and enumerationOptions.

System.IO.DirectoryInfo.EnumerateDirectories()

Returns an enumerable collection of directory information that matches a specified search pattern and search subdirectory option.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of directories. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
searchOption One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is System.IO.SearchOption.TopDirectoryOnly.

Returns

An enumerable collection of directories that matches searchPattern and searchOption.

System.IO.DirectoryInfo.EnumerateFiles

Returns an enumerable collection of file information in the current directory.

Returns

An enumerable collection of the files in the current directory.

System.IO.DirectoryInfo.EnumerateFiles()

Returns an enumerable collection of file information that matches a search pattern.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of files. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.

Returns

An enumerable collection of files that matches searchPattern.

System.IO.DirectoryInfo.EnumerateFiles()

Returns an enumerable collection of file information that matches the specified search pattern and enumeration options.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of files. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
enumerationOptions An object that describes the search and enumeration configuration to use.

Returns

An enumerable collection of files that matches searchPattern and enumerationOptions.

System.IO.DirectoryInfo.EnumerateFiles()

Returns an enumerable collection of file information that matches a specified search pattern and search subdirectory option.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of files. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
searchOption One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is System.IO.SearchOption.TopDirectoryOnly.

Returns

An enumerable collection of files that matches searchPattern and searchOption.

System.IO.DirectoryInfo.EnumerateFileSystemInfos

Returns an enumerable collection of file system information in the current directory.

Returns

An enumerable collection of file system information in the current directory.

System.IO.DirectoryInfo.EnumerateFileSystemInfos()

Returns an enumerable collection of file system information that matches a specified search pattern.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of directories. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.

Returns

An enumerable collection of file system information objects that matches searchPattern.

System.IO.DirectoryInfo.EnumerateFileSystemInfos()

Returns an enumerable collection of file system information that matches the specified search pattern and enumeration options.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of directories. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
enumerationOptions An object that describes the search and enumeration configuration to use.

Returns

An enumerable collection of file system information objects that matches searchPattern and enumerationOptions.

System.IO.DirectoryInfo.EnumerateFileSystemInfos()

Returns an enumerable collection of file system information that matches a specified search pattern and search subdirectory option.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of directories. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
searchOption One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is System.IO.SearchOption.TopDirectoryOnly.

Returns

An enumerable collection of file system information objects that matches searchPattern and searchOption.

System.IO.DirectoryInfo.GetDirectories

Returns the subdirectories of the current directory.

Returns

An array of System.IO.DirectoryInfo objects.

System.IO.DirectoryInfo.GetDirectories()

Returns an array of directories in the current System.IO.DirectoryInfo matching the given search criteria.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of directories. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.

Returns

An array of type DirectoryInfo matching searchPattern.

System.IO.DirectoryInfo.GetDirectories()

Returns an array of directories in the current System.IO.DirectoryInfo matching the specified search pattern and enumeration options.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of directories. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
enumerationOptions An object that describes the search and enumeration configuration to use.

Returns

An array of type DirectoryInfo matching searchPattern and enumerationOptions.

System.IO.DirectoryInfo.GetDirectories()

Returns an array of directories in the current System.IO.DirectoryInfo matching the given search criteria and using a value to determine whether to search subdirectories.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of directories. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
searchOption One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories.

Returns

An array of type DirectoryInfo matching searchPattern.

System.IO.DirectoryInfo.GetFiles

Returns a file list from the current directory.

Returns

An array of type System.IO.FileInfo.

System.IO.DirectoryInfo.GetFiles()

Returns a file list from the current directory matching the given search pattern.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of files. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.

Returns

An array of type System.IO.FileInfo.

System.IO.DirectoryInfo.GetFiles()

Returns a file list from the current directory matching the specified search pattern and enumeration options.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of files. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
enumerationOptions An object that describes the search and enumeration configuration to use.

Returns

An array of strongly typed System.IO.FileInfo objects that match searchPattern and enumerationOptions.

System.IO.DirectoryInfo.GetFiles()

Returns a file list from the current directory matching the given search pattern and using a value to determine whether to search subdirectories.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of files. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
searchOption One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories.

Returns

An array of type System.IO.FileInfo.

System.IO.DirectoryInfo.GetFileSystemInfos

Returns an array of strongly typed System.IO.FileSystemInfo entries representing all the files and subdirectories in a directory.

Returns

An array of strongly typed System.IO.FileSystemInfo entries.

System.IO.DirectoryInfo.GetFileSystemInfos()

Retrieves an array of strongly typed System.IO.FileSystemInfo objects representing the files and subdirectories that match the specified search criteria.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of directories and files. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.

Returns

An array of strongly typed FileSystemInfo objects matching the search criteria.

System.IO.DirectoryInfo.GetFileSystemInfos()

Retrieves an array of strongly typed System.IO.FileSystemInfo objects representing the files and subdirectories that match the specified search pattern and enumeration options.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of directories and files. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
enumerationOptions An object that describes the search and enumeration configuration to use.

Returns

An array of strongly typed FileSystemInfo objects matching searchPattern and enumerationOptions.

System.IO.DirectoryInfo.GetFileSystemInfos()

Retrieves an array of System.IO.FileSystemInfo objects that represent the files and subdirectories matching the specified search criteria.

Parameters

NameDescriptionDefault
searchPattern The search string to match against the names of directories and files. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
searchOption One of the enumeration values that specifies whether the search operation should include only the current directory or all subdirectories. The default value is System.IO.SearchOption.TopDirectoryOnly.

Returns

An array of file system entries that match the search criteria.

System.IO.DirectoryInfo.MoveTo()

Moves a System.IO.DirectoryInfo instance and its contents to a new path.

Parameters

NameDescriptionDefault
destDirName The name and path to which to move this directory. The destination cannot be another disk volume or a directory with the identical name. It can be an existing directory to which you want to add this directory as a subdirectory.

System.IO.DirectoryInfo.ToString

Returns the original path that was passed to the System.IO.DirectoryInfo constructor. Use the System.IO.DirectoryInfo.FullName or System.IO.DirectoryInfo.Name properties for the full path or file/directory name instead of this method.

Returns

The original path that was passed by the user.

System.IO.DirectoryInfo.Exists

Gets a value indicating whether the directory exists.

Returns

true if the directory exists; otherwise, false.

System.IO.DirectoryInfo.Name

Gets the name of this System.IO.DirectoryInfo instance.

Returns

The directory name.

System.IO.DirectoryInfo.Parent

Gets the parent directory of a specified subdirectory.

Returns

The parent directory, or null if the path is null or if the file path denotes a root (such as \, C:\, or \\server\share).

System.IO.DirectoryInfo.Root

Gets the root portion of the directory.

Returns

An object that represents the root of the directory.

System.IO.DirectoryNotFoundException

The exception that is thrown when part of a file or directory cannot be found.

System.IO.DirectoryNotFoundException.#ctor

Initializes a new instance of the System.IO.DirectoryNotFoundException class with its message string set to a system-supplied message and its HRESULT set to COR_E_DIRECTORYNOTFOUND.

System.IO.DirectoryNotFoundException.#ctor()

Initializes a new instance of the System.IO.DirectoryNotFoundException class with the specified serialization and context information.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.IO.DirectoryNotFoundException.#ctor()

Initializes a new instance of the System.IO.DirectoryNotFoundException class with its message string set to message and its HRESULT set to COR_E_DIRECTORYNOTFOUND.

Parameters

NameDescriptionDefault
message A System.String that describes the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.

System.IO.DirectoryNotFoundException.#ctor()

Initializes a new instance of the System.IO.DirectoryNotFoundException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.IO.EndOfStreamException

The exception that is thrown when reading is attempted past the end of a stream.

System.IO.EndOfStreamException.#ctor

Initializes a new instance of the System.IO.EndOfStreamException class with its message string set to a system-supplied message and its HRESULT set to COR_E_ENDOFSTREAM.

System.IO.EndOfStreamException.#ctor()

Initializes a new instance of the System.IO.EndOfStreamException class with the specified serialization and context information.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.IO.EndOfStreamException.#ctor()

Initializes a new instance of the System.IO.EndOfStreamException class with its message string set to message and its HRESULT set to COR_E_ENDOFSTREAM.

Parameters

NameDescriptionDefault
message A string that describes the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.

System.IO.EndOfStreamException.#ctor()

Initializes a new instance of the System.IO.EndOfStreamException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message A string that describes the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.IO.Enumeration.FileSystemEntry

Provides a lower level view of System.IO.FileSystemInfo to help process and filter find results.

System.IO.Enumeration.FileSystemEntry.ToFileSystemInfo

Converts the value of this instance to a System.IO.FileSystemInfo.

Returns

The value of this instance as a System.IO.FileSystemInfo.

System.IO.Enumeration.FileSystemEntry.ToFullPath

Returns the full path of the find result.

Returns

A string representing the full path.

System.IO.Enumeration.FileSystemEntry.ToSpecifiedFullPath

Returns the full path for the find results, based on the initially provided path.

Returns

A string representing the full path.

System.IO.Enumeration.FileSystemEntry.Attributes

Gets the attributes for this entry.

Returns

The attributes for this entry.

System.IO.Enumeration.FileSystemEntry.CreationTimeUtc

Gets the creation time for the entry or the oldest available time stamp if the operating system does not support creation time stamps.

Returns

The creation time for the entry.

System.IO.Enumeration.FileSystemEntry.Directory

Gets the full path of the directory this entry resides in.

Returns

The full path of this entry's directory.

System.IO.Enumeration.FileSystemEntry.FileName

Gets the file name for this entry.

Returns

This entry's file name.

System.IO.Enumeration.FileSystemEntry.IsDirectory

Gets a value that indicates whether this entry is a directory.

Returns

true if the entry is a directory; otherwise, false.

System.IO.Enumeration.FileSystemEntry.IsHidden

Gets a value that indicates whether the file has the hidden attribute.

Returns

true if the file has the hidden attribute; otherwise, false.

System.IO.Enumeration.FileSystemEntry.LastAccessTimeUtc

Gets a datetime offset that represents the last access time in UTC.

Returns

The last access time in UTC.

System.IO.Enumeration.FileSystemEntry.LastWriteTimeUtc

Gets a datetime offset that represents the last write time in UTC.

Returns

The last write time in UTC.

System.IO.Enumeration.FileSystemEntry.Length

Gets the length of the file, in bytes.

Returns

The file length in bytes.

System.IO.Enumeration.FileSystemEntry.OriginalRootDirectory

Gets the root directory for the enumeration as specified in the constructor.

Returns

The original root directory.

System.IO.Enumeration.FileSystemEntry.RootDirectory

Gets the full path of the root directory used for the enumeration.

Returns

The root directory.

System.IO.Enumeration.FileSystemEnumerable`1

Allows utilizing custom filter predicates and transform delegates for enumeration purposes.

System.IO.Enumeration.FileSystemEnumerable`1.#ctor()

Initializes a new instance of the System.IO.Enumeration.FileSystemEnumerable`1 class with specific search and filtering options.

Parameters

NameDescriptionDefault
directory The path of the directory where the enumeration will be performed.
transform A delegate method for transforming raw find data into a result.
options An object describing the enumeration options.

System.IO.Enumeration.FileSystemEnumerable`1.GetEnumerator

Retrieves the enumerator for this type of result.

Returns

An enumerator.

System.IO.Enumeration.FileSystemEnumerable`1.System#Collections#IEnumerable#GetEnumerator

Gets an enumerator that can be used to iterate.

Returns

An enumerator instance.

System.IO.Enumeration.FileSystemEnumerable`1.ShouldIncludePredicate

Gets or sets the predicate that can be used to verify if the TResults should be included.

Returns

The include predicate.

System.IO.Enumeration.FileSystemEnumerable`1.ShouldRecursePredicate

Gets or sets the predicate that can be used to verify if the TResults should be recursed.

Returns

The recurse predicate.

System.IO.Enumeration.FileSystemEnumerable`1.FindPredicate

Encapsulates a method for filtering out find results.

Parameters

NameDescriptionDefault
entry A reference to the file system entry that will be evaluated with the predicate condition.

Returns

true if the predicate condition is met; otherwise, false.

System.IO.Enumeration.FileSystemEnumerable`1.FindTransform

Encapsulates a method for transforming raw find data into a result.

Parameters

NameDescriptionDefault
entry A reference to the file system entry that will be evaluated with the predicate condition.

Returns

An instance of the type that this delegate encapsulates.

System.IO.Enumeration.FileSystemEnumerator`1

Enumerates the file system elements of the provided type that are being searched and filtered by a System.IO.Enumeration.FileSystemEnumerable`1.

System.IO.Enumeration.FileSystemEnumerator`1.#ctor()

Encapsulates a find operation.

Parameters

NameDescriptionDefault
directory The directory to search in.
options Enumeration options to use.

System.IO.Enumeration.FileSystemEnumerator`1.ContinueOnError()

When overriden in a derived class, returns a value that indicates whether to continue execution or throw the default exception.

Parameters

NameDescriptionDefault
error The native error code.

Returns

true to continue; false to throw the default exception for the given error.

System.IO.Enumeration.FileSystemEnumerator`1.Dispose

Releases the resources used by the current instance of the System.IO.Enumeration.FileSystemEnumerator`1 class.

System.IO.Enumeration.FileSystemEnumerator`1.Dispose()

When overridden in a derived class, releases the unmanaged resources used by the System.IO.Enumeration.FileSystemEnumerator`1 class and optionally releases the managed resources.

Parameters

NameDescriptionDefault
disposing true to release both managed and unmanaged resources; false to release only unmanaged resources.

System.IO.Enumeration.FileSystemEnumerator`1.MoveNext

Advances the enumerator to the next item of the System.IO.Enumeration.FileSystemEnumerator`1.

Returns

true if the enumerator successfully advanced to the next item; false if the end of the enumerator has been passed.

System.IO.Enumeration.FileSystemEnumerator`1.OnDirectoryFinished()

When overriden in a derived class, this method is called whenever the end of a directory is reached.

Parameters

NameDescriptionDefault
directory The directory path as a read-only span.

System.IO.Enumeration.FileSystemEnumerator`1.Reset

System.IO.Enumeration.FileSystemEnumerator`1.ShouldIncludeEntry()

When overridden in a derived class, determines whether the specified file system entry should be included in the results.

Parameters

NameDescriptionDefault
entry A file system entry reference.

Returns

true if the specified file system entry should be included in the results; otherwise, false.

System.IO.Enumeration.FileSystemEnumerator`1.ShouldRecurseIntoEntry()

When overridden in a derived class, determines whether the specified file system entry should be recursed.

Parameters

NameDescriptionDefault
entry A file system entry reference.

Returns

true if the specified directory entry should be recursed into; otherwise, false.

System.IO.Enumeration.FileSystemEnumerator`1.TransformEntry()

When overridden in a derived class, generates the result type from the current entry.

Parameters

NameDescriptionDefault
entry A file system entry reference.

Returns

The result type from the current entry.

System.IO.Enumeration.FileSystemEnumerator`1.Current

Gets the currently visited element.

Returns

The currently visited element.

System.IO.Enumeration.FileSystemEnumerator`1.System#Collections#IEnumerator#Current

Gets the currently visited object.

Returns

The currently visited object.

System.IO.Enumeration.FileSystemName

Provides methods for matching file system names.

System.IO.Enumeration.FileSystemName.MatchesSimpleExpression()

Verifies if the given expression matches the given name. Supports the following wildcards: '*' and '?'. The backslash character '\' escapes.

Parameters

NameDescriptionDefault
expression The expression to match with.
name The name to check against the expression.
ignoreCase true to ignore case (default); false if the match should be case-sensitive.

Returns

true if the given expression matches the given name; otherwise, false.

System.IO.Enumeration.FileSystemName.MatchesWin32Expression()

Verifies if the given Win32 expression matches the given name. Supports the following wildcards: '*', '?', '<', '>', '"'. The backslash character '\' escapes.

Parameters

NameDescriptionDefault
expression The expression to match with, such as "*.foo".
name The name to check against the expression.
ignoreCase true to ignore case (default), false if the match should be case-sensitive.

Returns

true if the given expression matches the given name; otherwise, false.

System.IO.Enumeration.FileSystemName.TranslateWin32Expression()

Translates the given Win32 expression. Change '*' and '?' to '<', '>' and '"' to match Win32 behavior.

Parameters

NameDescriptionDefault
expression The expression to translate.

Returns

A string with the translated Win32 expression.

System.IO.EnumerationOptions

Provides file and directory enumeration options.

System.IO.EnumerationOptions.#ctor

Initializes a new instance of the System.IO.EnumerationOptions class with the recommended default options.

System.IO.EnumerationOptions.AttributesToSkip

Gets or sets the attributes to skip.

Returns

The attributes to skip. The default is FileAttributes.Hidden | FileAttributes.System.

System.IO.EnumerationOptions.BufferSize

Gets or sets the suggested buffer size, in bytes.

Returns

The buffer size. The default is 0 (no suggestion).

System.IO.EnumerationOptions.IgnoreInaccessible

Gets or sets a value that indicates whether to skip files or directories when access is denied (for example, System.UnauthorizedAccessException or System.Security.SecurityException).

Returns

true to skip innacessible files or directories; otherwise, false. The default is true.

System.IO.EnumerationOptions.MatchCasing

Gets or sets the case-matching behavior.

Returns

One of the enumeration values that indicates the case-matching behavior. The default is System.IO.MatchCasing.PlatformDefault.

System.IO.EnumerationOptions.MatchType

Gets or sets the match type.

Returns

One of the enumeration values that indicates the match type. The default is System.IO.MatchType.Simple.

System.IO.EnumerationOptions.MaxRecursionDepth

Gets or sets a value that indicates the maximum directory depth to recurse while enumerating, when System.IO.EnumerationOptions.RecurseSubdirectories is set to true.

Returns

A number that represents the maximum directory depth to recurse while enumerating. The default is Int32.MaxValue.

System.IO.EnumerationOptions.RecurseSubdirectories

Gets or sets a value that indicates whether to recurse into subdirectories while enumerating.

Returns

true to recurse into subdirectories; otherwise, false. The default is false.

System.IO.EnumerationOptions.ReturnSpecialDirectories

Gets or sets a value that indicates whether to return the special directory entries "." and "..".

Returns

true to return the special directory entries "." and ".."; otherwise, false.

System.IO.File

Provides static methods for the creation, copying, deletion, moving, and opening of a single file, and aids in the creation of System.IO.FileStream objects.

System.IO.File.AppendAllLines()

Appends lines to a file, and then closes the file. If the specified file does not exist, this method creates a file, writes the specified lines to the file, and then closes the file.

Parameters

NameDescriptionDefault
path The file to append the lines to. The file is created if it doesn't already exist.
contents The lines to append to the file.

System.IO.File.AppendAllLines()

Appends lines to a file by using a specified encoding, and then closes the file. If the specified file does not exist, this method creates a file, writes the specified lines to the file, and then closes the file.

Parameters

NameDescriptionDefault
path The file to append the lines to. The file is created if it doesn't already exist.
contents The lines to append to the file.
encoding The character encoding to use.

System.IO.File.AppendAllLinesAsync()

Asynchronously appends lines to a file by using a specified encoding, and then closes the file. If the specified file does not exist, this method creates a file, writes the specified lines to the file, and then closes the file.

Parameters

NameDescriptionDefault
path The file to append the lines to. The file is created if it doesn't already exist.
contents The lines to append to the file.
encoding The character encoding to use.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous append operation.

System.IO.File.AppendAllLinesAsync()

Asynchronously appends lines to a file, and then closes the file. If the specified file does not exist, this method creates a file, writes the specified lines to the file, and then closes the file.

Parameters

NameDescriptionDefault
path The file to append the lines to. The file is created if it doesn't already exist.
contents The lines to append to the file.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous append operation.

System.IO.File.AppendAllText()

Opens a file, appends the specified string to the file, and then closes the file. If the file does not exist, this method creates a file, writes the specified string to the file, then closes the file.

Parameters

NameDescriptionDefault
path The file to append the specified string to.
contents The string to append to the file.

System.IO.File.AppendAllText()

Appends the specified string to the file using the specified encoding, creating the file if it does not already exist.

Parameters

NameDescriptionDefault
path The file to append the specified string to.
contents The string to append to the file.
encoding The character encoding to use.

System.IO.File.AppendAllTextAsync()

Asynchronously opens a file or creates the file if it does not already exist, appends the specified string to the file using the specified encoding, and then closes the file.

Parameters

NameDescriptionDefault
path The file to append the specified string to.
contents The string to append to the file.
encoding The character encoding to use.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous append operation.

System.IO.File.AppendAllTextAsync()

Asynchronously opens a file or creates a file if it does not already exist, appends the specified string to the file, and then closes the file.

Parameters

NameDescriptionDefault
path The file to append the specified string to.
contents The string to append to the file.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous append operation.

System.IO.File.AppendText()

Creates a System.IO.StreamWriter that appends UTF-8 encoded text to an existing file, or to a new file if the specified file does not exist.

Parameters

NameDescriptionDefault
path The path to the file to append to.

Returns

A stream writer that appends UTF-8 encoded text to the specified file or to a new file.

System.IO.File.Copy()

Copies an existing file to a new file. Overwriting a file of the same name is not allowed.

Parameters

NameDescriptionDefault
sourceFileName The file to copy.
destFileName The name of the destination file. This cannot be a directory or an existing file.

System.IO.File.Copy()

Copies an existing file to a new file. Overwriting a file of the same name is allowed.

Parameters

NameDescriptionDefault
sourceFileName The file to copy.
destFileName The name of the destination file. This cannot be a directory.
overwrite true if the destination file can be overwritten; otherwise, false.

System.IO.File.Create()

Creates or overwrites a file in the specified path.

Parameters

NameDescriptionDefault
path The path and name of the file to create.

Returns

A System.IO.FileStream that provides read/write access to the file specified in path.

System.IO.File.Create()

Creates or overwrites a file in the specified path, specifying a buffer size.

Parameters

NameDescriptionDefault
path The path and name of the file to create.
bufferSize The number of bytes buffered for reads and writes to the file.

Returns

A System.IO.FileStream with the specified buffer size that provides read/write access to the file specified in path.

System.IO.File.Create()

Creates or overwrites a file in the specified path, specifying a buffer size and options that describe how to create or overwrite the file.

Parameters

NameDescriptionDefault
path The path and name of the file to create.
bufferSize The number of bytes buffered for reads and writes to the file.
options One of the System.IO.FileOptions values that describes how to create or overwrite the file.

Returns

A new file with the specified buffer size.

System.IO.File.CreateSymbolicLink()

Creates a file symbolic link identified by path that points to pathToTarget.

Parameters

NameDescriptionDefault
path The path where the symbolic link should be created.
pathToTarget The path of the target to which the symbolic link points.

Returns

A System.IO.FileInfo instance that wraps the newly created file symbolic link.

System.IO.File.CreateText()

Creates or opens a file for writing UTF-8 encoded text. If the file already exists, its contents are overwritten.

Parameters

NameDescriptionDefault
path The file to be opened for writing.

Returns

A System.IO.StreamWriter that writes to the specified file using UTF-8 encoding.

System.IO.File.Decrypt()

Decrypts a file that was encrypted by the current account using the System.IO.File.Encrypt() method.

Parameters

NameDescriptionDefault
path A path that describes a file to decrypt.

System.IO.File.Delete()

Deletes the specified file.

Parameters

NameDescriptionDefault
path The name of the file to be deleted. Wildcard characters are not supported.

System.IO.File.Encrypt()

Encrypts a file so that only the account used to encrypt the file can decrypt it.

Parameters

NameDescriptionDefault
path A path that describes a file to encrypt.

System.IO.File.Exists()

Determines whether the specified file exists.

Parameters

NameDescriptionDefault
path The file to check.

Returns

true if the caller has the required permissions and path contains the name of an existing file; otherwise, false. This method also returns false if path is null, an invalid path, or a zero-length string. If the caller does not have sufficient permissions to read the specified file, no exception is thrown and the method returns false regardless of the existence of path.

System.IO.File.GetAttributes()

Gets the specified System.IO.FileAttributes of the file or directory associated with fileHandle.

Parameters

NameDescriptionDefault
fileHandle A Microsoft.Win32.SafeHandles.SafeFileHandle to the file or directory for which the attributes are to be retrieved.

Returns

The System.IO.FileAttributes of the file or directory.

System.IO.File.GetAttributes()

Gets the System.IO.FileAttributes of the file on the path.

Parameters

NameDescriptionDefault
path The path to the file.

Returns

The System.IO.FileAttributes of the file on the path.

System.IO.File.GetCreationTime()

Returns the creation time of the specified file or directory.

Parameters

NameDescriptionDefault
fileHandle A Microsoft.Win32.SafeHandles.SafeFileHandle to the file or directory for which to obtain creation date and time information.

Returns

A System.DateTime structure set to the creation date and time for the specified file or directory. This value is expressed in local time.

System.IO.File.GetCreationTime()

Returns the creation date and time of the specified file or directory.

Parameters

NameDescriptionDefault
path The file or directory for which to obtain creation date and time information.

Returns

A System.DateTime structure set to the creation date and time for the specified file or directory. This value is expressed in local time.

System.IO.File.GetCreationTimeUtc()

Returns the creation date and time, in Coordinated Universal Time (UTC), of the specified file or directory.

Parameters

NameDescriptionDefault
fileHandle A Microsoft.Win32.SafeHandles.SafeFileHandle to the file or directory for which to obtain creation date and time information.

Returns

A System.DateTime structure set to the creation date and time for the specified file or directory. This value is expressed in UTC time.

System.IO.File.GetCreationTimeUtc()

Returns the creation date and time, in Coordinated Universal Time (UTC), of the specified file or directory.

Parameters

NameDescriptionDefault
path The file or directory for which to obtain creation date and time information.

Returns

A System.DateTime structure set to the creation date and time for the specified file or directory. This value is expressed in UTC time.

System.IO.File.GetLastAccessTime()

Returns the last access date and time of the specified file or directory.

Parameters

NameDescriptionDefault
fileHandle A Microsoft.Win32.SafeHandles.SafeFileHandle to the file or directory for which to obtain last access date and time information.

Returns

A System.DateTime structure set to the last access date and time for the specified file or directory. This value is expressed in local time.

System.IO.File.GetLastAccessTime()

Returns the date and time the specified file or directory was last accessed.

Parameters

NameDescriptionDefault
path The file or directory for which to obtain access date and time information.

Returns

A System.DateTime structure set to the date and time that the specified file or directory was last accessed. This value is expressed in local time.

System.IO.File.GetLastAccessTimeUtc()

Returns the last access date and time, in Coordinated Universal Time (UTC), of the specified file or directory.

Parameters

NameDescriptionDefault
fileHandle A Microsoft.Win32.SafeHandles.SafeFileHandle to the file or directory for which to obtain last access date and time information.

Returns

A System.DateTime structure set to the last access date and time for the specified file or directory. This value is expressed in UTC time.

System.IO.File.GetLastAccessTimeUtc()

Returns the date and time, in Coordinated Universal Time (UTC), that the specified file or directory was last accessed.

Parameters

NameDescriptionDefault
path The file or directory for which to obtain access date and time information.

Returns

A System.DateTime structure set to the date and time that the specified file or directory was last accessed. This value is expressed in UTC time.

System.IO.File.GetLastWriteTime()

Returns the last write date and time of the specified file or directory.

Parameters

NameDescriptionDefault
fileHandle A Microsoft.Win32.SafeHandles.SafeFileHandle to the file or directory for which to obtain last write date and time information.

Returns

A System.DateTime structure set to the last write date and time for the specified file or directory. This value is expressed in local time.

System.IO.File.GetLastWriteTime()

Returns the date and time the specified file or directory was last written to.

Parameters

NameDescriptionDefault
path The file or directory for which to obtain write date and time information.

Returns

A System.DateTime structure set to the date and time that the specified file or directory was last written to. This value is expressed in local time.

System.IO.File.GetLastWriteTimeUtc()

Returns the last write date and time, in Coordinated Universal Time (UTC), of the specified file or directory.

Parameters

NameDescriptionDefault
fileHandle A Microsoft.Win32.SafeHandles.SafeFileHandle to the file or directory for which to obtain last write date and time information.

Returns

A System.DateTime structure set to the last write date and time for the specified file or directory. This value is expressed in UTC time.

System.IO.File.GetLastWriteTimeUtc()

Returns the date and time, in Coordinated Universal Time (UTC), that the specified file or directory was last written to.

Parameters

NameDescriptionDefault
path The file or directory for which to obtain write date and time information.

Returns

A System.DateTime structure set to the date and time that the specified file or directory was last written to. This value is expressed in UTC time.

System.IO.File.GetUnixFileMode()

Gets the System.IO.UnixFileMode of the specified file handle.

Parameters

NameDescriptionDefault
fileHandle The file handle.

Returns

The System.IO.UnixFileMode of the file handle.

System.IO.File.GetUnixFileMode()

Gets the System.IO.UnixFileMode of the file on the path.

Parameters

NameDescriptionDefault
path The path to the file.

Returns

The System.IO.UnixFileMode of the file on the path.

System.IO.File.Move()

Moves a specified file to a new location, providing the option to specify a new file name.

Parameters

NameDescriptionDefault
sourceFileName The name of the file to move. Can include a relative or absolute path.
destFileName The new path and name for the file.

System.IO.File.Move()

Moves a specified file to a new location, providing the options to specify a new file name and to overwrite the destination file if it already exists.

Parameters

NameDescriptionDefault
sourceFileName The name of the file to move. Can include a relative or absolute path.
destFileName The new path and name for the file.
overwrite true to overwrite the destination file if it already exists; false otherwise.

System.IO.File.Open()

Opens a System.IO.FileStream on the specified path with read/write access with no sharing.

Parameters

NameDescriptionDefault
path The file to open.
mode A System.IO.FileMode value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten.

Returns

A System.IO.FileStream opened in the specified mode and path, with read/write access and not shared.

System.IO.File.Open()

Opens a System.IO.FileStream on the specified path, with the specified mode and access with no sharing.

Parameters

NameDescriptionDefault
path The file to open.
mode A System.IO.FileMode value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten.
access A System.IO.FileAccess value that specifies the operations that can be performed on the file.

Returns

An unshared System.IO.FileStream that provides access to the specified file, with the specified mode and access.

System.IO.File.Open()

Opens a System.IO.FileStream on the specified path, having the specified mode with read, write, or read/write access and the specified sharing option.

Parameters

NameDescriptionDefault
path The file to open.
mode A System.IO.FileMode value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten.
access A System.IO.FileAccess value that specifies the operations that can be performed on the file.
share A System.IO.FileShare value specifying the type of access other threads have to the file.

Returns

A System.IO.FileStream on the specified path, having the specified mode with read, write, or read/write access and the specified sharing option.

System.IO.File.Open()

Initializes a new instance of the System.IO.FileStream class with the specified path, creation mode, read/write and sharing permission, the access other FileStreams can have to the same file, the buffer size, additional file options and the allocation size.

Parameters

NameDescriptionDefault
path The path of the file to open.
options An object that describes optional System.IO.FileStream parameters to use.

Returns

A System.IO.FileStream instance that wraps the opened file.

System.IO.File.OpenHandle()

Initializes a new instance of the Microsoft.Win32.SafeHandles.SafeFileHandle class with the specified path, creation mode, read/write and sharing permission, the access other SafeFileHandles can have to the same file, additional file options and the allocation size.

Parameters

NameDescriptionDefault
path A relative or absolute path for the file that the current Microsoft.Win32.SafeHandles.SafeFileHandle instance will encapsulate.
mode One of the enumeration values that determines how to open or create the file. The default value is System.IO.FileMode.Open
access A bitwise combination of the enumeration values that determines how the file can be accessed. The default value is System.IO.FileAccess.Read
share A bitwise combination of the enumeration values that determines how the file will be shared by processes. The default value is System.IO.FileShare.Read.
options An object that describes optional Microsoft.Win32.SafeHandles.SafeFileHandle parameters to use.
preallocationSize The initial allocation size in bytes for the file. A positive value is effective only when a regular file is being created, overwritten, or replaced. Negative values are not allowed. In other cases (including the default 0 value), it's ignored.

Returns

System.IO.File.OpenRead()

Opens an existing file for reading.

Parameters

NameDescriptionDefault
path The file to be opened for reading.

Returns

A read-only System.IO.FileStream on the specified path.

System.IO.File.OpenText()

Opens an existing UTF-8 encoded text file for reading.

Parameters

NameDescriptionDefault
path The file to be opened for reading.

Returns

A System.IO.StreamReader on the specified path.

System.IO.File.OpenWrite()

Opens an existing file or creates a new file for writing.

Parameters

NameDescriptionDefault
path The file to be opened for writing.

Returns

An unshared System.IO.FileStream object on the specified path with System.IO.FileAccess.Write access.

System.IO.File.ReadAllBytes()

Opens a binary file, reads the contents of the file into a byte array, and then closes the file.

Parameters

NameDescriptionDefault
path The file to open for reading.

Returns

A byte array containing the contents of the file.

System.IO.File.ReadAllBytesAsync()

Asynchronously opens a binary file, reads the contents of the file into a byte array, and then closes the file.

Parameters

NameDescriptionDefault
path The file to open for reading.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous read operation, which wraps the byte array containing the contents of the file.

System.IO.File.ReadAllLines()

Opens a text file, reads all lines of the file, and then closes the file.

Parameters

NameDescriptionDefault
path The file to open for reading.

Returns

A string array containing all lines of the file.

System.IO.File.ReadAllLines()

Opens a file, reads all lines of the file with the specified encoding, and then closes the file.

Parameters

NameDescriptionDefault
path The file to open for reading.
encoding The encoding applied to the contents of the file.

Returns

A string array containing all lines of the file.

System.IO.File.ReadAllLinesAsync()

Asynchronously opens a text file, reads all lines of the file with the specified encoding, and then closes the file.

Parameters

NameDescriptionDefault
path The file to open for reading.
encoding The encoding applied to the contents of the file.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous read operation, which wraps the string array containing all lines of the file.

System.IO.File.ReadAllLinesAsync()

Asynchronously opens a text file, reads all lines of the file, and then closes the file.

Parameters

NameDescriptionDefault
path The file to open for reading.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous read operation, which wraps the string array containing all lines of the file.

System.IO.File.ReadAllText()

Opens a text file, reads all the text in the file, and then closes the file.

Parameters

NameDescriptionDefault
path The file to open for reading.

Returns

A string containing all the text in the file.

System.IO.File.ReadAllText()

Opens a file, reads all text in the file with the specified encoding, and then closes the file.

Parameters

NameDescriptionDefault
path The file to open for reading.
encoding The encoding applied to the contents of the file.

Returns

A string containing all text in the file.

System.IO.File.ReadAllTextAsync()

Asynchronously opens a text file, reads all text in the file with the specified encoding, and then closes the file.

Parameters

NameDescriptionDefault
path The file to open for reading.
encoding The encoding applied to the contents of the file.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous read operation, which wraps the string containing all text in the file.

System.IO.File.ReadAllTextAsync()

Asynchronously opens a text file, reads all the text in the file, and then closes the file.

Parameters

NameDescriptionDefault
path The file to open for reading.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous read operation, which wraps the string containing all text in the file.

System.IO.File.ReadLines()

Reads the lines of a file.

Parameters

NameDescriptionDefault
path The file to read.

Returns

All the lines of the file, or the lines that are the result of a query.

System.IO.File.ReadLines()

Read the lines of a file that has a specified encoding.

Parameters

NameDescriptionDefault
path The file to read.
encoding The encoding that is applied to the contents of the file.

Returns

All the lines of the file, or the lines that are the result of a query.

System.IO.File.ReadLinesAsync()

Asynchronously reads the lines of a file that has a specified encoding.

Parameters

NameDescriptionDefault
path The file to read.
encoding The encoding that is applied to the contents of the file.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

The async enumerable that represents all the lines of the file, or the lines that are the result of a query.

System.IO.File.ReadLinesAsync()

Asynchronously reads the lines of a file.

Parameters

NameDescriptionDefault
path The file to read.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

The async enumerable that represents all the lines of the file, or the lines that are the result of a query.

System.IO.File.Replace()

Replaces the contents of a specified file with the contents of another file, deleting the original file, and creating a backup of the replaced file.

Parameters

NameDescriptionDefault
sourceFileName The name of a file that replaces the file specified by destinationFileName.
destinationFileName The name of the file being replaced.
destinationBackupFileName The name of the backup file.

System.IO.File.Replace()

Replaces the contents of a specified file with the contents of another file, deleting the original file, and creating a backup of the replaced file and optionally ignores merge errors.

Parameters

NameDescriptionDefault
sourceFileName The name of a file that replaces the file specified by destinationFileName.
destinationFileName The name of the file being replaced.
destinationBackupFileName The name of the backup file.
ignoreMetadataErrors true to ignore merge errors (such as attributes and access control lists (ACLs)) from the replaced file to the replacement file; otherwise, false.

System.IO.File.ResolveLinkTarget()

Gets the target of the specified file link.

Parameters

NameDescriptionDefault
linkPath The path of the file link.
returnFinalTarget true to follow links to the final target; false to return the immediate next link.

Returns

A System.IO.FileInfo instance if linkPath exists, independently if the target exists or not. null if linkPath is not a link.

System.IO.File.SetAttributes()

Sets the specified System.IO.FileAttributes of the file or directory associated with fileHandle.

Parameters

NameDescriptionDefault
fileHandle A Microsoft.Win32.SafeHandles.SafeFileHandle to the file or directory for which fileAttributes should be set.
fileAttributes A bitwise combination of the enumeration values.

System.IO.File.SetAttributes()

Sets the specified System.IO.FileAttributes of the file on the specified path.

Parameters

NameDescriptionDefault
path The path to the file.
fileAttributes A bitwise combination of the enumeration values.

System.IO.File.SetCreationTime()

Sets the date and time the file or directory was created.

Parameters

NameDescriptionDefault
fileHandle A Microsoft.Win32.SafeHandles.SafeFileHandle to the file or directory for which to set the creation date and time information.
creationTime A System.DateTime containing the value to set for the creation date and time of fileHandle. This value is expressed in local time.

System.IO.File.SetCreationTime()

Sets the date and time the file was created.

Parameters

NameDescriptionDefault
path The file for which to set the creation date and time information.
creationTime A System.DateTime containing the value to set for the creation date and time of path. This value is expressed in local time.

System.IO.File.SetCreationTimeUtc()

Sets the date and time, in Coordinated Universal Time (UTC), that the file or directory was created.

Parameters

NameDescriptionDefault
fileHandle A Microsoft.Win32.SafeHandles.SafeFileHandle to the file or directory for which to set the creation date and time information.
creationTimeUtc A System.DateTime containing the value to set for the creation date and time of fileHandle. This value is expressed in UTC time.

System.IO.File.SetCreationTimeUtc()

Sets the date and time, in Coordinated Universal Time (UTC), that the file was created.

Parameters

NameDescriptionDefault
path The file for which to set the creation date and time information.
creationTimeUtc A System.DateTime containing the value to set for the creation date and time of path. This value is expressed in UTC time.

System.IO.File.SetLastAccessTime()

Sets the date and time the specified file or directory was last accessed.

Parameters

NameDescriptionDefault
fileHandle A Microsoft.Win32.SafeHandles.SafeFileHandle to the file or directory for which to set the last access date and time information.
lastAccessTime A System.DateTime containing the value to set for the last access date and time of fileHandle. This value is expressed in local time.

System.IO.File.SetLastAccessTime()

Sets the date and time the specified file was last accessed.

Parameters

NameDescriptionDefault
path The file for which to set the access date and time information.
lastAccessTime A System.DateTime containing the value to set for the last access date and time of path. This value is expressed in local time.

System.IO.File.SetLastAccessTimeUtc()

Sets the date and time, in Coordinated Universal Time (UTC), that the specified file or directory was last accessed.

Parameters

NameDescriptionDefault
fileHandle A Microsoft.Win32.SafeHandles.SafeFileHandle to the file or directory for which to set the last access date and time information.
lastAccessTimeUtc A System.DateTime containing the value to set for the last access date and time of fileHandle. This value is expressed in UTC time.

System.IO.File.SetLastAccessTimeUtc()

Sets the date and time, in Coordinated Universal Time (UTC), that the specified file was last accessed.

Parameters

NameDescriptionDefault
path The file for which to set the access date and time information.
lastAccessTimeUtc A System.DateTime containing the value to set for the last access date and time of path. This value is expressed in UTC time.

System.IO.File.SetLastWriteTime()

Sets the date and time that the specified file or directory was last written to.

Parameters

NameDescriptionDefault
fileHandle A Microsoft.Win32.SafeHandles.SafeFileHandle to the file or directory for which to set the last write date and time information.
lastWriteTime A System.DateTime containing the value to set for the last write date and time of fileHandle. This value is expressed in local time.

System.IO.File.SetLastWriteTime()

Sets the date and time that the specified file was last written to.

Parameters

NameDescriptionDefault
path The file for which to set the date and time information.
lastWriteTime A System.DateTime containing the value to set for the last write date and time of path. This value is expressed in local time.

System.IO.File.SetLastWriteTimeUtc()

Sets the date and time, in Coordinated Universal Time (UTC), that the specified file or directory was last written to.

Parameters

NameDescriptionDefault
fileHandle A Microsoft.Win32.SafeHandles.SafeFileHandle to the file or directory for which to set the last write date and time information.
lastWriteTimeUtc A System.DateTime containing the value to set for the last write date and time of fileHandle. This value is expressed in UTC time.

System.IO.File.SetLastWriteTimeUtc()

Sets the date and time, in Coordinated Universal Time (UTC), that the specified file was last written to.

Parameters

NameDescriptionDefault
path The file for which to set the date and time information.
lastWriteTimeUtc A System.DateTime containing the value to set for the last write date and time of path. This value is expressed in UTC time.

System.IO.File.SetUnixFileMode()

Sets the specified System.IO.UnixFileMode of the specified file handle.

Parameters

NameDescriptionDefault
fileHandle The file handle.
mode The Unix file mode.

System.IO.File.SetUnixFileMode()

Sets the specified System.IO.UnixFileMode of the file on the specified path.

Parameters

NameDescriptionDefault
path The path to the file.
mode The Unix file mode.

System.IO.File.WriteAllBytes()

Creates a new file, writes the specified byte array to the file, and then closes the file. If the target file already exists, it is overwritten.

Parameters

NameDescriptionDefault
path The file to write to.
bytes The bytes to write to the file.

System.IO.File.WriteAllBytesAsync()

Asynchronously creates a new file, writes the specified byte array to the file, and then closes the file. If the target file already exists, it is overwritten.

Parameters

NameDescriptionDefault
path The file to write to.
bytes The bytes to write to the file.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.File.WriteAllLines()

Creates a new file, writes a collection of strings to the file, and then closes the file.

Parameters

NameDescriptionDefault
path The file to write to.
contents The lines to write to the file.

System.IO.File.WriteAllLines()

Creates a new file by using the specified encoding, writes a collection of strings to the file, and then closes the file.

Parameters

NameDescriptionDefault
path The file to write to.
contents The lines to write to the file.
encoding The character encoding to use.

System.IO.File.WriteAllLines()

Creates a new file, write the specified string array to the file, and then closes the file.

Parameters

NameDescriptionDefault
path The file to write to.
contents The string array to write to the file.

System.IO.File.WriteAllLines()

Creates a new file, writes the specified string array to the file by using the specified encoding, and then closes the file.

Parameters

NameDescriptionDefault
path The file to write to.
contents The string array to write to the file.
encoding An System.Text.Encoding object that represents the character encoding applied to the string array.

System.IO.File.WriteAllLinesAsync()

Asynchronously creates a new file, write the specified lines to the file by using the specified encoding, and then closes the file.

Parameters

NameDescriptionDefault
path The file to write to.
contents The lines to write to the file.
encoding The character encoding to use.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.File.WriteAllLinesAsync()

Asynchronously creates a new file, writes the specified lines to the file, and then closes the file.

Parameters

NameDescriptionDefault
path The file to write to.
contents The lines to write to the file.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.File.WriteAllText()

Creates a new file, writes the specified string to the file, and then closes the file. If the target file already exists, it is overwritten.

Parameters

NameDescriptionDefault
path The file to write to.
contents The string to write to the file.

System.IO.File.WriteAllText()

Creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. If the target file already exists, it is overwritten.

Parameters

NameDescriptionDefault
path The file to write to.
contents The string to write to the file.
encoding The encoding to apply to the string.

System.IO.File.WriteAllTextAsync()

Asynchronously creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. If the target file already exists, it is overwritten.

Parameters

NameDescriptionDefault
path The file to write to.
contents The string to write to the file.
encoding The encoding to apply to the string.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.File.WriteAllTextAsync()

Asynchronously creates a new file, writes the specified string to the file, and then closes the file. If the target file already exists, it is overwritten.

Parameters

NameDescriptionDefault
path The file to write to.
contents The string to write to the file.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.FileAccess

Defines constants for read, write, or read/write access to a file.

System.IO.FileAccess.Read

Read access to the file. Data can be read from the file. Combine with Write for read/write access.

System.IO.FileAccess.ReadWrite

Read and write access to the file. Data can be written to and read from the file.

System.IO.FileAccess.Write

Write access to the file. Data can be written to the file. Combine with Read for read/write access.

System.IO.FileAttributes

Provides attributes for files and directories.

System.IO.FileAttributes.Archive

This file is marked to be included in incremental backup operation. Windows sets this attribute whenever the file is modified, and backup software should clear it when processing the file during incremental backup.

System.IO.FileAttributes.Compressed

The file is compressed.

System.IO.FileAttributes.Device

Reserved for future use.

System.IO.FileAttributes.Directory

The file is a directory. Directory is supported on Windows, Linux, and macOS.

System.IO.FileAttributes.Encrypted

The file or directory is encrypted. For a file, this means that all data in the file is encrypted. For a directory, this means that encryption is the default for newly created files and directories.

System.IO.FileAttributes.Hidden

The file is hidden, and thus is not included in an ordinary directory listing. Hidden is supported on Windows, Linux, and macOS.

System.IO.FileAttributes.IntegrityStream

The file or directory includes data integrity support. When this value is applied to a file, all data streams in the file have integrity support. When this value is applied to a directory, all new files and subdirectories within that directory, by default, include integrity support.

System.IO.FileAttributes.None

System.IO.FileAttributes.Normal

The file is a standard file that has no special attributes. This attribute is valid only if it is used alone. Normal is supported on Windows, Linux, and macOS.

System.IO.FileAttributes.NoScrubData

The file or directory is excluded from the data integrity scan. When this value is applied to a directory, by default, all new files and subdirectories within that directory are excluded from data integrity.

System.IO.FileAttributes.NotContentIndexed

The file will not be indexed by the operating system's content indexing service.

System.IO.FileAttributes.Offline

The file is offline. The data of the file is not immediately available.

System.IO.FileAttributes.ReadOnly

The file is read-only. ReadOnly is supported on Windows, Linux, and macOS. On Linux and macOS, changing the ReadOnly flag is a permissions operation.

System.IO.FileAttributes.ReparsePoint

The file contains a reparse point, which is a block of user-defined data associated with a file or a directory. ReparsePoint is supported on Windows, Linux, and macOS.

System.IO.FileAttributes.SparseFile

The file is a sparse file. Sparse files are typically large files whose data consists of mostly zeros.

System.IO.FileAttributes.System

The file is a system file. That is, the file is part of the operating system or is used exclusively by the operating system.

System.IO.FileAttributes.Temporary

The file is temporary. A temporary file contains data that is needed while an application is executing but is not needed after the application is finished. File systems try to keep all the data in memory for quicker access rather than flushing the data back to mass storage. A temporary file should be deleted by the application as soon as it is no longer needed.

System.IO.FileInfo

Provides properties and instance methods for the creation, copying, deletion, moving, and opening of files, and aids in the creation of System.IO.FileStream objects. This class cannot be inherited.

System.IO.FileInfo.#ctor()

Initializes a new instance of the System.IO.FileInfo class, which acts as a wrapper for a file path.

Parameters

NameDescriptionDefault
fileName The fully qualified name of the new file, or the relative file name. Do not end the path with the directory separator character.

System.IO.FileInfo.AppendText

Creates a System.IO.StreamWriter that appends text to the file represented by this instance of the System.IO.FileInfo.

Returns

A new StreamWriter.

System.IO.FileInfo.CopyTo()

Copies an existing file to a new file, disallowing the overwriting of an existing file.

Parameters

NameDescriptionDefault
destFileName The name of the new file to copy to.

Returns

A new file with a fully qualified path.

System.IO.FileInfo.CopyTo()

Copies an existing file to a new file, allowing the overwriting of an existing file.

Parameters

NameDescriptionDefault
destFileName The name of the new file to copy to.
overwrite true to allow an existing file to be overwritten; otherwise, false.

Returns

A new file, or an overwrite of an existing file if overwrite is true. If the file exists and overwrite is false, an System.IO.IOException is thrown.

System.IO.FileInfo.Create

Creates a file.

Returns

A new file.

System.IO.FileInfo.CreateText

Creates a System.IO.StreamWriter that writes a new text file.

Returns

A new StreamWriter.

System.IO.FileInfo.Decrypt

Decrypts a file that was encrypted by the current account using the System.IO.FileInfo.Encrypt method.

System.IO.FileInfo.Delete

Permanently deletes a file.

System.IO.FileInfo.Encrypt

Encrypts a file so that only the account used to encrypt the file can decrypt it.

System.IO.FileInfo.MoveTo()

Moves a specified file to a new location, providing the option to specify a new file name.

Parameters

NameDescriptionDefault
destFileName The path to move the file to, which can specify a different file name.

System.IO.FileInfo.MoveTo()

Moves a specified file to a new location, providing the options to specify a new file name and to overwrite the destination file if it already exists.

Parameters

NameDescriptionDefault
destFileName The path to move the file to, which can specify a different file name.
overwrite true to overwrite the destination file if it already exists; false otherwise.

System.IO.FileInfo.Open()

Opens a file in the specified mode.

Parameters

NameDescriptionDefault
mode A System.IO.FileMode constant specifying the mode (for example, Open or Append) in which to open the file.

Returns

A file opened in the specified mode, with read/write access and unshared.

System.IO.FileInfo.Open()

Opens a file in the specified mode with read, write, or read/write access.

Parameters

NameDescriptionDefault
mode A System.IO.FileMode constant specifying the mode (for example, Open or Append) in which to open the file.
access A System.IO.FileAccess constant specifying whether to open the file with Read, Write, or ReadWrite file access.

Returns

A System.IO.FileStream object opened in the specified mode and access, and unshared.

System.IO.FileInfo.Open()

Opens a file in the specified mode with read, write, or read/write access and the specified sharing option.

Parameters

NameDescriptionDefault
mode A System.IO.FileMode constant specifying the mode (for example, Open or Append) in which to open the file.
access A System.IO.FileAccess constant specifying whether to open the file with Read, Write, or ReadWrite file access.
share A System.IO.FileShare constant specifying the type of access other FileStream objects have to this file.

Returns

A System.IO.FileStream object opened with the specified mode, access, and sharing options.

System.IO.FileInfo.Open()

Initializes a new instance of the System.IO.FileStream class with the specified creation mode, read/write and sharing permission, the access other FileStreams can have to the same file, the buffer size, additional file options and the allocation size.

Parameters

NameDescriptionDefault
options An object that describes optional System.IO.FileStream parameters to use.

Returns

A System.IO.FileStream that wraps the opened file.

System.IO.FileInfo.OpenRead

Creates a read-only System.IO.FileStream.

Returns

A new read-only System.IO.FileStream object.

System.IO.FileInfo.OpenText

Creates a System.IO.StreamReader with UTF8 encoding that reads from an existing text file.

Returns

A new StreamReader with UTF8 encoding.

System.IO.FileInfo.OpenWrite

Creates a write-only System.IO.FileStream.

Returns

A write-only unshared System.IO.FileStream object for a new or existing file.

System.IO.FileInfo.Replace()

Replaces the contents of a specified file with the file described by the current System.IO.FileInfo object, deleting the original file, and creating a backup of the replaced file.

Parameters

NameDescriptionDefault
destinationFileName The name of a file to replace with the current file.
destinationBackupFileName The name of a file with which to create a backup of the file described by the destFileName parameter.

Returns

A System.IO.FileInfo object that encapsulates information about the file described by the destFileName parameter.

System.IO.FileInfo.Replace()

Replaces the contents of a specified file with the file described by the current System.IO.FileInfo object, deleting the original file, and creating a backup of the replaced file. Also specifies whether to ignore merge errors.

Parameters

NameDescriptionDefault
destinationFileName The name of a file to replace with the current file.
destinationBackupFileName The name of a file with which to create a backup of the file described by the destFileName parameter.
ignoreMetadataErrors true to ignore merge errors (such as attributes and ACLs) from the replaced file to the replacement file; otherwise false.

Returns

A System.IO.FileInfo object that encapsulates information about the file described by the destFileName parameter.

System.IO.FileInfo.Directory

Gets an instance of the parent directory.

Returns

A System.IO.DirectoryInfo object representing the parent directory of this file.

System.IO.FileInfo.DirectoryName

Gets a string representing the directory's full path.

Returns

A string representing the directory's full path.

System.IO.FileInfo.Exists

Gets a value indicating whether a file exists.

Returns

true if the file exists; false if the file does not exist or if the file is a directory.

System.IO.FileInfo.IsReadOnly

Gets or sets a value that determines if the current file is read only.

Returns

true if the current file is read only or could not be found; otherwise, false.

System.IO.FileInfo.Length

Gets the size, in bytes, of the current file.

Returns

The size of the current file in bytes.

System.IO.FileInfo.Name

Gets the name of the file.

Returns

The name of the file.

System.IO.FileLoadException

The exception that is thrown when a managed assembly is found but cannot be loaded.

System.IO.FileLoadException.#ctor

Initializes a new instance of the System.IO.FileLoadException class, setting the System.Exception.Message property of the new instance to a system-supplied message that describes the error, such as "Could not load the specified file." This message takes into account the current system culture.

System.IO.FileLoadException.#ctor()

Initializes a new instance of the System.IO.FileLoadException class with serialized data.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.IO.FileLoadException.#ctor()

Initializes a new instance of the System.IO.FileLoadException class with the specified error message.

Parameters

NameDescriptionDefault
message A System.String that describes the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.

System.IO.FileLoadException.#ctor()

Initializes a new instance of the System.IO.FileLoadException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message A System.String that describes the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.
inner The exception that is the cause of the current exception. If the inner parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.IO.FileLoadException.#ctor()

Initializes a new instance of the System.IO.FileLoadException class with a specified error message and the name of the file that could not be loaded.

Parameters

NameDescriptionDefault
message A System.String that describes the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.
fileName A System.String containing the name of the file that was not loaded.

System.IO.FileLoadException.#ctor()

Initializes a new instance of the System.IO.FileLoadException class with a specified error message, the name of the file that could not be loaded, and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message A System.String that describes the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.
fileName A System.String containing the name of the file that was not loaded.
inner The exception that is the cause of the current exception. If the inner parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.IO.FileLoadException.GetObjectData()

Sets the System.Runtime.Serialization.SerializationInfo with the file name and additional exception information.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.IO.FileLoadException.ToString

Returns the fully qualified name of the current exception, and possibly the error message, the name of the inner exception, and the stack trace.

Returns

A string containing the fully qualified name of this exception, and possibly the error message, the name of the inner exception, and the stack trace, depending on which System.IO.FileLoadException constructor is used.

System.IO.FileLoadException.FileName

Gets the name of the file that causes this exception.

Returns

A System.String containing the name of the file with the invalid image, or a null reference if no file name was passed to the constructor for the current instance.

System.IO.FileLoadException.FusionLog

Gets the log file that describes why an assembly load failed.

Returns

A string containing errors reported by the assembly cache.

System.IO.FileLoadException.Message

Gets the error message and the name of the file that caused this exception.

Returns

A string containing the error message and the name of the file that caused this exception.

System.IO.FileMode

Specifies how the operating system should open a file.

System.IO.FileMode.Append

Opens the file if it exists and seeks to the end of the file, or creates a new file. This requires System.Security.Permissions.FileIOPermissionAccess.Append permission. FileMode.Append can be used only in conjunction with FileAccess.Write. Trying to seek to a position before the end of the file throws an System.IO.IOException exception, and any attempt to read fails and throws a System.NotSupportedException exception.

System.IO.FileMode.Create

Specifies that the operating system should create a new file. If the file already exists, it will be overwritten. This requires System.Security.Permissions.FileIOPermissionAccess.Write permission. FileMode.Create is equivalent to requesting that if the file does not exist, use System.IO.FileMode.CreateNew; otherwise, use System.IO.FileMode.Truncate. If the file already exists but is a hidden file, an System.UnauthorizedAccessException exception is thrown.

System.IO.FileMode.CreateNew

Specifies that the operating system should create a new file. This requires System.Security.Permissions.FileIOPermissionAccess.Write permission. If the file already exists, an System.IO.IOException exception is thrown.

System.IO.FileMode.Open

Specifies that the operating system should open an existing file. The ability to open the file is dependent on the value specified by the System.IO.FileAccess enumeration. A System.IO.FileNotFoundException exception is thrown if the file does not exist.

System.IO.FileMode.OpenOrCreate

Specifies that the operating system should open a file if it exists; otherwise, a new file should be created. If the file is opened with FileAccess.Read, System.Security.Permissions.FileIOPermissionAccess.Read permission is required. If the file access is FileAccess.Write, System.Security.Permissions.FileIOPermissionAccess.Write permission is required. If the file is opened with FileAccess.ReadWrite, both System.Security.Permissions.FileIOPermissionAccess.Read and System.Security.Permissions.FileIOPermissionAccess.Write permissions are required.

System.IO.FileMode.Truncate

Specifies that the operating system should open an existing file. When the file is opened, it should be truncated so that its size is zero bytes. This requires System.Security.Permissions.FileIOPermissionAccess.Write permission. Attempts to read from a file opened with FileMode.Truncate cause an System.ArgumentException exception.

System.IO.FileNotFoundException

The exception that is thrown when an attempt to access a file that does not exist on disk fails.

System.IO.FileNotFoundException.#ctor

Initializes a new instance of the System.IO.FileNotFoundException class with its message string set to a system-supplied message.

System.IO.FileNotFoundException.#ctor()

Initializes a new instance of the System.IO.FileNotFoundException class with the specified serialization and context information.

Parameters

NameDescriptionDefault
info An object that holds the serialized object data about the exception being thrown.
context An object that contains contextual information about the source or destination.

System.IO.FileNotFoundException.#ctor()

Initializes a new instance of the System.IO.FileNotFoundException class with a specified error message.

Parameters

NameDescriptionDefault
message A description of the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.

System.IO.FileNotFoundException.#ctor()

Initializes a new instance of the System.IO.FileNotFoundException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message A description of the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.IO.FileNotFoundException.#ctor()

Initializes a new instance of the System.IO.FileNotFoundException class with a specified error message, and the file name that cannot be found.

Parameters

NameDescriptionDefault
message A description of the error, or null to use a system-supplied message with the given fileName. The content of message should be understood by humans. The caller of this constructor must ensure that this string has been localized for the current system culture.
fileName The full name of the file with the invalid image.

System.IO.FileNotFoundException.#ctor()

Initializes a new instance of the System.IO.FileNotFoundException class with a specified error message, the file name that cannot be found, and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
fileName The full name of the file with the invalid image.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.IO.FileNotFoundException.GetObjectData()

Sets the System.Runtime.Serialization.SerializationInfo object with the file name and additional exception information.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data about the exception being thrown.
context The object that contains contextual information about the source or destination.

System.IO.FileNotFoundException.ToString

Returns the fully qualified name of this exception and possibly the error message, the name of the inner exception, and the stack trace.

Returns

The fully qualified name of this exception and possibly the error message, the name of the inner exception, and the stack trace.

System.IO.FileNotFoundException.FileName

Gets the name of the file that cannot be found.

Returns

The name of the file, or null if no file name was passed to the constructor for this instance.

System.IO.FileNotFoundException.FusionLog

Gets the log file that describes why loading of an assembly failed.

Returns

The errors reported by the assembly cache.

System.IO.FileNotFoundException.Message

Gets the error message that explains the reason for the exception.

Returns

The error message.

System.IO.FileOptions

Represents advanced options for creating a System.IO.FileStream object.

System.IO.FileOptions.Asynchronous

Indicates that a file can be used for asynchronous reading and writing.

System.IO.FileOptions.DeleteOnClose

Indicates that a file is automatically deleted when it is no longer in use.

System.IO.FileOptions.Encrypted

Indicates that a file is encrypted and can be decrypted only by using the same user account used for encryption.

System.IO.FileOptions.None

Indicates that no additional options should be used when creating a System.IO.FileStream object.

System.IO.FileOptions.RandomAccess

Indicates that the file is accessed randomly. The system can use this as a hint to optimize file caching.

System.IO.FileOptions.SequentialScan

Indicates that the file is to be accessed sequentially from beginning to end. The system can use this as a hint to optimize file caching. If an application moves the file pointer for random access, optimum caching may not occur; however, correct operation is still guaranteed. Specifying this flag can increase performance in some cases.

System.IO.FileOptions.WriteThrough

Indicates that the system should write through any intermediate cache and go directly to disk.

System.IO.FileShare

Contains constants for controlling the kind of access other operations can have to the same file.

System.IO.FileShare.Delete

Allows subsequent deleting of a file.

System.IO.FileShare.Inheritable

Makes the file handle inheritable by child processes. This is not directly supported by Win32.

System.IO.FileShare.None

Declines sharing of the current file. Any request to open the file (by this process or another process) will fail until the file is closed.

System.IO.FileShare.Read

Allows subsequent opening of the file for reading. If this flag is not specified, any request to open the file for reading (by this process or another process) will fail until the file is closed. However, even if this flag is specified, additional permissions might still be needed to access the file.

System.IO.FileShare.ReadWrite

Allows subsequent opening of the file for reading or writing. If this flag is not specified, any request to open the file for reading or writing (by this process or another process) will fail until the file is closed. However, even if this flag is specified, additional permissions might still be needed to access the file.

System.IO.FileShare.Write

Allows subsequent opening of the file for writing. If this flag is not specified, any request to open the file for writing (by this process or another process) will fail until the file is closed. However, even if this flag is specified, additional permissions might still be needed to access the file.

System.IO.FileStream

Provides a System.IO.Stream for a file, supporting both synchronous and asynchronous read and write operations.

System.IO.FileStream.#ctor()

Initializes a new instance of the System.IO.FileStream class for the specified file handle, with the specified read/write permission.

Parameters

NameDescriptionDefault
handle A file handle for the file that the current FileStream object will encapsulate.
access A bitwise combination of the enumeration values that sets the System.IO.FileStream.CanRead and System.IO.FileStream.CanWrite properties of the FileStream object.

System.IO.FileStream.#ctor()

Initializes a new instance of the System.IO.FileStream class for the specified file handle, with the specified read/write permission, and buffer size.

Parameters

NameDescriptionDefault
handle A file handle for the file that the current FileStream object will encapsulate.
access A System.IO.FileAccess constant that sets the System.IO.FileStream.CanRead and System.IO.FileStream.CanWrite properties of the FileStream object.
bufferSize A positive System.Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096.

System.IO.FileStream.#ctor()

Initializes a new instance of the System.IO.FileStream class for the specified file handle, with the specified read/write permission, buffer size, and synchronous or asynchronous state.

Parameters

NameDescriptionDefault
handle A file handle for the file that this FileStream object will encapsulate.
access A bitwise combination of the enumeration values that sets the System.IO.FileStream.CanRead and System.IO.FileStream.CanWrite properties of the FileStream object.
bufferSize A positive System.Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096.
isAsync true if the handle was opened asynchronously (that is, in overlapped I/O mode); otherwise, false.

System.IO.FileStream.#ctor()

Initializes a new instance of the System.IO.FileStream class for the specified file handle, with the specified read/write permission.

Parameters

NameDescriptionDefault
handle A file handle for the file that the current FileStream object will encapsulate.
access A bitwise combination of the enumeration values that sets the System.IO.FileStream.CanRead and System.IO.FileStream.CanWrite properties of the FileStream object.

System.IO.FileStream.#ctor()

Initializes a new instance of the System.IO.FileStream class for the specified file handle, with the specified read/write permission and FileStream instance ownership.

Parameters

NameDescriptionDefault
handle A file handle for the file that the current FileStream object will encapsulate.
access A bitwise combination of the enumeration values that sets the System.IO.FileStream.CanRead and System.IO.FileStream.CanWrite properties of the FileStream object.
ownsHandle true if the file handle will be owned by this FileStream instance; otherwise, false.

System.IO.FileStream.#ctor()

Initializes a new instance of the System.IO.FileStream class for the specified file handle, with the specified read/write permission, FileStream instance ownership, and buffer size.

Parameters

NameDescriptionDefault
handle A file handle for the file that this FileStream object will encapsulate.
access A bitwise combination of the enumeration values that sets the System.IO.FileStream.CanRead and System.IO.FileStream.CanWrite properties of the FileStream object.
ownsHandle true if the file handle will be owned by this FileStream instance; otherwise, false.
bufferSize A positive System.Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096.

System.IO.FileStream.#ctor()

Initializes a new instance of the System.IO.FileStream class for the specified file handle, with the specified read/write permission, FileStream instance ownership, buffer size, and synchronous or asynchronous state.

Parameters

NameDescriptionDefault
handle A file handle for the file that this FileStream object will encapsulate.
access A bitwise combination of the enumeration values that sets the System.IO.FileStream.CanRead and System.IO.FileStream.CanWrite properties of the FileStream object.
ownsHandle true if the file handle will be owned by this FileStream instance; otherwise, false.
bufferSize A positive System.Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096.
isAsync true if the handle was opened asynchronously (that is, in overlapped I/O mode); otherwise, false.

System.IO.FileStream.#ctor()

Initializes a new instance of the System.IO.FileStream class with the specified path and creation mode.

Parameters

NameDescriptionDefault
path A relative or absolute path for the file that the current FileStream object will encapsulate.
mode One of the enumeration values that determines how to open or create the file.

System.IO.FileStream.#ctor()

Initializes a new instance of the System.IO.FileStream class with the specified path, creation mode, and read/write permission.

Parameters

NameDescriptionDefault
path A relative or absolute path for the file that the current FileStream object will encapsulate.
mode One of the enumeration values that determines how to open or create the file.
access A bitwise combination of the enumeration values that determines how the file can be accessed by the FileStream object. This also determines the values returned by the System.IO.FileStream.CanRead and System.IO.FileStream.CanWrite properties of the FileStream object. System.IO.FileStream.CanSeek is true if path specifies a disk file.

System.IO.FileStream.#ctor()

Initializes a new instance of the System.IO.FileStream class with the specified path, creation mode, read/write permission, and sharing permission.

Parameters

NameDescriptionDefault
path A relative or absolute path for the file that the current FileStream object will encapsulate.
mode One of the enumeration values that determines how to open or create the file.
access A bitwise combination of the enumeration values that determines how the file can be accessed by the FileStream object. This also determines the values returned by the System.IO.FileStream.CanRead and System.IO.FileStream.CanWrite properties of the FileStream object. System.IO.FileStream.CanSeek is true if path specifies a disk file.
share A bitwise combination of the enumeration values that determines how the file will be shared by processes.

System.IO.FileStream.#ctor()

Initializes a new instance of the System.IO.FileStream class with the specified path, creation mode, read/write and sharing permission, and buffer size.

Parameters

NameDescriptionDefault
path A relative or absolute path for the file that the current FileStream object will encapsulate.
mode One of the enumeration values that determines how to open or create the file.
access A bitwise combination of the enumeration values that determines how the file can be accessed by the FileStream object. This also determines the values returned by the System.IO.FileStream.CanRead and System.IO.FileStream.CanWrite properties of the FileStream object. System.IO.FileStream.CanSeek is true if path specifies a disk file.
share A bitwise combination of the enumeration values that determines how the file will be shared by processes.
bufferSize A positive System.Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096.

System.IO.FileStream.#ctor()

Initializes a new instance of the System.IO.FileStream class with the specified path, creation mode, read/write and sharing permission, buffer size, and synchronous or asynchronous state.

Parameters

NameDescriptionDefault
path A relative or absolute path for the file that the current FileStream object will encapsulate.
mode One of the enumeration values that determines how to open or create the file.
access A bitwise combination of the enumeration values that determines how the file can be accessed by the FileStream object. This also determines the values returned by the System.IO.FileStream.CanRead and System.IO.FileStream.CanWrite properties of the FileStream object. System.IO.FileStream.CanSeek is true if path specifies a disk file.
share A bitwise combination of the enumeration values that determines how the file will be shared by processes.
bufferSize A positive System.Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096.
useAsync Specifies whether to use asynchronous I/O or synchronous I/O. However, note that the underlying operating system might not support asynchronous I/O, so when specifying true, the handle might be opened synchronously depending on the platform. When opened asynchronously, the System.IO.FileStream.BeginRead() and System.IO.FileStream.BeginWrite() methods perform better on large reads or writes, but they might be much slower for small reads or writes. If the application is designed to take advantage of asynchronous I/O, set the useAsync parameter to true. Using asynchronous I/O correctly can speed up applications by as much as a factor of 10, but using it without redesigning the application for asynchronous I/O can decrease performance by as much as a factor of 10.

System.IO.FileStream.#ctor()

Initializes a new instance of the System.IO.FileStream class with the specified path, creation mode, read/write and sharing permission, the access other FileStreams can have to the same file, the buffer size, and additional file options.

Parameters

NameDescriptionDefault
path A relative or absolute path for the file that the current FileStream object will encapsulate.
mode One of the enumeration values that determines how to open or create the file.
access A bitwise combination of the enumeration values that determines how the file can be accessed by the FileStream object. This also determines the values returned by the System.IO.FileStream.CanRead and System.IO.FileStream.CanWrite properties of the FileStream object. System.IO.FileStream.CanSeek is true if path specifies a disk file.
share A bitwise combination of the enumeration values that determines how the file will be shared by processes.
bufferSize A positive System.Int32 value greater than 0 indicating the buffer size. The default buffer size is 4096.
options A bitwise combination of the enumeration values that specifies additional file options.

System.IO.FileStream.#ctor()

Initializes a new instance of the System.IO.FileStream class with the specified path, creation mode, read/write and sharing permission, buffer size, additional file options, preallocation size, and the access other FileStreams can have to the same file.

Parameters

NameDescriptionDefault
path A relative or absolute path for the file that the current System.IO.FileStream instance will encapsulate.
options An object that describes optional System.IO.FileStream parameters to use.

System.IO.FileStream.BeginRead()

Begins an asynchronous read operation. Consider using System.IO.FileStream.ReadAsync() instead.

Parameters

NameDescriptionDefault
buffer The buffer to read data into.
offset The byte offset in array at which to begin reading.
count The maximum number of bytes to read.
callback The method to be called when the asynchronous read operation is completed.
state A user-provided object that distinguishes this particular asynchronous read request from other requests.

Returns

An object that references the asynchronous read.

System.IO.FileStream.BeginWrite()

Begins an asynchronous write operation. Consider using System.IO.FileStream.WriteAsync() instead.

Parameters

NameDescriptionDefault
buffer The buffer containing data to write to the current stream.
offset The zero-based byte offset in array at which to begin copying bytes to the current stream.
count The maximum number of bytes to write.
callback The method to be called when the asynchronous write operation is completed.
state A user-provided object that distinguishes this particular asynchronous write request from other requests.

Returns

An object that references the asynchronous write.

System.IO.FileStream.CopyToAsync()

Asynchronously reads the bytes from the current file stream and writes them to another stream, using a specified buffer size and cancellation token.

Parameters

NameDescriptionDefault
destination The stream to which the contents of the current file stream will be copied.
bufferSize The size, in bytes, of the buffer. This value must be greater than zero. The default size is 81920.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous copy operation.

System.IO.FileStream.Dispose()

Releases the unmanaged resources used by the System.IO.FileStream and optionally releases the managed resources.

Parameters

NameDescriptionDefault
disposing true to release both managed and unmanaged resources; false to release only unmanaged resources.

System.IO.FileStream.DisposeAsync

Asynchronously releases the unmanaged resources used by the System.IO.FileStream.

Returns

A task that represents the asynchronous dispose operation.

System.IO.FileStream.EndRead()

Waits for the pending asynchronous read operation to complete. (Consider using System.IO.FileStream.ReadAsync() instead.)

Parameters

NameDescriptionDefault
asyncResult The reference to the pending asynchronous request to wait for.

Returns

The number of bytes read from the stream, between 0 and the number of bytes you requested. Streams only return 0 at the end of the stream, otherwise, they should block until at least 1 byte is available.

System.IO.FileStream.EndWrite()

Ends an asynchronous write operation and blocks until the I/O operation is complete. (Consider using System.IO.FileStream.WriteAsync() instead.)

Parameters

NameDescriptionDefault
asyncResult The pending asynchronous I/O request.

System.IO.FileStream.Finalize

Ensures that resources are freed and other cleanup operations are performed when the garbage collector reclaims the FileStream.

System.IO.FileStream.Flush

Clears buffers for this stream and causes any buffered data to be written to the file.

System.IO.FileStream.Flush()

Clears buffers for this stream and causes any buffered data to be written to the file, and also clears all intermediate file buffers.

Parameters

NameDescriptionDefault
flushToDisk true to flush all intermediate file buffers; otherwise, false.

System.IO.FileStream.FlushAsync()

Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.

Parameters

NameDescriptionDefault
cancellationToken The token to monitor for cancellation requests.

Returns

A task that represents the asynchronous flush operation.

System.IO.FileStream.Lock()

Prevents other processes from reading from or writing to the System.IO.FileStream.

Parameters

NameDescriptionDefault
position The beginning of the range to lock. The value of this parameter must be equal to or greater than zero (0).
length The range to be locked.

System.IO.FileStream.Read()

Reads a block of bytes from the stream and writes the data in a given buffer.

Parameters

NameDescriptionDefault
buffer
offset The byte offset in array at which the read bytes will be placed.
count The maximum number of bytes to read.

Returns

The total number of bytes read into the buffer. This might 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.

System.IO.FileStream.Read()

Reads a sequence of bytes from the current file stream and advances the position within the file stream by the number of bytes read.

Parameters

NameDescriptionDefault
buffer A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current file stream.

Returns

The total number of bytes read into the buffer. This can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.

System.IO.FileStream.ReadAsync()

Asynchronously reads a sequence of bytes from the current file stream and writes them to a byte array beginning at a specified offset, advances the position within the file stream by the number of bytes read, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The buffer to write the data into.
offset The byte offset in buffer at which to begin writing data from the stream.
count The maximum number of bytes to read.
cancellationToken The token to monitor for cancellation requests.

Returns

A task that represents the asynchronous read operation and wraps the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

System.IO.FileStream.ReadAsync()

Asynchronously reads a sequence of bytes from the current file stream and writes them to a memory region, advances the position within the file stream by the number of bytes read, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The buffer to write the data into.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous read operation and wraps the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

System.IO.FileStream.ReadByte

Reads a byte from the file and advances the read position one byte.

Returns

The byte, cast to an System.Int32, or -1 if the end of the stream has been reached.

System.IO.FileStream.Seek()

Sets the current position of this stream to the given value.

Parameters

NameDescriptionDefault
offset The point relative to origin from which to begin seeking.
origin Specifies the beginning, the end, or the current position as a reference point for offset, using a value of type System.IO.SeekOrigin.

Returns

The new position in the stream.

System.IO.FileStream.SetLength()

Sets the length of this stream to the given value.

Parameters

NameDescriptionDefault
value The new length of the stream.

System.IO.FileStream.Unlock()

Allows access by other processes to all or part of a file that was previously locked.

Parameters

NameDescriptionDefault
position The beginning of the range to unlock.
length The range to be unlocked.

System.IO.FileStream.Write()

Writes a block of bytes to the file stream.

Parameters

NameDescriptionDefault
buffer
offset The zero-based byte offset in array from which to begin copying bytes to the stream.
count The maximum number of bytes to write.

System.IO.FileStream.Write()

Writes a sequence of bytes from a read-only span to the current file stream and advances the current position within this file stream by the number of bytes written.

Parameters

NameDescriptionDefault
buffer A region of memory. This method copies the contents of this region to the current file stream.

System.IO.FileStream.WriteAsync()

Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The buffer to write data from.
offset The zero-based byte offset in buffer from which to begin copying bytes to the stream.
count The maximum number of bytes to write.
cancellationToken The token to monitor for cancellation requests.

Returns

A task that represents the asynchronous write operation.

System.IO.FileStream.WriteAsync()

Asynchronously writes a sequence of bytes from a memory region to the current file stream, advances the current position within this file stream by the number of bytes written, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The region of memory to write data from.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.FileStream.WriteByte()

Writes a byte to the current position in the file stream.

Parameters

NameDescriptionDefault
value A byte to write to the stream.

System.IO.FileStream.CanRead

Gets a value that indicates whether the current stream supports reading.

Returns

true if the stream supports reading; false if the stream is closed or was opened with write-only access.

System.IO.FileStream.CanSeek

Gets a value that indicates whether the current stream supports seeking.

Returns

true if the stream supports seeking; false if the stream is closed or if the FileStream was constructed from an operating-system handle such as a pipe or output to the console.

System.IO.FileStream.CanWrite

Gets a value that indicates whether the current stream supports writing.

Returns

true if the stream supports writing; false if the stream is closed or was opened with read-only access.

System.IO.FileStream.Handle

Gets the operating system file handle for the file that the current FileStream object encapsulates.

Returns

The operating system file handle for the file encapsulated by this FileStream object, or -1 if the FileStream has been closed.

System.IO.FileStream.IsAsync

Gets a value that indicates whether the FileStream was opened asynchronously or synchronously.

Returns

true if the FileStream was opened asynchronously; otherwise, false.

System.IO.FileStream.Length

Gets the length in bytes of the stream.

Returns

A long value representing the length of the stream in bytes.

System.IO.FileStream.Name

Gets the absolute path of the file opened in the FileStream.

Returns

A string that is the absolute path of the file.

System.IO.FileStream.Position

Gets or sets the current position of this stream.

Returns

The current position of this stream.

System.IO.FileStream.SafeFileHandle

Gets a Microsoft.Win32.SafeHandles.SafeFileHandle object that represents the operating system file handle for the file that the current System.IO.FileStream object encapsulates.

Returns

An object that represents the operating system file handle for the file that the current System.IO.FileStream object encapsulates.

System.IO.FileStreamOptions

Defines a variety of configuration options for System.IO.FileStream.

System.IO.FileStreamOptions.#ctor

Initializes a System.IO.FileStreamOptions instance with default values.

System.IO.FileStreamOptions.Access

A bitwise combination of the enumeration values that determines how the file can be accessed by the System.IO.FileStream object. This also determines the values returned by the System.IO.FileStream.CanRead and System.IO.FileStream.CanWrite properties of the System.IO.FileStream object.

Returns

A bitwise combination of the System.IO.FileAccess enum flags.

System.IO.FileStreamOptions.BufferSize

The size of the buffer used by System.IO.FileStream for buffering. The default buffer size is 4096. 0 or 1 means that buffering should be disabled. Negative values are not allowed.

Returns

A non-negative number that represents the buffer size used by System.IO.FileStream for buffering.

System.IO.FileStreamOptions.Mode

One of the enumeration values that determines how to open or create the file.

Returns

One of the enumeration values of the System.IO.FileMode enum.

System.IO.FileStreamOptions.Options

A bitwise combination of the enumeration values that specifies additional file options. The default value is System.IO.FileOptions.None, which indicates synchronous IO.

Returns

A bitwise combination of the System.IO.FileOptions enum flags.

System.IO.FileStreamOptions.PreallocationSize

The initial allocation size in bytes for the file. A positive value is effective only when a regular file is being created or overwritten (System.IO.FileMode.Create or System.IO.FileMode.CreateNew). Negative values are not allowed. In other cases (including the default 0 value), it's ignored. This value is a hint and is not a strong guarantee. It is not supported on Web Assembly (WASM) and FreeBSD (the value is ignored). For Windows, Linux and macOS we will try to preallocate the disk space to fill the requested allocation size. If that turns out to be impossible, the operation is going to throw an exception. The final file length (EOF) will be determined by the number of bytes written to the file.

Returns

A non-negative number that represents the initial allocation size in bytes for the file.

System.IO.FileStreamOptions.Share

A bitwise combination of the enumeration values that determines how the file will be shared by processes. The default value is System.IO.FileShare.Read.

Returns

A bitwise combination of the System.IO.FileShare enum flags.

System.IO.FileStreamOptions.UnixCreateMode

Gets or sets the Unix file mode used when a new file is created.

System.IO.FileSystemInfo

Provides the base class for both System.IO.FileInfo and System.IO.DirectoryInfo objects.

System.IO.FileSystemInfo.FullPath

Represents the fully qualified path of the directory or file.

System.IO.FileSystemInfo.OriginalPath

The path originally specified by the user, whether relative or absolute.

System.IO.FileSystemInfo.#ctor

Initializes a new instance of the System.IO.FileSystemInfo class.

System.IO.FileSystemInfo.#ctor()

Initializes a new instance of the System.IO.FileSystemInfo class with serialized data.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.IO.FileSystemInfo.CreateAsSymbolicLink()

Creates a symbolic link located in System.IO.FileSystemInfo.FullName that points to the specified pathToTarget.

Parameters

NameDescriptionDefault
pathToTarget The path of the symbolic link target.

System.IO.FileSystemInfo.Delete

Deletes a file or directory.

System.IO.FileSystemInfo.GetObjectData()

Sets the System.Runtime.Serialization.SerializationInfo object with the file name and additional exception information.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.IO.FileSystemInfo.Refresh

Refreshes the state of the object.

System.IO.FileSystemInfo.ResolveLinkTarget()

Gets the target of the specified link.

Parameters

NameDescriptionDefault
returnFinalTarget true to follow links to the final target; false to return the immediate next link.

Returns

A System.IO.FileSystemInfo instance if the link exists, independently if the target exists or not; null if this file or directory is not a link.

System.IO.FileSystemInfo.ToString

Returns the original path. Use the System.IO.FileSystemInfo.FullName or System.IO.FileSystemInfo.Name properties for the full path or file/directory name.

Returns

A string with the original path.

System.IO.FileSystemInfo.Attributes

Gets or sets the attributes for the current file or directory.

Returns

System.IO.FileSystemInfo.CreationTime

Gets or sets the creation time of the current file or directory.

Returns

The creation date and time of the current System.IO.FileSystemInfo object.

System.IO.FileSystemInfo.CreationTimeUtc

Gets or sets the creation time, in coordinated universal time (UTC), of the current file or directory.

Returns

The creation date and time in UTC format of the current System.IO.FileSystemInfo object.

System.IO.FileSystemInfo.Exists

Gets a value indicating whether the file or directory exists.

Returns

true if the file or directory exists; otherwise, false.

System.IO.FileSystemInfo.Extension

Gets the extension part of the file name, including the leading dot . even if it is the entire file name, or an empty string if no extension is present.

Returns

A string containing the System.IO.FileSystemInfo extension.

System.IO.FileSystemInfo.FullName

Gets the full path of the directory or file.

Returns

A string containing the full path.

System.IO.FileSystemInfo.LastAccessTime

Gets or sets the time the current file or directory was last accessed.

Returns

The time that the current file or directory was last accessed.

System.IO.FileSystemInfo.LastAccessTimeUtc

Gets or sets the time, in coordinated universal time (UTC), that the current file or directory was last accessed.

Returns

The UTC time that the current file or directory was last accessed.

System.IO.FileSystemInfo.LastWriteTime

Gets or sets the time when the current file or directory was last written to.

Returns

The time the current file was last written.

System.IO.FileSystemInfo.LastWriteTimeUtc

Gets or sets the time, in coordinated universal time (UTC), when the current file or directory was last written to.

Returns

The UTC time when the current file was last written to.

System.IO.FileSystemInfo.LinkTarget

Gets the target path of the link located in System.IO.FileSystemInfo.FullName, or null if this System.IO.FileSystemInfo instance doesn't represent a link.

Returns

The target path of the link located in System.IO.FileSystemInfo.FullName, or null if this System.IO.FileSystemInfo instance doesn't represent a link.

System.IO.FileSystemInfo.Name

For files, gets the name of the file. For directories, gets the name of the last directory in the hierarchy if a hierarchy exists. Otherwise, the Name property gets the name of the directory.

Returns

A string that is the name of the parent directory, the name of the last directory in the hierarchy, or the name of a file, including the file name extension.

System.IO.FileSystemInfo.UnixFileMode

Gets or sets the Unix file mode for the current file or directory.

Returns

System.IO.HandleInheritability

Specifies whether the underlying handle is inheritable by child processes.

System.IO.HandleInheritability.Inheritable

Specifies that the handle is inheritable by child processes.

System.IO.HandleInheritability.None

Specifies that the handle is not inheritable by child processes.

System.IO.InvalidDataException

The exception that is thrown when a data stream is in an invalid format.

System.IO.InvalidDataException.#ctor

Initializes a new instance of the System.IO.InvalidDataException class.

System.IO.InvalidDataException.#ctor()

Initializes a new instance of the System.IO.InvalidDataException class with a specified error message.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.

System.IO.InvalidDataException.#ctor()

Initializes a new instance of the System.IO.InvalidDataException class with a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.IO.IOException

The exception that is thrown when an I/O error occurs.

System.IO.IOException.#ctor

Initializes a new instance of the System.IO.IOException class with its message string set to the empty string (""), its HRESULT set to COR_E_IO, and its inner exception set to a null reference.

System.IO.IOException.#ctor()

Initializes a new instance of the System.IO.IOException class with the specified serialization and context information.

Parameters

NameDescriptionDefault
info The data for serializing or deserializing the object.
context The source and destination for the object.

System.IO.IOException.#ctor()

Initializes a new instance of the System.IO.IOException class with its message string set to message, its HRESULT set to COR_E_IO, and its inner exception set to null.

Parameters

NameDescriptionDefault
message A System.String that describes the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.

System.IO.IOException.#ctor()

Initializes a new instance of the System.IO.IOException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.IO.IOException.#ctor()

Initializes a new instance of the System.IO.IOException class with its message string set to message and its HRESULT user-defined.

Parameters

NameDescriptionDefault
message A System.String that describes the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.
hresult An integer identifying the error that has occurred.

System.IO.MatchCasing

Specifies the type of character casing to match.

System.IO.MatchCasing.CaseInsensitive

Matches ignoring character casing.

System.IO.MatchCasing.CaseSensitive

Matches respecting character casing.

System.IO.MatchCasing.PlatformDefault

Matches using the default casing for the given platform.

System.IO.MatchType

Specifies the type of wildcard matching to use.

System.IO.MatchType.Simple

Matches using '*' and '?' wildcards.

* matches from zero to any amount of characters. ? matches exactly one character. *.* matches any name with a period in it (with System.IO.MatchType.Win32, this would match all items).

System.IO.MatchType.Win32

Match using Win32 DOS style matching semantics.

'*', '?', '<', '>', and '"' are all considered wildcards. Matches in a traditional DOS / Windows command prompt way. *.* matches all files. ? matches collapse to periods. file.??t will match file.t, file.at, and file.txt.

System.IO.MemoryStream

Creates a stream whose backing store is memory.

System.IO.MemoryStream.#ctor

Initializes a new instance of the System.IO.MemoryStream class with an expandable capacity initialized to zero.

System.IO.MemoryStream.#ctor()

Initializes a new non-resizable instance of the System.IO.MemoryStream class based on the specified byte array.

Parameters

NameDescriptionDefault
buffer The array of unsigned bytes from which to create the current stream.

System.IO.MemoryStream.#ctor()

Initializes a new non-resizable instance of the System.IO.MemoryStream class based on the specified byte array with the System.IO.MemoryStream.CanWrite property set as specified.

Parameters

NameDescriptionDefault
buffer The array of unsigned bytes from which to create this stream.
writable The setting of the System.IO.MemoryStream.CanWrite property, which determines whether the stream supports writing.

System.IO.MemoryStream.#ctor()

Initializes a new non-resizable instance of the System.IO.MemoryStream class based on the specified region (index) of a byte array.

Parameters

NameDescriptionDefault
buffer The array of unsigned bytes from which to create this stream.
index The index into buffer at which the stream begins.
count The length of the stream in bytes.

System.IO.MemoryStream.#ctor()

Initializes a new non-resizable instance of the System.IO.MemoryStream class based on the specified region of a byte array, with the System.IO.MemoryStream.CanWrite property set as specified.

Parameters

NameDescriptionDefault
buffer The array of unsigned bytes from which to create this stream.
index The index in buffer at which the stream begins.
count The length of the stream in bytes.
writable The setting of the System.IO.MemoryStream.CanWrite property, which determines whether the stream supports writing.

System.IO.MemoryStream.#ctor()

Initializes a new instance of the System.IO.MemoryStream class based on the specified region of a byte array, with the System.IO.MemoryStream.CanWrite property set as specified, and the ability to call System.IO.MemoryStream.GetBuffer set as specified.

Parameters

NameDescriptionDefault
buffer The array of unsigned bytes from which to create this stream.
index The index into buffer at which the stream begins.
count The length of the stream in bytes.
writable The setting of the System.IO.MemoryStream.CanWrite property, which determines whether the stream supports writing.
publiclyVisible true to enable System.IO.MemoryStream.GetBuffer, which returns the unsigned byte array from which the stream was created; otherwise, false.

System.IO.MemoryStream.#ctor()

Initializes a new instance of the System.IO.MemoryStream class with an expandable capacity initialized as specified.

Parameters

NameDescriptionDefault
capacity The initial size of the internal array in bytes.

System.IO.MemoryStream.BeginRead()

Begins an asynchronous read operation. (Consider using System.IO.MemoryStream.ReadAsync() instead.)

Parameters

NameDescriptionDefault
buffer The buffer to read the data into.
offset The byte offset in buffer at which to begin writing data read from the memory stream.
count The maximum number of bytes to read.
callback An optional asynchronous callback, to be called when the read is complete.
state A user-provided object that distinguishes this particular asynchronous read request from other requests.

Returns

An System.IAsyncResult that represents the asynchronous read, which could still be pending.

System.IO.MemoryStream.BeginWrite()

Begins an asynchronous write operation. (Consider using System.IO.MemoryStream.WriteAsync() instead.)

Parameters

NameDescriptionDefault
buffer The buffer to write data from.
offset The byte offset in buffer from which to begin writing.
count The maximum number of bytes to write.
callback An optional asynchronous callback, to be called when the write is complete.
state A user-provided object that distinguishes this particular asynchronous write request from other requests.

Returns

An IAsyncResult that represents the asynchronous write, which could still be pending.

System.IO.MemoryStream.CopyTo()

Reads the bytes from the current memory stream and writes them to another stream, using a specified buffer size.

Parameters

NameDescriptionDefault
destination The stream to which the contents of the current memory stream will be copied.
bufferSize The size of the buffer. This value must be greater than zero. The default size is 81920.

System.IO.MemoryStream.CopyToAsync()

Asynchronously reads all the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.

Parameters

NameDescriptionDefault
destination The stream to which the contents of the current stream will be copied.
bufferSize The size, in bytes, of the buffer. This value must be greater than zero.
cancellationToken The token to monitor for cancellation requests.

Returns

A task that represents the asynchronous copy operation.

System.IO.MemoryStream.Dispose()

Releases the unmanaged resources used by the System.IO.MemoryStream class and optionally releases the managed resources.

Parameters

NameDescriptionDefault
disposing true to release both managed and unmanaged resources; false to release only unmanaged resources.

System.IO.MemoryStream.EndRead()

Waits for the pending asynchronous read to complete. (Consider using System.IO.MemoryStream.ReadAsync() instead.)

Parameters

NameDescriptionDefault
asyncResult The reference to the pending asynchronous request to finish.

Returns

The number of bytes read from the memory stream, between zero (0) and the number of bytes you requested. Returns zero (0) only at the end of the memory stream, otherwise, it should block until at least one byte is available.

System.IO.MemoryStream.EndWrite()

Ends an asynchronous write operation. (Consider using System.IO.MemoryStream.WriteAsync() instead.)

Parameters

NameDescriptionDefault
asyncResult A reference to the outstanding asynchronous I/O request.

System.IO.MemoryStream.Flush

Overrides the System.IO.Stream.Flush method so that no action is performed.

System.IO.MemoryStream.FlushAsync()

Asynchronously clears all buffers for this stream, and monitors cancellation requests.

Parameters

NameDescriptionDefault
cancellationToken The token to monitor for cancellation requests.

Returns

A task that represents the asynchronous flush operation.

System.IO.MemoryStream.GetBuffer

Returns the array of unsigned bytes from which this stream was created.

Returns

The byte array from which this stream was created, or the underlying array if a byte array was not provided to the System.IO.MemoryStream constructor during construction of the current instance.

System.IO.MemoryStream.Read()

Reads a block of bytes from the current stream and writes the data to a buffer.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified byte array with the values between offset and (offset + count - 1) replaced by the characters read from the current stream.
offset The zero-based byte offset in buffer at which to begin storing data from the current stream.
count The maximum number of bytes to read.

Returns

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.

System.IO.MemoryStream.Read()

Reads a sequence of bytes from the current memory stream and advances the position within the memory stream by the number of bytes read.

Parameters

NameDescriptionDefault
buffer

Returns

The total number of bytes read into the buffer. This can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or zero (0) if the end of the memory stream has been reached.

System.IO.MemoryStream.ReadAsync()

Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The buffer to write the data into.
offset The byte offset in buffer at which to begin writing data from the stream.
count The maximum number of bytes to read.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

System.IO.MemoryStream.ReadAsync()

Asynchronously reads a sequence of bytes from the current memory stream, writes the sequence into destination, advances the position within the memory stream by the number of bytes read, and monitors cancellation requests.

Parameters

NameDescriptionDefault
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.
buffer

Returns

A task that represents the asynchronous read operation. The value of its System.Threading.Tasks.ValueTask`1.Result property contains the total number of bytes read into the destination. The result value can be less than the number of bytes allocated in destination if that many bytes are not currently available, or it can be 0 (zero) if the end of the memory stream has been reached.

System.IO.MemoryStream.ReadByte

Reads a byte from the current stream.

Returns

The byte cast to a System.Int32, or -1 if the end of the stream has been reached.

System.IO.MemoryStream.Seek()

Sets the position within the current stream to the specified value.

Parameters

NameDescriptionDefault
offset The new position within the stream. This is relative to the loc parameter, and can be positive or negative.
loc A value of type System.IO.SeekOrigin, which acts as the seek reference point.

Returns

The new position within the stream, calculated by combining the initial reference point and the offset.

System.IO.MemoryStream.SetLength()

Sets the length of the current stream to the specified value.

Parameters

NameDescriptionDefault
value The value at which to set the length.

System.IO.MemoryStream.ToArray

Writes the stream contents to a byte array, regardless of the System.IO.MemoryStream.Position property.

Returns

A new byte array.

System.IO.MemoryStream.TryGetBuffer()

Returns the array of unsigned bytes from which this stream was created. The return value indicates whether the conversion succeeded.

Parameters

NameDescriptionDefault
buffer When this method returns true, the byte array segment from which this stream was created; when this method returns false, this parameter is set to default.

Returns

true if the buffer is exposable; otherwise, false.

System.IO.MemoryStream.Write()

Writes a block of bytes to the current stream using data read from a buffer.

Parameters

NameDescriptionDefault
buffer The buffer to write data from.
offset The zero-based byte offset in buffer at which to begin copying bytes to the current stream.
count The maximum number of bytes to write.

System.IO.MemoryStream.Write()

Writes the sequence of bytes contained in source into the current memory stream and advances the current position within this memory stream by the number of bytes written.

Parameters

NameDescriptionDefault
buffer

System.IO.MemoryStream.WriteAsync()

Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The buffer to write data from.
offset The zero-based byte offset in buffer from which to begin copying bytes to the stream.
count The maximum number of bytes to write.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.MemoryStream.WriteAsync()

Asynchronously writes the sequence of bytes contained in source into the current memory stream, advances the current position within this memory stream by the number of bytes written, and monitors cancellation requests.

Parameters

NameDescriptionDefault
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.
buffer

Returns

A task that represents the asynchronous write operation.

System.IO.MemoryStream.WriteByte()

Writes a byte to the current stream at the current position.

Parameters

NameDescriptionDefault
value The byte to write.

System.IO.MemoryStream.WriteTo()

Writes the entire contents of this memory stream to another stream.

Parameters

NameDescriptionDefault
stream The stream to write this memory stream to.

System.IO.MemoryStream.CanRead

Gets a value indicating whether the current stream supports reading.

Returns

true if the stream is open.

System.IO.MemoryStream.CanSeek

Gets a value indicating whether the current stream supports seeking.

Returns

true if the stream is open.

System.IO.MemoryStream.CanWrite

Gets a value indicating whether the current stream supports writing.

Returns

true if the stream supports writing; otherwise, false.

System.IO.MemoryStream.Capacity

Gets or sets the number of bytes allocated for this stream.

Returns

The length of the usable portion of the buffer for the stream.

System.IO.MemoryStream.Length

Gets the length of the stream in bytes.

Returns

The length of the stream in bytes.

System.IO.MemoryStream.Position

Gets or sets the current position within the stream.

Returns

The current position within the stream.

System.IO.Path

Performs operations on System.String instances that contain file or directory path information. These operations are performed in a cross-platform manner.

System.IO.Path.AltDirectorySeparatorChar

Provides a platform-specific alternate character used to separate directory levels in a path string that reflects a hierarchical file system organization.

System.IO.Path.DirectorySeparatorChar

Provides a platform-specific character used to separate directory levels in a path string that reflects a hierarchical file system organization.

System.IO.Path.InvalidPathChars

Provides a platform-specific array of characters that cannot be specified in path string arguments passed to members of the System.IO.Path class.

System.IO.Path.PathSeparator

A platform-specific separator character used to separate path strings in environment variables.

System.IO.Path.VolumeSeparatorChar

Provides a platform-specific volume separator character.

System.IO.Path.ChangeExtension()

Changes the extension of a path string.

Parameters

NameDescriptionDefault
path The path information to modify.
extension The new extension (with or without a leading period). Specify null to remove an existing extension from path.

Returns

The modified path information. On Windows-based desktop platforms, if path is null or an empty string (""), the path information is returned unmodified. If extension is null, the returned string contains the specified path with its extension removed. If path has no extension, and extension is not null, the returned path string contains extension appended to the end of path.

System.IO.Path.Combine()

Combines two strings into a path.

Parameters

NameDescriptionDefault
path1 The first path to combine.
path2 The second path to combine.

Returns

The combined paths. If one of the specified paths is a zero-length string, this method returns the other path. If path2 contains an absolute path, this method returns path2.

System.IO.Path.Combine()

Combines three strings into a path.

Parameters

NameDescriptionDefault
path1 The first path to combine.
path2 The second path to combine.
path3 The third path to combine.

Returns

The combined paths.

System.IO.Path.Combine()

Combines four strings into a path.

Parameters

NameDescriptionDefault
path1 The first path to combine.
path2 The second path to combine.
path3 The third path to combine.
path4 The fourth path to combine.

Returns

The combined paths.

System.IO.Path.Combine()

Combines an array of strings into a path.

Parameters

NameDescriptionDefault
paths An array of parts of the path.

Returns

The combined paths.

System.IO.Path.EndsInDirectorySeparator()

Returns a value that indicates whether the path, specified as a read-only span, ends in a directory separator.

Parameters

NameDescriptionDefault
path The path to analyze.

Returns

true if the path ends in a directory separator; otherwise, false.

System.IO.Path.EndsInDirectorySeparator()

Returns a value that indicates whether the specified path ends in a directory separator.

Parameters

NameDescriptionDefault
path The path to analyze.

Returns

true if the path ends in a directory separator; otherwise, false.

System.IO.Path.Exists()

Determines whether the specified file or directory exists.

Parameters

NameDescriptionDefault
path The path to check

Returns

true if the caller has the required permissions and path contains the name of an existing file or directory; otherwise, false. This method also returns false if path is null, an invalid path, or a zero-length string. If the caller does not have sufficient permissions to read the specified path, no exception is thrown and the method returns false regardless of the existence of path.

System.IO.Path.GetDirectoryName()

Returns the directory information for the specified path represented by a character span.

Parameters

NameDescriptionDefault
path The path to retrieve the directory information from.

Returns

Directory information for path, or an empty span if path is null, an empty span, or a root (such as \, C:, or \\server\share).

System.IO.Path.GetDirectoryName()

Returns the directory information for the specified path.

Parameters

NameDescriptionDefault
path The path of a file or directory.

Returns

Directory information for path, or null if path denotes a root directory or is null. Returns System.String.Empty if path does not contain directory information.

System.IO.Path.GetExtension()

Returns the extension of a file path that is represented by a read-only character span.

Parameters

NameDescriptionDefault
path The file path from which to get the extension.

Returns

The extension of the specified path (including the period, "."), or System.ReadOnlySpan`1.Empty if path does not have extension information.

System.IO.Path.GetExtension()

Returns the extension (including the period ".") of the specified path string.

Parameters

NameDescriptionDefault
path The path string from which to get the extension.

Returns

The extension of the specified path (including the period "."), or null, or System.String.Empty. If path is null, System.IO.Path.GetExtension() returns null. If path does not have extension information, System.IO.Path.GetExtension() returns System.String.Empty.

System.IO.Path.GetFileName()

Returns the file name and extension of a file path that is represented by a read-only character span.

Parameters

NameDescriptionDefault
path A read-only span that contains the path from which to obtain the file name and extension.

Returns

The characters after the last directory separator character in path.

System.IO.Path.GetFileName()

Returns the file name and extension of the specified path string.

Parameters

NameDescriptionDefault
path The path string from which to obtain the file name and extension.

Returns

The characters after the last directory separator character in path. If the last character of path is a directory or volume separator character, this method returns System.String.Empty. If path is null, this method returns null.

System.IO.Path.GetFileNameWithoutExtension()

Returns the file name without the extension of a file path that is represented by a read-only character span.

Parameters

NameDescriptionDefault
path A read-only span that contains the path from which to obtain the file name without the extension.

Returns

The characters in the read-only span returned by System.IO.Path.GetFileName(), minus the last period (.) and all characters following it.

System.IO.Path.GetFileNameWithoutExtension()

Returns the file name of the specified path string without the extension.

Parameters

NameDescriptionDefault
path The path of the file.

Returns

The string returned by System.IO.Path.GetFileName(), minus the last period (.) and all characters following it.

System.IO.Path.GetFullPath()

Returns the absolute path for the specified path string.

Parameters

NameDescriptionDefault
path The file or directory for which to obtain absolute path information.

Returns

The fully qualified location of path, such as "C:\MyFile.txt".

System.IO.Path.GetFullPath()

Returns an absolute path from a relative path and a fully qualified base path.

Parameters

NameDescriptionDefault
path A relative path to concatenate to basePath.
basePath The beginning of a fully qualified path.

Returns

The absolute path.

System.IO.Path.GetInvalidFileNameChars

Gets an array containing the characters that are not allowed in file names.

Returns

An array containing the characters that are not allowed in file names.

System.IO.Path.GetInvalidPathChars

Gets an array containing the characters that are not allowed in path names.

Returns

An array containing the characters that are not allowed in path names.

System.IO.Path.GetPathRoot()

Gets the root directory information from the path contained in the specified character span.

Parameters

NameDescriptionDefault
path A read-only span of characters containing the path from which to obtain root directory information.

Returns

A read-only span of characters containing the root directory of path.

System.IO.Path.GetPathRoot()

Gets the root directory information from the path contained in the specified string.

Parameters

NameDescriptionDefault
path A string containing the path from which to obtain root directory information.

Returns

The root directory of path if it is rooted. -or- System.String.Empty if path does not contain root directory information. -or- null if path is null or is effectively empty.

System.IO.Path.GetRandomFileName

Returns a random folder name or file name.

Returns

A random folder name or file name.

System.IO.Path.GetRelativePath()

Returns a relative path from one path to another.

Parameters

NameDescriptionDefault
relativeTo The source path the result should be relative to. This path is always considered to be a directory.
path The destination path.

Returns

The relative path, or path if the paths don't share the same root.

System.IO.Path.GetTempFileName

Creates a uniquely named, zero-byte temporary file on disk and returns the full path of that file.

Returns

The full path of the temporary file.

System.IO.Path.GetTempPath

Returns the path of the current user's temporary folder.

Returns

The path to the temporary folder, ending with a System.IO.Path.DirectorySeparatorChar.

System.IO.Path.HasExtension()

Determines whether the path represented by the specified character span includes a file name extension.

Parameters

NameDescriptionDefault
path The path to search for an extension.

Returns

true if the characters that follow the last directory separator character or volume separator in the path include a period (".") followed by one or more characters; otherwise, false.

System.IO.Path.HasExtension()

Determines whether a path includes a file name extension.

Parameters

NameDescriptionDefault
path The path to search for an extension.

Returns

true if the characters that follow the last directory separator (\ or /) or volume separator (:) in the path include a period (.) followed by one or more characters; otherwise, false.

System.IO.Path.IsPathFullyQualified()

Returns a value that indicates whether the file path represented by the specified character span is fixed to a specific drive or UNC path.

Parameters

NameDescriptionDefault
path A file path.

Returns

true if the path is fixed to a specific drive or UNC path; false if the path is relative to the current drive or working directory.

System.IO.Path.IsPathFullyQualified()

Returns a value that indicates whether the specified file path is fixed to a specific drive or UNC path.

Parameters

NameDescriptionDefault
path A file path.

Returns

true if the path is fixed to a specific drive or UNC path; false if the path is relative to the current drive or working directory.

System.IO.Path.IsPathRooted()

Returns a value that indicates whether the specified character span that represents a file path contains a root.

Parameters

NameDescriptionDefault
path The path to test.

Returns

true if path contains a root; otherwise, false.

System.IO.Path.IsPathRooted()

Returns a value indicating whether the specified path string contains a root.

Parameters

NameDescriptionDefault
path The path to test.

Returns

true if path contains a root; otherwise, false.

System.IO.Path.Join()

Concatenates two path components into a single path.

Parameters

NameDescriptionDefault
path1 A character span that contains the first path to join.
path2 A character span that contains the second path to join.

Returns

The combined paths.

System.IO.Path.Join()

Concatenates three path components into a single path.

Parameters

NameDescriptionDefault
path1 A character span that contains the first path to join.
path2 A character span that contains the second path to join.
path3 A character span that contains the third path to join.

Returns

The concatenated path.

System.IO.Path.Join()

Concatenates four path components into a single path.

Parameters

NameDescriptionDefault
path1 A character span that contains the first path to join.
path2 A character span that contains the second path to join.
path3 A character span that contains the third path to join.
path4 A character span that contains the fourth path to join.

Returns

The concatenated path.

System.IO.Path.Join()

Concatenates two paths into a single path.

Parameters

NameDescriptionDefault
path1 The first path to join.
path2 The second path to join.

Returns

The concatenated path.

System.IO.Path.Join()

Concatenates three paths into a single path.

Parameters

NameDescriptionDefault
path1 The first path to join.
path2 The second path to join.
path3 The third path to join.

Returns

The concatenated path.

System.IO.Path.Join()

Concatenates four paths into a single path.

Parameters

NameDescriptionDefault
path1 The first path to join.
path2 The second path to join.
path3 The third path to join.
path4 The fourth path to join.

Returns

The concatenated path.

System.IO.Path.Join()

Concatenates an array of paths into a single path.

Parameters

NameDescriptionDefault
paths An array of paths.

Returns

The concatenated path.

System.IO.Path.TrimEndingDirectorySeparator()

Trims one trailing directory separator beyond the root of the specified path.

Parameters

NameDescriptionDefault
path The path to trim.

Returns

The path without any trailing directory separators.

System.IO.Path.TrimEndingDirectorySeparator()

Trims one trailing directory separator beyond the root of the specified path.

Parameters

NameDescriptionDefault
path The path to trim.

Returns

The path without any trailing directory separators.

System.IO.Path.TryJoin()

Attempts to concatenate three path components to a single preallocated character span, and returns a value that indicates whether the operation succeeded.

Parameters

NameDescriptionDefault
path1 A character span that contains the first path to join.
path2 A character span that contains the second path to join.
path3 A character span that contains the third path to join.
destination A character span to hold the concatenated path.
charsWritten When the method returns, a value that indicates the number of characters written to the destination.

Returns

true if the concatenation operation is successful; otherwise, false.

System.IO.Path.TryJoin()

Attempts to concatenate two path components to a single preallocated character span, and returns a value that indicates whether the operation succeeded.

Parameters

NameDescriptionDefault
path1 A character span that contains the first path to join.
path2 A character span that contains the second path to join.
destination A character span to hold the concatenated path.
charsWritten When the method returns, a value that indicates the number of characters written to the destination.

Returns

true if the concatenation operation is successful; otherwise, false.

System.IO.PathTooLongException

The exception that is thrown when a path or fully qualified file name is longer than the system-defined maximum length.

System.IO.PathTooLongException.#ctor

Initializes a new instance of the System.IO.PathTooLongException class with its HRESULT set to COR_E_PATHTOOLONG.

System.IO.PathTooLongException.#ctor()

Initializes a new instance of the System.IO.PathTooLongException class with the specified serialization and context information.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.IO.PathTooLongException.#ctor()

Initializes a new instance of the System.IO.PathTooLongException class with its message string set to message and its HRESULT set to COR_E_PATHTOOLONG.

Parameters

NameDescriptionDefault
message A System.String that describes the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.

System.IO.PathTooLongException.#ctor()

Initializes a new instance of the System.IO.PathTooLongException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message A System.String that describes the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.IO.RandomAccess

Provides offset-based APIs for reading and writing files in a thread-safe manner.

System.IO.RandomAccess.FlushToDisk()

Flushes the operating system buffers for the given file to disk.

Parameters

NameDescriptionDefault
handle The file handle.

System.IO.RandomAccess.GetLength()

Gets the length of the file in bytes.

Parameters

NameDescriptionDefault
handle The file handle.

Returns

A long value representing the length of the file in bytes.

System.IO.RandomAccess.Read()

Reads a sequence of bytes from given file at given offset.

Parameters

NameDescriptionDefault
handle The file handle.
buffers A list of memory buffers. When this method returns, the contents of the buffers are replaced by the bytes read from the file.
fileOffset The file position to read from.

Returns

The total number of bytes read into the buffers. This can be less than the number of bytes allocated in the buffers if that many bytes are not currently available, or zero (0) if the end of the file has been reached.

System.IO.RandomAccess.Read()

Reads a sequence of bytes from given file at given offset.

Parameters

NameDescriptionDefault
handle The file handle.
buffer A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the file.
fileOffset The file position to read from.

Returns

The total number of bytes read into the buffer. This can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or zero (0) if the end of the file has been reached.

System.IO.RandomAccess.ReadAsync()

Reads a sequence of bytes from given file at given offset.

Parameters

NameDescriptionDefault
handle The file handle.
buffers A list of memory buffers. When this method returns, the contents of these buffers are replaced by the bytes read from the file.
fileOffset The file position to read from.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

The total number of bytes read into the buffers. This can be less than the number of bytes allocated in the buffers if that many bytes are not currently available, or zero (0) if the end of the file has been reached.

System.IO.RandomAccess.ReadAsync()

Reads a sequence of bytes from given file at given offset.

Parameters

NameDescriptionDefault
handle The file handle.
buffer A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the file.
fileOffset The file position to read from.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

The total number of bytes read into the buffer. This can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or zero (0) if the end of the file has been reached.

System.IO.RandomAccess.SetLength()

Sets the length of the file to the given value.

Parameters

NameDescriptionDefault
handle The file handle.
length The length of the file in bytes.

System.IO.RandomAccess.Write()

Writes a sequence of bytes from given buffers to given file at given offset.

Parameters

NameDescriptionDefault
handle The file handle.
buffers A list of memory buffers. This method copies the contents of these buffers to the file.
fileOffset The file position to write to.

System.IO.RandomAccess.Write()

Writes a sequence of bytes from given buffer to given file at given offset.

Parameters

NameDescriptionDefault
handle The file handle.
buffer A region of memory. This method copies the contents of this region to the file.
fileOffset The file position to write to.

System.IO.RandomAccess.WriteAsync()

Writes a sequence of bytes from given buffers to given file at given offset.

Parameters

NameDescriptionDefault
handle The file handle.
buffers A list of memory buffers. This method copies the contents of these buffers to the file.
fileOffset The file position to write to.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task representing the asynchronous completion of the write operation.

System.IO.RandomAccess.WriteAsync()

Writes a sequence of bytes from given buffer to given file at given offset.

Parameters

NameDescriptionDefault
handle The file handle.
buffer A region of memory. This method copies the contents of this region to the file.
fileOffset The file position to write to.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task representing the asynchronous completion of the write operation.

System.IO.SearchOption

Specifies whether to search the current directory, or the current directory and all subdirectories.

System.IO.SearchOption.AllDirectories

Includes the current directory and all its subdirectories in a search operation. This option includes reparse points such as mounted drives and symbolic links in the search.

System.IO.SearchOption.TopDirectoryOnly

Includes only the current directory in a search operation.

System.IO.SeekOrigin

Specifies the position in a stream to use for seeking.

System.IO.SeekOrigin.Begin

Specifies the beginning of a stream.

System.IO.SeekOrigin.Current

Specifies the current position within a stream.

System.IO.SeekOrigin.End

Specifies the end of a stream.

System.IO.Stream

Provides a generic view of a sequence of bytes. This is an abstract class.

System.IO.Stream.Null

A Stream with no backing store.

System.IO.Stream.#ctor

Initializes a new instance of the System.IO.Stream class.

System.IO.Stream.BeginRead()

Begins an asynchronous read operation. (Consider using System.IO.Stream.ReadAsync() instead.)

Parameters

NameDescriptionDefault
buffer The buffer to read the data into.
offset The byte offset in buffer at which to begin writing data read from the stream.
count The maximum number of bytes to read.
callback An optional asynchronous callback, to be called when the read is complete.
state A user-provided object that distinguishes this particular asynchronous read request from other requests.

Returns

An System.IAsyncResult that represents the asynchronous read, which could still be pending.

System.IO.Stream.BeginWrite()

Begins an asynchronous write operation. (Consider using System.IO.Stream.WriteAsync() instead.)

Parameters

NameDescriptionDefault
buffer The buffer to write data from.
offset The byte offset in buffer from which to begin writing.
count The maximum number of bytes to write.
callback An optional asynchronous callback, to be called when the write is complete.
state A user-provided object that distinguishes this particular asynchronous write request from other requests.

Returns

An IAsyncResult that represents the asynchronous write, which could still be pending.

System.IO.Stream.Close

Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed.

System.IO.Stream.CopyTo()

Reads the bytes from the current stream and writes them to another stream. Both streams positions are advanced by the number of bytes copied.

Parameters

NameDescriptionDefault
destination The stream to which the contents of the current stream will be copied.

System.IO.Stream.CopyTo()

Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. Both streams positions are advanced by the number of bytes copied.

Parameters

NameDescriptionDefault
destination The stream to which the contents of the current stream will be copied.
bufferSize The size of the buffer. This value must be greater than zero. The default size is 81920.

System.IO.Stream.CopyToAsync()

Asynchronously reads the bytes from the current stream and writes them to another stream. Both streams positions are advanced by the number of bytes copied.

Parameters

NameDescriptionDefault
destination The stream to which the contents of the current stream will be copied.

Returns

A task that represents the asynchronous copy operation.

System.IO.Stream.CopyToAsync()

Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. Both streams positions are advanced by the number of bytes copied.

Parameters

NameDescriptionDefault
destination The stream to which the contents of the current stream will be copied.
bufferSize The size, in bytes, of the buffer. This value must be greater than zero. The default size is 81920.

Returns

A task that represents the asynchronous copy operation.

System.IO.Stream.CopyToAsync()

Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. Both streams positions are advanced by the number of bytes copied.

Parameters

NameDescriptionDefault
destination The stream to which the contents of the current stream will be copied.
bufferSize The size, in bytes, of the buffer. This value must be greater than zero. The default size is 81920.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous copy operation.

System.IO.Stream.CopyToAsync()

Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified cancellation token. Both streams positions are advanced by the number of bytes copied.

Parameters

NameDescriptionDefault
destination The stream to which the contents of the current stream will be copied.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous copy operation.

System.IO.Stream.CreateWaitHandle

Allocates a System.Threading.WaitHandle object.

Returns

A reference to the allocated WaitHandle.

System.IO.Stream.Dispose

Releases all resources used by the System.IO.Stream.

System.IO.Stream.Dispose()

Releases the unmanaged resources used by the System.IO.Stream and optionally releases the managed resources.

Parameters

NameDescriptionDefault
disposing true to release both managed and unmanaged resources; false to release only unmanaged resources.

System.IO.Stream.DisposeAsync

Asynchronously releases the unmanaged resources used by the System.IO.Stream.

Returns

A task that represents the asynchronous dispose operation.

System.IO.Stream.EndRead()

Waits for the pending asynchronous read to complete. (Consider using System.IO.Stream.ReadAsync() instead.)

Parameters

NameDescriptionDefault
asyncResult The reference to the pending asynchronous request to finish.

Returns

The number of bytes read from the stream, between zero (0) and the number of bytes requested. ReadAsync returns zero (0) only if zero bytes were requested or if no more bytes will be available because it's at the end of the stream; otherwise, read operations do not complete until at least one byte is available. If zero bytes are requested, read operations may complete immediately or may not complete until at least one byte is available (but without consuming any data).

System.IO.Stream.EndWrite()

Ends an asynchronous write operation. (Consider using System.IO.Stream.WriteAsync() instead.)

Parameters

NameDescriptionDefault
asyncResult A reference to the outstanding asynchronous I/O request.

System.IO.Stream.Flush

When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.

System.IO.Stream.FlushAsync

Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.

Returns

A task that represents the asynchronous flush operation.

System.IO.Stream.FlushAsync()

Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.

Parameters

NameDescriptionDefault
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous flush operation.

System.IO.Stream.ObjectInvariant

Provides support for a System.Diagnostics.Contracts.Contract.

System.IO.Stream.Read()

When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Parameters

NameDescriptionDefault
buffer An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.
offset The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
count The maximum number of bytes to be read from the current stream.

Returns

The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if count is 0 or the end of the stream has been reached.

System.IO.Stream.Read()

When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Parameters

NameDescriptionDefault
buffer A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source.

Returns

The total number of bytes read into the buffer. This can be less than the size of the buffer if that many bytes are not currently available, or zero (0) if the buffer's length is zero or the end of the stream has been reached.

System.IO.Stream.ReadAsync()

Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Parameters

NameDescriptionDefault
buffer The buffer to write the data into.
offset The byte offset in buffer at which to begin writing data from the stream.
count The maximum number of bytes to read.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if count is 0 or if the end of the stream has been reached.

System.IO.Stream.ReadAsync()

Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The buffer to write the data into.
offset The byte offset in buffer at which to begin writing data from the stream.
count The maximum number of bytes to read.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if count is 0 or if the end of the stream has been reached.

System.IO.Stream.ReadAsync()

Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The region of memory to write the data into.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous read operation. The value of its System.Threading.Tasks.ValueTask`1.Result property contains the total number of bytes read into the buffer. The result value can be less than the length of the buffer if that many bytes are not currently available, or it can be 0 (zero) if the length of the buffer is 0 or if the end of the stream has been reached.

System.IO.Stream.ReadAtLeast()

Reads at least a minimum number of bytes from the current stream and advances the position within the stream by the number of bytes read.

Parameters

NameDescriptionDefault
buffer A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current stream.
minimumBytes The minimum number of bytes to read into the buffer.
throwOnEndOfStream true to throw an exception if the end of the stream is reached before reading minimumBytes of bytes; false to return less than minimumBytes when the end of the stream is reached. The default is true.

Returns

The total number of bytes read into the buffer. This is guaranteed to be greater than or equal to minimumBytes when throwOnEndOfStream is true. This will be less than minimumBytes when the end of the stream is reached and throwOnEndOfStream is false. This can be less than the number of bytes allocated in the buffer if that many bytes are not currently available.

System.IO.Stream.ReadAtLeastAsync()

Asynchronously reads at least a minimum number of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The region of memory to write the data into.
minimumBytes The minimum number of bytes to read into the buffer.
throwOnEndOfStream true to throw an exception if the end of the stream is reached before reading minimumBytes of bytes; false to return less than minimumBytes when the end of the stream is reached. The default is true.
cancellationToken The token to monitor for cancellation requests.

Returns

A task that represents the asynchronous read operation. The value of its System.Threading.Tasks.ValueTask`1.Result property contains the total number of bytes read into the buffer. This is guaranteed to be greater than or equal to minimumBytes when throwOnEndOfStream is true. This will be less than minimumBytes when the end of the stream is reached and throwOnEndOfStream is false. This can be less than the number of bytes allocated in the buffer if that many bytes are not currently available.

System.IO.Stream.ReadByte

Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.

Returns

The unsigned byte cast to an System.Int32, or -1 if at the end of the stream.

System.IO.Stream.ReadExactly()

Reads count number of bytes from the current stream and advances the position within the stream.

Parameters

NameDescriptionDefault
buffer An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current stream.
offset The byte offset in buffer at which to begin storing the data read from the current stream.
count The number of bytes to be read from the current stream.

System.IO.Stream.ReadExactly()

Reads bytes from the current stream and advances the position within the stream until the buffer is filled.

Parameters

NameDescriptionDefault
buffer A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current stream.

System.IO.Stream.ReadExactlyAsync()

Asynchronously reads count number of bytes from the current stream, advances the position within the stream, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The buffer to write the data into.
offset The byte offset in buffer at which to begin writing data from the stream.
count The number of bytes to be read from the current stream.
cancellationToken The token to monitor for cancellation requests.

Returns

A task that represents the asynchronous read operation.

System.IO.Stream.ReadExactlyAsync()

Asynchronously reads bytes from the current stream, advances the position within the stream until the buffer is filled, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The buffer to write the data into.
cancellationToken The token to monitor for cancellation requests.

Returns

A task that represents the asynchronous read operation.

System.IO.Stream.Seek()

When overridden in a derived class, sets the position within the current stream.

Parameters

NameDescriptionDefault
offset A byte offset relative to the origin parameter.
origin A value of type System.IO.SeekOrigin indicating the reference point used to obtain the new position.

Returns

The new position within the current stream.

System.IO.Stream.SetLength()

When overridden in a derived class, sets the length of the current stream.

Parameters

NameDescriptionDefault
value The desired length of the current stream in bytes.

System.IO.Stream.Synchronized()

Creates a thread-safe (synchronized) wrapper around the specified System.IO.Stream object.

Parameters

NameDescriptionDefault
stream The System.IO.Stream object to synchronize.

Returns

A thread-safe System.IO.Stream object.

System.IO.Stream.ValidateBufferArguments()

Validates arguments provided to reading and writing methods on System.IO.Stream.

Parameters

NameDescriptionDefault
buffer The array "buffer" argument passed to the reading or writing method.
offset The integer "offset" argument passed to the reading or writing method.
count The integer "count" argument passed to the reading or writing method.

System.IO.Stream.ValidateCopyToArguments()

Validates arguments provided to the System.IO.Stream.CopyTo() or System.IO.Stream.CopyToAsync() methods.

Parameters

NameDescriptionDefault
destination The System.IO.Stream "destination" argument passed to the copy method.
bufferSize The integer "bufferSize" argument passed to the copy method.

System.IO.Stream.Write()

When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

Parameters

NameDescriptionDefault
buffer An array of bytes. This method copies count bytes from buffer to the current stream.
offset The zero-based byte offset in buffer at which to begin copying bytes to the current stream.
count The number of bytes to be written to the current stream.

System.IO.Stream.Write()

When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

Parameters

NameDescriptionDefault
buffer A region of memory. This method copies the contents of this region to the current stream.

System.IO.Stream.WriteAsync()

Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

Parameters

NameDescriptionDefault
buffer The buffer to write data from.
offset The zero-based byte offset in buffer from which to begin copying bytes to the stream.
count The maximum number of bytes to write.

Returns

A task that represents the asynchronous write operation.

System.IO.Stream.WriteAsync()

Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The buffer to write data from.
offset The zero-based byte offset in buffer from which to begin copying bytes to the stream.
count The maximum number of bytes to write.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.Stream.WriteAsync()

Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The region of memory to write data from.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.Stream.WriteByte()

Writes a byte to the current position in the stream and advances the position within the stream by one byte.

Parameters

NameDescriptionDefault
value The byte to write to the stream.

System.IO.Stream.CanRead

When overridden in a derived class, gets a value indicating whether the current stream supports reading.

Returns

true if the stream supports reading; otherwise, false.

System.IO.Stream.CanSeek

When overridden in a derived class, gets a value indicating whether the current stream supports seeking.

Returns

true if the stream supports seeking; otherwise, false.

System.IO.Stream.CanTimeout

Gets a value that determines whether the current stream can time out.

Returns

A value that determines whether the current stream can time out.

System.IO.Stream.CanWrite

When overridden in a derived class, gets a value indicating whether the current stream supports writing.

Returns

true if the stream supports writing; otherwise, false.

System.IO.Stream.Length

When overridden in a derived class, gets the length in bytes of the stream.

Returns

A long value representing the length of the stream in bytes.

System.IO.Stream.Position

When overridden in a derived class, gets or sets the position within the current stream.

Returns

The current position within the stream.

System.IO.Stream.ReadTimeout

Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.

Returns

A value, in milliseconds, that determines how long the stream will attempt to read before timing out.

System.IO.Stream.WriteTimeout

Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.

Returns

A value, in milliseconds, that determines how long the stream will attempt to write before timing out.

System.IO.StreamReader

Implements a System.IO.TextReader that reads characters from a byte stream in a particular encoding.

System.IO.StreamReader.Null

A System.IO.StreamReader object around an empty stream.

System.IO.StreamReader.#ctor()

Initializes a new instance of the System.IO.StreamReader class for the specified stream.

Parameters

NameDescriptionDefault
stream The stream to be read.

System.IO.StreamReader.#ctor()

Initializes a new instance of the System.IO.StreamReader class for the specified stream, with the specified byte order mark detection option.

Parameters

NameDescriptionDefault
stream The stream to be read.
detectEncodingFromByteOrderMarks Indicates whether to look for byte order marks at the beginning of the file.

System.IO.StreamReader.#ctor()

Initializes a new instance of the System.IO.StreamReader class for the specified stream, with the specified character encoding.

Parameters

NameDescriptionDefault
stream The stream to be read.
encoding The character encoding to use.

System.IO.StreamReader.#ctor()

Initializes a new instance of the System.IO.StreamReader class for the specified stream, with the specified character encoding and byte order mark detection option.

Parameters

NameDescriptionDefault
stream The stream to be read.
encoding The character encoding to use.
detectEncodingFromByteOrderMarks Indicates whether to look for byte order marks at the beginning of the file.

System.IO.StreamReader.#ctor()

Initializes a new instance of the System.IO.StreamReader class for the specified stream, with the specified character encoding, byte order mark detection option, and buffer size.

Parameters

NameDescriptionDefault
stream The stream to be read.
encoding The character encoding to use.
detectEncodingFromByteOrderMarks Indicates whether to look for byte order marks at the beginning of the file.
bufferSize The minimum buffer size.

System.IO.StreamReader.#ctor()

Initializes a new instance of the System.IO.StreamReader class for the specified stream based on the specified character encoding, byte order mark detection option, and buffer size, and optionally leaves the stream open.

Parameters

NameDescriptionDefault
stream The stream to read.
encoding The character encoding to use.
detectEncodingFromByteOrderMarks true to look for byte order marks at the beginning of the file; otherwise, false.
bufferSize The minimum buffer size.
leaveOpen true to leave the stream open after the System.IO.StreamReader object is disposed; otherwise, false.

System.IO.StreamReader.#ctor()

Initializes a new instance of the System.IO.StreamReader class for the specified file name.

Parameters

NameDescriptionDefault
path The complete file path to be read.

System.IO.StreamReader.#ctor()

Initializes a new instance of the System.IO.StreamReader class for the specified file name, with the specified byte order mark detection option.

Parameters

NameDescriptionDefault
path The complete file path to be read.
detectEncodingFromByteOrderMarks Indicates whether to look for byte order marks at the beginning of the file.

System.IO.StreamReader.#ctor()

Initializes a new instance of the System.IO.StreamReader class for the specified file path, using the default encoding, enabling detection of byte order marks at the beginning of the file, and configured with the specified System.IO.FileStreamOptions object.

Parameters

NameDescriptionDefault
path The complete file path to be read.
options An object that specifies the configuration options for the underlying System.IO.FileStream.

System.IO.StreamReader.#ctor()

Initializes a new instance of the System.IO.StreamReader class for the specified file name, with the specified character encoding.

Parameters

NameDescriptionDefault
path The complete file path to be read.
encoding The character encoding to use.

System.IO.StreamReader.#ctor()

Initializes a new instance of the System.IO.StreamReader class for the specified file name, with the specified character encoding and byte order mark detection option.

Parameters

NameDescriptionDefault
path The complete file path to be read.
encoding The character encoding to use.
detectEncodingFromByteOrderMarks Indicates whether to look for byte order marks at the beginning of the file.

System.IO.StreamReader.#ctor()

Initializes a new instance of the System.IO.StreamReader class for the specified file name, with the specified character encoding, byte order mark detection option, and buffer size.

Parameters

NameDescriptionDefault
path The complete file path to be read.
encoding The character encoding to use.
detectEncodingFromByteOrderMarks Indicates whether to look for byte order marks at the beginning of the file.
bufferSize The minimum buffer size, in number of 16-bit characters.

System.IO.StreamReader.#ctor()

Initializes a new instance of the System.IO.StreamReader class for the specified file path, with the specified character encoding, byte order mark detection option, and configured with the specified System.IO.FileStreamOptions object.

Parameters

NameDescriptionDefault
path The complete file path to be read.
encoding The character encoding to use.
detectEncodingFromByteOrderMarks Indicates whether to look for byte order marks at the beginning of the file.
options An object that specifies the configuration options for the underlying System.IO.FileStream.

System.IO.StreamReader.Close

Closes the System.IO.StreamReader object and the underlying stream, and releases any system resources associated with the reader.

System.IO.StreamReader.DiscardBufferedData

Clears the internal buffer.

System.IO.StreamReader.Dispose()

Closes the underlying stream, releases the unmanaged resources used by the System.IO.StreamReader, and optionally releases the managed resources.

Parameters

NameDescriptionDefault
disposing true to release both managed and unmanaged resources; false to release only unmanaged resources.

System.IO.StreamReader.Peek

Returns the next available character but does not consume it.

Returns

An integer representing the next character to be read, or -1 if there are no characters to be read or if the stream does not support seeking.

System.IO.StreamReader.Read

Reads the next character from the input stream and advances the character position by one character.

Returns

The next character from the input stream represented as an System.Int32 object, or -1 if no more characters are available.

System.IO.StreamReader.Read()

Reads a specified maximum of characters from the current stream into a buffer, beginning at the specified index.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.
index The index of buffer at which to begin writing.
count The maximum number of characters to read.

Returns

The number of characters that have been read, or 0 if at the end of the stream and no data was read. The number will be less than or equal to the count parameter, depending on whether the data is available within the stream.

System.IO.StreamReader.Read()

Reads the characters from the current stream into a span.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified span of characters replaced by the characters read from the current source.

Returns

The number of characters that have been read, or 0 if at the end of the stream and no data was read. The number will be less than or equal to the buffer length, depending on whether the data is available within the stream.

System.IO.StreamReader.ReadAsync()

Reads a specified maximum number of characters from the current stream asynchronously and writes the data to a buffer, beginning at the specified index.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.
index The position in buffer at which to begin writing.
count The maximum number of characters to read. If the end of the stream is reached before the specified number of characters is written into the buffer, the current method returns.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of characters read into the buffer. The result value can be less than the number of characters requested if the number of characters currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

System.IO.StreamReader.ReadAsync()

Asynchronously reads the characters from the current stream into a memory block.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified memory block of characters replaced by the characters read from the current source.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A value task that represents the asynchronous read operation. The value of the type parameter of the value task contains the number of characters that have been read, or 0 if at the end of the stream and no data was read. The number will be less than or equal to the buffer length, depending on whether the data is available within the stream.

System.IO.StreamReader.ReadBlock()

Reads a specified maximum number of characters from the current stream and writes the data to a buffer, beginning at the specified index.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.
index The position in buffer at which to begin writing.
count The maximum number of characters to read.

Returns

The number of characters that have been read. The number will be less than or equal to count, depending on whether all input characters have been read.

System.IO.StreamReader.ReadBlock()

Reads the characters from the current stream and writes the data to a buffer.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified span of characters replaced by the characters read from the current source.

Returns

The number of characters that have been read. The number will be less than or equal to the buffer length, depending on whether all input characters have been read.

System.IO.StreamReader.ReadBlockAsync()

Reads a specified maximum number of characters from the current stream asynchronously and writes the data to a buffer, beginning at the specified index.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.
index The position in buffer at which to begin writing.
count The maximum number of characters to read. If the end of the stream is reached before the specified number of characters is written into the buffer, the method returns.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of characters read into the buffer. The result value can be less than the number of characters requested if the number of characters currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

System.IO.StreamReader.ReadBlockAsync()

Asynchronously reads the characters from the current stream and writes the data to a buffer.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified memory block of characters replaced by the characters read from the current source.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A value task that represents the asynchronous read operation. The value of the type parameter of the value task contains the total number of characters read into the buffer. The result value can be less than the number of characters requested if the number of characters currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

System.IO.StreamReader.ReadLine

Reads a line of characters from the current stream and returns the data as a string.

Returns

The next line from the input stream, or null if the end of the input stream is reached.

System.IO.StreamReader.ReadLineAsync

Reads a line of characters asynchronously from the current stream and returns the data as a string.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the next line from the stream, or is null if all the characters have been read.

System.IO.StreamReader.ReadLineAsync()

Reads a line of characters asynchronously from the current stream and returns the data as a string.

Parameters

NameDescriptionDefault
cancellationToken The token to monitor for cancellation requests.

Returns

A value task that represents the asynchronous read operation. The value of the TResult parameter contains the next line from the stream, or is null if all of the characters have been read.

System.IO.StreamReader.ReadToEnd

Reads all characters from the current position to the end of the stream.

Returns

The rest of the stream as a string, from the current position to the end. If the current position is at the end of the stream, returns an empty string ("").

System.IO.StreamReader.ReadToEndAsync

Reads all characters from the current position to the end of the stream asynchronously and returns them as one string.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains a string with the characters from the current position to the end of the stream.

System.IO.StreamReader.ReadToEndAsync()

Reads all characters from the current position to the end of the stream asynchronously and returns them as one string.

Parameters

NameDescriptionDefault
cancellationToken The token to monitor for cancellation requests.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains a string with the characters from the current position to the end of the stream.

System.IO.StreamReader.BaseStream

Returns the underlying stream.

Returns

The underlying stream.

System.IO.StreamReader.CurrentEncoding

Gets the current character encoding that the current System.IO.StreamReader object is using.

Returns

The current character encoding used by the current reader. The value can be different after the first call to any System.IO.StreamReader.Read method of System.IO.StreamReader, since encoding autodetection is not done until the first call to a System.IO.StreamReader.Read method.

System.IO.StreamReader.EndOfStream

Gets a value that indicates whether the current stream position is at the end of the stream.

Returns

true if the current stream position is at the end of the stream; otherwise false.

System.IO.StreamWriter

Implements a System.IO.TextWriter for writing characters to a stream in a particular encoding.

System.IO.StreamWriter.Null

Provides a StreamWriter with no backing store that can be written to, but not read from.

System.IO.StreamWriter.#ctor()

Initializes a new instance of the System.IO.StreamWriter class for the specified stream by using UTF-8 encoding and the default buffer size.

Parameters

NameDescriptionDefault
stream The stream to write to.

System.IO.StreamWriter.#ctor()

Initializes a new instance of the System.IO.StreamWriter class for the specified stream by using the specified encoding and the default buffer size.

Parameters

NameDescriptionDefault
stream The stream to write to.
encoding The character encoding to use.

System.IO.StreamWriter.#ctor()

Initializes a new instance of the System.IO.StreamWriter class for the specified stream by using the specified encoding and buffer size.

Parameters

NameDescriptionDefault
stream The stream to write to.
encoding The character encoding to use.
bufferSize The buffer size, in bytes.

System.IO.StreamWriter.#ctor()

Initializes a new instance of the System.IO.StreamWriter class for the specified stream by using the specified encoding and buffer size, and optionally leaves the stream open.

Parameters

NameDescriptionDefault
stream The stream to write to.
encoding The character encoding to use.
bufferSize The buffer size, in bytes.
leaveOpen true to leave the stream open after the System.IO.StreamWriter object is disposed; otherwise, false.

System.IO.StreamWriter.#ctor()

Initializes a new instance of the System.IO.StreamWriter class for the specified file by using the default encoding and buffer size.

Parameters

NameDescriptionDefault
path The complete file path to write to. path can be a file name.

System.IO.StreamWriter.#ctor()

Initializes a new instance of the System.IO.StreamWriter class for the specified file by using the default encoding and buffer size. If the file exists, it can be either overwritten or appended to. If the file does not exist, this constructor creates a new file.

Parameters

NameDescriptionDefault
path The complete file path to write to.
append true to append data to the file; false to overwrite the file. If the specified file does not exist, this parameter has no effect, and the constructor creates a new file.

System.IO.StreamWriter.#ctor()

Initializes a new instance of the System.IO.StreamWriter class for the specified file by using the specified encoding and default buffer size. If the file exists, it can be either overwritten or appended to. If the file does not exist, this constructor creates a new file.

Parameters

NameDescriptionDefault
path The complete file path to write to.
append true to append data to the file; false to overwrite the file. If the specified file does not exist, this parameter has no effect, and the constructor creates a new file.
encoding The character encoding to use.

System.IO.StreamWriter.#ctor()

Initializes a new instance of the System.IO.StreamWriter class for the specified file on the specified path, using the specified encoding and buffer size. If the file exists, it can be either overwritten or appended to. If the file does not exist, this constructor creates a new file.

Parameters

NameDescriptionDefault
path The complete file path to write to.
append true to append data to the file; false to overwrite the file. If the specified file does not exist, this parameter has no effect, and the constructor creates a new file.
encoding The character encoding to use.
bufferSize The buffer size, in bytes.

System.IO.StreamWriter.#ctor()

Initializes a new instance of the System.IO.StreamWriter class for the specified file, using the default encoding, and configured with the specified System.IO.FileStreamOptions object.

Parameters

NameDescriptionDefault
path The complete file path to write to.
options An object that specifies the configuration options for the underlying System.IO.FileStream.

System.IO.StreamWriter.#ctor()

Initializes a new instance of the System.IO.StreamWriter class for the specified file, using the specified encoding, and configured with the specified System.IO.FileStreamOptions object.

Parameters

NameDescriptionDefault
path The complete file path to write to.
encoding The character encoding to use.
options An object that specifies the configuration options for the underlying System.IO.FileStream.

System.IO.StreamWriter.Close

Closes the current StreamWriter object and the underlying stream.

System.IO.StreamWriter.Dispose()

Causes any buffered data to be written to the underlying stream, releases the unmanaged resources used by the System.IO.StreamWriter, and optionally the managed resources.

Parameters

NameDescriptionDefault
disposing true to release both managed and unmanaged resources; false to release only unmanaged resources.

System.IO.StreamWriter.DisposeAsync

Asynchronously writes any buffered data to the underlying stream and releases the unmanaged resources used by the System.IO.StreamWriter.

Returns

A task that represents the asynchronous dispose operation.

System.IO.StreamWriter.Flush

Clears all buffers for the current writer and causes any buffered data to be written to the underlying stream.

System.IO.StreamWriter.FlushAsync

Clears all buffers for this stream asynchronously and causes any buffered data to be written to the underlying device.

Returns

A task that represents the asynchronous flush operation.

System.IO.StreamWriter.FlushAsync()

Clears all buffers for this stream asynchronously and causes any buffered data to be written to the underlying device.

Parameters

NameDescriptionDefault
cancellationToken The System.Threading.CancellationToken to monitor for cancellation requests.

Returns

A System.Threading.Tasks.Task that represents the asynchronous flush operation.

System.IO.StreamWriter.Write()

Writes a character to the stream.

Parameters

NameDescriptionDefault
value The character to write to the stream.

System.IO.StreamWriter.Write()

Writes a character array to the stream.

Parameters

NameDescriptionDefault
buffer A character array containing the data to write. If buffer is null, nothing is written.

System.IO.StreamWriter.Write()

Writes a subarray of characters to the stream.

Parameters

NameDescriptionDefault
buffer A character array that contains the data to write.
index The character position in the buffer at which to start reading data.
count The maximum number of characters to write.

System.IO.StreamWriter.Write()

Writes a character span to the stream.

Parameters

NameDescriptionDefault
buffer The character span to write.

System.IO.StreamWriter.Write()

Writes a string to the stream.

Parameters

NameDescriptionDefault
value The string to write to the stream. If value is null, nothing is written.

System.IO.StreamWriter.Write()

Writes a formatted string to the stream, using the same semantics as the System.String.Format() method.

Parameters

NameDescriptionDefault
format A composite format string.
arg0 The object to format and write.

System.IO.StreamWriter.Write()

Writes a formatted string to the stream using the same semantics as the System.String.Format() method.

Parameters

NameDescriptionDefault
format A composite format string.
arg0 The first object to format and write.
arg1 The second object to format and write.

System.IO.StreamWriter.Write()

Writes a formatted string to the stream, using the same semantics as the System.String.Format() method.

Parameters

NameDescriptionDefault
format A composite format string.
arg0 The first object to format and write.
arg1 The second object to format and write.
arg2 The third object to format and write.

System.IO.StreamWriter.Write()

Writes a formatted string to the stream, using the same semantics as the System.String.Format() method.

Parameters

NameDescriptionDefault
format A composite format string.
arg An object array that contains zero or more objects to format and write.

System.IO.StreamWriter.WriteAsync()

Asynchronously writes a character to the stream.

Parameters

NameDescriptionDefault
value The character to write to the stream.

Returns

A task that represents the asynchronous write operation.

System.IO.StreamWriter.WriteAsync()

Asynchronously writes a subarray of characters to the stream.

Parameters

NameDescriptionDefault
buffer A character array that contains the data to write.
index The character position in the buffer at which to begin reading data.
count The maximum number of characters to write.

Returns

A task that represents the asynchronous write operation.

System.IO.StreamWriter.WriteAsync()

Asynchronously writes a character memory region to the stream.

Parameters

NameDescriptionDefault
buffer The character memory region to write to the stream.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.StreamWriter.WriteAsync()

Asynchronously writes a string to the stream.

Parameters

NameDescriptionDefault
value The string to write to the stream. If value is null, nothing is written.

Returns

A task that represents the asynchronous write operation.

System.IO.StreamWriter.WriteLine()

Writes the text representation of a character span to the stream, followed by a line terminator.

Parameters

NameDescriptionDefault
buffer The character span to write to the stream.

System.IO.StreamWriter.WriteLine()

Writes a string to the stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The string to write. If value is null, only the line terminator is written.

System.IO.StreamWriter.WriteLine()

Writes a formatted string and a new line to the stream, using the same semantics as the System.String.Format() method.

Parameters

NameDescriptionDefault
format A composite format string.
arg0 The object to format and write.

System.IO.StreamWriter.WriteLine()

Writes a formatted string and a new line to the stream, using the same semantics as the System.String.Format() method.

Parameters

NameDescriptionDefault
format A composite format string.
arg0 The first object to format and write.
arg1 The second object to format and write.

System.IO.StreamWriter.WriteLine()

Writes out a formatted string and a new line to the stream, using the same semantics as System.String.Format().

Parameters

NameDescriptionDefault
format A composite format string.
arg0 The first object to format and write.
arg1 The second object to format and write.
arg2 The third object to format and write.

System.IO.StreamWriter.WriteLine()

Writes out a formatted string and a new line to the stream, using the same semantics as System.String.Format().

Parameters

NameDescriptionDefault
format A composite format string.
arg An object array that contains zero or more objects to format and write.

System.IO.StreamWriter.WriteLineAsync

Asynchronously writes a line terminator to the stream.

Returns

A task that represents the asynchronous write operation.

System.IO.StreamWriter.WriteLineAsync()

Asynchronously writes a character to the stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The character to write to the stream.

Returns

A task that represents the asynchronous write operation.

System.IO.StreamWriter.WriteLineAsync()

Asynchronously writes a subarray of characters to the stream, followed by a line terminator.

Parameters

NameDescriptionDefault
buffer The character array to write data from.
index The character position in the buffer at which to start reading data.
count The maximum number of characters to write.

Returns

A task that represents the asynchronous write operation.

System.IO.StreamWriter.WriteLineAsync()

Asynchronously writes the text representation of a character memory region to the stream, followed by a line terminator.

Parameters

NameDescriptionDefault
buffer The character memory region to write to the stream.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.StreamWriter.WriteLineAsync()

Asynchronously writes a string to the stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The string to write. If the value is null, only a line terminator is written.

Returns

A task that represents the asynchronous write operation.

System.IO.StreamWriter.AutoFlush

Gets or sets a value indicating whether the System.IO.StreamWriter will flush its buffer to the underlying stream after every call to System.IO.StreamWriter.Write().

Returns

true to force System.IO.StreamWriter to flush its buffer; otherwise, false.

System.IO.StreamWriter.BaseStream

Gets the underlying stream that interfaces with a backing store.

Returns

The stream this StreamWriter is writing to.

System.IO.StreamWriter.Encoding

Gets the System.Text.Encoding in which the output is written.

Returns

The System.Text.Encoding specified in the constructor for the current instance, or System.Text.UTF8Encoding if an encoding was not specified.

System.IO.StringReader

Implements a System.IO.TextReader that reads from a string.

System.IO.StringReader.#ctor()

Initializes a new instance of the System.IO.StringReader class that reads from the specified string.

Parameters

NameDescriptionDefault
s The string to which the System.IO.StringReader should be initialized.

System.IO.StringReader.Close

System.IO.StringReader.Dispose()

Releases the unmanaged resources used by the System.IO.StringReader and optionally releases the managed resources.

Parameters

NameDescriptionDefault
disposing true to release both managed and unmanaged resources; false to release only unmanaged resources.

System.IO.StringReader.Peek

Returns the next available character but does not consume it.

Returns

An integer representing the next character to be read, or -1 if no more characters are available or the stream does not support seeking.

System.IO.StringReader.Read

Reads the next character from the input string and advances the character position by one character.

Returns

The next character from the underlying string, or -1 if no more characters are available.

System.IO.StringReader.Read()

Reads a block of characters from the input string and advances the character position by count.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.
index The starting index in the buffer.
count The number of characters to read.

Returns

The total number of characters read into the buffer. This can be less than the number of characters requested if that many characters are not currently available, or zero if the end of the underlying string has been reached.

System.IO.StringReader.Read()

Reads all the characters from the input string, starting at the current position, and advances the current position to the end of the input string.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the characters read from the current source. If the total number of characters read is zero, the span remains unmodified.

Returns

The total number of characters read into the buffer.

System.IO.StringReader.ReadAsync()

Reads a specified maximum number of characters from the current string asynchronously and writes the data to a buffer, beginning at the specified index.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.
index The position in buffer at which to begin writing.
count The maximum number of characters to read. If the end of the string is reached before the specified number of characters is written into the buffer, the method returns.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the string has been reached.

System.IO.StringReader.ReadAsync()

Asynchronously reads all the characters from the input string, starting at the current position, and advances the current position to the end of the input string.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the characters read from the current source.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of characters read into the buffer.

System.IO.StringReader.ReadBlock()

Reads all the characters from the input string starting at the current position and advances the current position to the end of the input string.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the characters read from the current source. If the total number of characters read is zero, the span remains unmodified.

Returns

The total number of characters read into the buffer.

System.IO.StringReader.ReadBlockAsync()

Reads a specified maximum number of characters from the current string asynchronously and writes the data to a buffer, beginning at the specified index.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.
index The position in buffer at which to begin writing.
count The maximum number of characters to read. If the end of the string is reached before the specified number of characters is written into the buffer, the method returns.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the string has been reached.

System.IO.StringReader.ReadBlockAsync()

Asynchronously reads all the characters from the input string starting at the current position and advances the current position to the end of the input string.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the characters read from the current source. If the total number of characters read is zero, the span remains unmodified.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task representing the asynchronous read operation. The value of the TResult parameter contains the total number of characters read into the buffer.

System.IO.StringReader.ReadLine

Reads a line of characters from the current string and returns the data as a string.

Returns

The next line from the current string, or null if the end of the string is reached.

System.IO.StringReader.ReadLineAsync

Reads a line of characters asynchronously from the current string and returns the data as a string.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the next line from the string reader, or is null if all the characters have been read.

System.IO.StringReader.ReadLineAsync()

Reads a line of characters asynchronously from the current string and returns the data as a string.

Parameters

NameDescriptionDefault
cancellationToken The token to monitor for cancellation requests.

Returns

A value task that represents the asynchronous read operation. The value of the TResult parameter contains the next line from the string reader, or is null if all of the characters have been read.

System.IO.StringReader.ReadToEnd

Reads all characters from the current position to the end of the string and returns them as a single string.

Returns

The content from the current position to the end of the underlying string.

System.IO.StringReader.ReadToEndAsync

Reads all characters from the current position to the end of the string asynchronously and returns them as a single string.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains a string with the characters from the current position to the end of the string.

System.IO.StringReader.ReadToEndAsync()

Reads all characters from the current position to the end of the string asynchronously and returns them as a single string.

Parameters

NameDescriptionDefault
cancellationToken The token to monitor for cancellation requests.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains a string with the characters from the current position to the end of the string.

System.IO.StringWriter

Implements a System.IO.TextWriter for writing information to a string. The information is stored in an underlying System.Text.StringBuilder.

System.IO.StringWriter.#ctor

Initializes a new instance of the System.IO.StringWriter class.

System.IO.StringWriter.#ctor()

Initializes a new instance of the System.IO.StringWriter class with the specified format control.

Parameters

NameDescriptionDefault
formatProvider An System.IFormatProvider object that controls formatting.

System.IO.StringWriter.#ctor()

Initializes a new instance of the System.IO.StringWriter class that writes to the specified System.Text.StringBuilder.

Parameters

NameDescriptionDefault
sb The System.Text.StringBuilder object to write to.

System.IO.StringWriter.#ctor()

Initializes a new instance of the System.IO.StringWriter class that writes to the specified System.Text.StringBuilder and has the specified format provider.

Parameters

NameDescriptionDefault
sb The System.Text.StringBuilder object to write to.
formatProvider An System.IFormatProvider object that controls formatting.

System.IO.StringWriter.Close

Closes the current System.IO.StringWriter and the underlying stream.

System.IO.StringWriter.Dispose()

Releases the unmanaged resources used by the System.IO.StringWriter and optionally releases the managed resources.

Parameters

NameDescriptionDefault
disposing true to release both managed and unmanaged resources; false to release only unmanaged resources.

System.IO.StringWriter.FlushAsync

Asynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device.

Returns

A task that represents the asynchronous flush operation.

System.IO.StringWriter.GetStringBuilder

Returns the underlying System.Text.StringBuilder.

Returns

The underlying StringBuilder.

System.IO.StringWriter.ToString

Returns a string containing the characters written to the current StringWriter so far.

Returns

The string containing the characters written to the current StringWriter.

System.IO.StringWriter.Write()

Writes a character to the string.

Parameters

NameDescriptionDefault
value The character to write.

System.IO.StringWriter.Write()

Writes a subarray of characters to the string.

Parameters

NameDescriptionDefault
buffer The character array to write data from.
index The position in the buffer at which to start reading data.
count The maximum number of characters to write.

System.IO.StringWriter.Write()

Writes the string representation of a span of chars to the current string.

Parameters

NameDescriptionDefault
buffer A span of chars to write to the string.

System.IO.StringWriter.Write()

Writes a string to the current string.

Parameters

NameDescriptionDefault
value The string to write.

System.IO.StringWriter.Write()

Writes the string representation of a string builder to the current string.

Parameters

NameDescriptionDefault
value The string builder to write to the string.

System.IO.StringWriter.WriteAsync()

Writes a character to the string asynchronously.

Parameters

NameDescriptionDefault
value The character to write to the string.

Returns

A task that represents the asynchronous write operation.

System.IO.StringWriter.WriteAsync()

Writes a subarray of characters to the string asynchronously.

Parameters

NameDescriptionDefault
buffer The character array to write data from.
index The position in the buffer at which to start reading data.
count The maximum number of characters to write.

Returns

A task that represents the asynchronous write operation.

System.IO.StringWriter.WriteAsync()

Asynchronously writes a memory region of characters to the string.

Parameters

NameDescriptionDefault
buffer The character memory region to write to the string.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.StringWriter.WriteAsync()

Writes a string to the current string asynchronously.

Parameters

NameDescriptionDefault
value The string to write. If value is null, nothing is written to the text stream.

Returns

A task that represents the asynchronous write operation.

System.IO.StringWriter.WriteAsync()

Asynchronously writes the text representation of a string builder to the string.

Parameters

NameDescriptionDefault
value The string builder to write to the string.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.StringWriter.WriteLine()

Writes the text representation a span of characters to the string, followed by a line terminator.

Parameters

NameDescriptionDefault
buffer The span of characters to write to the string.

System.IO.StringWriter.WriteLine()

Writes the text representation of a string builder to the string, followed by a line terminator.

Parameters

NameDescriptionDefault
value The string, as a string builder, to write to the string.

System.IO.StringWriter.WriteLineAsync()

Asynchronously writes a character to the string, followed by a line terminator.

Parameters

NameDescriptionDefault
value The character to write to the string.

Returns

A task that represents the asynchronous write operation.

System.IO.StringWriter.WriteLineAsync()

asynchronously writes a subarray of characters to the string, followed by a line terminator.

Parameters

NameDescriptionDefault
buffer The character array to write data from.
index The position in the buffer at which to start reading data.
count The maximum number of characters to write.

Returns

A task that represents the asynchronous write operation.

System.IO.StringWriter.WriteLineAsync()

Asynchronously writes the string representation of the memory region of characters to the current string, followed by a line terminator.

Parameters

NameDescriptionDefault
buffer A memory region of characters to write to the string.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.StringWriter.WriteLineAsync()

Asynchronously writes a string to the current string, followed by a line terminator.

Parameters

NameDescriptionDefault
value The string to write. If the value is null, only a line terminator is written.

Returns

A task that represents the asynchronous write operation.

System.IO.StringWriter.WriteLineAsync()

Asynchronously writes the string representation of the string builder to the current string, followed by a line terminator.

Parameters

NameDescriptionDefault
value The string builder to write to the string.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.StringWriter.Encoding

Gets the System.Text.Encoding in which the output is written.

Returns

The Encoding in which the output is written.

System.IO.TextReader

Represents a reader that can read a sequential series of characters.

System.IO.TextReader.Null

Provides a TextReader with no data to read from.

System.IO.TextReader.#ctor

Initializes a new instance of the System.IO.TextReader class.

System.IO.TextReader.Close

Closes the System.IO.TextReader and releases any system resources associated with the TextReader.

System.IO.TextReader.Dispose

Releases all resources used by the System.IO.TextReader object.

System.IO.TextReader.Dispose()

Releases the unmanaged resources used by the System.IO.TextReader and optionally releases the managed resources.

Parameters

NameDescriptionDefault
disposing true to release both managed and unmanaged resources; false to release only unmanaged resources.

System.IO.TextReader.Peek

Reads the next character without changing the state of the reader or the character source. Returns the next available character without actually reading it from the reader.

Returns

An integer representing the next character to be read, or -1 if no more characters are available or the reader does not support seeking.

System.IO.TextReader.Read

Reads the next character from the text reader and advances the character position by one character.

Returns

The next character from the text reader, or -1 if no more characters are available. The default implementation returns -1.

System.IO.TextReader.Read()

Reads a specified maximum number of characters from the current reader and writes the data to a buffer, beginning at the specified index.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.
index The position in buffer at which to begin writing.
count The maximum number of characters to read. If the end of the reader is reached before the specified number of characters is read into the buffer, the method returns.

Returns

The number of characters that have been read. The number will be less than or equal to count, depending on whether the data is available within the reader. This method returns 0 (zero) if it is called when no more characters are left to read.

System.IO.TextReader.Read()

Reads the characters from the current reader and writes the data to the specified buffer.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified span of characters replaced by the characters read from the current source.

Returns

The number of characters that have been read. The number will be less than or equal to the buffer length, depending on whether the data is available within the reader. This method returns 0 (zero) if it is called when no more characters are left to read.

System.IO.TextReader.ReadAsync()

Reads a specified maximum number of characters from the current text reader asynchronously and writes the data to a buffer, beginning at the specified index.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.
index The position in buffer at which to begin writing.
count The maximum number of characters to read. If the end of the text is reached before the specified number of characters is read into the buffer, the current method returns.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the text has been reached.

System.IO.TextReader.ReadAsync()

Asynchronously reads the characters from the current stream into a memory block.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified memory block of characters replaced by the characters read from the current source.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A value task that represents the asynchronous read operation. The value of the type parameter contains the number of characters that have been read, or 0 if at the end of the stream and no data was read. The number will be less than or equal to the buffer length, depending on whether the data is available within the stream.

System.IO.TextReader.ReadBlock()

Reads a specified maximum number of characters from the current text reader and writes the data to a buffer, beginning at the specified index.

Parameters

NameDescriptionDefault
buffer When this method returns, this parameter contains the specified character array with the values between index and (index + count -1) replaced by the characters read from the current source.
index The position in buffer at which to begin writing.
count The maximum number of characters to read.

Returns

The number of characters that have been read. The number will be less than or equal to count, depending on whether all input characters have been read.

System.IO.TextReader.ReadBlock()

Reads the characters from the current stream and writes the data to a buffer.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified span of characters replaced by the characters read from the current source.

Returns

The number of characters that have been read. The number will be less than or equal to the buffer length, depending on whether all input characters have been read.

System.IO.TextReader.ReadBlockAsync()

Reads a specified maximum number of characters from the current text reader asynchronously and writes the data to a buffer, beginning at the specified index.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.
index The position in buffer at which to begin writing.
count The maximum number of characters to read. If the end of the text is reached before the specified number of characters is read into the buffer, the current method returns.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the text has been reached.

System.IO.TextReader.ReadBlockAsync()

Asynchronously reads the characters from the current stream and writes the data to a buffer.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified memory block of characters replaced by the characters read from the current source.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A value task that represents the asynchronous read operation. The value of the type parameter contains the total number of characters read into the buffer. The result value can be less than the number of characters requested if the number of characters currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

System.IO.TextReader.ReadLine

Reads a line of characters from the text reader and returns the data as a string.

Returns

The next line from the reader, or null if all characters have been read.

System.IO.TextReader.ReadLineAsync

Reads a line of characters asynchronously and returns the data as a string.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the next line from the text reader, or is null if all of the characters have been read.

System.IO.TextReader.ReadLineAsync()

Reads a line of characters asynchronously and returns the data as a string.

Parameters

NameDescriptionDefault
cancellationToken The token to monitor for cancellation requests.

Returns

A value task that represents the asynchronous read operation. The value of the TResult parameter contains the next line from the text reader, or is null if all of the characters have been read.

System.IO.TextReader.ReadToEnd

Reads all characters from the current position to the end of the text reader and returns them as one string.

Returns

A string that contains all characters from the current position to the end of the text reader.

System.IO.TextReader.ReadToEndAsync

Reads all characters from the current position to the end of the text reader asynchronously and returns them as one string.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains a string with the characters from the current position to the end of the text reader.

System.IO.TextReader.ReadToEndAsync()

Reads all characters from the current position to the end of the text reader asynchronously and returns them as one string.

Parameters

NameDescriptionDefault
cancellationToken The token to monitor for cancellation requests.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains a string with the characters from the current position to the end of the text reader.

System.IO.TextReader.Synchronized()

Creates a thread-safe wrapper around the specified TextReader.

Parameters

NameDescriptionDefault
reader The TextReader to synchronize.

Returns

A thread-safe System.IO.TextReader.

System.IO.TextWriter

Represents a writer that can write a sequential series of characters. This class is abstract.

System.IO.TextWriter.CoreNewLine

Stores the newline characters used for this TextWriter.

System.IO.TextWriter.Null

Provides a TextWriter with no backing store that can be written to, but not read from.

System.IO.TextWriter.#ctor

Initializes a new instance of the System.IO.TextWriter class.

System.IO.TextWriter.#ctor()

Initializes a new instance of the System.IO.TextWriter class with the specified format provider.

Parameters

NameDescriptionDefault
formatProvider An System.IFormatProvider object that controls formatting.

System.IO.TextWriter.Close

Closes the current writer and releases any system resources associated with the writer.

System.IO.TextWriter.Dispose

Releases all resources used by the System.IO.TextWriter object.

System.IO.TextWriter.Dispose()

Releases the unmanaged resources used by the System.IO.TextWriter and optionally releases the managed resources.

Parameters

NameDescriptionDefault
disposing true to release both managed and unmanaged resources; false to release only unmanaged resources.

System.IO.TextWriter.DisposeAsync

Asynchronously releases all resources used by the System.IO.TextWriter object.

Returns

A task that represents the asynchronous dispose operation.

System.IO.TextWriter.Flush

Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.

System.IO.TextWriter.FlushAsync

Asynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device.

Returns

A task that represents the asynchronous flush operation.

System.IO.TextWriter.FlushAsync()

Asynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device.

Parameters

NameDescriptionDefault
cancellationToken The System.Threading.CancellationToken to monitor for cancellation requests.

Returns

A System.Threading.Tasks.Task that represents the asynchronous flush operation.

System.IO.TextWriter.Synchronized()

Creates a thread-safe wrapper around the specified TextWriter.

Parameters

NameDescriptionDefault
writer The TextWriter to synchronize.

Returns

A thread-safe wrapper.

System.IO.TextWriter.Write()

Writes the text representation of a Boolean value to the text stream.

Parameters

NameDescriptionDefault
value The Boolean value to write.

System.IO.TextWriter.Write()

Writes a character to the text stream.

Parameters

NameDescriptionDefault
value The character to write to the text stream.

System.IO.TextWriter.Write()

Writes a character array to the text stream.

Parameters

NameDescriptionDefault
buffer The character array to write to the text stream.

System.IO.TextWriter.Write()

Writes a subarray of characters to the text stream.

Parameters

NameDescriptionDefault
buffer The character array to write data from.
index The character position in the buffer at which to start retrieving data.
count The number of characters to write.

System.IO.TextWriter.Write()

Writes the text representation of a decimal value to the text stream.

Parameters

NameDescriptionDefault
value The decimal value to write.

System.IO.TextWriter.Write()

Writes the text representation of an 8-byte floating-point value to the text stream.

Parameters

NameDescriptionDefault
value The 8-byte floating-point value to write.

System.IO.TextWriter.Write()

Writes the text representation of a 4-byte signed integer to the text stream.

Parameters

NameDescriptionDefault
value The 4-byte signed integer to write.

System.IO.TextWriter.Write()

Writes the text representation of an 8-byte signed integer to the text stream.

Parameters

NameDescriptionDefault
value The 8-byte signed integer to write.

System.IO.TextWriter.Write()

Writes the text representation of an object to the text stream by calling the ToString method on that object.

Parameters

NameDescriptionDefault
value The object to write.

System.IO.TextWriter.Write()

Writes a character span to the text stream.

Parameters

NameDescriptionDefault
buffer The character span to write.

System.IO.TextWriter.Write()

Writes the text representation of a 4-byte floating-point value to the text stream.

Parameters

NameDescriptionDefault
value The 4-byte floating-point value to write.

System.IO.TextWriter.Write()

Writes a string to the text stream.

Parameters

NameDescriptionDefault
value The string to write.

System.IO.TextWriter.Write()

Writes a formatted string to the text stream, using the same semantics as the System.String.Format() method.

Parameters

NameDescriptionDefault
format A composite format string.
arg0 The object to format and write.

System.IO.TextWriter.Write()

Writes a formatted string to the text stream using the same semantics as the System.String.Format() method.

Parameters

NameDescriptionDefault
format A composite format string.
arg0 The first object to format and write.
arg1 The second object to format and write.

System.IO.TextWriter.Write()

Writes a formatted string to the text stream, using the same semantics as the System.String.Format() method.

Parameters

NameDescriptionDefault
format A composite format string.
arg0 The first object to format and write.
arg1 The second object to format and write.
arg2 The third object to format and write.

System.IO.TextWriter.Write()

Writes a formatted string to the text stream, using the same semantics as the System.String.Format() method.

Parameters

NameDescriptionDefault
format A composite format string.
arg An object array that contains zero or more objects to format and write.

System.IO.TextWriter.Write()

Writes a string builder to the text stream.

Parameters

NameDescriptionDefault
value The string, as a string builder, to write to the text stream.

System.IO.TextWriter.Write()

Writes the text representation of a 4-byte unsigned integer to the text stream.

Parameters

NameDescriptionDefault
value The 4-byte unsigned integer to write.

System.IO.TextWriter.Write()

Writes the text representation of an 8-byte unsigned integer to the text stream.

Parameters

NameDescriptionDefault
value The 8-byte unsigned integer to write.

System.IO.TextWriter.WriteAsync()

Writes a character to the text stream asynchronously.

Parameters

NameDescriptionDefault
value The character to write to the text stream.

Returns

A task that represents the asynchronous write operation.

System.IO.TextWriter.WriteAsync()

Writes a character array to the text stream asynchronously.

Parameters

NameDescriptionDefault
buffer The character array to write to the text stream. If buffer is null, nothing is written.

Returns

A task that represents the asynchronous write operation.

System.IO.TextWriter.WriteAsync()

Writes a subarray of characters to the text stream asynchronously.

Parameters

NameDescriptionDefault
buffer The character array to write data from.
index The character position in the buffer at which to start retrieving data.
count The number of characters to write.

Returns

A task that represents the asynchronous write operation.

System.IO.TextWriter.WriteAsync()

Asynchronously writes a character memory region to the text stream.

Parameters

NameDescriptionDefault
buffer The character memory region to write to the text stream.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.TextWriter.WriteAsync()

Writes a string to the text stream asynchronously.

Parameters

NameDescriptionDefault
value The string to write. If value is null, nothing is written to the text stream.

Returns

A task that represents the asynchronous write operation.

System.IO.TextWriter.WriteAsync()

Asynchronously writes a string builder to the text stream.

Parameters

NameDescriptionDefault
value The string, as a string builder, to write to the text stream.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.TextWriter.WriteLine

Writes a line terminator to the text stream.

System.IO.TextWriter.WriteLine()

Writes the text representation of a Boolean value to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The Boolean value to write.

System.IO.TextWriter.WriteLine()

Writes a character to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The character to write to the text stream.

System.IO.TextWriter.WriteLine()

Writes an array of characters to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
buffer The character array from which data is read.

System.IO.TextWriter.WriteLine()

Writes a subarray of characters to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
buffer The character array from which data is read.
index The character position in buffer at which to start reading data.
count The maximum number of characters to write.

System.IO.TextWriter.WriteLine()

Writes the text representation of a decimal value to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The decimal value to write.

System.IO.TextWriter.WriteLine()

Writes the text representation of a 8-byte floating-point value to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The 8-byte floating-point value to write.

System.IO.TextWriter.WriteLine()

Writes the text representation of a 4-byte signed integer to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The 4-byte signed integer to write.

System.IO.TextWriter.WriteLine()

Writes the text representation of an 8-byte signed integer to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The 8-byte signed integer to write.

System.IO.TextWriter.WriteLine()

Writes the text representation of an object to the text stream, by calling the ToString method on that object, followed by a line terminator.

Parameters

NameDescriptionDefault
value The object to write. If value is null, only the line terminator is written.

System.IO.TextWriter.WriteLine()

Writes the text representation of a character span to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
buffer The char span value to write to the text stream.

System.IO.TextWriter.WriteLine()

Writes the text representation of a 4-byte floating-point value to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The 4-byte floating-point value to write.

System.IO.TextWriter.WriteLine()

Writes a string to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The string to write. If value is null, only the line terminator is written.

System.IO.TextWriter.WriteLine()

Writes a formatted string and a new line to the text stream, using the same semantics as the System.String.Format() method.

Parameters

NameDescriptionDefault
format A composite format string.
arg0 The object to format and write.

System.IO.TextWriter.WriteLine()

Writes a formatted string and a new line to the text stream, using the same semantics as the System.String.Format() method.

Parameters

NameDescriptionDefault
format A composite format string.
arg0 The first object to format and write.
arg1 The second object to format and write.

System.IO.TextWriter.WriteLine()

Writes out a formatted string and a new line to the text stream, using the same semantics as System.String.Format().

Parameters

NameDescriptionDefault
format A composite format string.
arg0 The first object to format and write.
arg1 The second object to format and write.
arg2 The third object to format and write.

System.IO.TextWriter.WriteLine()

Writes out a formatted string and a new line to the text stream, using the same semantics as System.String.Format().

Parameters

NameDescriptionDefault
format A composite format string.
arg An object array that contains zero or more objects to format and write.

System.IO.TextWriter.WriteLine()

Writes the text representation of a string builder to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The string, as a string builder, to write to the text stream.

System.IO.TextWriter.WriteLine()

Writes the text representation of a 4-byte unsigned integer to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The 4-byte unsigned integer to write.

System.IO.TextWriter.WriteLine()

Writes the text representation of an 8-byte unsigned integer to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The 8-byte unsigned integer to write.

System.IO.TextWriter.WriteLineAsync

Asynchronously writes a line terminator to the text stream.

Returns

A task that represents the asynchronous write operation.

System.IO.TextWriter.WriteLineAsync()

Asynchronously writes a character to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The character to write to the text stream.

Returns

A task that represents the asynchronous write operation.

System.IO.TextWriter.WriteLineAsync()

Asynchronously writes an array of characters to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
buffer The character array to write to the text stream. If the character array is null, only the line terminator is written.

Returns

A task that represents the asynchronous write operation.

System.IO.TextWriter.WriteLineAsync()

Asynchronously writes a subarray of characters to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
buffer The character array to write data from.
index The character position in the buffer at which to start retrieving data.
count The number of characters to write.

Returns

A task that represents the asynchronous write operation.

System.IO.TextWriter.WriteLineAsync()

Asynchronously writes the text representation of a character memory region to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
buffer The character memory region to write to the text stream.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.TextWriter.WriteLineAsync()

Asynchronously writes a string to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The string to write. If the value is null, only a line terminator is written.

Returns

A task that represents the asynchronous write operation.

System.IO.TextWriter.WriteLineAsync()

Asynchronously writes the text representation of a string builder to the text stream, followed by a line terminator.

Parameters

NameDescriptionDefault
value The string, as a string builder, to write to the text stream.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.TextWriter.Encoding

When overridden in a derived class, returns the character encoding in which the output is written.

Returns

The character encoding in which the output is written.

System.IO.TextWriter.FormatProvider

Gets an object that controls formatting.

Returns

An System.IFormatProvider object for a specific culture, or the formatting of the current culture if no other culture is specified.

System.IO.TextWriter.NewLine

Gets or sets the line terminator string used by the current TextWriter.

Returns

The line terminator string for the current TextWriter.

System.IO.UnixFileMode

Represents the Unix filesystem permissions.

This enumeration supports a bitwise combination of its member values.

System.IO.UnixFileMode.GroupExecute

Execute permission for group.

System.IO.UnixFileMode.GroupRead

Read permission for group.

System.IO.UnixFileMode.GroupWrite

Write permission for group.

System.IO.UnixFileMode.None

No permissions.

System.IO.UnixFileMode.OtherExecute

Execute permission for others.

System.IO.UnixFileMode.OtherRead

Read permission for others.

System.IO.UnixFileMode.OtherWrite

Write permission for others.

System.IO.UnixFileMode.SetGroup

Set group permission.

System.IO.UnixFileMode.SetUser

Set user permission.

System.IO.UnixFileMode.StickyBit

Sticky bit permission.

System.IO.UnixFileMode.UserExecute

Execute permission for owner.

System.IO.UnixFileMode.UserRead

Read permission for owner.

System.IO.UnixFileMode.UserWrite

Write permission for owner.

System.IO.UnmanagedMemoryStream

Provides access to unmanaged blocks of memory from managed code.

System.IO.UnmanagedMemoryStream.#ctor

Initializes a new instance of the System.IO.UnmanagedMemoryStream class.

System.IO.UnmanagedMemoryStream.#ctor()

Initializes a new instance of the System.IO.UnmanagedMemoryStream class using the specified location and memory length.

Parameters

NameDescriptionDefault
pointer A pointer to an unmanaged memory location.
length The length of the memory to use.

System.IO.UnmanagedMemoryStream.#ctor()

Initializes a new instance of the System.IO.UnmanagedMemoryStream class using the specified location, memory length, total amount of memory, and file access values.

Parameters

NameDescriptionDefault
pointer A pointer to an unmanaged memory location.
length The length of the memory to use.
capacity The total amount of memory assigned to the stream.
access One of the System.IO.FileAccess values.

System.IO.UnmanagedMemoryStream.#ctor()

Initializes a new instance of the System.IO.UnmanagedMemoryStream class in a safe buffer with a specified offset and length.

Parameters

NameDescriptionDefault
buffer The buffer to contain the unmanaged memory stream.
offset The byte position in the buffer at which to start the unmanaged memory stream.
length The length of the unmanaged memory stream.

System.IO.UnmanagedMemoryStream.#ctor()

Initializes a new instance of the System.IO.UnmanagedMemoryStream class in a safe buffer with a specified offset, length, and file access.

Parameters

NameDescriptionDefault
buffer The buffer to contain the unmanaged memory stream.
offset The byte position in the buffer at which to start the unmanaged memory stream.
length The length of the unmanaged memory stream.
access The mode of file access to the unmanaged memory stream.

System.IO.UnmanagedMemoryStream.Dispose()

Releases the unmanaged resources used by the System.IO.UnmanagedMemoryStream and optionally releases the managed resources.

Parameters

NameDescriptionDefault
disposing true to release both managed and unmanaged resources; false to release only unmanaged resources.

System.IO.UnmanagedMemoryStream.Flush

Overrides the System.IO.Stream.Flush method so that no action is performed.

System.IO.UnmanagedMemoryStream.FlushAsync()

Overrides the System.IO.Stream.FlushAsync() method so that the operation is cancelled if specified, but no other action is performed.

Parameters

NameDescriptionDefault
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous flush operation.

System.IO.UnmanagedMemoryStream.Initialize()

Initializes a new instance of the System.IO.UnmanagedMemoryStream class by using a pointer to an unmanaged memory location.

Parameters

NameDescriptionDefault
pointer A pointer to an unmanaged memory location.
length The length of the memory to use.
capacity The total amount of memory assigned to the stream.
access One of the System.IO.FileAccess values.

System.IO.UnmanagedMemoryStream.Initialize()

Initializes a new instance of the System.IO.UnmanagedMemoryStream class in a safe buffer with a specified offset, length, and file access.

Parameters

NameDescriptionDefault
buffer The buffer to contain the unmanaged memory stream.
offset The byte position in the buffer at which to start the unmanaged memory stream.
length The length of the unmanaged memory stream.
access The mode of file access to the unmanaged memory stream.

System.IO.UnmanagedMemoryStream.Read()

Reads the specified number of bytes into the specified array.

Parameters

NameDescriptionDefault
buffer When this method returns, contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source. This parameter is passed uninitialized.
offset The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
count The maximum number of bytes to read from the current stream.

Returns

The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.

System.IO.UnmanagedMemoryStream.Read()

Reads all the bytes of this unmanaged memory stream into the specified span of bytes.

Parameters

NameDescriptionDefault
buffer

Returns

The total number of bytes read into the destination.

System.IO.UnmanagedMemoryStream.ReadAsync()

Asynchronously reads the specified number of bytes into the specified array.

Parameters

NameDescriptionDefault
buffer The buffer to write the data into.
offset The byte offset in buffer at which to begin writing data from the stream.
count The maximum number of bytes to read.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

System.IO.UnmanagedMemoryStream.ReadAsync()

Asynchronously reads the unmanaged memory stream bytes into the memory region.

Parameters

NameDescriptionDefault
buffer When the asynchronous method finishes, this memory region contains all the bytes read from the unmanaged memory stream.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous read operation, and wraps the total number of bytes read into the buffer.

System.IO.UnmanagedMemoryStream.ReadByte

Reads a byte from a stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.

Returns

The unsigned byte cast to an System.Int32 object, or -1 if at the end of the stream.

System.IO.UnmanagedMemoryStream.Seek()

Sets the current position of the current stream to the given value.

Parameters

NameDescriptionDefault
offset The point relative to origin to begin seeking from.
loc Specifies the beginning, the end, or the current position as a reference point for origin, using a value of type System.IO.SeekOrigin.

Returns

The new position in the stream.

System.IO.UnmanagedMemoryStream.SetLength()

Sets the length of a stream to a specified value.

Parameters

NameDescriptionDefault
value The length of the stream.

System.IO.UnmanagedMemoryStream.Write()

Writes a block of bytes to the current stream using data from a buffer.

Parameters

NameDescriptionDefault
buffer The byte array from which to copy bytes to the current stream.
offset The offset in the buffer at which to begin copying bytes to the current stream.
count The number of bytes to write to the current stream.

System.IO.UnmanagedMemoryStream.Write()

Writes a block of bytes to the current unmanaged memory stream using data from the provided span of bytes.

Parameters

NameDescriptionDefault
buffer

System.IO.UnmanagedMemoryStream.WriteAsync()

Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The buffer to write data from.
offset The zero-based byte offset in buffer from which to begin copying bytes to the stream.
count The maximum number of bytes to write.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.UnmanagedMemoryStream.WriteAsync()

Asynchronously writes a span of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

Parameters

NameDescriptionDefault
buffer The buffer to write data from.
cancellationToken The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.

Returns

A task that represents the asynchronous write operation.

System.IO.UnmanagedMemoryStream.WriteByte()

Writes a byte to the current position in the file stream.

Parameters

NameDescriptionDefault
value A byte value written to the stream.

System.IO.UnmanagedMemoryStream.CanRead

Gets a value indicating whether a stream supports reading.

Returns

false if the object was created by a constructor with an access parameter that did not include reading the stream and if the stream is closed; otherwise, true.

System.IO.UnmanagedMemoryStream.CanSeek

Gets a value indicating whether a stream supports seeking.

Returns

false if the stream is closed; otherwise, true.

System.IO.UnmanagedMemoryStream.CanWrite

Gets a value indicating whether a stream supports writing.

Returns

false if the object was created by a constructor with an access parameter value that supports writing or was created by a constructor that had no parameters, or if the stream is closed; otherwise, true.

System.IO.UnmanagedMemoryStream.Capacity

Gets the stream length (size) or the total amount of memory assigned to a stream (capacity).

Returns

The size or capacity of the stream.

System.IO.UnmanagedMemoryStream.Length

Gets the length of the data in a stream.

Returns

The length of the data in the stream.

System.IO.UnmanagedMemoryStream.Position

Gets or sets the current position in a stream.

Returns

The current position in the stream.

System.IO.UnmanagedMemoryStream.PositionPointer

Gets or sets a byte pointer to a stream based on the current position in the stream.

Returns

A byte pointer.

System.IObservable`1

Defines a provider for push-based notification.

System.IObservable`1.Subscribe()

Notifies the provider that an observer is to receive notifications.

Parameters

NameDescriptionDefault
observer The object that is to receive notifications.

Returns

A reference to an interface that allows observers to stop receiving notifications before the provider has finished sending them.

System.IObserver`1

Provides a mechanism for receiving push-based notifications.

System.IObserver`1.OnCompleted

Notifies the observer that the provider has finished sending push-based notifications.

System.IObserver`1.OnError()

Notifies the observer that the provider has experienced an error condition.

Parameters

NameDescriptionDefault
error An object that provides additional information about the error.

System.IObserver`1.OnNext()

Provides the observer with new data.

Parameters

NameDescriptionDefault
value The current notification information.

System.IParsable`1

Defines a mechanism for parsing a string to a value.

System.IParsable`1.Parse()

Parses a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about s.

Returns

The result of parsing s.

System.IParsable`1.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
provider An object that provides culture-specific formatting information about s.
result When this method returns, contains the result of successfully parsing s or an undefined value on failure.

Returns

true if s was successfully parsed; otherwise, false.

System.IProgress`1

Defines a provider for progress updates.

System.IProgress`1.Report()

Reports a progress update.

Parameters

NameDescriptionDefault
value The value of the updated progress.

System.ISpanFormattable

Provides functionality to format the string representation of an object into a span.

System.ISpanFormattable.TryFormat()

Tries to format the value of the current instance into the provided span of characters.

Parameters

NameDescriptionDefault
destination The span in which to write this instance's value formatted as a span of characters.
charsWritten When this method returns, contains the number of characters that were written in destination.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for destination.
provider An optional object that supplies culture-specific formatting information for destination.

Returns

true if the formatting was successful; otherwise, false.

System.ISpanParsable`1

Defines a mechanism for parsing a span of characters to a value.

System.ISpanParsable`1.Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about s.

Returns

The result of parsing s.

System.ISpanParsable`1.TryParse()

Tries to parse a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
provider An object that provides culture-specific formatting information about s.
result When this method returns, contains the result of successfully parsing s, or an undefined value on failure.

Returns

true if s was successfully parsed; otherwise, false.

System.IUtf8SpanFormattable

Provides functionality to format the string representation of an object into a span as UTF-8.

System.IUtf8SpanFormattable.TryFormat()

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

Parameters

NameDescriptionDefault
utf8Destination The span in which to write this instance's value formatted as a span of bytes.
bytesWritten When this method returns, contains the number of bytes that were written in utf8Destination.
format A span containing the characters that represent a standard or custom format string that defines the acceptable format for utf8Destination.
provider An optional object that supplies culture-specific formatting information for utf8Destination.

Returns

true if the formatting was successful; otherwise, false.

System.IUtf8SpanParsable`1

Defines a mechanism for parsing a span of UTF-8 characters to a value.

System.IUtf8SpanParsable`1.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about utf8Text.

Returns

The result of parsing utf8Text.

System.IUtf8SpanParsable`1.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about utf8Text.
result On return, contains the result of successfully parsing utf8Text or an undefined value on failure.

Returns

true if utf8Text was successfully parsed; otherwise, false.

System.Lazy`1

Provides support for lazy initialization.

System.Lazy`1.#ctor

Initializes a new instance of the System.Lazy`1 class. When lazy initialization occurs, the parameterless constructor of the target type is used.

System.Lazy`1.#ctor()

Initializes a new instance of the System.Lazy`1 class that uses a preinitialized specified value.

Parameters

NameDescriptionDefault
value The preinitialized value to be used.

System.Lazy`1.#ctor()

Initializes a new instance of the System.Lazy`1 class. When lazy initialization occurs, the parameterless constructor of the target type and the specified initialization mode are used.

Parameters

NameDescriptionDefault
isThreadSafe true to make this instance usable concurrently by multiple threads; false to make the instance usable by only one thread at a time.

System.Lazy`1.#ctor()

Initializes a new instance of the System.Lazy`1 class. When lazy initialization occurs, the specified initialization function is used.

Parameters

NameDescriptionDefault
valueFactory The delegate that is invoked to produce the lazily initialized value when it is needed.

System.Lazy`1.#ctor()

Initializes a new instance of the System.Lazy`1 class. When lazy initialization occurs, the specified initialization function and initialization mode are used.

Parameters

NameDescriptionDefault
valueFactory The delegate that is invoked to produce the lazily initialized value when it is needed.
isThreadSafe true to make this instance usable concurrently by multiple threads; false to make this instance usable by only one thread at a time.

System.Lazy`1.#ctor()

Initializes a new instance of the System.Lazy`1 class that uses the specified initialization function and thread-safety mode.

Parameters

NameDescriptionDefault
valueFactory The delegate that is invoked to produce the lazily initialized value when it is needed.
mode One of the enumeration values that specifies the thread safety mode.

System.Lazy`1.#ctor()

Initializes a new instance of the System.Lazy`1 class that uses the parameterless constructor of T and the specified thread-safety mode.

Parameters

NameDescriptionDefault
mode One of the enumeration values that specifies the thread safety mode.

System.Lazy`1.ToString

Creates and returns a string representation of the System.Lazy`1.Value property for this instance.

Returns

The result of calling the System.Object.ToString method on the System.Lazy`1.Value property for this instance, if the value has been created (that is, if the System.Lazy`1.IsValueCreated property returns true). Otherwise, a string indicating that the value has not been created.

System.Lazy`1.IsValueCreated

Gets a value that indicates whether a value has been created for this System.Lazy`1 instance.

Returns

true if a value has been created for this System.Lazy`1 instance; otherwise, false.

System.Lazy`1.Value

Gets the lazily initialized value of the current System.Lazy`1 instance.

Returns

The lazily initialized value of the current System.Lazy`1 instance.

System.Lazy`2

Provides a lazy indirect reference to an object and its associated metadata for use by the Managed Extensibility Framework.

System.Lazy`2.#ctor()

Initializes a new instance of the System.Lazy`2 class with the specified metadata.

Parameters

NameDescriptionDefault
metadata The metadata associated with the referenced object.

System.Lazy`2.#ctor()

Initializes a new instance of the System.Lazy`2 class with the specified metadata and thread safety value.

Parameters

NameDescriptionDefault
metadata The metadata associated with the referenced object.
isThreadSafe Indicates whether the System.Lazy`2 object that is created will be thread-safe.

System.Lazy`2.#ctor()

Initializes a new instance of the System.Lazy`2 class with the specified metadata and thread synchronization mode.

Parameters

NameDescriptionDefault
metadata The metadata associated with the referenced object.
mode The thread synchronization mode.

System.Lazy`2.#ctor()

Initializes a new instance of the System.Lazy`2 class with the specified metadata that uses the specified function to get the referenced object.

Parameters

NameDescriptionDefault
valueFactory A function that returns the referenced object.
metadata The metadata associated with the referenced object.

System.Lazy`2.#ctor()

Initializes a new instance of the System.Lazy`2 class with the specified metadata and thread safety value that uses the specified function to get the referenced object.

Parameters

NameDescriptionDefault
valueFactory A function that returns the referenced object.
metadata The metadata associated with the referenced object.
isThreadSafe Indicates whether the System.Lazy`2 object that is created will be thread-safe.

System.Lazy`2.#ctor()

Initializes a new instance of the System.Lazy`2 class with the specified metadata and thread synchronization mode that uses the specified function to get the referenced object.

Parameters

NameDescriptionDefault
valueFactory A function that returns the referenced object.
metadata The metadata associated with the referenced object.
mode The thread synchronization mode.

System.Lazy`2.Metadata

Gets the metadata associated with the referenced object.

Returns

The metadata associated with the referenced object.

System.LdapStyleUriParser

A customizable parser based on the Lightweight Directory Access Protocol (LDAP) scheme.

System.LdapStyleUriParser.#ctor

Creates a customizable parser based on the Lightweight Directory Access Protocol (LDAP) scheme.

System.LoaderOptimization

An enumeration used with the System.LoaderOptimizationAttribute class to specify loader optimizations for an executable.

System.LoaderOptimization.DisallowBindings

Ignored by the common language runtime.

System.LoaderOptimization.DomainMask

Do not use. This mask selects the domain-related values, screening out the unused System.LoaderOptimization.DisallowBindings flag.

System.LoaderOptimization.MultiDomain

Indicates that the application will probably have many domains that use the same code, and the loader must share maximal internal resources across application domains.

System.LoaderOptimization.MultiDomainHost

Indicates that the application will probably host unique code in multiple domains, and the loader must share resources across application domains only for globally available (strong-named) assemblies that have been added to the global assembly cache.

System.LoaderOptimization.NotSpecified

Indicates that no optimizations for sharing internal resources are specified. If the default domain or hosting interface specified an optimization, then the loader uses that; otherwise, the loader uses System.LoaderOptimization.SingleDomain.

System.LoaderOptimization.SingleDomain

Indicates that the application will probably have a single domain, and loader must not share internal resources across application domains.

System.LoaderOptimizationAttribute

Used to set the default loader optimization policy for the main method of an executable application.

System.LoaderOptimizationAttribute.#ctor()

Initializes a new instance of the System.LoaderOptimizationAttribute class to the specified value.

Parameters

NameDescriptionDefault
value A value equivalent to a System.LoaderOptimization constant.

System.LoaderOptimizationAttribute.#ctor()

Initializes a new instance of the System.LoaderOptimizationAttribute class to the specified value.

Parameters

NameDescriptionDefault
value A System.LoaderOptimization constant.

System.LoaderOptimizationAttribute.Value

Gets the current System.LoaderOptimization value for this instance.

Returns

System.MarshalByRefObject

Enables access to objects across application domain boundaries in applications that support remoting.

System.MarshalByRefObject.#ctor

Initializes a new instance of the System.MarshalByRefObject class.

System.MarshalByRefObject.GetLifetimeService

Retrieves the current lifetime service object that controls the lifetime policy for this instance.

Returns

An object of type System.Runtime.Remoting.Lifetime.ILease used to control the lifetime policy for this instance.

System.MarshalByRefObject.InitializeLifetimeService

Obtains a lifetime service object to control the lifetime policy for this instance.

Returns

An object of type System.Runtime.Remoting.Lifetime.ILease used to control the lifetime policy for this instance. This is the current lifetime service object for this instance if one exists; otherwise, a new lifetime service object initialized to the value of the System.Runtime.Remoting.Lifetime.LifetimeServices.LeaseManagerPollTime property.

System.MarshalByRefObject.MemberwiseClone()

Creates a shallow copy of the current System.MarshalByRefObject object.

Parameters

NameDescriptionDefault
cloneIdentity false to delete the current System.MarshalByRefObject object's identity, which will cause the object to be assigned a new identity when it is marshaled across a remoting boundary. A value of false is usually appropriate. true to copy the current System.MarshalByRefObject object's identity to its clone, which will cause remoting client calls to be routed to the remote server object.

Returns

A shallow copy of the current System.MarshalByRefObject object.

System.Math

Provides constants and static methods for trigonometric, logarithmic, and other common mathematical functions.

System.Math.E

Represents the natural logarithmic base, specified by the constant, e.

System.Math.PI

Represents the ratio of the circumference of a circle to its diameter, specified by the constant, π.

System.Math.Tau

Represents the number of radians in one turn, specified by the constant, Ļ„.

System.Math.Abs()

Returns the absolute value of a System.Decimal number.

Parameters

NameDescriptionDefault
value A number that is greater than or equal to Decimal.MinValue, but less than or equal to Decimal.MaxValue.

Returns

A decimal number, x, such that 0 ≤ x ≤ Decimal.MaxValue.

System.Math.Abs()

Returns the absolute value of a double-precision floating-point number.

Parameters

NameDescriptionDefault
value A number that is greater than or equal to Double.MinValue, but less than or equal to Double.MaxValue.

Returns

A double-precision floating-point number, x, such that 0 ≤ x ≤ Double.MaxValue.

System.Math.Abs()

Returns the absolute value of a 16-bit signed integer.

Parameters

NameDescriptionDefault
value A number that is greater than Int16.MinValue, but less than or equal to Int16.MaxValue.

Returns

A 16-bit signed integer, x, such that 0 ≤ x ≤ Int16.MaxValue.

System.Math.Abs()

Returns the absolute value of a 32-bit signed integer.

Parameters

NameDescriptionDefault
value A number that is greater than Int32.MinValue, but less than or equal to Int32.MaxValue.

Returns

A 32-bit signed integer, x, such that 0 ≤ x ≤ Int32.MaxValue.

System.Math.Abs()

Returns the absolute value of a 64-bit signed integer.

Parameters

NameDescriptionDefault
value A number that is greater than Int64.MinValue, but less than or equal to Int64.MaxValue.

Returns

A 64-bit signed integer, x, such that 0 ≤ x ≤ Int64.MaxValue.

System.Math.Abs()

Returns the absolute value of a native signed integer.

Parameters

NameDescriptionDefault
value A number that is greater than System.IntPtr.MinValue, but less than or equal to System.IntPtr.MaxValue.

Returns

A native signed integer, x, such that 0 ≤ x ≤ System.IntPtr.MaxValue.

System.Math.Abs()

Returns the absolute value of an 8-bit signed integer.

Parameters

NameDescriptionDefault
value A number that is greater than SByte.MinValue, but less than or equal to SByte.MaxValue.

Returns

An 8-bit signed integer, x, such that 0 ≤ x ≤ SByte.MaxValue.

System.Math.Abs()

Returns the absolute value of a single-precision floating-point number.

Parameters

NameDescriptionDefault
value A number that is greater than or equal to Single.MinValue, but less than or equal to Single.MaxValue.

Returns

A single-precision floating-point number, x, such that 0 ≤ x ≤ Single.MaxValue.

System.Math.Acos()

Returns the angle whose cosine is the specified number.

Parameters

NameDescriptionDefault
d A number representing a cosine, where d must be greater than or equal to -1, but less than or equal to 1.

Returns

An angle, Īø, measured in radians, such that 0 ≤ Īø ≤ Ļ€. -or- System.Double.NaN if d < -1 or d > 1 or d equals System.Double.NaN.

System.Math.Acosh()

Returns the angle whose hyperbolic cosine is the specified number.

Parameters

NameDescriptionDefault
d A number representing a hyperbolic cosine, where d must be greater than or equal to 1, but less than or equal to System.Double.PositiveInfinity.

Returns

An angle, Īø, measured in radians, such that 0 ≤ Īø ≤ āˆž. -or- System.Double.NaN if d < 1 or d equals System.Double.NaN.

System.Math.Asin()

Returns the angle whose sine is the specified number.

Parameters

NameDescriptionDefault
d A number representing a sine, where d must be greater than or equal to -1, but less than or equal to 1.

Returns

An angle, Īø, measured in radians, such that -Ļ€/2 ≤ Īø ≤ Ļ€/2. -or- System.Double.NaN if d < -1 or d > 1 or d equals System.Double.NaN.

System.Math.Asinh()

Returns the angle whose hyperbolic sine is the specified number.

Parameters

NameDescriptionDefault
d A number representing a hyperbolic sine, where d must be greater than or equal to System.Double.NegativeInfinity, but less than or equal to System.Double.PositiveInfinity.

Returns

An angle, Īø, measured in radians. -or- System.Double.NaN if d equals System.Double.NaN.

System.Math.Atan()

Returns the angle whose tangent is the specified number.

Parameters

NameDescriptionDefault
d A number representing a tangent.

Returns

An angle, Īø, measured in radians, such that -Ļ€/2 ≤ Īø ≤ Ļ€/2. -or- System.Double.NaN if d equals System.Double.NaN, -Ļ€/2 rounded to double precision (-1.5707963267949) if d equals System.Double.NegativeInfinity, or Ļ€/2 rounded to double precision (1.5707963267949) if d equals System.Double.PositiveInfinity.

System.Math.Atan2()

Returns the angle whose tangent is the quotient of two specified numbers.

Parameters

NameDescriptionDefault
y The y coordinate of a point.
x The x coordinate of a point.

Returns

An angle, Īø, measured in radians, such that tan(Īø) = y / x, where (x, y) is a point in the Cartesian plane. Observe the following: - For (x, y) in quadrant 1, 0 < Īø < Ļ€/2. - For (x, y) in quadrant 2, Ļ€/2 < Īø ≤ Ļ€. - For (x, y) in quadrant 3, -Ļ€ ≤ Īø < -Ļ€/2. - For (x, y) in quadrant 4, -Ļ€/2 < Īø < 0. For points on the boundaries of the quadrants, the return value is the following: - If y is 0 and x is not negative, Īø = 0. - If y is 0 and x is negative, Īø = Ļ€. - If y is positive and x is 0, Īø = Ļ€/2. - If y is negative and x is 0, Īø = -Ļ€/2. - If y is 0 and x is 0, Īø = 0. If x or y is System.Double.NaN, or if x and y are either System.Double.PositiveInfinity or System.Double.NegativeInfinity, the method returns System.Double.NaN.

System.Math.Atanh()

Returns the angle whose hyperbolic tangent is the specified number.

Parameters

NameDescriptionDefault
d A number representing a hyperbolic tangent, where d must be greater than or equal to -1, but less than or equal to 1.

Returns

An angle, Īø, measured in radians, such that -āˆž < Īø < -1, or 1 < Īø < āˆž. -or- System.Double.NaN if d < -1 or d > 1 or d equals System.Double.NaN.

System.Math.BigMul()

Produces the full product of two 32-bit numbers.

Parameters

NameDescriptionDefault
a The first number to multiply.
b The second number to multiply.

Returns

The number containing the product of the specified numbers.

System.Math.BigMul()

Produces the full product of two 64-bit numbers.

Parameters

NameDescriptionDefault
a The first number to multiply.
b The second number to multiply.
low When this method returns, contains the low 64-bit of the product of the specified numbers.

Returns

The high 64-bit of the product of the specified numbers.

System.Math.BigMul()

Produces the full product of two unsigned 64-bit numbers.

Parameters

NameDescriptionDefault
a The first number to multiply.
b The second number to multiply.
low When this method returns, contains the low 64-bit of the product of the specified numbers.

Returns

The high 64-bit of the product of the specified numbers.

System.Math.BitDecrement()

Returns the largest value that compares less than a specified value.

Parameters

NameDescriptionDefault
x The value to decrement.

Returns

The largest value that compares less than x. -or- System.Double.NegativeInfinity if x equals System.Double.NegativeInfinity. -or- System.Double.NaN if x equals System.Double.NaN.

System.Math.BitIncrement()

Returns the smallest value that compares greater than a specified value.

Parameters

NameDescriptionDefault
x The value to increment.

Returns

The smallest value that compares greater than x. -or- System.Double.PositiveInfinity if x equals System.Double.PositiveInfinity. -or- System.Double.NaN if x equals System.Double.NaN.

System.Math.Cbrt()

Returns the cube root of a specified number.

Parameters

NameDescriptionDefault
d The number whose cube root is to be found.

Returns

The cube root of d. -or- System.Double.NaN if x equals System.Double.NaN.

System.Math.Ceiling()

Returns the smallest integral value that is greater than or equal to the specified decimal number.

Parameters

NameDescriptionDefault
d A decimal number.

Returns

The smallest integral value that is greater than or equal to d. Note that this method returns a System.Decimal instead of an integral type.

System.Math.Ceiling()

Returns the smallest integral value that is greater than or equal to the specified double-precision floating-point number.

Parameters

NameDescriptionDefault
a A double-precision floating-point number.

Returns

The smallest integral value that is greater than or equal to a. If a is equal to System.Double.NaN, System.Double.NegativeInfinity, or System.Double.PositiveInfinity, that value is returned. Note that this method returns a System.Double instead of an integral type.

System.Math.Clamp()

Returns value clamped to the inclusive range of min and max.

Parameters

NameDescriptionDefault
value The value to be clamped.
min The lower bound of the result.
max The upper bound of the result.

Returns

value if min ≤ value ≤ max.

-or-

min if value < min.

-or-

max if max < value.

System.Math.Clamp()

Returns value clamped to the inclusive range of min and max.

Parameters

NameDescriptionDefault
value The value to be clamped.
min The lower bound of the result.
max The upper bound of the result.

Returns

value if min ≤ value ≤ max. -or- min if value <min. -or- max if max < value.

System.Math.Clamp()

Returns value clamped to the inclusive range of min and max.

Parameters

NameDescriptionDefault
value The value to be clamped.
min The lower bound of the result.
max The upper bound of the result.

Returns

value if min ≤ value ≤ max. -or- min if value < min. -or- max if max < value. -or- System.Double.NaN if value equals System.Double.NaN.

System.Math.Clamp()

Returns value clamped to the inclusive range of min and max.

Parameters

NameDescriptionDefault
value The value to be clamped.
min The lower bound of the result.
max The upper bound of the result.

Returns

value if min ≤ value ≤ max. -or- min if value < min. -or- max if max < value.

System.Math.Clamp()

Returns value clamped to the inclusive range of min and max.

Parameters

NameDescriptionDefault
value The value to be clamped.
min The lower bound of the result.
max The upper bound of the result.

Returns

value if min ≤ value ≤ max. -or- min if value < min. -or- max if max < value.

System.Math.Clamp()

Returns value clamped to the inclusive range of min and max.

Parameters

NameDescriptionDefault
value The value to be clamped.
min The lower bound of the result.
max The upper bound of the result.

Returns

value if min ≤ value ≤ max. -or- min if value < min. -or- max if max < value.

System.Math.Clamp()

Returns value clamped to the inclusive range of min and max.

Parameters

NameDescriptionDefault
value The value to be clamped.
min The lower bound of the result.
max The upper bound of the result.

Returns

value if min ≤ value ≤ max.

-or-

min if value < min.

-or-

max if max < value.

System.Math.Clamp()

Returns value clamped to the inclusive range of min and max.

Parameters

NameDescriptionDefault
value The value to be clamped.
min The lower bound of the result.
max The upper bound of the result.

Returns

value if min ≤ value ≤ max. -or- min if value < min. -or- max if max < value.

System.Math.Clamp()

Returns value clamped to the inclusive range of min and max.

Parameters

NameDescriptionDefault
value The value to be clamped.
min The lower bound of the result.
max The upper bound of the result.

Returns

value if min ≤ value ≤ max. -or- min if value < min. -or- max if max < value. -or- System.Single.NaN if value equals System.Single.NaN.

System.Math.Clamp()

Returns value clamped to the inclusive range of min and max.

Parameters

NameDescriptionDefault
value The value to be clamped.
min The lower bound of the result.
max The upper bound of the result.

Returns

value if min ≤ value ≤ max. -or- min if value < min. -or- max if max < value.

System.Math.Clamp()

Returns value clamped to the inclusive range of min and max.

Parameters

NameDescriptionDefault
value The value to be clamped.
min The lower bound of the result.
max The upper bound of the result.

Returns

value if min ≤ value ≤ max. -or- min if value < min. -or- max if max < value.

System.Math.Clamp()

Returns value clamped to the inclusive range of min and max.

Parameters

NameDescriptionDefault
value The value to be clamped.
min The lower bound of the result.
max The upper bound of the result.

Returns

value if min ≤ value ≤ max. -or- min if value < min. -or- max if max < value.

System.Math.Clamp()

Returns value clamped to the inclusive range of min and max.

Parameters

NameDescriptionDefault
value The value to be clamped.
min The lower bound of the result.
max The upper bound of the result.

Returns

value if min ≤ value ≤ max.

-or-

min if value < min.

-or-

max if max < value.

System.Math.CopySign()

Returns a value with the magnitude of x and the sign of y.

Parameters

NameDescriptionDefault
x A number whose magnitude is used in the result.
y A number whose sign is the used in the result.

Returns

A value with the magnitude of x and the sign of y.

System.Math.Cos()

Returns the cosine of the specified angle.

Parameters

NameDescriptionDefault
d An angle, measured in radians.

Returns

The cosine of d. If d is equal to System.Double.NaN, System.Double.NegativeInfinity, or System.Double.PositiveInfinity, this method returns System.Double.NaN.

System.Math.Cosh()

Returns the hyperbolic cosine of the specified angle.

Parameters

NameDescriptionDefault
value An angle, measured in radians.

Returns

The hyperbolic cosine of value. If value is equal to System.Double.NegativeInfinity or System.Double.PositiveInfinity, System.Double.PositiveInfinity is returned. If value is equal to System.Double.NaN, System.Double.NaN is returned.

System.Math.DivRem()

Produces the quotient and the remainder of two unsigned 8-bit numbers.

Parameters

NameDescriptionDefault
left The dividend.
right The divisor.

Returns

The quotient and the remainder of the specified numbers.

System.Math.DivRem()

Produces the quotient and the remainder of two signed 16-bit numbers.

Parameters

NameDescriptionDefault
left The dividend.
right The divisor.

Returns

The quotient and the remainder of the specified numbers.

System.Math.DivRem()

Produces the quotient and the remainder of two signed 32-bit numbers.

Parameters

NameDescriptionDefault
left The dividend.
right The divisor.

Returns

The quotient and the remainder of the specified numbers.

System.Math.DivRem()

Calculates the quotient of two 32-bit signed integers and also returns the remainder in an output parameter.

Parameters

NameDescriptionDefault
a The dividend.
b The divisor.
result When this method returns, contains the remainder.

Returns

The quotient of the specified numbers.

System.Math.DivRem()

Produces the quotient and the remainder of two signed 64-bit numbers.

Parameters

NameDescriptionDefault
left The dividend.
right The divisor.

Returns

The quotient and the remainder of the specified numbers.

System.Math.DivRem()

Calculates the quotient of two 64-bit signed integers and also returns the remainder in an output parameter.

Parameters

NameDescriptionDefault
a The dividend.
b The divisor.
result When this method returns, contains the remainder.

Returns

The quotient of the specified numbers.

System.Math.DivRem()

Produces the quotient and the remainder of two signed native-size numbers.

Parameters

NameDescriptionDefault
left The dividend.
right The divisor.

Returns

The quotient and the remainder of the specified numbers.

System.Math.DivRem()

Produces the quotient and the remainder of two signed 8-bit numbers.

Parameters

NameDescriptionDefault
left The dividend.
right The divisor.

Returns

The quotient and the remainder of the specified numbers.

System.Math.DivRem()

Produces the quotient and the remainder of two unsigned 16-bit numbers.

Parameters

NameDescriptionDefault
left The dividend.
right The divisor.

Returns

The quotient and the remainder of the specified numbers.

System.Math.DivRem()

Produces the quotient and the remainder of two unsigned 32-bit numbers.

Parameters

NameDescriptionDefault
left The dividend.
right The divisor.

Returns

The quotient and the remainder of the specified numbers.

System.Math.DivRem()

Produces the quotient and the remainder of two unsigned 64-bit numbers.

Parameters

NameDescriptionDefault
left The dividend.
right The divisor.

Returns

The quotient and the remainder of the specified numbers.

System.Math.DivRem()

Produces the quotient and the remainder of two unsigned native-size numbers.

Parameters

NameDescriptionDefault
left The dividend.
right The divisor.

Returns

The quotient and the remainder of the specified numbers.

System.Math.Exp()

Returns e raised to the specified power.

Parameters

NameDescriptionDefault
d A number specifying a power.

Returns

The number e raised to the power d. If d equals System.Double.NaN or System.Double.PositiveInfinity, that value is returned. If d equals System.Double.NegativeInfinity, 0 is returned.

System.Math.Floor()

Returns the largest integral value less than or equal to the specified decimal number.

Parameters

NameDescriptionDefault
d A decimal number.

Returns

The largest integral value less than or equal to d. Note that the method returns an integral value of type System.Decimal.

System.Math.Floor()

Returns the largest integral value less than or equal to the specified double-precision floating-point number.

Parameters

NameDescriptionDefault
d A double-precision floating-point number.

Returns

The largest integral value less than or equal to d. If d is equal to System.Double.NaN, System.Double.NegativeInfinity, or System.Double.PositiveInfinity, that value is returned.

System.Math.FusedMultiplyAdd()

Returns (x * y) + z, rounded as one ternary operation.

Parameters

NameDescriptionDefault
x The number to be multiplied with y.
y The number to be multiplied with x.
z The number to be added to the result of x multiplied by y.

Returns

(x * y) + z, rounded as one ternary operation.

System.Math.IEEERemainder()

Returns the remainder resulting from the division of a specified number by another specified number.

Parameters

NameDescriptionDefault
x A dividend.
y A divisor.

Returns

A number equal to x - (y Q), where Q is the quotient of x / y rounded to the nearest integer (if x / y falls halfway between two integers, the even integer is returned). If x - (y Q) is zero, the value +0 is returned if x is positive, or -0 if x is negative. If y = 0, System.Double.NaN is returned.

System.Math.ILogB()

Returns the base 2 integer logarithm of a specified number.

Parameters

NameDescriptionDefault
x The number whose logarithm is to be found.

Returns

One of the values in the following table. x parameter Return value Default The base 2 integer log of x; that is, (int)log2(x). ZeroInt32.MinValue Equal to System.Double.NaN or System.Double.PositiveInfinity or System.Double.NegativeInfinityInt32.MaxValue

System.Math.Log()

Returns the natural (base e) logarithm of a specified number.

Parameters

NameDescriptionDefault
d The number whose logarithm is to be found.

Returns

One of the values in the following table. d parameter Return value Positive The natural logarithm of d; that is, ln d, or log e d ZeroSystem.Double.NegativeInfinity NegativeSystem.Double.NaN Equal to System.Double.NaNSystem.Double.NaN Equal to System.Double.PositiveInfinitySystem.Double.PositiveInfinity

System.Math.Log()

Returns the logarithm of a specified number in a specified base.

Parameters

NameDescriptionDefault
a The number whose logarithm is to be found.
newBase The base of the logarithm.

Returns

One of the values in the following table. (+Infinity denotes System.Double.PositiveInfinity, -Infinity denotes System.Double.NegativeInfinity, and NaN denotes System.Double.NaN.) anewBase Return valuea> 0 (0 <newBase< 1) -or- (newBase> 1) lognewBase(a)a< 0 (any value) NaN (any value)newBase< 0 NaNa != 1newBase = 0 NaNa != 1newBase = +Infinity NaNa = NaN (any value) NaN (any value)newBase = NaN NaN (any value)newBase = 1 NaNa = 0 0 <newBase< 1 +Infinitya = 0newBase> 1 -Infinitya = +Infinity 0 <newBase< 1 -Infinitya = +InfinitynewBase> 1 +Infinitya = 1newBase = 0 0a = 1newBase = +Infinity 0

System.Math.Log10()

Returns the base 10 logarithm of a specified number.

Parameters

NameDescriptionDefault
d A number whose logarithm is to be found.

Returns

One of the values in the following table. d parameter Return value Positive The base 10 log of d; that is, log 10d. ZeroSystem.Double.NegativeInfinity NegativeSystem.Double.NaN Equal to System.Double.NaNSystem.Double.NaN Equal to System.Double.PositiveInfinitySystem.Double.PositiveInfinity

System.Math.Log2()

Returns the base 2 logarithm of a specified number.

Parameters

NameDescriptionDefault
x A number whose logarithm is to be found.

Returns

One of the values in the following table. x parameter Return value Positive The base 2 log of x; that is, log 2x. ZeroSystem.Double.NegativeInfinity NegativeSystem.Double.NaN Equal to System.Double.NaNSystem.Double.NaN Equal to System.Double.PositiveInfinitySystem.Double.PositiveInfinity

System.Math.Max()

Returns the larger of two 8-bit unsigned integers.

Parameters

NameDescriptionDefault
val1 The first of two 8-bit unsigned integers to compare.
val2 The second of two 8-bit unsigned integers to compare.

Returns

Parameter val1 or val2, whichever is larger.

System.Math.Max()

Returns the larger of two decimal numbers.

Parameters

NameDescriptionDefault
val1 The first of two decimal numbers to compare.
val2 The second of two decimal numbers to compare.

Returns

Parameter val1 or val2, whichever is larger.

System.Math.Max()

Returns the larger of two double-precision floating-point numbers.

Parameters

NameDescriptionDefault
val1 The first of two double-precision floating-point numbers to compare.
val2 The second of two double-precision floating-point numbers to compare.

Returns

Parameter val1 or val2, whichever is larger. If val1, val2, or both val1 and val2 are equal to System.Double.NaN, System.Double.NaN is returned.

System.Math.Max()

Returns the larger of two 16-bit signed integers.

Parameters

NameDescriptionDefault
val1 The first of two 16-bit signed integers to compare.
val2 The second of two 16-bit signed integers to compare.

Returns

Parameter val1 or val2, whichever is larger.

System.Math.Max()

Returns the larger of two 32-bit signed integers.

Parameters

NameDescriptionDefault
val1 The first of two 32-bit signed integers to compare.
val2 The second of two 32-bit signed integers to compare.

Returns

Parameter val1 or val2, whichever is larger.

System.Math.Max()

Returns the larger of two 64-bit signed integers.

Parameters

NameDescriptionDefault
val1 The first of two 64-bit signed integers to compare.
val2 The second of two 64-bit signed integers to compare.

Returns

Parameter val1 or val2, whichever is larger.

System.Math.Max()

Returns the larger of two native signed integers.

Parameters

NameDescriptionDefault
val1 The first of two native signed integers to compare.
val2 The second of two native signed integers to compare.

Returns

Parameter val1 or val2, whichever is larger.

System.Math.Max()

Returns the larger of two 8-bit signed integers.

Parameters

NameDescriptionDefault
val1 The first of two 8-bit signed integers to compare.
val2 The second of two 8-bit signed integers to compare.

Returns

Parameter val1 or val2, whichever is larger.

System.Math.Max()

Returns the larger of two single-precision floating-point numbers.

Parameters

NameDescriptionDefault
val1 The first of two single-precision floating-point numbers to compare.
val2 The second of two single-precision floating-point numbers to compare.

Returns

Parameter val1 or val2, whichever is larger. If val1, or val2, or both val1 and val2 are equal to System.Single.NaN, System.Single.NaN is returned.

System.Math.Max()

Returns the larger of two 16-bit unsigned integers.

Parameters

NameDescriptionDefault
val1 The first of two 16-bit unsigned integers to compare.
val2 The second of two 16-bit unsigned integers to compare.

Returns

Parameter val1 or val2, whichever is larger.

System.Math.Max()

Returns the larger of two 32-bit unsigned integers.

Parameters

NameDescriptionDefault
val1 The first of two 32-bit unsigned integers to compare.
val2 The second of two 32-bit unsigned integers to compare.

Returns

Parameter val1 or val2, whichever is larger.

System.Math.Max()

Returns the larger of two 64-bit unsigned integers.

Parameters

NameDescriptionDefault
val1 The first of two 64-bit unsigned integers to compare.
val2 The second of two 64-bit unsigned integers to compare.

Returns

Parameter val1 or val2, whichever is larger.

System.Math.Max()

Returns the larger of two native unsigned integers.

Parameters

NameDescriptionDefault
val1 The first of two native unsigned integers to compare.
val2 The second of two native unsigned integers to compare.

Returns

Parameter val1 or val2, whichever is larger.

System.Math.MaxMagnitude()

Returns the larger magnitude of two double-precision floating-point numbers.

Parameters

NameDescriptionDefault
x The first of two double-precision floating-point numbers to compare.
y The second of two double-precision floating-point numbers to compare.

Returns

Parameter x or y, whichever has the larger magnitude. If x, or y, or both x and y are equal to System.Double.NaN, System.Double.NaN is returned.

System.Math.Min()

Returns the smaller of two 8-bit unsigned integers.

Parameters

NameDescriptionDefault
val1 The first of two 8-bit unsigned integers to compare.
val2 The second of two 8-bit unsigned integers to compare.

Returns

Parameter val1 or val2, whichever is smaller.

System.Math.Min()

Returns the smaller of two decimal numbers.

Parameters

NameDescriptionDefault
val1 The first of two decimal numbers to compare.
val2 The second of two decimal numbers to compare.

Returns

Parameter val1 or val2, whichever is smaller.

System.Math.Min()

Returns the smaller of two double-precision floating-point numbers.

Parameters

NameDescriptionDefault
val1 The first of two double-precision floating-point numbers to compare.
val2 The second of two double-precision floating-point numbers to compare.

Returns

Parameter val1 or val2, whichever is smaller. If val1, val2, or both val1 and val2 are equal to System.Double.NaN, System.Double.NaN is returned.

System.Math.Min()

Returns the smaller of two 16-bit signed integers.

Parameters

NameDescriptionDefault
val1 The first of two 16-bit signed integers to compare.
val2 The second of two 16-bit signed integers to compare.

Returns

Parameter val1 or val2, whichever is smaller.

System.Math.Min()

Returns the smaller of two 32-bit signed integers.

Parameters

NameDescriptionDefault
val1 The first of two 32-bit signed integers to compare.
val2 The second of two 32-bit signed integers to compare.

Returns

Parameter val1 or val2, whichever is smaller.

System.Math.Min()

Returns the smaller of two 64-bit signed integers.

Parameters

NameDescriptionDefault
val1 The first of two 64-bit signed integers to compare.
val2 The second of two 64-bit signed integers to compare.

Returns

Parameter val1 or val2, whichever is smaller.

System.Math.Min()

Returns the smaller of two native signed integers.

Parameters

NameDescriptionDefault
val1 The first of two native signed integers to compare.
val2 The second of two native signed integers to compare.

Returns

Parameter val1 or val2, whichever is smaller.

System.Math.Min()

Returns the smaller of two 8-bit signed integers.

Parameters

NameDescriptionDefault
val1 The first of two 8-bit signed integers to compare.
val2 The second of two 8-bit signed integers to compare.

Returns

Parameter val1 or val2, whichever is smaller.

System.Math.Min()

Returns the smaller of two single-precision floating-point numbers.

Parameters

NameDescriptionDefault
val1 The first of two single-precision floating-point numbers to compare.
val2 The second of two single-precision floating-point numbers to compare.

Returns

Parameter val1 or val2, whichever is smaller. If val1, val2, or both val1 and val2 are equal to System.Single.NaN, System.Single.NaN is returned.

System.Math.Min()

Returns the smaller of two 16-bit unsigned integers.

Parameters

NameDescriptionDefault
val1 The first of two 16-bit unsigned integers to compare.
val2 The second of two 16-bit unsigned integers to compare.

Returns

Parameter val1 or val2, whichever is smaller.

System.Math.Min()

Returns the smaller of two 32-bit unsigned integers.

Parameters

NameDescriptionDefault
val1 The first of two 32-bit unsigned integers to compare.
val2 The second of two 32-bit unsigned integers to compare.

Returns

Parameter val1 or val2, whichever is smaller.

System.Math.Min()

Returns the smaller of two 64-bit unsigned integers.

Parameters

NameDescriptionDefault
val1 The first of two 64-bit unsigned integers to compare.
val2 The second of two 64-bit unsigned integers to compare.

Returns

Parameter val1 or val2, whichever is smaller.

System.Math.Min()

Returns the smaller of two native unsigned integers.

Parameters

NameDescriptionDefault
val1 The first of two native unsigned integers to compare.
val2 The second of two native unsigned integers to compare.

Returns

Parameter val1 or val2, whichever is smaller.

System.Math.MinMagnitude()

Returns the smaller magnitude of two double-precision floating-point numbers.

Parameters

NameDescriptionDefault
x The first of two double-precision floating-point numbers to compare.
y The second of two double-precision floating-point numbers to compare.

Returns

Parameter x or y, whichever has the smaller magnitude. If x, or y, or both x and y are equal to System.Double.NaN, System.Double.NaN is returned.

System.Math.Pow()

Returns a specified number raised to the specified power.

Parameters

NameDescriptionDefault
x A double-precision floating-point number to be raised to a power.
y A double-precision floating-point number that specifies a power.

Returns

The number x raised to the power y.

System.Math.ReciprocalEstimate()

Returns an estimate of the reciprocal of a specified number.

Parameters

NameDescriptionDefault
d The number whose reciprocal is to be estimated.

Returns

An estimate of the reciprocal of d.

System.Math.ReciprocalSqrtEstimate()

Returns an estimate of the reciprocal square root of a specified number.

Parameters

NameDescriptionDefault
d The number whose reciprocal square root is to be estimated.

Returns

An estimate of the reciprocal square root d.

System.Math.Round()

Rounds a decimal value to the nearest integral value, and rounds midpoint values to the nearest even number.

Parameters

NameDescriptionDefault
d A decimal number to be rounded.

Returns

The integer nearest the d parameter. If the fractional component of d is halfway between two integers, one of which is even and the other odd, the even number is returned. Note that this method returns a System.Decimal instead of an integral type.

System.Math.Round()

Rounds a decimal value to a specified number of fractional digits, and rounds midpoint values to the nearest even number.

Parameters

NameDescriptionDefault
d A decimal number to be rounded.
decimals The number of decimal places in the return value.

Returns

The number nearest to d that contains a number of fractional digits equal to decimals.

System.Math.Round()

Rounds a decimal value to a specified number of fractional digits using the specified rounding convention.

Parameters

NameDescriptionDefault
d A decimal number to be rounded.
decimals The number of decimal places in the return value.
mode One of the enumeration values that specifies which rounding strategy to use.

Returns

The number with decimals fractional digits that d is rounded to. If d has fewer fractional digits than decimals, d is returned unchanged.

System.Math.Round()

Rounds a decimal value an integer using the specified rounding convention.

Parameters

NameDescriptionDefault
d A decimal number to be rounded.
mode One of the enumeration values that specifies which rounding strategy to use.

Returns

The integer that d is rounded to. This method returns a System.Decimal instead of an integral type.

System.Math.Round()

Rounds a double-precision floating-point value to the nearest integral value, and rounds midpoint values to the nearest even number.

Parameters

NameDescriptionDefault
a A double-precision floating-point number to be rounded.

Returns

The integer nearest a. If the fractional component of a is halfway between two integers, one of which is even and the other odd, then the even number is returned. Note that this method returns a System.Double instead of an integral type.

System.Math.Round()

Rounds a double-precision floating-point value to a specified number of fractional digits, and rounds midpoint values to the nearest even number.

Parameters

NameDescriptionDefault
value A double-precision floating-point number to be rounded.
digits The number of fractional digits in the return value.

Returns

The number nearest to value that contains a number of fractional digits equal to digits.

System.Math.Round()

Rounds a double-precision floating-point value to a specified number of fractional digits using the specified rounding convention.

Parameters

NameDescriptionDefault
value A double-precision floating-point number to be rounded.
digits The number of fractional digits in the return value.
mode One of the enumeration values that specifies which rounding strategy to use.

Returns

The number that has digits fractional digits that value is rounded to. If value has fewer fractional digits than digits, value is returned unchanged.

System.Math.Round()

Rounds a double-precision floating-point value to an integer using the specified rounding convention.

Parameters

NameDescriptionDefault
value A double-precision floating-point number to be rounded.
mode One of the enumeration values that specifies which rounding strategy to use.

Returns

The integer that value is rounded to. This method returns a System.Double instead of an integral type.

System.Math.ScaleB()

Returns x * 2^n computed efficiently.

Parameters

NameDescriptionDefault
x A double-precision floating-point number that specifies the base value.
n A 32-bit integer that specifies the power.

Returns

x * 2^n computed efficiently.

System.Math.Sign()

Returns an integer that indicates the sign of a decimal number.

Parameters

NameDescriptionDefault
value A signed decimal number.

Returns

A number that indicates the sign of value, as shown in the following table. Return value Meaning -1value is less than zero. 0value is equal to zero. 1value is greater than zero.

System.Math.Sign()

Returns an integer that indicates the sign of a double-precision floating-point number.

Parameters

NameDescriptionDefault
value A signed number.

Returns

A number that indicates the sign of value, as shown in the following table. Return value Meaning -1value is less than zero. 0value is equal to zero. 1value is greater than zero.

System.Math.Sign()

Returns an integer that indicates the sign of a 16-bit signed integer.

Parameters

NameDescriptionDefault
value A signed number.

Returns

A number that indicates the sign of value, as shown in the following table. Return value Meaning -1value is less than zero. 0value is equal to zero. 1value is greater than zero.

System.Math.Sign()

Returns an integer that indicates the sign of a 32-bit signed integer.

Parameters

NameDescriptionDefault
value A signed number.

Returns

A number that indicates the sign of value, as shown in the following table. Return value Meaning -1value is less than zero. 0value is equal to zero. 1value is greater than zero.

System.Math.Sign()

Returns an integer that indicates the sign of a 64-bit signed integer.

Parameters

NameDescriptionDefault
value A signed number.

Returns

A number that indicates the sign of value, as shown in the following table. Return value Meaning -1value is less than zero. 0value is equal to zero. 1value is greater than zero.

System.Math.Sign()

Returns an integer that indicates the sign of a native sized signed integer.

Parameters

NameDescriptionDefault
value A signed number.

Returns

A number that indicates the sign of value, as shown in the following table. Return value Meaning -1value is less than zero. 0value is equal to zero. 1value is greater than zero.

System.Math.Sign()

Returns an integer that indicates the sign of an 8-bit signed integer.

Parameters

NameDescriptionDefault
value A signed number.

Returns

A number that indicates the sign of value, as shown in the following table. Return value Meaning -1value is less than zero. 0value is equal to zero. 1value is greater than zero.

System.Math.Sign()

Returns an integer that indicates the sign of a single-precision floating-point number.

Parameters

NameDescriptionDefault
value A signed number.

Returns

A number that indicates the sign of value, as shown in the following table. Return value Meaning -1value is less than zero. 0value is equal to zero. 1value is greater than zero.

System.Math.Sin()

Returns the sine of the specified angle.

Parameters

NameDescriptionDefault
a An angle, measured in radians.

Returns

The sine of a. If a is equal to System.Double.NaN, System.Double.NegativeInfinity, or System.Double.PositiveInfinity, this method returns System.Double.NaN.

System.Math.SinCos()

Returns the sine and cosine of the specified angle.

Parameters

NameDescriptionDefault
x An angle, measured in radians.

Returns

The sine and cosine of x. If x is equal to System.Double.NaN, System.Double.NegativeInfinity, or System.Double.PositiveInfinity, this method returns System.Double.NaN.

System.Math.Sinh()

Returns the hyperbolic sine of the specified angle.

Parameters

NameDescriptionDefault
value An angle, measured in radians.

Returns

The hyperbolic sine of value. If value is equal to System.Double.NegativeInfinity, System.Double.PositiveInfinity, or System.Double.NaN, this method returns a System.Double equal to value.

System.Math.Sqrt()

Returns the square root of a specified number.

Parameters

NameDescriptionDefault
d The number whose square root is to be found.

Returns

One of the values in the following table. d parameter Return value Zero or positive The positive square root of d. NegativeSystem.Double.NaN Equals System.Double.NaNSystem.Double.NaN Equals System.Double.PositiveInfinitySystem.Double.PositiveInfinity

System.Math.Tan()

Returns the tangent of the specified angle.

Parameters

NameDescriptionDefault
a An angle, measured in radians.

Returns

The tangent of a. If a is equal to System.Double.NaN, System.Double.NegativeInfinity, or System.Double.PositiveInfinity, this method returns System.Double.NaN.

System.Math.Tanh()

Returns the hyperbolic tangent of the specified angle.

Parameters

NameDescriptionDefault
value An angle, measured in radians.

Returns

The hyperbolic tangent of value. If value is equal to System.Double.NegativeInfinity, this method returns -1. If value is equal to System.Double.PositiveInfinity, this method returns 1. If value is equal to System.Double.NaN, this method returns System.Double.NaN.

System.Math.Truncate()

Calculates the integral part of a specified decimal number.

Parameters

NameDescriptionDefault
d A number to truncate.

Returns

The integral part of d; that is, the number that remains after any fractional digits have been discarded.

System.Math.Truncate()

Calculates the integral part of a specified double-precision floating-point number.

Parameters

NameDescriptionDefault
d A number to truncate.

Returns

The integral part of d; that is, the number that remains after any fractional digits have been discarded, or one of the values listed in the following table. d Return valueSystem.Double.NaNSystem.Double.NaNSystem.Double.NegativeInfinitySystem.Double.NegativeInfinitySystem.Double.PositiveInfinitySystem.Double.PositiveInfinity

System.MathF

Provides constants and static methods for trigonometric, logarithmic, and other common mathematical functions.

System.MathF.E

Represents the natural logarithmic base, specified by the constant, e.

System.MathF.PI

Represents the ratio of the circumference of a circle to its diameter, specified by the constant, p.

System.MathF.Tau

Represents the number of radians in one turn, specified by the constant, Ļ„.

System.MathF.Abs()

Returns the absolute value of a single-precision floating-point number.

Parameters

NameDescriptionDefault
x A number that is greater than or equal to Single.MinValue, but less than or equal to Single.MaxValue.

Returns

A single-precision floating-point number, x, such that 0 ≤ x ≤ Single.MaxValue.

System.MathF.Acos()

Returns the angle whose cosine is the specified number.

Parameters

NameDescriptionDefault
x A number representing a cosine, where x must be greater than or equal to -1, but less than or equal to 1.

Returns

An angle, Īø, measured in radians, such that 0 ≤ Īø ≤ Ļ€. -or- System.Single.NaN if x < -1 or x > 1 or x equals System.Single.NaN.

System.MathF.Acosh()

Returns the angle whose hyperbolic cosine is the specified number.

Parameters

NameDescriptionDefault
x A number representing a hyperbolic cosine, where x must be greater than or equal to 1, but less than or equal to System.Single.PositiveInfinity.

Returns

An angle, Īø, measured in radians, such that 0 ≤ Īø ≤ āˆž. -or- System.Single.NaN if x < 1 or x equals System.Single.NaN.

System.MathF.Asin()

Returns the angle whose sine is the specified number.

Parameters

NameDescriptionDefault
x A number representing a sine, where x must be greater than or equal to -1, but less than or equal to 1.

Returns

An angle, Īø, measured in radians, such that -Ļ€/2 ≤ Īø ≤ Ļ€/2. -or- System.Single.NaN if x < -1 or x > 1 or x equals System.Single.NaN.

System.MathF.Asinh()

Returns the angle whose hyperbolic sine is the specified number.

Parameters

NameDescriptionDefault
x A number representing a hyperbolic sine, where x must be greater than or equal to System.Single.NegativeInfinity, but less than or equal to System.Single.PositiveInfinity.

Returns

An angle, Īø, measured in radians. -or- System.Single.NaN if x equals System.Single.NaN.

System.MathF.Atan()

Returns the angle whose tangent is the specified number.

Parameters

NameDescriptionDefault
x A number representing a tangent.

Returns

An angle, Īø, measured in radians, such that -Ļ€/2 ≤ Īø ≤ Ļ€/2. -or- System.Single.NaN if x equals System.Single.NaN, -Ļ€/2 rounded to double precision (-1.5707963267949) if x equals System.Single.NegativeInfinity, or Ļ€/2 rounded to double precision (1.5707963267949) if x equals System.Single.PositiveInfinity.

System.MathF.Atan2()

Returns the angle whose tangent is the quotient of two specified numbers.

Parameters

NameDescriptionDefault
y The y coordinate of a point.
x The x coordinate of a point.

Returns

An angle, Īø, measured in radians, such that -Ļ€ ≤ Īø ≤ Ļ€, and tan(Īø) = y / x, where (x, y) is a point in the Cartesian plane. Observe the following: - For (x, y) in quadrant 1, 0 < Īø < Ļ€/2. - For (x, y) in quadrant 2, Ļ€/2 < Īø ≤ Ļ€. - For (x, y) in quadrant 3, -Ļ€ < Īø < -Ļ€/2. - For (x, y) in quadrant 4, -Ļ€/2 < Īø < 0. For points on the boundaries of the quadrants, the return value is the following: - If y is 0 and x is not negative, Īø = 0. - If y is 0 and x is negative, Īø = Ļ€. - If y is positive and x is 0, Īø = Ļ€/2. - If y is negative and x is 0, Īø = -Ļ€/2. - If y is 0 and x is 0, Īø = 0. If x or y is System.Single.NaN, or if x and y are either System.Single.PositiveInfinity or System.Single.NegativeInfinity, the method returns System.Single.NaN.

System.MathF.Atanh()

Returns the angle whose hyperbolic tangent is the specified number.

Parameters

NameDescriptionDefault
x A number representing a hyperbolic tangent, where x must be greater than or equal to -1, but less than or equal to 1.

Returns

An angle, Īø, measured in radians, such that -āˆž < Īø <-1, or 1 < Īø < āˆž. -or- System.Single.NaN if x < -1 or x > 1 or x equals System.Single.NaN.

System.MathF.BitDecrement()

Returns the largest value that compares less than a specified value.

Parameters

NameDescriptionDefault
x The value to decrement.

Returns

The largest value that compares less than x. -or- System.Single.NegativeInfinity if x is equals System.Single.NegativeInfinity. -or- System.Single.NaN if x equals System.Single.NaN.

System.MathF.BitIncrement()

Returns the smallest value that compares greater than a specified value.

Parameters

NameDescriptionDefault
x The value to increment.

Returns

The smallest value that compares greater than x. -or- System.Single.PositiveInfinity if x equals System.Single.PositiveInfinity. -or- System.Single.NaN if x is equals System.Single.NaN.

System.MathF.Cbrt()

Returns the cube root of a specified number.

Parameters

NameDescriptionDefault
x The number whose cube root is to be found.

Returns

The cube root of x. -or- System.Single.NaN if x is equals System.Single.NaN.

System.MathF.Ceiling()

Returns the smallest integral value that is greater than or equal to the specified single-precision floating-point number.

Parameters

NameDescriptionDefault
x A single-precision floating-point number.

Returns

The smallest integral value that is greater than or equal to x. If x is equal to System.Single.NaN, System.Single.NegativeInfinity, or System.Single.PositiveInfinity, that value is returned. Note that this method returns a System.Single instead of an integral type.

System.MathF.CopySign()

Returns a value with the magnitude of x and the sign of y.

Parameters

NameDescriptionDefault
x A number whose magnitude is used in the result.
y A number whose sign is the used in the result.

Returns

A value with the magnitude of x and the sign of y.

System.MathF.Cos()

Returns the cosine of the specified angle.

Parameters

NameDescriptionDefault
x An angle, measured in radians.

Returns

The cosine of x. If x is equal to System.Single.NaN, System.Single.NegativeInfinity, or System.Single.PositiveInfinity, this method returns System.Single.NaN.

System.MathF.Cosh()

Returns the hyperbolic cosine of the specified angle.

Parameters

NameDescriptionDefault
x An angle, measured in radians.

Returns

The hyperbolic cosine of x. If x is equal to System.Single.NegativeInfinity or System.Single.PositiveInfinity, System.Single.PositiveInfinity is returned. If x is equal to System.Single.NaN, System.Single.NaN is returned.

System.MathF.Exp()

Returns e raised to the specified power.

Parameters

NameDescriptionDefault
x A number specifying a power.

Returns

The number e raised to the power x. If x equals System.Single.NaN or System.Single.PositiveInfinity, that value is returned. If x equals System.Single.NegativeInfinity, 0 is returned.

System.MathF.Floor()

Returns the largest integral value less than or equal to the specified single-precision floating-point number.

Parameters

NameDescriptionDefault
x A single-precision floating-point number.

Returns

The largest integral value less than or equal to x. If x is equal to System.Single.NaN, System.Single.NegativeInfinity, or System.Single.PositiveInfinity, that value is returned.

System.MathF.FusedMultiplyAdd()

Returns (x * y) + z, rounded as one ternary operation.

Parameters

NameDescriptionDefault
x The number to be multiplied with y.
y The number to be multiplied with x.
z The number to be added to the result of x multiplied by y.

Returns

(x * y) + z, rounded as one ternary operation.

System.MathF.IEEERemainder()

Returns the remainder resulting from the division of a specified number by another specified number.

Parameters

NameDescriptionDefault
x A dividend.
y A divisor.

Returns

A number equal to x - (y Q), where Q is the quotient of x / y rounded to the nearest integer (if x / y falls halfway between two integers, the even integer is returned). If x - (y Q) is zero, the value +0 is returned if x is positive, or -0 if x is negative. If y = 0, System.Single.NaN is returned.

System.MathF.ILogB()

Returns the base 2 integer logarithm of a specified number.

Parameters

NameDescriptionDefault
x The number whose logarithm is to be found.

Returns

One of the values in the following table. x parameter Return value Default The base 2 integer log of x; that is, (int)log2(x). ZeroInt32.MinValue Equal to System.Single.NaN or System.Single.PositiveInfinity or System.Single.NegativeInfinityInt32.MaxValue

System.MathF.Log()

Returns the natural (base e) logarithm of a specified number.

Parameters

NameDescriptionDefault
x The number whose logarithm is to be found.

Returns

One of the values in the following table. x parameter Return value Positive The natural logarithm of x; that is, ln x, or log e x ZeroSystem.Single.NegativeInfinity NegativeSystem.Single.NaN Equal to System.Single.NaNSystem.Single.NaN Equal to System.Single.PositiveInfinitySystem.Single.PositiveInfinity

System.MathF.Log()

Returns the logarithm of a specified number in a specified base.

Parameters

NameDescriptionDefault
x The number whose logarithm is to be found.
y The base.

Returns

One of the values in the following table. (+Infinity denotes System.Single.PositiveInfinity, -Infinity denotes System.Single.NegativeInfinity, and NaN denotes System.Single.NaN.) xnewBase Return valuex> 0 (0 <newBase< 1) -or-(newBase> 1) lognewBase(a)x< 0 (any value) NaN (any value)newBase< 0 NaNx != 1newBase = 0 NaNx != 1newBase = +Infinity NaNx = NaN (any value) NaN (any value)newBase = NaN NaN (any value)newBase = 1 NaNx = 0 0 <newBase< 1 +Infinityx = 0newBase> 1 -Infinityx = +Infinity 0 <newBase< 1 -Infinityx = +InfinitynewBase> 1 +Infinityx = 1newBase = 0 0x = 1newBase = +Infinity 0

System.MathF.Log10()

Returns the base 10 logarithm of a specified number.

Parameters

NameDescriptionDefault
x A number whose logarithm is to be found.

Returns

One of the values in the following table. x parameter Return value Positive The base 10 log of x; that is, log 10x. ZeroSystem.Single.NegativeInfinity NegativeSystem.Single.NaN Equal to System.Single.NaNSystem.Single.NaN Equal to System.Single.PositiveInfinitySystem.Single.PositiveInfinity

System.MathF.Log2()

Returns the base 2 logarithm of a specified number.

Parameters

NameDescriptionDefault
x A number whose logarithm is to be found.

Returns

One of the values in the following table. x parameter Return value Positive The base 2 log of x; that is, log 2x. ZeroSystem.Single.NegativeInfinity NegativeSystem.Single.NaN Equal to System.Single.NaNSystem.Single.NaN Equal to System.Single.PositiveInfinitySystem.Single.PositiveInfinity

System.MathF.Max()

Returns the larger of two single-precision floating-point numbers.

Parameters

NameDescriptionDefault
x The first of two single-precision floating-point numbers to compare.
y The second of two single-precision floating-point numbers to compare.

Returns

Parameter x or y, whichever is larger. If x, or y, or both x and y are equal to System.Single.NaN, System.Single.NaN is returned.

System.MathF.MaxMagnitude()

Returns the larger magnitude of two single-precision floating-point numbers.

Parameters

NameDescriptionDefault
x The first of two single-precision floating-point numbers to compare.
y The second of two single-precision floating-point numbers to compare.

Returns

Parameter x or y, whichever has the larger magnitude. If x, or y, or both x and y are equal to System.Single.NaN, System.Single.NaN is returned.

System.MathF.Min()

Returns the smaller of two single-precision floating-point numbers.

Parameters

NameDescriptionDefault
x The first of two single-precision floating-point numbers to compare.
y The second of two single-precision floating-point numbers to compare.

Returns

Parameter x or y, whichever is smaller. If x, y, or both x and y are equal to System.Single.NaN, System.Single.NaN is returned.

System.MathF.MinMagnitude()

Returns the smaller magnitude of two single-precision floating-point numbers.

Parameters

NameDescriptionDefault
x The first of two single-precision floating-point numbers to compare.
y The second of two single-precision floating-point numbers to compare.

Returns

Parameter x or y, whichever has the smaller magnitude. If x, or y, or both x and y are equal to System.Single.NaN, System.Single.NaN is returned.

System.MathF.Pow()

Returns a specified number raised to the specified power.

Parameters

NameDescriptionDefault
x A single-precision floating-point number to be raised to a power.
y A single-precision floating-point number that specifies a power.

Returns

The number x raised to the power y.

System.MathF.ReciprocalEstimate()

Returns an estimate of the reciprocal of a specified number.

Parameters

NameDescriptionDefault
x The number whose reciprocal is to be estimated.

Returns

An estimate of the reciprocal of x.

System.MathF.ReciprocalSqrtEstimate()

Returns an estimate of the reciprocal square root of a specified number.

Parameters

NameDescriptionDefault
x The number whose reciprocal square root is to be estimated.

Returns

An estimate of the reciprocal square root x.

System.MathF.Round()

Rounds a single-precision floating-point value to the nearest integral value, and rounds midpoint values to the nearest even number.

Parameters

NameDescriptionDefault
x A single-precision floating-point number to be rounded.

Returns

The integer nearest x. If the fractional component of x is halfway between two integers, one of which is even and the other odd, then the even number is returned. Note that this method returns a System.Single instead of an integral type.

System.MathF.Round()

Rounds a single-precision floating-point value to a specified number of fractional digits, and rounds midpoint values to the nearest even number.

Parameters

NameDescriptionDefault
x A single-precision floating-point number to be rounded.
digits The number of fractional digits in the return value.

Returns

The number nearest to x that contains a number of fractional digits equal to digits.

System.MathF.Round()

Rounds a single-precision floating-point value to a specified number of fractional digits using the specified rounding convention.

Parameters

NameDescriptionDefault
x A single-precision floating-point number to be rounded.
digits The number of fractional digits in the return value.
mode One of the enumeration values that specifies which rounding strategy to use.

Returns

The number that x is rounded to that has digits fractional digits. If x has fewer fractional digits than digits, x is returned unchanged.

System.MathF.Round()

Rounds a single-precision floating-point value to an integer using the specified rounding convention.

Parameters

NameDescriptionDefault
x A single-precision floating-point number to be rounded.
mode One of the enumeration values that specifies which rounding strategy to use.

Returns

The integer that x is rounded to using the mode rounding convention. This method returns a System.Single instead of an integral type.

System.MathF.ScaleB()

Returns x * 2^n computed efficiently.

Parameters

NameDescriptionDefault
x A single-precision floating-point number that specifies the base value.
n A single-precision floating-point number that specifies the power.

Returns

x * 2^n computed efficiently.

System.MathF.Sign()

Returns an integer that indicates the sign of a single-precision floating-point number.

Parameters

NameDescriptionDefault
x A signed number.

Returns

A number that indicates the sign of x, as shown in the following table. Return value Meaning -1x is less than zero. 0x is equal to zero. 1x is greater than zero.

System.MathF.Sin()

Returns the sine of the specified angle.

Parameters

NameDescriptionDefault
x An angle, measured in radians.

Returns

The sine of x. If x is equal to System.Single.NaN, System.Single.NegativeInfinity, or System.Single.PositiveInfinity, this method returns System.Single.NaN.

System.MathF.SinCos()

Returns the sine and cosine of the specified angle.

Parameters

NameDescriptionDefault
x An angle, measured in radians.

Returns

The sine and cosine of x. If x is equal to System.Single.NaN, System.Single.NegativeInfinity, or System.Single.PositiveInfinity, this method returns System.Single.NaN.

System.MathF.Sinh()

Returns the hyperbolic sine of the specified angle.

Parameters

NameDescriptionDefault
x An angle, measured in radians.

Returns

The hyperbolic sine of x. If x is equal to System.Single.NegativeInfinity, System.Single.PositiveInfinity, or System.Single.NaN, this method returns a System.Single equal to x.

System.MathF.Sqrt()

Returns the square root of a specified number.

Parameters

NameDescriptionDefault
x The number whose square root is to be found.

Returns

One of the values in the following table. x parameter Return value Zero or positive The positive square root of x. NegativeSystem.Single.NaN Equals System.Single.NaNSystem.Single.NaN Equals System.Single.PositiveInfinitySystem.Single.PositiveInfinity

System.MathF.Tan()

Returns the tangent of the specified angle.

Parameters

NameDescriptionDefault
x An angle, measured in radians.

Returns

The tangent of x. If x is equal to System.Single.NaN, System.Single.NegativeInfinity, or System.Single.PositiveInfinity, this method returns System.Single.NaN.

System.MathF.Tanh()

Returns the hyperbolic tangent of the specified angle.

Parameters

NameDescriptionDefault
x An angle, measured in radians.

Returns

The hyperbolic tangent of x. If x is equal to System.Single.NegativeInfinity, this method returns -1. If value is equal to System.Single.PositiveInfinity, this method returns 1. If x is equal to System.Single.NaN, this method returns System.Single.NaN.

System.MathF.Truncate()

Calculates the integral part of a specified single-precision floating-point number.

Parameters

NameDescriptionDefault
x A number to truncate.

Returns

The integral part of x; that is, the number that remains after any fractional digits have been discarded, or one of the values listed in the following table. x Return valueSystem.Single.NaNSystem.Single.NaNSystem.Single.NegativeInfinitySystem.Single.NegativeInfinitySystem.Single.PositiveInfinitySystem.Single.PositiveInfinity

System.MemberAccessException

The exception that is thrown when an attempt to access a class member fails.

System.MemberAccessException.#ctor

Initializes a new instance of the System.MemberAccessException class.

System.MemberAccessException.#ctor()

Initializes a new instance of the System.MemberAccessException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.MemberAccessException.#ctor()

Initializes a new instance of the System.MemberAccessException class with a specified error message.

Parameters

NameDescriptionDefault
message The message that describes the error.

System.MemberAccessException.#ctor()

Initializes a new instance of the System.MemberAccessException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
inner The exception that is the cause of the current exception. If the inner parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.Memory`1

Represents a contiguous region of memory.

System.Memory`1.#ctor()

Creates a new System.Memory`1 object over the entirety of a specified array.

Parameters

NameDescriptionDefault
array The array from which to create the System.Memory`1 object.

System.Memory`1.#ctor()

Creates a new System.Memory`1 object that includes a specified number of elements of an array beginning at a specified index.

Parameters

NameDescriptionDefault
array The source array.
start The index of the first element to include in the new System.Memory`1.
length The number of elements to include in the new System.Memory`1.

System.Memory`1.CopyTo()

Copies the contents of a System.Memory`1 object into a destination System.Memory`1 object.

Parameters

NameDescriptionDefault
destination The destination System.Memory`1 object.

System.Memory`1.Equals()

Determines whether the specified System.Memory`1 object is equal to the current object.

Parameters

NameDescriptionDefault
other The object to compare with the current instance.

Returns

true if the current instance and other are equal; otherwise, false.

System.Memory`1.Equals()

Determines whether the specified object is equal to the current object.

Parameters

NameDescriptionDefault
obj The object to compare with the current instance.

Returns

true if the current instance and obj are equal; otherwise, false.

System.Memory`1.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Memory`1.op_Implicit()

Defines an implicit conversion of an array to a System.Memory`1 object.

Parameters

NameDescriptionDefault
array The array to convert.

Returns

The converted object.

System.Memory`1.op_Implicit()

Defines an implicit conversion of an System.ArraySegment`1 object to a System.Memory`1 object.

Parameters

NameDescriptionDefault
segment The object to convert.

Returns

The converted System.ArraySegment`1 object.

System.Memory`1.op_Implicit()

Defines an implicit conversion of a System.Memory`1 object to a System.ReadOnlyMemory`1 object.

Parameters

NameDescriptionDefault
memory The object to convert.

Returns

The converted object.

System.Memory`1.Pin

Creates a handle for the System.Memory`1 object.

Returns

A handle for the System.Memory`1 object.

System.Memory`1.Slice()

Forms a slice out of the current memory that begins at a specified index.

Parameters

NameDescriptionDefault
start The index at which to begin the slice.

Returns

An object that contains all elements of the current instance from start to the end of the instance.

System.Memory`1.Slice()

Forms a slice out of the current memory starting at a specified index for a specified length.

Parameters

NameDescriptionDefault
start The index at which to begin the slice.
length The number of elements to include in the slice.

Returns

An object that contains length elements from the current instance starting at start.

System.Memory`1.ToArray

Copies the contents from the memory into a new array.

Returns

An array containing the elements in the current memory.

System.Memory`1.ToString

Returns the string representation of this System.Memory`1 object.

Returns

the string representation of this System.Memory`1 object.

System.Memory`1.TryCopyTo()

Copies the contents of the memory into a destination System.Memory`1 instance.

Parameters

NameDescriptionDefault
destination The destination System.Memory`1 object.

Returns

true if the copy operation succeeds; otherwise, false.

System.Memory`1.Empty

Returns an empty System.Memory`1 object.

Returns

An empty object.

System.Memory`1.IsEmpty

Indicates whether the current instance is empty.

Returns

true if the current instance is empty; otherwise, false.

System.Memory`1.Length

Gets the number of items in the current instance.

Returns

The number of items in the current instance.

System.Memory`1.Span

Returns a span from the current instance.

Returns

A span created from the current System.Memory`1 object.

System.MethodAccessException

The exception that is thrown when there is an invalid attempt to access a method, such as accessing a private method from partially trusted code.

System.MethodAccessException.#ctor

Initializes a new instance of the System.MethodAccessException class, setting the System.Exception.Message property of the new instance to a system-supplied message that describes the error, such as "Attempt to access the method failed." This message takes into account the current system culture.

System.MethodAccessException.#ctor()

Initializes a new instance of the System.MethodAccessException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.MethodAccessException.#ctor()

Initializes a new instance of the System.MethodAccessException class with a specified error message.

Parameters

NameDescriptionDefault
message A System.String that describes the error.

System.MethodAccessException.#ctor()

Initializes a new instance of the System.MethodAccessException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
inner The exception that is the cause of the current exception. If the inner parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.MidpointRounding

Specifies the strategy that mathematical rounding methods should use to round a number.

System.MidpointRounding.AwayFromZero

The strategy of rounding to the nearest number, and when a number is halfway between two others, it's rounded toward the nearest number that's away from zero.

System.MidpointRounding.ToEven

The strategy of rounding to the nearest number, and when a number is halfway between two others, it's rounded toward the nearest even number.

System.MidpointRounding.ToNegativeInfinity

The strategy of downwards-directed rounding, with the result closest to and no greater than the infinitely precise result.

System.MidpointRounding.ToPositiveInfinity

The strategy of upwards-directed rounding, with the result closest to and no less than the infinitely precise result.

System.MidpointRounding.ToZero

The strategy of directed rounding toward zero, with the result closest to and no greater in magnitude than the infinitely precise result.

System.MissingFieldException

The exception that is thrown when there is an attempt to dynamically access a field that does not exist. If a field in a class library has been removed or renamed, recompile any assemblies that reference that library.

System.MissingFieldException.#ctor

Initializes a new instance of the System.MissingFieldException class.

System.MissingFieldException.#ctor()

Initializes a new instance of the System.MissingFieldException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.MissingFieldException.#ctor()

Initializes a new instance of the System.MissingFieldException class with a specified error message.

Parameters

NameDescriptionDefault
message A System.String that describes the error.

System.MissingFieldException.#ctor()

Initializes a new instance of the System.MissingFieldException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
inner The exception that is the cause of the current exception. If the inner parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.MissingFieldException.#ctor()

Initializes a new instance of the System.MissingFieldException class with the specified class name and field name.

Parameters

NameDescriptionDefault
className The name of the class in which access to a nonexistent field was attempted.
fieldName The name of the field that cannot be accessed.

System.MissingFieldException.Message

Gets the text string showing the signature of the missing field, the class name, and the field name. This property is read-only.

Returns

The error message string.

System.MissingMemberException

The exception that is thrown when there is an attempt to dynamically access a class member that does not exist or that is not declared as public. If a member in a class library has been removed or renamed, recompile any assemblies that reference that library.

System.MissingMemberException.ClassName

Holds the class name of the missing member.

System.MissingMemberException.MemberName

Holds the name of the missing member.

System.MissingMemberException.Signature

Holds the signature of the missing member.

System.MissingMemberException.#ctor

Initializes a new instance of the System.MissingMemberException class.

System.MissingMemberException.#ctor()

Initializes a new instance of the System.MissingMemberException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.MissingMemberException.#ctor()

Initializes a new instance of the System.MissingMemberException class with a specified error message.

Parameters

NameDescriptionDefault
message The message that describes the error.

System.MissingMemberException.#ctor()

Initializes a new instance of the System.MissingMemberException class with a specified error message and a reference to the inner exception that is the root cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
inner An instance of System.Exception that is the cause of the current Exception. If inner is not a null reference (Nothing in Visual Basic), then the current Exception is raised in a catch block handling inner.

System.MissingMemberException.#ctor()

Initializes a new instance of the System.MissingMemberException class with the specified class name and member name.

Parameters

NameDescriptionDefault
className The name of the class in which access to a nonexistent member was attempted.
memberName The name of the member that cannot be accessed.

System.MissingMemberException.GetObjectData()

Sets the System.Runtime.Serialization.SerializationInfo object with the class name, the member name, the signature of the missing member, and additional exception information.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.MissingMemberException.Message

Gets the text string showing the class name, the member name, and the signature of the missing member.

Returns

The error message string.

System.MissingMethodException

The exception that is thrown when there is an attempt to dynamically access a method that does not exist.

System.MissingMethodException.#ctor

Initializes a new instance of the System.MissingMethodException class.

System.MissingMethodException.#ctor()

Initializes a new instance of the System.MissingMethodException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.MissingMethodException.#ctor()

Initializes a new instance of the System.MissingMethodException class with a specified error message.

Parameters

NameDescriptionDefault
message A System.String that describes the error.

System.MissingMethodException.#ctor()

Initializes a new instance of the System.MissingMethodException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
inner The exception that is the cause of the current exception. If the inner parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.MissingMethodException.#ctor()

Initializes a new instance of the System.MissingMethodException class with the specified class name and method name.

Parameters

NameDescriptionDefault
className The name of the class in which access to a nonexistent method was attempted.
methodName The name of the method that cannot be accessed.

System.MissingMethodException.Message

Gets the text string showing the class name, the method name, and the signature of the missing method. This property is read-only.

Returns

The error message string.

System.ModuleHandle

Represents a runtime handle for a module.

System.ModuleHandle.EmptyHandle

Represents an empty module handle.

System.ModuleHandle.Equals()

Returns a System.Boolean value indicating whether the specified System.ModuleHandle structure is equal to the current System.ModuleHandle.

Parameters

NameDescriptionDefault
handle The System.ModuleHandle structure to be compared with the current System.ModuleHandle.

Returns

true if handle is equal to the current System.ModuleHandle structure; otherwise false.

System.ModuleHandle.Equals()

Returns a System.Boolean value indicating whether the specified object is a System.ModuleHandle structure, and equal to the current System.ModuleHandle.

Parameters

NameDescriptionDefault
obj The object to be compared with the current System.ModuleHandle structure.

Returns

true if obj is a System.ModuleHandle structure, and is equal to the current System.ModuleHandle structure; otherwise, false.

System.ModuleHandle.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer that is the hash code for this instance.

System.ModuleHandle.GetRuntimeFieldHandleFromMetadataToken()

Returns a runtime handle for the field identified by the specified metadata token.

Parameters

NameDescriptionDefault
fieldToken A metadata token that identifies a field in the module.

Returns

A System.RuntimeFieldHandle for the field identified by fieldToken.

System.ModuleHandle.GetRuntimeMethodHandleFromMetadataToken()

Returns a runtime method handle for the method or constructor identified by the specified metadata token.

Parameters

NameDescriptionDefault
methodToken A metadata token that identifies a method or constructor in the module.

Returns

A System.RuntimeMethodHandle for the method or constructor identified by methodToken.

System.ModuleHandle.GetRuntimeTypeHandleFromMetadataToken()

Returns a runtime type handle for the type identified by the specified metadata token.

Parameters

NameDescriptionDefault
typeToken A metadata token that identifies a type in the module.

Returns

A System.RuntimeTypeHandle for the type identified by typeToken.

System.ModuleHandle.op_Equality()

Tests whether two System.ModuleHandle structures are equal.

Parameters

NameDescriptionDefault
left The System.ModuleHandle structure to the left of the equality operator.
right The System.ModuleHandle structure to the right of the equality operator.

Returns

true if the System.ModuleHandle structures are equal; otherwise, false.

System.ModuleHandle.op_Inequality()

Tests whether two System.ModuleHandle structures are unequal.

Parameters

NameDescriptionDefault
left The System.ModuleHandle structure to the left of the inequality operator.
right The System.ModuleHandle structure to the right of the inequality operator.

Returns

true if the System.ModuleHandle structures are unequal; otherwise, false.

System.ModuleHandle.ResolveFieldHandle()

Returns a runtime handle for the field identified by the specified metadata token.

Parameters

NameDescriptionDefault
fieldToken A metadata token that identifies a field in the module.

Returns

A System.RuntimeFieldHandle for the field identified by fieldToken.

System.ModuleHandle.ResolveFieldHandle()

Returns a runtime field handle for the field identified by the specified metadata token, specifying the generic type arguments of the type and method where the token is in scope.

Parameters

NameDescriptionDefault
fieldToken A metadata token that identifies a field in the module.
typeInstantiationContext An array of System.RuntimeTypeHandle structures representing the generic type arguments of the type where the token is in scope, or null if that type is not generic.
methodInstantiationContext An array of System.RuntimeTypeHandle structures representing the generic type arguments of the method where the token is in scope, or null if that method is not generic.

Returns

A System.RuntimeFieldHandle for the field identified by fieldToken.

System.ModuleHandle.ResolveMethodHandle()

Returns a runtime method handle for the method or constructor identified by the specified metadata token.

Parameters

NameDescriptionDefault
methodToken A metadata token that identifies a method or constructor in the module.

Returns

A System.RuntimeMethodHandle for the method or constructor identified by methodToken.

System.ModuleHandle.ResolveMethodHandle()

Returns a runtime method handle for the method or constructor identified by the specified metadata token, specifying the generic type arguments of the type and method where the token is in scope.

Parameters

NameDescriptionDefault
methodToken A metadata token that identifies a method or constructor in the module.
typeInstantiationContext An array of System.RuntimeTypeHandle structures representing the generic type arguments of the type where the token is in scope, or null if that type is not generic.
methodInstantiationContext An array of System.RuntimeTypeHandle structures representing the generic type arguments of the method where the token is in scope, or null if that method is not generic.

Returns

A System.RuntimeMethodHandle for the method or constructor identified by methodToken.

System.ModuleHandle.ResolveTypeHandle()

Returns a runtime type handle for the type identified by the specified metadata token.

Parameters

NameDescriptionDefault
typeToken A metadata token that identifies a type in the module.

Returns

A System.RuntimeTypeHandle for the type identified by typeToken.

System.ModuleHandle.ResolveTypeHandle()

Returns a runtime type handle for the type identified by the specified metadata token, specifying the generic type arguments of the type and method where the token is in scope.

Parameters

NameDescriptionDefault
typeToken A metadata token that identifies a type in the module.
typeInstantiationContext An array of System.RuntimeTypeHandle structures representing the generic type arguments of the type where the token is in scope, or null if that type is not generic.
methodInstantiationContext An array of System.RuntimeTypeHandle structures objects representing the generic type arguments of the method where the token is in scope, or null if that method is not generic.

Returns

A System.RuntimeTypeHandle for the type identified by typeToken.

System.ModuleHandle.MDStreamVersion

Gets the metadata stream version.

Returns

A 32-bit integer representing the metadata stream version. The high-order two bytes represent the major version number, and the low-order two bytes represent the minor version number.

System.MTAThreadAttribute

Indicates that the COM threading model for an application is multithreaded apartment (MTA).

System.MTAThreadAttribute.#ctor

Initializes a new instance of the System.MTAThreadAttribute class.

System.MulticastDelegate

Represents a multicast delegate; that is, a delegate that can have more than one element in its invocation list.

System.MulticastDelegate.#ctor()

Initializes a new instance of the System.MulticastDelegate class.

Parameters

NameDescriptionDefault
target The object on which method is defined.
method The name of the method for which a delegate is created.

System.MulticastDelegate.#ctor()

Initializes a new instance of the System.MulticastDelegate class.

Parameters

NameDescriptionDefault
target The type of object on which method is defined.
method The name of the static method for which a delegate is created.

System.MulticastDelegate.CombineImpl()

Combines this System.Delegate with the specified System.Delegate to form a new delegate.

Parameters

NameDescriptionDefault
follow The delegate to combine with this delegate.

Returns

A delegate that is the new root of the System.MulticastDelegate invocation list.

System.MulticastDelegate.Equals()

Determines whether this multicast delegate and the specified object are equal.

Parameters

NameDescriptionDefault
obj The object to compare with this instance.

Returns

true if obj and this instance have the same invocation lists; otherwise, false.

System.MulticastDelegate.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.MulticastDelegate.GetInvocationList

Returns the invocation list of this multicast delegate, in invocation order.

Returns

An array of delegates whose invocation lists collectively match the invocation list of this instance.

System.MulticastDelegate.GetMethodImpl

Returns a method represented by the current System.MulticastDelegate.

Returns

A method represented by the current System.MulticastDelegate.

System.MulticastDelegate.GetObjectData()

Populates a System.Runtime.Serialization.SerializationInfo object with all the data needed to serialize this instance.

Parameters

NameDescriptionDefault
info An object that holds all the data needed to serialize or deserialize this instance.
context (Reserved) The location where serialized data is stored and retrieved.

System.MulticastDelegate.op_Equality()

Determines whether two System.MulticastDelegate objects are equal.

Parameters

NameDescriptionDefault
d1 The left operand.
d2 The right operand.

Returns

true if d1 and d2 have the same invocation lists; otherwise, false.

System.MulticastDelegate.op_Inequality()

Determines whether two System.MulticastDelegate objects are not equal.

Parameters

NameDescriptionDefault
d1 The left operand.
d2 The right operand.

Returns

true if d1 and d2 do not have the same invocation lists; otherwise, false.

System.MulticastDelegate.RemoveImpl()

Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate.

Parameters

NameDescriptionDefault
value The delegate to search for in the invocation list.

Returns

If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list.

System.MulticastNotSupportedException

The exception that is thrown when there is an attempt to combine two delegates based on the System.Delegate type instead of the System.MulticastDelegate type. This class cannot be inherited.

System.MulticastNotSupportedException.#ctor

Initializes a new instance of the System.MulticastNotSupportedException class.

System.MulticastNotSupportedException.#ctor()

Initializes a new instance of the System.MulticastNotSupportedException class with a specified error message.

Parameters

NameDescriptionDefault
message The message that describes the error.

System.MulticastNotSupportedException.#ctor()

Initializes a new instance of the System.MulticastNotSupportedException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
inner The exception that is the cause of the current exception. If the inner parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.Net.WebUtility

Provides methods for encoding and decoding URLs when processing Web requests.

System.Net.WebUtility.HtmlDecode()

Converts a string that has been HTML-encoded for HTTP transmission into a decoded string.

Parameters

NameDescriptionDefault
value The string to decode.

Returns

A decoded string.

System.Net.WebUtility.HtmlDecode()

Converts a string that has been HTML-encoded into a decoded string, and sends the decoded string to a System.IO.TextWriter output stream.

Parameters

NameDescriptionDefault
value The string to decode.
output A System.IO.TextWriter stream of output.

System.Net.WebUtility.HtmlEncode()

Converts a string to an HTML-encoded string.

Parameters

NameDescriptionDefault
value The string to encode.

Returns

An encoded string.

System.Net.WebUtility.HtmlEncode()

Converts a string into an HTML-encoded string, and returns the output as a System.IO.TextWriter stream of output.

Parameters

NameDescriptionDefault
value The string to encode.
output A System.IO.TextWriter output stream.

System.Net.WebUtility.UrlDecode()

Converts a string that has been encoded for transmission in a URL into a decoded string.

Parameters

NameDescriptionDefault
encodedValue A URL-encoded string to decode.

Returns

A decoded string.

System.Net.WebUtility.UrlDecodeToBytes()

Converts an encoded byte array that has been encoded for transmission in a URL into a decoded byte array.

Parameters

NameDescriptionDefault
encodedValue A URL-encoded System.Byte array to decode.
offset The offset, in bytes, from the start of the System.Byte array to decode.
count The count, in bytes, to decode from the System.Byte array.

Returns

A decoded System.Byte array.

System.Net.WebUtility.UrlEncode()

Converts a text string into a URL-encoded string.

Parameters

NameDescriptionDefault
value The text to URL-encode.

Returns

A URL-encoded string.

System.Net.WebUtility.UrlEncodeToBytes()

Converts a byte array into a URL-encoded byte array.

Parameters

NameDescriptionDefault
value The System.Byte array to URL-encode.
offset The offset, in bytes, from the start of the System.Byte array to encode.
count The count, in bytes, to encode from the System.Byte array.

Returns

An encoded System.Byte array.

System.NetPipeStyleUriParser

A parser based on the NetPipe scheme for the "Indigo" system.

System.NetPipeStyleUriParser.#ctor

Create a parser based on the NetPipe scheme for the "Indigo" system.

System.NetTcpStyleUriParser

A parser based on the NetTcp scheme for the "Indigo" system.

System.NetTcpStyleUriParser.#ctor

Create a parser based on the NetTcp scheme for the "Indigo" system.

System.NewsStyleUriParser

A customizable parser based on the news scheme using the Network News Transfer Protocol (NNTP).

System.NewsStyleUriParser.#ctor

Create a customizable parser based on the news scheme using the Network News Transfer Protocol (NNTP).

System.NonSerializedAttribute

Indicates that a field of a serializable class should not be serialized. This class cannot be inherited.

System.NonSerializedAttribute.#ctor

Initializes a new instance of the System.NonSerializedAttribute class.

System.NotFiniteNumberException

The exception that is thrown when a floating-point value is positive infinity, negative infinity, or Not-a-Number (NaN).

System.NotFiniteNumberException.#ctor

Initializes a new instance of the System.NotFiniteNumberException class.

System.NotFiniteNumberException.#ctor()

Initializes a new instance of the System.NotFiniteNumberException class with the invalid number.

Parameters

NameDescriptionDefault
offendingNumber The value of the argument that caused the exception.

System.NotFiniteNumberException.#ctor()

Initializes a new instance of the System.NotFiniteNumberException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.NotFiniteNumberException.#ctor()

Initializes a new instance of the System.NotFiniteNumberException class with a specified error message.

Parameters

NameDescriptionDefault
message The message that describes the error.

System.NotFiniteNumberException.#ctor()

Initializes a new instance of the System.NotFiniteNumberException class with a specified error message and the invalid number.

Parameters

NameDescriptionDefault
message The message that describes the error.
offendingNumber The value of the argument that caused the exception.

System.NotFiniteNumberException.#ctor()

Initializes a new instance of the System.NotFiniteNumberException class with a specified error message, the invalid number, and a reference to the inner exception that is root cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
offendingNumber The value of the argument that caused the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.NotFiniteNumberException.#ctor()

Initializes a new instance of the System.NotFiniteNumberException class with a specified error message and a reference to the inner exception that is root cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.NotFiniteNumberException.GetObjectData()

Sets the System.Runtime.Serialization.SerializationInfo object with the invalid number and additional exception information.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.NotFiniteNumberException.OffendingNumber

Gets the invalid number that is a positive infinity, a negative infinity, or Not-a-Number (NaN).

Returns

The invalid number.

System.NotImplementedException

The exception that is thrown when a requested method or operation is not implemented.

System.NotImplementedException.#ctor

Initializes a new instance of the System.NotImplementedException class with default properties.

System.NotImplementedException.#ctor()

Initializes a new instance of the System.NotImplementedException class with serialized data.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.NotImplementedException.#ctor()

Initializes a new instance of the System.NotImplementedException class with a specified error message.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.

System.NotImplementedException.#ctor()

Initializes a new instance of the System.NotImplementedException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
inner The exception that is the cause of the current exception. If the inner parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.NotSupportedException

The exception that is thrown when an invoked method is not supported, or when there is an attempt to read, seek, or write to a stream that does not support the invoked functionality.

System.NotSupportedException.#ctor

Initializes a new instance of the System.NotSupportedException class, setting the System.Exception.Message property of the new instance to a system-supplied message that describes the error. This message takes into account the current system culture.

System.NotSupportedException.#ctor()

Initializes a new instance of the System.NotSupportedException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.NotSupportedException.#ctor()

Initializes a new instance of the System.NotSupportedException class with a specified error message.

Parameters

NameDescriptionDefault
message A System.String that describes the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.

System.NotSupportedException.#ctor()

Initializes a new instance of the System.NotSupportedException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.

System.Nullable

Supports a value type that can be assigned null. This class cannot be inherited.

System.Nullable.Compare``1()

Compares the relative values of two System.Nullable`1 objects.

Parameters

NameDescriptionDefault
n1 A System.Nullable`1 object.
n2 A System.Nullable`1 object.

Returns

An integer that indicates the relative values of the n1 and n2 parameters. Return Value Description Less than zero The System.Nullable`1.HasValue property for n1 is false, and the System.Nullable`1.HasValue property for n2 is true, or the System.Nullable`1.HasValue properties for n1 and n2 are true, and the value of the System.Nullable`1.Value property for n1 is less than the value of the System.Nullable`1.Value property for n2. Zero The System.Nullable`1.HasValue properties for n1 and n2 are false, or the System.Nullable`1.HasValue properties for n1 and n2 are true, and the value of the System.Nullable`1.Value property for n1 is equal to the value of the System.Nullable`1.Value property for n2. Greater than zero The System.Nullable`1.HasValue property for n1 is true, and the System.Nullable`1.HasValue property for n2 is false, or the System.Nullable`1.HasValue properties for n1 and n2 are true, and the value of the System.Nullable`1.Value property for n1 is greater than the value of the System.Nullable`1.Value property for n2.

System.Nullable.Equals``1()

Indicates whether two specified System.Nullable`1 objects are equal.

Parameters

NameDescriptionDefault
n1 A System.Nullable`1 object.
n2 A System.Nullable`1 object.

Returns

true if the n1 parameter is equal to the n2 parameter; otherwise, false. The return value depends on the System.Nullable`1.HasValue and System.Nullable`1.Value properties of the two parameters that are compared. Return Value Descriptiontrue The System.Nullable`1.HasValue properties for n1 and n2 are false, or the System.Nullable`1.HasValue properties for n1 and n2 are true, and the System.Nullable`1.Value properties of the parameters are equal.false The System.Nullable`1.HasValue property is true for one parameter and false for the other parameter, or the System.Nullable`1.HasValue properties for n1 and n2 are true, and the System.Nullable`1.Value properties of the parameters are unequal.

System.Nullable.GetUnderlyingType()

Returns the underlying type argument of the specified nullable type.

Parameters

NameDescriptionDefault
nullableType A System.Type object that describes a closed generic nullable type.

Returns

The type argument of the nullableType parameter, if the nullableType parameter is a closed generic nullable type; otherwise, null.

System.Nullable.GetValueRefOrDefaultRef``1()

Retrieves a readonly reference to the location in the System.Nullable`1 instance where the value is stored.

Parameters

NameDescriptionDefault
nullable The readonly reference to the input System.Nullable`1 value.

Returns

A readonly reference to the location where the instance's value is stored. If the instance's System.Nullable`1.HasValue is false, the current value at that location may be the default value.

System.Nullable`1

Represents a value type that can be assigned null.

System.Nullable`1.#ctor()

Initializes a new instance of the System.Nullable`1 structure to the specified value.

Parameters

NameDescriptionDefault
value A value type.

System.Nullable`1.Equals()

Indicates whether the current System.Nullable`1 object is equal to a specified object.

Parameters

NameDescriptionDefault
other An object.

Returns

true if the other parameter is equal to the current System.Nullable`1 object; otherwise, false. This table describes how equality is defined for the compared values: Return Value Descriptiontrue The System.Nullable`1.HasValue property is false, and the other parameter is null (that is, two null values are equal by definition), OR the System.Nullable`1.HasValue property is true, and the value returned by the System.Nullable`1.Value property is equal to the other parameter.false The System.Nullable`1.HasValue property for the current System.Nullable`1 structure is true, and the other parameter is null, OR the System.Nullable`1.HasValue property for the current System.Nullable`1 structure is false, and the other parameter is not null, OR the System.Nullable`1.HasValue property for the current System.Nullable`1 structure is true, and the value returned by the System.Nullable`1.Value property is not equal to the other parameter.

System.Nullable`1.GetHashCode

Retrieves the hash code of the object returned by the System.Nullable`1.Value property.

Returns

The hash code of the object returned by the System.Nullable`1.Value property if the System.Nullable`1.HasValue property is true, or zero if the System.Nullable`1.HasValue property is false.

System.Nullable`1.GetValueOrDefault

Retrieves the value of the current System.Nullable`1 object, or the default value of the underlying type.

Returns

The value of the System.Nullable`1.Value property if the System.Nullable`1.HasValue property is true; otherwise, the default value of the underlying type.

System.Nullable`1.GetValueOrDefault()

Retrieves the value of the current System.Nullable`1 object, or the specified default value.

Parameters

NameDescriptionDefault
defaultValue A value to return if the System.Nullable`1.HasValue property is false.

Returns

The value of the System.Nullable`1.Value property if the System.Nullable`1.HasValue property is true; otherwise, the defaultValue parameter.

System.Nullable`1.op_Explicit()

Defines an explicit conversion of a System.Nullable`1 instance to its underlying value.

Parameters

NameDescriptionDefault
value A nullable value.

Returns

The value of the System.Nullable`1.Value property for the value parameter.

System.Nullable`1.op_Implicit()

Creates a new System.Nullable`1 object initialized to a specified value.

Parameters

NameDescriptionDefault
value A value type.

Returns

A System.Nullable`1 object whose System.Nullable`1.Value property is initialized with the value parameter.

System.Nullable`1.ToString

Returns the text representation of the value of the current System.Nullable`1 object.

Returns

The text representation of the value of the current System.Nullable`1 object if the System.Nullable`1.HasValue property is true, or an empty string ("") if the System.Nullable`1.HasValue property is false.

System.Nullable`1.HasValue

Gets a value indicating whether the current System.Nullable`1 object has a valid value of its underlying type.

Returns

true if the current System.Nullable`1 object has a value; false if the current System.Nullable`1 object has no value.

System.Nullable`1.Value

Gets the value of the current System.Nullable`1 object if it has been assigned a valid underlying value.

Returns

The value of the current System.Nullable`1 object if the System.Nullable`1.HasValue property is true. An exception is thrown if the System.Nullable`1.HasValue property is false.

System.NullReferenceException

The exception that is thrown when there is an attempt to dereference a null object reference.

System.NullReferenceException.#ctor

Initializes a new instance of the System.NullReferenceException class, setting the System.Exception.Message property of the new instance to a system-supplied message that describes the error, such as "The value 'null' was found where an instance of an object was required." This message takes into account the current system culture.

System.NullReferenceException.#ctor()

Initializes a new instance of the System.NullReferenceException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.NullReferenceException.#ctor()

Initializes a new instance of the System.NullReferenceException class with a specified error message.

Parameters

NameDescriptionDefault
message A System.String that describes the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.

System.NullReferenceException.#ctor()

Initializes a new instance of the System.NullReferenceException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.Numerics.BitOperations

Provides utility methods for intrinsic bit-twiddling operations. The methods use hardware intrinsics when available on the underlying platform; otherwise, they use optimized software fallbacks.

System.Numerics.BitOperations.Crc32C()

Accumulates the CRC (Cyclic redundancy check) checksum.

Parameters

NameDescriptionDefault
crc The base value to calculate checksum on.
data The data for which to compute the checksum.

Returns

The CRC-checksum.

System.Numerics.BitOperations.Crc32C()

Accumulates the CRC (Cyclic redundancy check) checksum.

Parameters

NameDescriptionDefault
crc The base value to calculate checksum on.
data The data for which to compute the checksum.

Returns

The CRC-checksum.

System.Numerics.BitOperations.Crc32C()

Accumulates the CRC (Cyclic redundancy check) checksum.

Parameters

NameDescriptionDefault
crc The base value to calculate checksum on.
data The data for which to compute the checksum.

Returns

The CRC-checksum.

System.Numerics.BitOperations.Crc32C()

Accumulates the CRC (Cyclic redundancy check) checksum.

Parameters

NameDescriptionDefault
crc The base value to calculate checksum on.
data The data for which to compute the checksum.

Returns

The CRC-checksum.

System.Numerics.BitOperations.IsPow2()

Evaluates whether the specified System.Int32 value is a power of two.

Parameters

NameDescriptionDefault
value The value to evaluate as being a power of two.

Returns

true if the specified value is a power of two; false otherwise.

System.Numerics.BitOperations.IsPow2()

Evaluates whether the specified System.Int64 value is a power of two.

Parameters

NameDescriptionDefault
value The value to evaluate as being a power of two.

Returns

true if the specified value is a power of two; false otherwise.

System.Numerics.BitOperations.IsPow2()

Determines whether the specified integral value is a power of 2.

Parameters

NameDescriptionDefault
value The value.

Returns

true if the value is a power of 2; false otherwise.

System.Numerics.BitOperations.IsPow2()

Evaluates whether the specified System.UInt32 value is a power of two.

Parameters

NameDescriptionDefault
value The value to evaluate as being a power of two.

Returns

true if the specified value is a power of two; false otherwise.

System.Numerics.BitOperations.IsPow2()

Evaluates whether the specified System.UInt64 value is a power of two.

Parameters

NameDescriptionDefault
value The value to evaluate as being a power of two.

Returns

true if the specified value is a power of two; false otherwise.

System.Numerics.BitOperations.IsPow2()

Determines whether the specified integral value is a power of 2.

Parameters

NameDescriptionDefault
value The value.

Returns

true if the value is a power of 2; false otherwise.

System.Numerics.BitOperations.LeadingZeroCount()

Counts the number of leading zero bits in an unsigned 32-bit integer mask.

Parameters

NameDescriptionDefault
value The mask.

Returns

The number of leading zero bits in a mask.

System.Numerics.BitOperations.LeadingZeroCount()

Counts the number of leading zero bits in an unsigned 64-bit integer mask.

Parameters

NameDescriptionDefault
value The mask.

Returns

The number of leading zero bits in a mask.

System.Numerics.BitOperations.LeadingZeroCount()

Counts the number of leading zero bits in a mask. Similar in behavior to the x86 instruction LZCNT.

Parameters

NameDescriptionDefault
value The value.

Returns

The count of leading zeros bits in a mask.

System.Numerics.BitOperations.Log2()

Returns the integer (floor) log of the specified value, base 2.

Parameters

NameDescriptionDefault
value The number from which to obtain the logarithm.

Returns

The log of the specified value, base 2.

System.Numerics.BitOperations.Log2()

Returns the integer (floor) log of the specified value, base 2.

Parameters

NameDescriptionDefault
value The number from which to obtain the logarithm.

Returns

The log of the specified value, base 2.

System.Numerics.BitOperations.Log2()

Returns the integer (floor) log of the specified value, base 2.

Parameters

NameDescriptionDefault
value The value.

Returns

The logarithm value.

System.Numerics.BitOperations.PopCount()

Returns the population count (number of bits set) of a mask.

Parameters

NameDescriptionDefault
value The mask.

Returns

The population count of a mask.

System.Numerics.BitOperations.PopCount()

Returns the population count (number of bits set) of an unsigned 64-bit integer mask.

Parameters

NameDescriptionDefault
value The mask.

Returns

The population count of the mask.

System.Numerics.BitOperations.PopCount()

Returns the population count (number of bits set) of a mask. Similar in behavior to the x86 instruction POPCNT.

Parameters

NameDescriptionDefault
value The value.

Returns

The population count.

System.Numerics.BitOperations.RotateLeft()

Rotates the specified value left by the specified number of bits.

Parameters

NameDescriptionDefault
value The value to rotate.
offset The number of bits to rotate by. Any value outside the range [0..31] is treated as congruent mod 32.

Returns

The rotated value.

System.Numerics.BitOperations.RotateLeft()

Rotates the specified value left by the specified number of bits.

Parameters

NameDescriptionDefault
value The value to rotate.
offset The number of bits to rotate by. Any value outside the range [0..63] is treated as congruent mod 64.

Returns

The rotated value.

System.Numerics.BitOperations.RotateLeft()

Rotates the specified value left by the specified number of bits. Similar in behavior to the x86 instruction ROL.

Parameters

NameDescriptionDefault
value The value to rotate.
offset The number of bits to rotate by. Any value outside the range [0..31] is treated as congruent mod 32 on a 32-bit process, and any value outside the range [0..63] is treated as congruent mod 64 on a 64-bit process.

Returns

The rotated value.

System.Numerics.BitOperations.RotateRight()

Rotates the specified value right by the specified number of bits.

Parameters

NameDescriptionDefault
value The value to rotate.
offset The number of bits to rotate by. Any value outside the range [0..31] is treated as congruent mod 32.

Returns

The rotated value.

System.Numerics.BitOperations.RotateRight()

Rotates the specified value right by the specified number of bits.

Parameters

NameDescriptionDefault
value The value to rotate.
offset The number of bits to rotate by. Any value outside the range [0..63] is treated as congruent mod 64.

Returns

The rotated value.

System.Numerics.BitOperations.RotateRight()

Rotates the specified value right by the specified number of bits. Similar in behavior to the x86 instruction ROR.

Parameters

NameDescriptionDefault
value The value to rotate.
offset The number of bits to rotate by. Any value outside the range [0..31] is treated as congruent mod 32 on a 32-bit process, and any value outside the range [0..63] is treated as congruent mod 64 on a 64-bit process.

Returns

The rotated value.

System.Numerics.BitOperations.RoundUpToPowerOf2()

Rounds the specified System.UInt32 value up to a power of two.

Parameters

NameDescriptionDefault
value The value to round up to a power of two.

Returns

The smallest power of two that's greater than or equal to value. If value is 0 or the result overflows, returns 0.

System.Numerics.BitOperations.RoundUpToPowerOf2()

Rounds the specified System.UInt64 value up to a power of two.

Parameters

NameDescriptionDefault
value The value to round up to a power of two.

Returns

The smallest power of two that's greater than or equal to value. If value is 0 or the result overflows, returns 0.

System.Numerics.BitOperations.RoundUpToPowerOf2()

Rounds the given integral value up to a power of 2.

Parameters

NameDescriptionDefault
value The value.

Returns

The smallest power of 2 which is greater than or equal to value. If value is 0 or the result overflows, returns 0.

System.Numerics.BitOperations.TrailingZeroCount()

Counts the number of trailing zero bits in an 32-bit integer value mask.

Parameters

NameDescriptionDefault
value The mask.

Returns

The number of trailing zero bits in the integer value.

System.Numerics.BitOperations.TrailingZeroCount()

Counts the number of trailing zero bits in a 64-bit integer value mask.

Parameters

NameDescriptionDefault
value The mask.

Returns

The number of trailing zero bits in the mask.

System.Numerics.BitOperations.TrailingZeroCount()

Counts the number of trailing zero bits in a mask. Similar in behavior to the x86 instruction TZCNT.

Parameters

NameDescriptionDefault
value The value.

Returns

The count of trailing zero bits in a mask.

System.Numerics.BitOperations.TrailingZeroCount()

Counts the number of trailing zero bits in an unsigned 32-bit integer value mask.

Parameters

NameDescriptionDefault
value The mask.

Returns

The number of trailing zero bits in the mask.

System.Numerics.BitOperations.TrailingZeroCount()

Count the number of trailing zero bits in an unsigned 64-bit integer value mask.

Parameters

NameDescriptionDefault
value The mask.

Returns

The number of trailing zero bits in the mask.

System.Numerics.BitOperations.TrailingZeroCount()

Counts the number of trailing zero bits in a mask. Similar in behavior to the x86 instruction TZCNT.

Parameters

NameDescriptionDefault
value The value.

Returns

The count of trailing zero bits in a mask.

System.Numerics.IAdditionOperators`3

Defines a mechanism for computing the sum of two values.

System.Numerics.IAdditionOperators`3.op_Addition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which right is added.
right The value which is added to left.

Returns

The sum of left and right.

System.Numerics.IAdditionOperators`3.op_CheckedAddition()

Adds two values together to compute their sum.

Parameters

NameDescriptionDefault
left The value to which right is added.
right The value which is added to left.

Returns

The sum of left and right.

System.Numerics.IAdditiveIdentity`2

Defines a mechanism for getting the additive identity of a given type.

System.Numerics.IAdditiveIdentity`2.AdditiveIdentity

Gets the additive identity of the current type.

System.Numerics.IBinaryFloatingPointIeee754`1

Defines an IEEE 754 floating-point type that is represented in a base-2 format.

System.Numerics.IBinaryInteger`1

Defines an integer type that is represented in a base-2 format.

System.Numerics.IBinaryInteger`1.DivRem()

Computes the quotient and remainder of two values.

Parameters

NameDescriptionDefault
left The value which right divides.
right The value which divides left.

Returns

The quotient and remainder of left divided by right.

System.Numerics.IBinaryInteger`1.GetByteCount

Gets the number of bytes that will be written as part of System.Numerics.IBinaryInteger`1.TryWriteLittleEndian().

Returns

The number of bytes that will be written as part of System.Numerics.IBinaryInteger`1.TryWriteLittleEndian().

System.Numerics.IBinaryInteger`1.GetShortestBitLength

Gets the length, in bits, of the shortest two's complement representation of the current value.

Returns

The length, in bits, of the shortest two's complement representation of the current value.

System.Numerics.IBinaryInteger`1.LeadingZeroCount()

Computes the number of leading zero bits in a value.

Parameters

NameDescriptionDefault
value The value whose leading zero bits are to be counted.

Returns

The number of leading zero bits in value.

System.Numerics.IBinaryInteger`1.PopCount()

Computes the number of bits that are set in a value.

Parameters

NameDescriptionDefault
value The value whose set bits are to be counted.

Returns

The number of set bits in value.

System.Numerics.IBinaryInteger`1.ReadBigEndian()

Reads a two's complement number from a given array, in big-endian format, and converts it to an instance of the current type.

Parameters

NameDescriptionDefault
source The array from which the two's complement number should be read.
isUnsigned true if source represents an unsigned two's complement number; otherwise, false to indicate it represents a signed two's complement number.

Returns

The value read from source.

System.Numerics.IBinaryInteger`1.ReadBigEndian()

Reads a two's complement number from a given array, in big-endian format, and converts it to an instance of the current type.

Parameters

NameDescriptionDefault
source The array from which the two's complement number should be read.
startIndex The starting index from which the value should be read.
isUnsigned true if source represents an unsigned two's complement number; otherwise, false to indicate it represents a signed two's complement number.

Returns

The value read from source starting at startIndex.

System.Numerics.IBinaryInteger`1.ReadBigEndian()

Reads a two's complement number from a given span, in big-endian format, and converts it to an instance of the current type.

Parameters

NameDescriptionDefault
source The array from which the two's complement number should be read.
isUnsigned true if source represents an unsigned two's complement number; otherwise, false to indicate it represents a signed two's complement number.

Returns

The value read from source.

System.Numerics.IBinaryInteger`1.ReadLittleEndian()

Reads a two's complement number from a given array, in little-endian format, and converts it to an instance of the current type.

Parameters

NameDescriptionDefault
source The array from which the two's complement number should be read.
isUnsigned true if source represents an unsigned two's complement number; otherwise, false to indicate it represents a signed two's complement number.

Returns

The value read from source.

System.Numerics.IBinaryInteger`1.ReadLittleEndian()

Reads a two's complement number from a given array, in little-endian format, and converts it to an instance of the current type.

Parameters

NameDescriptionDefault
source The array from which the two's complement number should be read.
startIndex The starting index from which the value should be read.
isUnsigned true if source represents an unsigned two's complement number; otherwise, false to indicate it represents a signed two's complement number.

Returns

The value read from source starting at startIndex.

System.Numerics.IBinaryInteger`1.ReadLittleEndian()

Reads a two's complement number from a given span, in little-endian format, and converts it to an instance of the current type.

Parameters

NameDescriptionDefault
source The array from which the two's complement number should be read.
isUnsigned true if source represents an unsigned two's complement number; otherwise, false to indicate it represents a signed two's complement number.

Returns

The value read from source.

System.Numerics.IBinaryInteger`1.RotateLeft()

Rotates a value left by a given amount.

Parameters

NameDescriptionDefault
value The value which is rotated left by rotateAmount.
rotateAmount The amount by which value is rotated left.

Returns

The result of rotating value left by rotateAmount.

System.Numerics.IBinaryInteger`1.RotateRight()

Rotates a value right by a given amount.

Parameters

NameDescriptionDefault
value The value which is rotated right by rotateAmount.
rotateAmount The amount by which value is rotated right.

Returns

The result of rotating value right by rotateAmount.

System.Numerics.IBinaryInteger`1.TrailingZeroCount()

Computes the number of trailing zero bits in a value.

Parameters

NameDescriptionDefault
value The value whose trailing zero bits are to be counted.

Returns

The number of trailing zero bits in value.

System.Numerics.IBinaryInteger`1.TryReadBigEndian()

Tries to read a two's complement number from a span, in big-endian format, and convert it to an instance of the current type.

Parameters

NameDescriptionDefault
source The span from which the two's complement number should be read.
isUnsigned true if source represents an unsigned two's complement number; otherwise, false to indicate it represents a signed two's complement number.
value On return, contains the value read from source or default if a value could not be read.

Returns

true if the value was succesfully read from source; otherwise, false.

System.Numerics.IBinaryInteger`1.TryReadLittleEndian()

Tries to read a two's complement number from a span, in little-endian format, and convert it to an instance of the current type.

Parameters

NameDescriptionDefault
source The span from which the two's complement number should be read.
isUnsigned true if source represents an unsigned two's complement number; otherwise, false to indicate it represents a signed two's complement number.
value On return, contains the value read from source or default if a value could not be read.

Returns

true if the value was succesfully read from source; otherwise, false.

System.Numerics.IBinaryInteger`1.TryWriteBigEndian()

Tries to write the current value, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.
bytesWritten When this method returns, contains the number of bytes written to destination.

Returns

true if the value was succesfully written to destination; otherwise, false.

System.Numerics.IBinaryInteger`1.TryWriteLittleEndian()

Tries to write the current value, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.
bytesWritten When this method returns, contains the number of bytes written to destination.

Returns

true if the value was succesfully written to destination; otherwise, false.

System.Numerics.IBinaryInteger`1.WriteBigEndian()

Writes the current value, in big-endian format, to a given array.

Parameters

NameDescriptionDefault
destination The array to which the current value should be written.

Returns

The number of bytes written to destination.

System.Numerics.IBinaryInteger`1.WriteBigEndian()

Writes the current value, in big-endian format, to a given array.

Parameters

NameDescriptionDefault
destination The array to which the current value should be written.
startIndex The starting index at which the value should be written.

Returns

The number of bytes written to destination starting at startIndex.

System.Numerics.IBinaryInteger`1.WriteBigEndian()

Writes the current value, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.

Returns

The number of bytes written to destination.

System.Numerics.IBinaryInteger`1.WriteLittleEndian()

Writes the current value, in little-endian format, to a given array.

Parameters

NameDescriptionDefault
destination The array to which the current value should be written.

Returns

The number of bytes written to destination.

System.Numerics.IBinaryInteger`1.WriteLittleEndian()

Writes the current value, in little-endian format, to a specified array starting at a specified index.

Parameters

NameDescriptionDefault
destination The array to which the current value should be written.
startIndex The starting index at which the value should be written.

Returns

The number of bytes written to destination starting at startIndex.

System.Numerics.IBinaryInteger`1.WriteLittleEndian()

Writes the current value, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current value should be written.

Returns

The number of bytes written to destination.

System.Numerics.IBinaryNumber`1

Defines a number that is represented in a base-2 format.

System.Numerics.IBinaryNumber`1.IsPow2()

Determines if a value is a power of two.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a power of two; otherwise, false.

System.Numerics.IBinaryNumber`1.Log2()

Computes the log2 of a value.

Parameters

NameDescriptionDefault
value The value whose log2 is to be computed.

Returns

The log2 of value.

System.Numerics.IBinaryNumber`1.AllBitsSet

Gets an instance of the binary type in which all bits are set.

System.Numerics.IBitwiseOperators`3

Defines a mechanism for performing bitwise operations over two values.

System.Numerics.IBitwiseOperators`3.op_BitwiseAnd()

Computes the bitwise-and of two values.

Parameters

NameDescriptionDefault
left The value to and with right.
right The value to and with left.

Returns

The bitwise-and of left and right.

System.Numerics.IBitwiseOperators`3.op_BitwiseOr()

Computes the bitwise-or of two values.

Parameters

NameDescriptionDefault
left The value to or with right.
right The value to or with left.

Returns

The bitwise-or of left and right.

System.Numerics.IBitwiseOperators`3.op_ExclusiveOr()

Computes the exclusive-or of two values.

Parameters

NameDescriptionDefault
left The value to xor with right.
right The value to xor with left.

Returns

The exclusive-or of left and right.

System.Numerics.IBitwiseOperators`3.op_OnesComplement()

Computes the ones-complement representation of a given value.

Parameters

NameDescriptionDefault
value The value for which to compute the ones-complement.

Returns

The ones-complement of value.

System.Numerics.IComparisonOperators`3

Defines a mechanism for comparing two values to determine relative order.

System.Numerics.IComparisonOperators`3.op_GreaterThan()

Compares two values to determine which is greater.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is greater than right; otherwise, false.

System.Numerics.IComparisonOperators`3.op_GreaterThanOrEqual()

Compares two values to determine which is greater or equal.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is greater than or equal to right; otherwise, false.

System.Numerics.IComparisonOperators`3.op_LessThan()

Compares two values to determine which is less.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is less than right; otherwise, false.

System.Numerics.IComparisonOperators`3.op_LessThanOrEqual()

Compares two values to determine which is less or equal.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is less than or equal to right; otherwise, false.

System.Numerics.IDecrementOperators`1

Defines a mechanism for decrementing a given value.

System.Numerics.IDecrementOperators`1.op_CheckedDecrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing value.

System.Numerics.IDecrementOperators`1.op_Decrement()

Decrements a value.

Parameters

NameDescriptionDefault
value The value to decrement.

Returns

The result of decrementing value.

System.Numerics.IDivisionOperators`3

Defines a mechanism for computing the quotient of two values.

System.Numerics.IDivisionOperators`3.op_CheckedDivision()

Divides two values together to compute their quotient.

Parameters

NameDescriptionDefault
left The value which right divides.
right The value which divides left.

Returns

The quotient of left divided by right.

System.Numerics.IDivisionOperators`3.op_Division()

Divides one value by another to compute their quotient.

Parameters

NameDescriptionDefault
left The value which right divides.
right The value which divides left.

Returns

The quotient of left divided by right.

System.Numerics.IEqualityOperators`3

Defines a mechanism for comparing two values to determine equality.

System.Numerics.IEqualityOperators`3.op_Equality()

Compares two values to determine equality.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is equal to right; otherwise, false.

System.Numerics.IEqualityOperators`3.op_Inequality()

Compares two values to determine inequality.

Parameters

NameDescriptionDefault
left The value to compare with right.
right The value to compare with left.

Returns

true if left is not equal to right; otherwise, false.

System.Numerics.IExponentialFunctions`1

Defines support for exponential functions.

System.Numerics.IExponentialFunctions`1.Exp()

Computes E raised to a given power.

Parameters

NameDescriptionDefault
x The power to which E is raised.

Returns

E raised to the power of x.

System.Numerics.IExponentialFunctions`1.Exp10()

Computes 10 raised to a given power.

Parameters

NameDescriptionDefault
x The power to which 10 is raised.

Returns

10

System.Numerics.IExponentialFunctions`1.Exp10M1()

Computes 10 raised to a given power and subtracts one.

Parameters

NameDescriptionDefault
x The power to which 10 is raised.

Returns

10 - 1

System.Numerics.IExponentialFunctions`1.Exp2()

Computes 2 raised to a given power.

Parameters

NameDescriptionDefault
x The power to which 2 is raised.

Returns

2

System.Numerics.IExponentialFunctions`1.Exp2M1()

Computes 2 raised to a given power and subtracts one.

Parameters

NameDescriptionDefault
x The power to which 2 is raised.

Returns

2 - 1

System.Numerics.IExponentialFunctions`1.ExpM1()

Computes E raised to a given power and subtracts one.

Parameters

NameDescriptionDefault
x The power to which E is raised.

Returns

E - 1

System.Numerics.IFloatingPoint`1

Defines a floating-point type.

System.Numerics.IFloatingPoint`1.Ceiling()

Computes the ceiling of a value.

Parameters

NameDescriptionDefault
x The value whose ceiling is to be computed.

Returns

The ceiling of x.

System.Numerics.IFloatingPoint`1.Floor()

Computes the floor of a value.

Parameters

NameDescriptionDefault
x The value whose floor is to be computed.

Returns

The floor of x.

System.Numerics.IFloatingPoint`1.GetExponentByteCount

Gets the number of bytes that will be written as part of System.Numerics.IFloatingPoint`1.TryWriteExponentLittleEndian().

Returns

The number of bytes that will be written as part of System.Numerics.IFloatingPoint`1.TryWriteExponentLittleEndian().

System.Numerics.IFloatingPoint`1.GetExponentShortestBitLength

Gets the length, in bits, of the shortest two's complement representation of the current exponent.

Returns

The length, in bits, of the shortest two's complement representation of the current exponent.

System.Numerics.IFloatingPoint`1.GetSignificandBitLength

Gets the length, in bits, of the current significand.

Returns

The length, in bits, of the current significand.

System.Numerics.IFloatingPoint`1.GetSignificandByteCount

Gets the number of bytes that will be written as part of System.Numerics.IFloatingPoint`1.TryWriteSignificandLittleEndian().

Returns

The number of bytes that will be written as part of System.Numerics.IFloatingPoint`1.TryWriteSignificandLittleEndian().

System.Numerics.IFloatingPoint`1.Round()

Rounds a value to the nearest integer using the default rounding mode (System.MidpointRounding.ToEven).

Parameters

NameDescriptionDefault
x The value to round.

Returns

The result of rounding x to the nearest integer using the default rounding mode.

System.Numerics.IFloatingPoint`1.Round()

Rounds a value to a specified number of fractional-digits using the default rounding mode (System.MidpointRounding.ToEven).

Parameters

NameDescriptionDefault
x The value to round.
digits The number of fractional digits to which x should be rounded.

Returns

The result of rounding x to digits fractional-digits using the default rounding mode.

System.Numerics.IFloatingPoint`1.Round()

Rounds a value to a specified number of fractional digits using the specified rounding mode.

Parameters

NameDescriptionDefault
x The value to round.
digits The number of fractional digits to which x should be rounded.
mode The mode under which x should be rounded.

Returns

The result of rounding x to digits fractional-digits using mode.

System.Numerics.IFloatingPoint`1.Round()

Rounds a value to the nearest integer using the specified rounding mode.

Parameters

NameDescriptionDefault
x The value to round.
mode The mode under which x should be rounded.

Returns

The result of rounding x to the nearest integer using mode.

System.Numerics.IFloatingPoint`1.Truncate()

Truncates a value.

Parameters

NameDescriptionDefault
x The value to truncate.

Returns

The truncation of x.

System.Numerics.IFloatingPoint`1.TryWriteExponentBigEndian()

Tries to write the current exponent, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current exponent should be written.
bytesWritten When this method returns, contains the number of bytes written to destination.

Returns

true if the exponent was succesfully written to destination; otherwise, false.

System.Numerics.IFloatingPoint`1.TryWriteExponentLittleEndian()

Tries to write the current exponent, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current exponent should be written.
bytesWritten When this method returns, contains the number of bytes written to destination.

Returns

true if the exponent was succesfully written to destination; otherwise, false.

System.Numerics.IFloatingPoint`1.TryWriteSignificandBigEndian()

Tries to write the current significand, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current significand should be written.
bytesWritten When this method returns, contains the number of bytes written to destination.

Returns

true if the significand was succesfully written to destination; otherwise, false.

System.Numerics.IFloatingPoint`1.TryWriteSignificandLittleEndian()

Tries to write the current significand, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current significand should be written.
bytesWritten When this method returns, contains the number of bytes written to destination.

Returns

true if the significand was succesfully written to destination; otherwise, false.

System.Numerics.IFloatingPoint`1.WriteExponentBigEndian()

Writes the current exponent, in big-endian format, to a given array.

Parameters

NameDescriptionDefault
destination The array to which the current exponent should be written.

Returns

The number of bytes written to destination.

System.Numerics.IFloatingPoint`1.WriteExponentBigEndian()

Writes the current exponent, in big-endian format, to a given array.

Parameters

NameDescriptionDefault
destination The array to which the current exponent should be written.
startIndex The starting index at which the exponent should be written.

Returns

The number of bytes written to destination starting at startIndex.

System.Numerics.IFloatingPoint`1.WriteExponentBigEndian()

Writes the current exponent, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current exponent should be written.

Returns

The number of bytes written to destination.

System.Numerics.IFloatingPoint`1.WriteExponentLittleEndian()

Writes the current exponent, in little-endian format, to a given array.

Parameters

NameDescriptionDefault
destination The array to which the current exponent should be written.

Returns

The number of bytes written to destination.

System.Numerics.IFloatingPoint`1.WriteExponentLittleEndian()

Writes the current exponent, in little-endian format, to a given array.

Parameters

NameDescriptionDefault
destination The array to which the current exponent should be written.
startIndex The starting index at which the exponent should be written.

Returns

The number of bytes written to destination starting at startIndex.

System.Numerics.IFloatingPoint`1.WriteExponentLittleEndian()

Writes the current exponent, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current exponent should be written.

Returns

The number of bytes written to destination.

System.Numerics.IFloatingPoint`1.WriteSignificandBigEndian()

Writes the current significand, in big-endian format, to a given array.

Parameters

NameDescriptionDefault
destination The array to which the current significand should be written.

Returns

The number of bytes written to destination.

System.Numerics.IFloatingPoint`1.WriteSignificandBigEndian()

Writes the current significand, in big-endian format, to a given array.

Parameters

NameDescriptionDefault
destination The array to which the current significand should be written.
startIndex The starting index at which the significand should be written.

Returns

The number of bytes written to destination starting at startIndex.

System.Numerics.IFloatingPoint`1.WriteSignificandBigEndian()

Writes the current significand, in big-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current significand should be written.

Returns

The number of bytes written to destination.

System.Numerics.IFloatingPoint`1.WriteSignificandLittleEndian()

Writes the current significand, in little-endian format, to a given array.

Parameters

NameDescriptionDefault
destination The array to which the current significand should be written.

Returns

The number of bytes written to destination.

System.Numerics.IFloatingPoint`1.WriteSignificandLittleEndian()

Writes the current significand, in little-endian format, to a given array.

Parameters

NameDescriptionDefault
destination The array to which the current significand should be written.
startIndex The starting index at which the significand should be written.

Returns

The number of bytes written to destination starting at startIndex.

System.Numerics.IFloatingPoint`1.WriteSignificandLittleEndian()

Writes the current significand, in little-endian format, to a given span.

Parameters

NameDescriptionDefault
destination The span to which the current significand should be written.

Returns

The number of bytes written to destination.

System.Numerics.IFloatingPointConstants`1

Defines support for floating-point constants.

System.Numerics.IFloatingPointConstants`1.E

Gets the mathematical constant e.

System.Numerics.IFloatingPointConstants`1.Pi

Gets the mathematical constant pi.

System.Numerics.IFloatingPointConstants`1.Tau

Gets the mathematical constant tau.

System.Numerics.IFloatingPointIeee754`1

Defines an IEEE 754 floating-point type.

System.Numerics.IFloatingPointIeee754`1.Atan2()

Computes the arc-tangent for the quotient of two values.

Parameters

NameDescriptionDefault
y The y-coordinate of a point.
x The x-coordinate of a point.

Returns

The arc-tangent of y divided-by x.

System.Numerics.IFloatingPointIeee754`1.Atan2Pi()

Computes the arc-tangent for the quotient of two values and divides the result by pi.

Parameters

NameDescriptionDefault
y The y-coordinate of a point.
x The x-coordinate of a point.

Returns

The arc-tangent of y divided-by x, divided by pi.

System.Numerics.IFloatingPointIeee754`1.BitDecrement()

Returns the largest value that compares less than a specified value.

Parameters

NameDescriptionDefault
x The value to be bitwise decremented.

Returns

The largest value that compares less than x.

System.Numerics.IFloatingPointIeee754`1.BitIncrement()

Returns the smallest value that compares greater than a specified value.

Parameters

NameDescriptionDefault
x The value to be bitwise incremented.

Returns

The smallest value that compares greater than x.

System.Numerics.IFloatingPointIeee754`1.FusedMultiplyAdd()

Computes the fused multiply-add of three values.

Parameters

NameDescriptionDefault
left The value which right multiplies.
right The value which multiplies left.
addend The value that is added to the product of left and right.

Returns

The result of left times right plus addend computed as one ternary operation.

System.Numerics.IFloatingPointIeee754`1.Ieee754Remainder()

Computes the remainder of two values as specified by IEEE 754.

Parameters

NameDescriptionDefault
left The value which right divides.
right The value which divides left.

Returns

The remainder of left divided by right as specified by IEEE 754.

System.Numerics.IFloatingPointIeee754`1.ILogB()

Computes the integer logarithm of a value.

Parameters

NameDescriptionDefault
x The value whose integer logarithm is to be computed.

Returns

The integer logarithm of x.

System.Numerics.IFloatingPointIeee754`1.Lerp()

Performs a linear interpolation between two values based on the given weight.

Parameters

NameDescriptionDefault
value1 The first value, which is intended to be the lower bound.
value2 The second value, which is intended to be the upper bound.
amount A value, intended to be between 0 and 1, that indicates the weight of the interpolation.

Returns

The interpolated value.

System.Numerics.IFloatingPointIeee754`1.ReciprocalEstimate()

Computes an estimate of the reciprocal of a value.

Parameters

NameDescriptionDefault
x The value whose estimate of the reciprocal is to be computed.

Returns

An estimate of the reciprocal of x.

System.Numerics.IFloatingPointIeee754`1.ReciprocalSqrtEstimate()

Computes an estimate of the reciprocal square root of a value.

Parameters

NameDescriptionDefault
x The value whose estimate of the reciprocal square root is to be computed.

Returns

An estimate of the reciprocal square root of x.

System.Numerics.IFloatingPointIeee754`1.ScaleB()

Computes the product of a value and its base-radix raised to the specified power.

Parameters

NameDescriptionDefault
x The value which base-radix raised to the power of n multiplies.
n The value to which base-radix is raised before multipliying x.

Returns

The product of x and base-radix raised to the power of n.

System.Numerics.IFloatingPointIeee754`1.Epsilon

Gets the smallest value such that can be added to 0 that does not result in 0.

System.Numerics.IFloatingPointIeee754`1.NaN

Gets a value that represents NaN.

System.Numerics.IFloatingPointIeee754`1.NegativeInfinity

Gets a value that represents negative infinity.

System.Numerics.IFloatingPointIeee754`1.NegativeZero

Gets a value that represents negative zero.

System.Numerics.IFloatingPointIeee754`1.PositiveInfinity

Gets a value that represents positive infinity.

System.Numerics.IHyperbolicFunctions`1

Defines support for hyperbolic functions.

System.Numerics.IHyperbolicFunctions`1.Acosh()

Computes the hyperbolic arc-cosine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic arc-cosine is to be computed.

Returns

The hyperbolic arc-cosine of x.

System.Numerics.IHyperbolicFunctions`1.Asinh()

Computes the hyperbolic arc-sine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic arc-sine is to be computed.

Returns

The hyperbolic arc-sine of x.

System.Numerics.IHyperbolicFunctions`1.Atanh()

Computes the hyperbolic arc-tangent of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic arc-tangent is to be computed.

Returns

The hyperbolic arc-tangent of x.

System.Numerics.IHyperbolicFunctions`1.Cosh()

Computes the hyperbolic cosine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic cosine is to be computed.

Returns

The hyperbolic cosine of x.

System.Numerics.IHyperbolicFunctions`1.Sinh()

Computes the hyperbolic sine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic sine is to be computed.

Returns

The hyperbolic sine of x.

System.Numerics.IHyperbolicFunctions`1.Tanh()

Computes the hyperbolic tangent of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose hyperbolic tangent is to be computed.

Returns

The hyperbolic tangent of x.

System.Numerics.IIncrementOperators`1

Defines a mechanism for incrementing a given value.

System.Numerics.IIncrementOperators`1.op_CheckedIncrement()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing value.

System.Numerics.IIncrementOperators`1.op_Increment()

Increments a value.

Parameters

NameDescriptionDefault
value The value to increment.

Returns

The result of incrementing value.

System.Numerics.ILogarithmicFunctions`1

Defines support for logarithmic functions.

System.Numerics.ILogarithmicFunctions`1.Log()

Computes the natural (base-E logarithm of a value.

Parameters

NameDescriptionDefault
x The value whose natural logarithm is to be computed.

Returns

The natural logarithm of x.

System.Numerics.ILogarithmicFunctions`1.Log()

Computes the logarithm of a value in the specified base.

Parameters

NameDescriptionDefault
x The value whose logarithm is to be computed.
newBase The base in which the logarithm is to be computed.

Returns

The base-newBase logarithm of x.

System.Numerics.ILogarithmicFunctions`1.Log10()

Computes the base-10 logarithm of a value.

Parameters

NameDescriptionDefault
x The value whose base-10 logarithm is to be computed.

Returns

The base-10 logarithm of x.

System.Numerics.ILogarithmicFunctions`1.Log10P1()

Computes the base-10 logarithm of a value plus one.

Parameters

NameDescriptionDefault
x The value to which one is added before computing the base-10 logarithm.

Returns

log10( + 1)

System.Numerics.ILogarithmicFunctions`1.Log2()

Computes the base-2 logarithm of a value.

Parameters

NameDescriptionDefault
x The value whose base-2 logarithm is to be computed.

Returns

The base-2 logarithm of x.

System.Numerics.ILogarithmicFunctions`1.Log2P1()

Computes the base-2 logarithm of a value plus one.

Parameters

NameDescriptionDefault
x The value to which one is added before computing the base-2 logarithm.

Returns

log2( + 1)

System.Numerics.ILogarithmicFunctions`1.LogP1()

Computes the natural (base-E) logarithm of a value plus one.

Parameters

NameDescriptionDefault
x The value to which one is added before computing the natural logarithm.

Returns

loge( + 1)

System.Numerics.IMinMaxValue`1

Defines a mechanism for getting the minimum and maximum value of a type.

System.Numerics.IMinMaxValue`1.MaxValue

Gets the maximum value of the current type.

System.Numerics.IMinMaxValue`1.MinValue

Gets the minimum value of the current type.

System.Numerics.IModulusOperators`3

Defines a mechanism for computing the modulus or remainder of two values.

System.Numerics.IModulusOperators`3.op_Modulus()

Divides two values together to compute their modulus or remainder.

Parameters

NameDescriptionDefault
left The value which right divides.
right The value which divides left.

Returns

The modulus or remainder of left divided by right.

System.Numerics.IMultiplicativeIdentity`2

Defines a mechanism for getting the multiplicative identity of a given type.

System.Numerics.IMultiplicativeIdentity`2.MultiplicativeIdentity

Gets the multiplicative identity of the current type.

System.Numerics.IMultiplyOperators`3

Defines a mechanism for computing the product of two values.

System.Numerics.IMultiplyOperators`3.op_CheckedMultiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value which right multiplies.
right The value which multiplies left.

Returns

The product of left multiplied by right.

System.Numerics.IMultiplyOperators`3.op_Multiply()

Multiplies two values together to compute their product.

Parameters

NameDescriptionDefault
left The value which right multiplies.
right The value which multiplies left.

Returns

The product of left multiplied by right.

System.Numerics.INumber`1

Defines a number type.

System.Numerics.INumber`1.Clamp()

Clamps a value to an inclusive minimum and maximum value.

Parameters

NameDescriptionDefault
value The value to clamp.
min The inclusive minimum to which value should clamp.
max The inclusive maximum to which value should clamp.

Returns

The result of clamping value to the inclusive range of min and max.

System.Numerics.INumber`1.CopySign()

Copies the sign of a value to the sign of another value.

Parameters

NameDescriptionDefault
value The value whose magnitude is used in the result.
sign The value whose sign is used in the result.

Returns

A value with the magnitude of value and the sign of sign.

System.Numerics.INumber`1.Max()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Numerics.INumber`1.MaxNumber()

Compares two values to compute which is greater and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Numerics.INumber`1.Min()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Numerics.INumber`1.MinNumber()

Compares two values to compute which is lesser and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Numerics.INumber`1.Sign()

Computes the sign of a value.

Parameters

NameDescriptionDefault
value The value whose sign is to be computed.

Returns

A positive value if value is positive, System.Numerics.INumberBase`1.Zero if value is zero, and a negative value if value is negative.

System.Numerics.INumberBase`1

Defines the base of other number types.

System.Numerics.INumberBase`1.Abs()

Computes the absolute of a value.

Parameters

NameDescriptionDefault
value The value for which to get its absolute.

Returns

The absolute of value.

System.Numerics.INumberBase`1.CreateChecked``1()

Creates an instance of the current type from a value, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .

Returns

An instance of created from value.

System.Numerics.INumberBase`1.CreateSaturating``1()

Creates an instance of the current type from a value, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value which is used to create the instance of .

Returns

An instance of created from value, saturating if value falls outside the representable range of .

System.Numerics.INumberBase`1.CreateTruncating``1()

Creates an instance of the current type from a value, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value which is used to create the instance of .

Returns

An instance of created from value, truncating if value falls outside the representable range of .

System.Numerics.INumberBase`1.IsCanonical()

Determines if a value is in its canonical representation.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is in its canonical representation; otherwise, false.

System.Numerics.INumberBase`1.IsComplexNumber()

Determines if a value represents a complex number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a complex number; otherwise, false.

System.Numerics.INumberBase`1.IsEvenInteger()

Determines if a value represents an even integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is an even integer; otherwise, false.

System.Numerics.INumberBase`1.IsFinite()

Determines if a value is finite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is finite; otherwise, false.

System.Numerics.INumberBase`1.IsImaginaryNumber()

Determines if a value represents a pure imaginary number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a pure imaginary number; otherwise, false.

System.Numerics.INumberBase`1.IsInfinity()

Determines if a value is infinite.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is infinite; otherwise, false.

System.Numerics.INumberBase`1.IsInteger()

Determines if a value represents an integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is an integer; otherwise, false.

System.Numerics.INumberBase`1.IsNaN()

Determines if a value is NaN.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is NaN; otherwise, false.

System.Numerics.INumberBase`1.IsNegative()

Determines if a value represents a negative real number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value represents negative zero or a negative real number; otherwise, false.

System.Numerics.INumberBase`1.IsNegativeInfinity()

Determines if a value is negative infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is negative infinity; otherwise, false.

System.Numerics.INumberBase`1.IsNormal()

Determines if a value is normal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is normal; otherwise, false.

System.Numerics.INumberBase`1.IsOddInteger()

Determines if a value represents an odd integral number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is an odd integer; otherwise, false.

System.Numerics.INumberBase`1.IsPositive()

Determines if a value represents zero or a positive real number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value represents (positive) zero or a positive real number; otherwise, false.

System.Numerics.INumberBase`1.IsPositiveInfinity()

Determines if a value is positive infinity.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is positive infinity; otherwise, false.

System.Numerics.INumberBase`1.IsRealNumber()

Determines if a value represents a real number.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is a real number; otherwise, false.

System.Numerics.INumberBase`1.IsSubnormal()

Determines if a value is subnormal.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is subnormal; otherwise, false.

System.Numerics.INumberBase`1.IsZero()

Determines if a value is zero.

Parameters

NameDescriptionDefault
value The value to be checked.

Returns

true if value is zero; otherwise, false.

System.Numerics.INumberBase`1.MaxMagnitude()

Compares two values to compute which is greater.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Numerics.INumberBase`1.MaxMagnitudeNumber()

Compares two values to compute which has the greater magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is greater than y; otherwise, y.

System.Numerics.INumberBase`1.MinMagnitude()

Compares two values to compute which is lesser.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Numerics.INumberBase`1.MinMagnitudeNumber()

Compares two values to compute which has the lesser magnitude and returning the other value if an input is NaN.

Parameters

NameDescriptionDefault
x The value to compare with y.
y The value to compare with x.

Returns

x if it is less than y; otherwise, y.

System.Numerics.INumberBase`1.Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in utf8Text.
provider An object that provides culture-specific formatting information about utf8Text.

Returns

The result of parsing utf8Text.

System.Numerics.INumberBase`1.Parse()

Parses a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
style A bitwise combination of number styles that can be present in s.
provider An object that provides culture-specific formatting information about s.

Returns

The result of parsing s.

System.Numerics.INumberBase`1.Parse()

Parses a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
style A bitwise combination of number styles that can be present in s.
provider An object that provides culture-specific formatting information about s.

Returns

The result of parsing s.

System.Numerics.INumberBase`1.System#IUtf8SpanParsable{TSelf}#Parse()

Parses a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about utf8Text.

Returns

The result of parsing utf8Text.

System.Numerics.INumberBase`1.System#IUtf8SpanParsable{TSelf}#TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
provider An object that provides culture-specific formatting information about utf8Text.
result On return, contains the result of successfully parsing utf8Text or an undefined value on failure.

Returns

true if utf8Text was successfully parsed; otherwise, false.

System.Numerics.INumberBase`1.TryConvertFromChecked``1()

Tries to convert a value to an instance of the the current type, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value that's used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Numerics.INumberBase`1.TryConvertFromSaturating``1()

Tries to convert a value to an instance of the the current type, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value which is used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Numerics.INumberBase`1.TryConvertFromTruncating``1()

Tries to convert a value to an instance of the the current type, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value which is used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Numerics.INumberBase`1.TryConvertToChecked``1()

Tries to convert an instance of the the current type to another type, throwing an overflow exception for any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value which is used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Numerics.INumberBase`1.TryConvertToSaturating``1()

Tries to convert an instance of the the current type to another type, saturating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value which is used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Numerics.INumberBase`1.TryConvertToTruncating``1()

Tries to convert an instance of the the current type to another type, truncating any values that fall outside the representable range of the current type.

Parameters

NameDescriptionDefault
value The value which is used to create the instance of .
result When this method returns, contains an instance of converted from value.

Returns

false if is not supported; otherwise, true.

System.Numerics.INumberBase`1.TryFormat()

Parameters

NameDescriptionDefault
utf8Destination
bytesWritten
format
provider

System.Numerics.INumberBase`1.TryParse()

Tries to parse a span of UTF-8 characters into a value.

Parameters

NameDescriptionDefault
utf8Text The span of UTF-8 characters to parse.
style A bitwise combination of number styles that can be present in utf8Text.
provider An object that provides culture-specific formatting information about utf8Text.
result On return, contains the result of successfully parsing utf8Text or an undefined value on failure.

Returns

true if utf8Text was successfully parsed; otherwise, false.

System.Numerics.INumberBase`1.TryParse()

Tries to parse a span of characters into a value.

Parameters

NameDescriptionDefault
s The span of characters to parse.
style A bitwise combination of number styles that can be present in s.
provider An object that provides culture-specific formatting information about s.
result On return, contains the result of succesfully parsing s or an undefined value on failure.

Returns

true if s was successfully parsed; otherwise, false.

System.Numerics.INumberBase`1.TryParse()

Tries to parse a string into a value.

Parameters

NameDescriptionDefault
s The string to parse.
style A bitwise combination of number styles that can be present in s.
provider An object that provides culture-specific formatting information about s.
result On return, contains the result of succesfully parsing s or an undefined value on failure.

Returns

true if s was successfully parsed; otherwise, false.

System.Numerics.INumberBase`1.One

Gets the value 1 for the type.

System.Numerics.INumberBase`1.Radix

Gets the radix, or base, for the type.

System.Numerics.INumberBase`1.Zero

Gets the value 0 for the type.

System.Numerics.IPowerFunctions`1

Defines support for power functions.

System.Numerics.IPowerFunctions`1.Pow()

Computes a value raised to a given power.

Parameters

NameDescriptionDefault
x The value which is raised to the power of x.
y The power to which x is raised.

Returns

x raised to the power of y.

System.Numerics.IRootFunctions`1

Defines support for root functions.

System.Numerics.IRootFunctions`1.Cbrt()

Computes the cube-root of a value.

Parameters

NameDescriptionDefault
x The value whose cube-root is to be computed.

Returns

The cube-root of x.

System.Numerics.IRootFunctions`1.Hypot()

Computes the hypotenuse given two values representing the lengths of the shorter sides in a right-angled triangle.

Parameters

NameDescriptionDefault
x The value to square and add to y.
y The value to square and add to x.

Returns

The square root of x-squared plus y-squared.

System.Numerics.IRootFunctions`1.RootN()

Computes the n-th root of a value.

Parameters

NameDescriptionDefault
x The value whose n-th root is to be computed.
n The degree of the root to be computed.

Returns

The n-th root of x.

System.Numerics.IRootFunctions`1.Sqrt()

Computes the square-root of a value.

Parameters

NameDescriptionDefault
x The value whose square-root is to be computed.

Returns

The square-root of x.

System.Numerics.IShiftOperators`3

Defines a mechanism for shifting a value by another value.

System.Numerics.IShiftOperators`3.op_LeftShift()

Shifts a value left by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted left by shiftAmount.
shiftAmount The amount by which value is shifted left.

Returns

The result of shifting value left by shiftAmount.

System.Numerics.IShiftOperators`3.op_RightShift()

Shifts a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted right by shiftAmount.
shiftAmount The amount by which value is shifted right.

Returns

The result of shifting value right by shiftAmount.

System.Numerics.IShiftOperators`3.op_UnsignedRightShift()

Shifts a value right by a given amount.

Parameters

NameDescriptionDefault
value The value that is shifted right by shiftAmount.
shiftAmount The amount by which value is shifted right.

Returns

The result of shifting value right by shiftAmount.

System.Numerics.ISignedNumber`1

Defines a number type which can represent both positive and negative values.

System.Numerics.ISignedNumber`1.NegativeOne

Gets the value -1 for the type.

System.Numerics.ISubtractionOperators`3

Defines a mechanism for computing the difference of two values.

System.Numerics.ISubtractionOperators`3.op_CheckedSubtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which right is subtracted.
right The value which is subtracted from left.

Returns

The value of right subtracted from left.

System.Numerics.ISubtractionOperators`3.op_Subtraction()

Subtracts two values to compute their difference.

Parameters

NameDescriptionDefault
left The value from which right is subtracted.
right The value which is subtracted from left.

Returns

The value of right subtracted from left.

System.Numerics.ITrigonometricFunctions`1

Defines support for trigonometric functions.

System.Numerics.ITrigonometricFunctions`1.Acos()

Computes the arc-cosine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose arc-cosine is to be computed.

Returns

The arc-cosine of x.

System.Numerics.ITrigonometricFunctions`1.AcosPi()

Computes the arc-cosine of a value and divides the result by pi.

Parameters

NameDescriptionDefault
x The value whose arc-cosine is to be computed.

Returns

The arc-cosine of x, divided by pi.

System.Numerics.ITrigonometricFunctions`1.Asin()

Computes the arc-sine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose arc-sine is to be computed.

Returns

The arc-sine of x.

System.Numerics.ITrigonometricFunctions`1.AsinPi()

Computes the arc-sine of a value and divides the result by pi.

Parameters

NameDescriptionDefault
x The value whose arc-sine is to be computed.

Returns

The arc-sine of x, divided by pi.

System.Numerics.ITrigonometricFunctions`1.Atan()

Computes the arc-tangent of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose arc-tangent is to be computed.

Returns

The arc-tangent of x.

System.Numerics.ITrigonometricFunctions`1.AtanPi()

Computes the arc-tangent of a value and divides the result by pi.

Parameters

NameDescriptionDefault
x The value whose arc-tangent is to be computed.

Returns

The arc-tangent of x, divided by pi.

System.Numerics.ITrigonometricFunctions`1.Cos()

Computes the cosine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose cosine is to be computed.

Returns

The cosine of x.

System.Numerics.ITrigonometricFunctions`1.CosPi()

Computes the cosine of a value that has been multipled by pi.

Parameters

NameDescriptionDefault
x The value, in half-revolutions, whose cosine is to be computed.

Returns

The cosine of x multiplied-by pi.

System.Numerics.ITrigonometricFunctions`1.DegreesToRadians()

Converts a given value from degrees to radians.

Parameters

NameDescriptionDefault
degrees The value to convert to radians.

Returns

The value of degrees converted to radians.

System.Numerics.ITrigonometricFunctions`1.RadiansToDegrees()

Converts a given value from radians to degrees.

Parameters

NameDescriptionDefault
radians The value to convert to degrees.

Returns

The value of radians converted to degrees.

System.Numerics.ITrigonometricFunctions`1.Sin()

Computes the sine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose sine is to be computed.

Returns

The sine of x.

System.Numerics.ITrigonometricFunctions`1.SinCos()

Computes the sine and cosine of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose sine and cosine are to be computed.

Returns

The sine and cosine of x.

System.Numerics.ITrigonometricFunctions`1.SinCosPi()

Computes the sine and cosine of a value that has been multiplied by pi.

Parameters

NameDescriptionDefault
x The value, in half-revolutions, that is multipled by pi before computing its sine and cosine.

Returns

The sine and cosine ofx multiplied-by pi.

System.Numerics.ITrigonometricFunctions`1.SinPi()

Computes the sine of a value that has been multiplied by pi.

Parameters

NameDescriptionDefault
x The value, in half-revolutions, that is multipled by pi before computing its sine.

Returns

The sine of x multiplied-by pi.

System.Numerics.ITrigonometricFunctions`1.Tan()

Computes the tangent of a value.

Parameters

NameDescriptionDefault
x The value, in radians, whose tangent is to be computed.

Returns

The tangent of x.

System.Numerics.ITrigonometricFunctions`1.TanPi()

Computes the tangent of a value that has been multipled by pi.

Parameters

NameDescriptionDefault
x The value, in half-revolutions, that is multipled by pi before computing its tangent.

Returns

The tangent of x multiplied-by pi.

System.Numerics.IUnaryNegationOperators`2

Defines a mechanism for computing the unary negation of a value.

System.Numerics.IUnaryNegationOperators`2.op_CheckedUnaryNegation()

Computes the checked unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of value.

System.Numerics.IUnaryNegationOperators`2.op_UnaryNegation()

Computes the unary negation of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary negation.

Returns

The unary negation of value.

System.Numerics.IUnaryPlusOperators`2

Defines a mechanism for computing the unary plus of a value.

System.Numerics.IUnaryPlusOperators`2.op_UnaryPlus()

Computes the unary plus of a value.

Parameters

NameDescriptionDefault
value The value for which to compute the unary plus.

Returns

The unary plus of value.

System.Numerics.IUnsignedNumber`1

Defines a number type that can only represent positive values.

System.Numerics.TotalOrderIeee754Comparer`1

Represents a comparison operation that compares floating-point numbers with IEEE 754 totalOrder semantic.

System.Numerics.TotalOrderIeee754Comparer`1.Compare()

Compares two numbers with IEEE 754 totalOrder semantic and returns a value indicating whether one is less than, equal to, or greater than the other.

Parameters

NameDescriptionDefault
x The first number to compare.
y The second number to compare.

Returns

A signed integer that indicates the relative values of x and y, as shown in the following table. Value Meaning Less than zerox is less than y Zerox equals y Greater than zerox is greater than y

System.Numerics.TotalOrderIeee754Comparer`1.Equals()

Determines whether the specified numbers are equal.

Parameters

NameDescriptionDefault
x The first number of type to compare.
y The second number of type to compare.

Returns

true if the specified numbers are equal; otherwise, false.

System.Numerics.TotalOrderIeee754Comparer`1.Equals()

Indicates whether the current object is equal to another object of the same type.

Parameters

NameDescriptionDefault
other An object to compare with this object.

Returns

true if the current object is equal to the other parameter; otherwise, false.

System.Numerics.TotalOrderIeee754Comparer`1.Equals()

Parameters

NameDescriptionDefault
obj

System.Numerics.TotalOrderIeee754Comparer`1.GetHashCode

System.Numerics.TotalOrderIeee754Comparer`1.GetHashCode()

Returns a hash code for the specified number.

Parameters

NameDescriptionDefault
obj The number for which a hash code is to be returned.

Returns

A hash code for the specified number.

System.Object

Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.

System.Object.#ctor

Initializes a new instance of the System.Object class.

System.Object.Equals()

Determines whether the specified object is equal to the current object.

Parameters

NameDescriptionDefault
obj The object to compare with the current object.

Returns

true if the specified object is equal to the current object; otherwise, false.

System.Object.Equals()

Determines whether the specified object instances are considered equal.

Parameters

NameDescriptionDefault
objA The first object to compare.
objB The second object to compare.

Returns

true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

System.Object.Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

System.Object.GetHashCode

Serves as the default hash function.

Returns

A hash code for the current object.

System.Object.GetType

Gets the System.Type of the current instance.

Returns

The exact runtime type of the current instance.

System.Object.MemberwiseClone

Creates a shallow copy of the current System.Object.

Returns

A shallow copy of the current System.Object.

System.Object.ReferenceEquals()

Determines whether the specified System.Object instances are the same instance.

Parameters

NameDescriptionDefault
objA The first object to compare.
objB The second object to compare.

Returns

true if objA is the same instance as objB or if both are null; otherwise, false.

System.Object.ToString

Returns a string that represents the current object.

Returns

A string that represents the current object.

System.ObjectDisposedException

The exception that is thrown when an operation is performed on a disposed object.

System.ObjectDisposedException.#ctor()

Initializes a new instance of the System.ObjectDisposedException class with serialized data.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.ObjectDisposedException.#ctor()

Initializes a new instance of the System.ObjectDisposedException class with a string containing the name of the disposed object.

Parameters

NameDescriptionDefault
objectName A string containing the name of the disposed object.

System.ObjectDisposedException.#ctor()

Initializes a new instance of the System.ObjectDisposedException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If innerException is not null, the current exception is raised in a catch block that handles the inner exception.

System.ObjectDisposedException.#ctor()

Initializes a new instance of the System.ObjectDisposedException class with the specified object name and message.

Parameters

NameDescriptionDefault
objectName The name of the disposed object.
message The error message that explains the reason for the exception.

System.ObjectDisposedException.GetObjectData()

Retrieves the System.Runtime.Serialization.SerializationInfo object with the parameter name and additional exception information.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.ObjectDisposedException.ThrowIf()

Throws an System.ObjectDisposedException if the specified condition is true.

Parameters

NameDescriptionDefault
condition The condition to evaluate.
instance The object whose type's full name should be included in any resulting System.ObjectDisposedException.

System.ObjectDisposedException.ThrowIf()

Throws an System.ObjectDisposedException if the specified condition is true.

Parameters

NameDescriptionDefault
condition The condition to evaluate.
type The type whose full name should be included in any resulting System.ObjectDisposedException.

System.ObjectDisposedException.Message

Gets the message that describes the error.

Returns

A string that describes the error.

System.ObjectDisposedException.ObjectName

Gets the name of the disposed object.

Returns

A string containing the name of the disposed object.

System.ObsoleteAttribute

Marks the program elements that are no longer in use. This class cannot be inherited.

System.ObsoleteAttribute.#ctor

Initializes a new instance of the System.ObsoleteAttribute class with default properties.

System.ObsoleteAttribute.#ctor()

Initializes a new instance of the System.ObsoleteAttribute class with a specified workaround message.

Parameters

NameDescriptionDefault
message The text string that describes alternative workarounds.

System.ObsoleteAttribute.#ctor()

Initializes a new instance of the System.ObsoleteAttribute class with a workaround message and a Boolean value indicating whether the obsolete element usage is considered an error.

Parameters

NameDescriptionDefault
message The text string that describes alternative workarounds.
error true if the obsolete element usage generates a compiler error; false if it generates a compiler warning.

System.ObsoleteAttribute.DiagnosticId

Gets or sets the ID that the compiler will use when reporting a use of the API.

Returns

The unique diagnostic ID.

System.ObsoleteAttribute.IsError

Gets a value that indicates whether the compiler will treat usage of the obsolete program element as an error.

Returns

true if the obsolete element usage is considered an error; otherwise, false. The default is false.

System.ObsoleteAttribute.Message

Gets the workaround message.

Returns

The workaround text string.

System.ObsoleteAttribute.UrlFormat

Gets or sets the URL for corresponding documentation. The API accepts a format string instead of an actual URL, creating a generic URL that includes the diagnostic ID.

Returns

The format string that represents a URL to corresponding documentation.

System.OperatingSystem

Represents information about an operating system, such as the version and platform identifier. This class cannot be inherited.

System.OperatingSystem.#ctor()

Initializes a new instance of the System.OperatingSystem class, using the specified platform identifier value and version object.

Parameters

NameDescriptionDefault
platform One of the System.PlatformID values that indicates the operating system platform.
version A System.Version object that indicates the version of the operating system.

System.OperatingSystem.Clone

Creates an System.OperatingSystem object that is identical to this instance.

Returns

An System.OperatingSystem object that is a copy of this instance.

System.OperatingSystem.GetObjectData()

Populates a System.Runtime.Serialization.SerializationInfo object with the data necessary to deserialize this instance.

Parameters

NameDescriptionDefault
info The object to populate with serialization information.
context The place to store and retrieve serialized data. Reserved for future use.

System.OperatingSystem.IsAndroid

Indicates whether the current application is running on Android.

Returns

true if the current application is running on Android; false otherwise.

System.OperatingSystem.IsAndroidVersionAtLeast()

Checks if the Android version (returned by the Linux command uname) is greater than or equal to the specified version. This method can be used to guard APIs that were added in the specified version.

Parameters

NameDescriptionDefault
major The major release number.
minor The minor release number.
build The build release number.
revision The revision release number.

Returns

true if the current application is running on an Android version that is at least what was specified in the parameters; false otherwise.

System.OperatingSystem.IsBrowser

Indicates whether the current application is running as WASM in a browser.

Returns

true if the current application is running as WASM in a browser; false otherwise.

System.OperatingSystem.IsFreeBSD

Indicates whether the current application is running on FreeBSD.

Returns

true if the current application is running on FreeBSD; false otherwise.

System.OperatingSystem.IsFreeBSDVersionAtLeast()

Checks if the FreeBSD version (returned by the Linux command uname) is greater than or equal to the specified version. This method can be used to guard APIs that were added in the specified version.

Parameters

NameDescriptionDefault
major The major release number.
minor The minor release number.
build The build release number.
revision The revision release number.

Returns

true if the current application is running on a FreeBSD version that is at least what was specified in the parameters; false otherwise.

System.OperatingSystem.IsIOS

Indicates whether the current application is running on iOS or MacCatalyst.

Returns

true if the current application is running on iOS or MacCatalyst; false otherwise.

System.OperatingSystem.IsIOSVersionAtLeast()

Checks if the iOS/MacCatalyst version (returned by libobjc.get_operatingSystemVersion) is greater than or equal to the specified version. This method can be used to guard APIs that were added in the specified iOS version.

Parameters

NameDescriptionDefault
major The major release number.
minor The minor release number.
build The build release number.

Returns

true if the current application is running on an iOS/MacCatalyst version that is at least what was specified in the parameters; false otherwise.

System.OperatingSystem.IsLinux

Indicates whether the current application is running on Linux.

Returns

true if the current application is running on Linux; false otherwise.

System.OperatingSystem.IsMacCatalyst

Indicates whether the current application is running on Mac Catalyst.

Returns

true if the current application is running on Mac Catalyst; false otherwise.

System.OperatingSystem.IsMacCatalystVersionAtLeast()

Check for the Mac Catalyst version (iOS version as presented in Apple documentation) with a ≤ version comparison. Used to guard APIs that were added in the given Mac Catalyst release.

Parameters

NameDescriptionDefault
major The version major number.
minor The version minor number.
build The version build number.

Returns

true if the Mac Catalyst version is greater or equal than the specified version comparison; false otherwise.

System.OperatingSystem.IsMacOS

Indicates whether the current application is running on macOS.

Returns

true if the current application is running on macOS; false otherwise.

System.OperatingSystem.IsMacOSVersionAtLeast()

Checks if the macOS version (returned by libobjc.get_operatingSystemVersion) is greater than or equal to the specified version. This method can be used to guard APIs that were added in the specified macOS version.

Parameters

NameDescriptionDefault
major The major release number.
minor The minor release number.
build The build release number.

Returns

true if the current application is running on an macOS version that is at least what was specified in the parameters; false otherwise.

System.OperatingSystem.IsOSPlatform()

Indicates whether the current application is running on the specified platform.

Parameters

NameDescriptionDefault
platform The case-insensitive platform name. Examples: Browser, Linux, FreeBSD, Android, iOS, macOS, tvOS, watchOS, Windows.

Returns

true if the current application is running on the specified platform; false otherwise.

System.OperatingSystem.IsOSPlatformVersionAtLeast()

Checks if the operating system version is greater than or equal to the specified platform version. This method can be used to guard APIs that were added in the specified OS version.

Parameters

NameDescriptionDefault
platform The case-insensitive platform name. Examples: Browser, Linux, FreeBSD, Android, iOS, macOS, tvOS, watchOS, Windows.
major The major release number.
minor The minor release number (optional).
build The build release number (optional).
revision The revision release number (optional).

Returns

true if the current application is running on the specified platform and is at least in the version specified in the parameters; false otherwise.

System.OperatingSystem.IsTvOS

Indicates whether the current application is running on tvOS.

Returns

true if the current application is running on tvOS; false otherwise.

System.OperatingSystem.IsTvOSVersionAtLeast()

Checks if the tvOS version (returned by libobjc.get_operatingSystemVersion) is greater than or equal to the specified version. This method can be used to guard APIs that were added in the specified tvOS version.

Parameters

NameDescriptionDefault
major The major release number.
minor The minor release number.
build The build release number.

Returns

true if the current application is running on a tvOS version that is at least what was specified in the parameters; false otherwise.

System.OperatingSystem.IsWasi

Indicates whether the current application is running as WASI.

System.OperatingSystem.IsWatchOS

Indicates whether the current application is running on watchOS.

Returns

true if the current application is running on watchOS; false otherwise.

System.OperatingSystem.IsWatchOSVersionAtLeast()

Checks if the watchOS version (returned by libobjc.get_operatingSystemVersion) is greater than or equal to the specified version. This method can be used to guard APIs that were added in the specified watchOS version.

Parameters

NameDescriptionDefault
major The major release number.
minor The minor release number.
build The build release number.

Returns

true if the current application is running on a watchOS version that is at least what was specified in the parameters; false otherwise.

System.OperatingSystem.IsWindows

Indicates whether the current application is running on Windows.

Returns

true if the current application is running on Windows; false otherwise.

System.OperatingSystem.IsWindowsVersionAtLeast()

Checks if the Windows version (returned by RtlGetVersion) is greater than or equal to the specified version. This method can be used to guard APIs that were added in the specified Windows version.

Parameters

NameDescriptionDefault
major The major release number.
minor The minor release number.
build The build release number.
revision The revision release number.

Returns

true if the current application is running on a Windows version that is at least what was specified in the parameters; false otherwise.

System.OperatingSystem.ToString

Converts the value of this System.OperatingSystem object to its equivalent string representation.

Returns

The string representation of the values returned by the System.OperatingSystem.Platform, System.OperatingSystem.Version, and System.OperatingSystem.ServicePack properties.

System.OperatingSystem.Platform

Gets a System.PlatformID enumeration value that identifies the operating system platform.

Returns

One of the System.PlatformID values.

System.OperatingSystem.ServicePack

Gets the service pack version represented by this System.OperatingSystem object.

Returns

The service pack version, if service packs are supported and at least one is installed; otherwise, an empty string ("").

System.OperatingSystem.Version

Gets a System.Version object that identifies the operating system.

Returns

A System.Version object that describes the major version, minor version, build, and revision numbers for the operating system.

System.OperatingSystem.VersionString

Gets the concatenated string representation of the platform identifier, version, and service pack that are currently installed on the operating system.

Returns

The string representation of the values returned by the System.OperatingSystem.Platform, System.OperatingSystem.Version, and System.OperatingSystem.ServicePack properties.

System.OperationCanceledException

The exception that is thrown in a thread upon cancellation of an operation that the thread was executing.

System.OperationCanceledException.#ctor

Initializes a new instance of the System.OperationCanceledException class with a system-supplied error message.

System.OperationCanceledException.#ctor()

Initializes a new instance of the System.OperationCanceledException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.OperationCanceledException.#ctor()

Initializes a new instance of the System.OperationCanceledException class with a specified error message.

Parameters

NameDescriptionDefault
message A System.String that describes the error.

System.OperationCanceledException.#ctor()

Initializes a new instance of the System.OperationCanceledException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.OperationCanceledException.#ctor()

Initializes a new instance of the System.OperationCanceledException class with a specified error message, a reference to the inner exception that is the cause of this exception, and a cancellation token.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.
token A cancellation token associated with the operation that was canceled.

System.OperationCanceledException.#ctor()

Initializes a new instance of the System.OperationCanceledException class with a specified error message and a cancellation token.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
token A cancellation token associated with the operation that was canceled.

System.OperationCanceledException.#ctor()

Initializes a new instance of the System.OperationCanceledException class with a cancellation token.

Parameters

NameDescriptionDefault
token A cancellation token associated with the operation that was canceled.

System.OperationCanceledException.CancellationToken

Gets a token associated with the operation that was canceled.

Returns

A token associated with the operation that was canceled, or a default token.

System.OutOfMemoryException

The exception that is thrown when there is not enough memory to continue the execution of a program.

System.OutOfMemoryException.#ctor

Initializes a new instance of the System.OutOfMemoryException class.

System.OutOfMemoryException.#ctor()

Initializes a new instance of the System.OutOfMemoryException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.OutOfMemoryException.#ctor()

Initializes a new instance of the System.OutOfMemoryException class with a specified error message.

Parameters

NameDescriptionDefault
message The message that describes the error.

System.OutOfMemoryException.#ctor()

Initializes a new instance of the System.OutOfMemoryException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.OverflowException

The exception that is thrown when an arithmetic, casting, or conversion operation in a checked context results in an overflow.

System.OverflowException.#ctor

Initializes a new instance of the System.OverflowException class.

System.OverflowException.#ctor()

Initializes a new instance of the System.OverflowException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.OverflowException.#ctor()

Initializes a new instance of the System.OverflowException class with a specified error message.

Parameters

NameDescriptionDefault
message The message that describes the error.

System.OverflowException.#ctor()

Initializes a new instance of the System.OverflowException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.ParamArrayAttribute

Indicates that a method will allow a variable number of arguments in its invocation. This class cannot be inherited.

System.ParamArrayAttribute.#ctor

Initializes a new instance of the System.ParamArrayAttribute class with default properties.

System.PlatformID

Identifies the operating system, or platform, supported by an assembly.

System.PlatformID.MacOSX

The operating system is Macintosh. This value was returned by Silverlight. On .NET Core, its replacement is Unix.

System.PlatformID.Other

Any other operating system. This includes Browser (WASM).

System.PlatformID.Unix

The operating system is Unix.

System.PlatformID.Win32NT

The operating system is Windows NT or later.

System.PlatformID.Win32S

The operating system is Win32s. This value is no longer in use.

System.PlatformID.Win32Windows

The operating system is Windows 95 or Windows 98. This value is no longer in use.

System.PlatformID.WinCE

The operating system is Windows CE. This value is no longer in use.

System.PlatformID.Xbox

The development platform is Xbox 360. This value is no longer in use.

System.PlatformNotSupportedException

The exception that is thrown when a feature does not run on a particular platform.

System.PlatformNotSupportedException.#ctor

Initializes a new instance of the System.PlatformNotSupportedException class with default properties.

System.PlatformNotSupportedException.#ctor()

Initializes a new instance of the System.PlatformNotSupportedException class with serialized data.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.PlatformNotSupportedException.#ctor()

Initializes a new instance of the System.PlatformNotSupportedException class with a specified error message.

Parameters

NameDescriptionDefault
message The text message that explains the reason for the exception.

System.PlatformNotSupportedException.#ctor()

Initializes a new instance of the System.PlatformNotSupportedException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
inner The exception that is the cause of the current exception. If the inner parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.Predicate`1

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

NameDescriptionDefault
obj The object to compare against the criteria defined within the method represented by this delegate.

Returns

true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

System.Progress`1

Provides an System.IProgress`1 that invokes callbacks for each reported progress value.

System.Progress`1.ProgressChanged

Raised for each reported progress value.

System.Progress`1.#ctor

Initializes the System.Progress`1 object.

System.Progress`1.#ctor()

Initializes the System.Progress`1 object with the specified callback.

Parameters

NameDescriptionDefault
handler A handler to invoke for each reported progress value. This handler will be invoked in addition to any delegates registered with the System.Progress`1.ProgressChanged event. Depending on the System.Threading.SynchronizationContext instance captured by the System.Progress`1 at construction, it is possible that this handler instance could be invoked concurrently with itself.

System.Progress`1.OnReport()

Reports a progress change.

Parameters

NameDescriptionDefault
value The value of the updated progress.

System.Progress`1.System#IProgress{T}#Report()

Reports a progress change.

Parameters

NameDescriptionDefault
value The value of the updated progress.

System.Random

Represents a pseudo-random number generator, which is an algorithm that produces a sequence of numbers that meet certain statistical requirements for randomness.

System.Random.#ctor

Initializes a new instance of the System.Random class using a default seed value.

System.Random.#ctor()

Initializes a new instance of the System.Random class, using the specified seed value.

Parameters

NameDescriptionDefault
Seed A number used to calculate a starting value for the pseudo-random number sequence. If a negative number is specified, the absolute value of the number is used.

System.Random.GetItems``1()

Creates an array populated with items chosen at random from the provided set of choices.

Parameters

NameDescriptionDefault
choices The items to use to populate the array.
length The length of array to return.

Returns

An array populated with random items.

System.Random.GetItems``1()

Creates an array populated with items chosen at random from the provided set of choices.

Parameters

NameDescriptionDefault
choices The items to use to populate the array.
length The length of array to return.

Returns

An array populated with random items.

System.Random.GetItems``1()

Fills the elements of a specified span with items chosen at random from the provided set of choices.

Parameters

NameDescriptionDefault
choices The items to use to populate the span.
destination The span to be filled with items.

System.Random.Next

Returns a non-negative random integer.

Returns

A 32-bit signed integer that is greater than or equal to 0 and less than Int32.MaxValue.

System.Random.Next()

Returns a non-negative random integer that is less than the specified maximum.

Parameters

NameDescriptionDefault
maxValue The exclusive upper bound of the random number to be generated. maxValue must be greater than or equal to 0.

Returns

A 32-bit signed integer that is greater than or equal to 0, and less than maxValue; that is, the range of return values ordinarily includes 0 but not maxValue. However, if maxValue equals 0, 0 is returned.

System.Random.Next()

Returns a random integer that is within a specified range.

Parameters

NameDescriptionDefault
minValue The inclusive lower bound of the random number returned.
maxValue The exclusive upper bound of the random number returned. maxValue must be greater than or equal to minValue.

Returns

A 32-bit signed integer greater than or equal to minValue and less than maxValue; that is, the range of return values includes minValue but not maxValue. If minValue equals maxValue, minValue is returned.

System.Random.NextBytes()

Fills the elements of a specified array of bytes with random numbers.

Parameters

NameDescriptionDefault
buffer The array to be filled with random numbers.

System.Random.NextBytes()

Fills the elements of a specified span of bytes with random numbers.

Parameters

NameDescriptionDefault
buffer The array to be filled with random numbers.

System.Random.NextDouble

Returns a random floating-point number that is greater than or equal to 0.0, and less than 1.0.

Returns

A double-precision floating point number that is greater than or equal to 0.0, and less than 1.0.

System.Random.NextInt64

Returns a non-negative random integer.

Returns

A 64-bit signed integer that is greater than or equal to 0 and less than Int64.MaxValue.

System.Random.NextInt64()

Returns a non-negative random integer that is less than the specified maximum.

Parameters

NameDescriptionDefault
maxValue The exclusive upper bound of the random number to be generated. maxValue must be greater than or equal to 0.

Returns

A 64-bit signed integer that is greater than or equal to 0, and less than maxValue; that is, the range of return values ordinarily includes 0 but not maxValue. However, if maxValue equals 0, maxValue is returned.

System.Random.NextInt64()

Returns a random integer that is within a specified range.

Parameters

NameDescriptionDefault
minValue The inclusive lower bound of the random number returned.
maxValue The exclusive upper bound of the random number returned. maxValue must be greater than or equal to minValue.

Returns

A 64-bit signed integer greater than or equal to minValue and less than maxValue; that is, the range of return values includes minValue but not maxValue. If minValue equals maxValue, minValue is returned.

System.Random.NextSingle

Returns a random floating-point number that is greater than or equal to 0.0, and less than 1.0.

Returns

A single-precision floating point number that is greater than or equal to 0.0, and less than 1.0.

System.Random.Sample

Returns a random floating-point number between 0.0 and 1.0.

Returns

A double-precision floating point number that is greater than or equal to 0.0, and less than 1.0.

System.Random.Shuffle``1()

Performs an in-place shuffle of an array.

Parameters

NameDescriptionDefault
values The array to shuffle.

System.Random.Shuffle``1()

Performs an in-place shuffle of a span.

Parameters

NameDescriptionDefault
values The span to shuffle.

System.Random.Shared

Provides a thread-safe System.Random instance that may be used concurrently from any thread.

Returns

A System.Random instance.

System.Range

Represents a range that has start and end indexes.

System.Range.#ctor()

Instantiates a new System.Range instance with the specified starting and ending indexes.

Parameters

NameDescriptionDefault
start The inclusive start index of the range.
end The exclusive end index of the range.

System.Range.EndAt()

Creates a System.Range object starting from the first element in the collection to a specified end index.

Parameters

NameDescriptionDefault
end The position of the last element up to which the System.Range object will be created.

Returns

A range that starts from the first element to end.

System.Range.Equals()

Returns a value that indicates whether the current instance is equal to a specified object.

Parameters

NameDescriptionDefault
value An object to compare with this Range object.

Returns

true if value is of type System.Range and is equal to the current instance; otherwise, false.

System.Range.Equals()

Returns a value that indicates whether the current instance is equal to another System.Range object.

Parameters

NameDescriptionDefault
other A Range object to compare with this Range object.

Returns

true if the current instance is equal to other; otherwise, false.

System.Range.GetHashCode

Returns the hash code for this instance.

Returns

The hash code.

System.Range.GetOffsetAndLength()

Calculates the start offset and length of the range object using a collection length.

Parameters

NameDescriptionDefault
length A positive integer that represents the length of the collection that the range will be used with.

Returns

The start offset and length of the range.

System.Range.StartAt()

Returns a new System.Range instance starting from a specified start index to the end of the collection.

Parameters

NameDescriptionDefault
start The position of the first element from which the Range will be created.

Returns

A range from start to the end of the collection.

System.Range.ToString

Returns the string representation of the current System.Range object.

Returns

The string representation of the range.

System.Range.All

Gets a System.Range object that starts from the first element to the end.

Returns

A range from the start to the end.

System.Range.End

Gets an System.Index that represents the exclusive end index of the range.

Returns

The end index of the range.

System.Range.Start

Gets the inclusive start index of the System.Range.

Returns

The inclusive start index of the range.

System.RankException

The exception that is thrown when an array with the wrong number of dimensions is passed to a method.

System.RankException.#ctor

Initializes a new instance of the System.RankException class.

System.RankException.#ctor()

Initializes a new instance of the System.RankException class with serialized data.

Parameters

NameDescriptionDefault
info The object that holds the serialized object data.
context The contextual information about the source or destination.

System.RankException.#ctor()

Initializes a new instance of the System.RankException class with a specified error message.

Parameters

NameDescriptionDefault
message A System.String that describes the error.

System.RankException.#ctor()

Initializes a new instance of the System.RankException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
innerException The exception that is the cause of the current exception. If the innerException parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

System.ReadOnlyMemory`1

Represents a contiguous region of memory, similar to System.ReadOnlySpan`1. Unlike System.ReadOnlySpan`1, it is not a byref-like type.

System.ReadOnlyMemory`1.#ctor()

Creates a new memory region over the entirety of the target array.

Parameters

NameDescriptionDefault
array The target array.

System.ReadOnlyMemory`1.#ctor()

Creates a new memory region over the portion of the target array beginning at a specified position and including a specified number of elements.

Parameters

NameDescriptionDefault
array The target array.
start The index at which to begin the memory region.
length The number of items in the memory region.

System.ReadOnlyMemory`1.CopyTo()

Copies the contents of the read-only memory region into a destination memory region.

Parameters

NameDescriptionDefault
destination The memory region to copy items into.

System.ReadOnlyMemory`1.Equals()

Determines whether the specified object is equal to the current read-only memory region.

Parameters

NameDescriptionDefault
obj The object to compare.

Returns

true if the current instance and obj are equal; otherwise, false.

System.ReadOnlyMemory`1.Equals()

Determines whether the current instance and a specified System.ReadOnlyMemory`1 objects are equal.

Parameters

NameDescriptionDefault
other The read-only memory to compare.

Returns

true if the current instance and other are equal; otherwise, false.

System.ReadOnlyMemory`1.GetHashCode

Returns the hash code for this System.ReadOnlyMemory`1.

Returns

The hash code.

System.ReadOnlyMemory`1.op_Implicit()

Defines an implicit conversion of an array to a System.ReadOnlyMemory`1.

Parameters

NameDescriptionDefault
array An array of type T to convert.

Returns

The read-only memory representation of the array of type T.

System.ReadOnlyMemory`1.op_Implicit()

Defines an implicit conversion of a System.ArraySegment`1 to a System.ReadOnlyMemory`1.

Parameters

NameDescriptionDefault
segment The array segment to convert.

Returns

A read-only memory representation of the array segment.

System.ReadOnlyMemory`1.Pin

Creates a handle for the memory.

Returns

A handle for the memory.

System.ReadOnlyMemory`1.Slice()

Forms a slice out of the given memory region, beginning at a specified position and continuing to its end.

Parameters

NameDescriptionDefault
start The index at which to begin this slice.

Returns

A read-only memory region representing the desired slice.

System.ReadOnlyMemory`1.Slice()

Forms a slice out of the given memory region starting at start position for length elements.

Parameters

NameDescriptionDefault
start The index at which to begin this slice.
length The desired length for the slice.

Returns

A read-only memory region representing the desired slice.

System.ReadOnlyMemory`1.ToArray

Copies the contents from the memory region into a new array.

Returns

An array.

System.ReadOnlyMemory`1.ToString

Returns the string representation of this read-only memory instance.

Returns

For System.ReadOnlyMemory`1 with char elements, returns an instance of string that represents the characters pointed to by the memory. Otherwise, returns a System.String with the name of the type and the number of elements.

System.ReadOnlyMemory`1.TryCopyTo()

Tries to copy the contents of the readonly-only memory into the destination and returns a value that indicates whether the copy operation succeeded.

Parameters

NameDescriptionDefault
destination The memory region to copy items into.

Returns

true if the copy operation succeeded. false if destination is smaller than the current instance, and no data is written to destination.

System.ReadOnlyMemory`1.Empty

Gets an empty System.ReadOnlyMemory`1.

Returns

An empty read-only memory region.

System.ReadOnlyMemory`1.IsEmpty

Gets a value that indicates whether this read-only memory region is empty.

Returns

true if the read-only memory region is empty (that is, its System.ReadOnlyMemory`1.Length is 0); otherwise, false.

System.ReadOnlyMemory`1.Length

Gets the number of items in the memory region.

Returns

The number of items in the memory region.

System.ReadOnlyMemory`1.Span

Gets a span from the memory region.

Returns

A memory span.

System.ReadOnlySpan`1

Provides a type-safe and memory-safe read-only representation of a contiguous region of arbitrary memory.

System.ReadOnlySpan`1.#ctor()

Creates a new System.ReadOnlySpan`1 of length 1 around the specified reference.

Parameters

NameDescriptionDefault
reference A reference to data.

System.ReadOnlySpan`1.#ctor()

Creates a new System.ReadOnlySpan`1 over the entirety of a specified array.

Parameters

NameDescriptionDefault
array The array from which to create the System.ReadOnlySpan`1.

System.ReadOnlySpan`1.#ctor()

Creates a new System.ReadOnlySpan`1 that includes a specified number of elements of an array starting at a specified index.

Parameters

NameDescriptionDefault
array The array from which to create the System.ReadOnlySpan`1.
start The index of the first element to include.
length The number of elements to include.

System.ReadOnlySpan`1.#ctor()

Creates a new System.ReadOnlySpan`1 from a specified number of elements starting at a specified memory address.

Parameters

NameDescriptionDefault
pointer A pointer to the starting address of a specified number of elements in memory.
length The number of elements to be included in the System.ReadOnlySpan`1.

System.ReadOnlySpan`1.CopyTo()

Copies the contents of this System.ReadOnlySpan`1 into a destination System.Span`1.

Parameters

NameDescriptionDefault
destination The span to copy items into.

System.ReadOnlySpan`1.Equals()

Not supported. Throws a System.NotSupportedException.

Parameters

NameDescriptionDefault
obj Not supported.

Returns

Not supported.

System.ReadOnlySpan`1.GetEnumerator

Returns an enumerator for this System.ReadOnlySpan`1.

Returns

An enumerator for this read-only span.

System.ReadOnlySpan`1.GetHashCode

Not supported. Throws a System.NotSupportedException.

Returns

Not supported.

System.ReadOnlySpan`1.GetPinnableReference

Returns a read-only reference to an object of type T that can be used for pinning. This method is intended to support .NET compilers and is not intended to be called by user code.

Returns

A reference to the element of the span at index 0, or null if the span is empty.

System.ReadOnlySpan`1.op_Equality()

Returns a value that indicates whether two System.ReadOnlySpan`1 instances are equal.

Parameters

NameDescriptionDefault
left The first span to compare.
right The second span to compare.

Returns

true if the two System.ReadOnlySpan`1 instances are equal; otherwise, false.

System.ReadOnlySpan`1.op_Implicit()

Defines an implicit conversion of an array to a System.ReadOnlySpan`1.

Parameters

NameDescriptionDefault
array The array to convert to a System.ReadOnlySpan`1.

Returns

The read-only span that corresponds to array.

System.ReadOnlySpan`1.op_Implicit()

Defines an implicit conversion of an System.ArraySegment`1 to a System.ReadOnlySpan`1.

Parameters

NameDescriptionDefault
segment The array segment to be converted to a System.ReadOnlySpan`1.

Returns

A read-only span that corresponds to the array segment.

System.ReadOnlySpan`1.op_Inequality()

Returns a value that indicates whether two System.ReadOnlySpan`1 instances are not equal.

Parameters

NameDescriptionDefault
left The first read-only span to compare.
right The second read-only span to compare.

Returns

true if the two System.ReadOnlySpan`1 instances are not equal; otherwise, false.

System.ReadOnlySpan`1.Slice()

Forms a slice out of the current read-only span that begins at a specified index.

Parameters

NameDescriptionDefault
start The index at which to begin the slice.

Returns

A span that consists of all elements of the current span from start to the end of the span.

System.ReadOnlySpan`1.Slice()

Forms a slice out of the current read-only span starting at a specified index for a specified length.

Parameters

NameDescriptionDefault
start The index at which to begin this slice.
length The desired length for the slice.

Returns

A read-only span that consists of length elements from the current span starting at start.

System.ReadOnlySpan`1.ToArray

Copies the contents of this read-only span into a new array.

Returns

An array containing the data in the current span.

System.ReadOnlySpan`1.ToString

Returns the string representation of this System.ReadOnlySpan`1.

Returns

The string representation of this instance.

System.ReadOnlySpan`1.TryCopyTo()

Attempts to copy the contents of this System.ReadOnlySpan`1 into a System.Span`1 and returns a value to indicate whether or not the operation succeeded.

Parameters

NameDescriptionDefault
destination The target of the copy operation.

Returns

true if the copy operation succeeded; otherwise, false.

System.ReadOnlySpan`1.Empty

Returns an empty System.ReadOnlySpan`1.

Returns

System.ReadOnlySpan`1.IsEmpty

Returns a value that indicates the current read-only span is empty.

Returns

true when the current span is empty; otherwise false.

System.ReadOnlySpan`1.Item()

Gets an item from the read-only span at the specified zero-based index.

Parameters

NameDescriptionDefault
index The zero-based index of the element to get.

Returns

The element from the read-only span.

System.ReadOnlySpan`1.Length

The number of items in the read-only span.

Returns

The number of items.

System.ReadOnlySpan`1.Enumerator

Provides an enumerator for the elements of a System.ReadOnlySpan`1.

System.ReadOnlySpan`1.Enumerator.MoveNext

Advances the enumerator to the next item of the System.ReadOnlySpan`1.

Returns

true if the enumerator successfully advanced to the next item; false if the end of the span has been passed.

System.ReadOnlySpan`1.Enumerator.Current

Gets a reference to the item at the current position of the enumerator.

Returns

The element in the System.ReadOnlySpan`1 at the current position of the enumerator.

System.Reflection.AmbiguousMatchException

The exception that is thrown when binding to a member results in more than one member matching the binding criteria. This class cannot be inherited.

System.Reflection.AmbiguousMatchException.#ctor

Initializes a new instance of the System.Reflection.AmbiguousMatchException class with an empty message string and the root cause exception set to null.

System.Reflection.AmbiguousMatchException.#ctor()

Initializes a new instance of the System.Reflection.AmbiguousMatchException class with its message string set to the given message and the root cause exception set to null.

Parameters

NameDescriptionDefault
message A string indicating the reason this exception was thrown.

System.Reflection.AmbiguousMatchException.#ctor()

Initializes a new instance of the System.Reflection.AmbiguousMatchException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
inner The exception that is the cause of the current exception. If the inner parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.Reflection.Assembly

Represents an assembly, which is a reusable, versionable, and self-describing building block of a common language runtime application.

System.Reflection.Assembly.ModuleResolve

Occurs when the common language runtime class loader cannot resolve a reference to an internal module of an assembly through normal means.

System.Reflection.Assembly.#ctor

Initializes a new instance of the System.Reflection.Assembly class.

System.Reflection.Assembly.CreateInstance()

Locates the specified type from this assembly and creates an instance of it using the system activator, using case-sensitive search.

Parameters

NameDescriptionDefault
typeName The System.Type.FullName of the type to locate.

Returns

An instance of the specified type created with the parameterless constructor; or null if typeName is not found. The type is resolved using the default binder, without specifying culture or activation attributes, and with System.Reflection.BindingFlags set to Public or Instance.

System.Reflection.Assembly.CreateInstance()

Locates the specified type from this assembly and creates an instance of it using the system activator, with optional case-sensitive search.

Parameters

NameDescriptionDefault
typeName The System.Type.FullName of the type to locate.
ignoreCase true to ignore the case of the type name; otherwise, false.

Returns

An instance of the specified type created with the parameterless constructor; or null if typeName is not found. The type is resolved using the default binder, without specifying culture or activation attributes, and with System.Reflection.BindingFlags set to Public or Instance.

System.Reflection.Assembly.CreateInstance()

Locates the specified type from this assembly and creates an instance of it using the system activator, with optional case-sensitive search and having the specified culture, arguments, and binding and activation attributes.

Parameters

NameDescriptionDefault
typeName The System.Type.FullName of the type to locate.
ignoreCase true to ignore the case of the type name; otherwise, false.
bindingAttr A bitmask that affects the way in which the search is conducted. The value is a combination of bit flags from System.Reflection.BindingFlags.
binder An object that enables the binding, coercion of argument types, invocation of members, and retrieval of MemberInfo objects via reflection. If binder is null, the default binder is used.
args An array that contains the arguments to be passed to the constructor. This array of arguments must match in number, order, and type the parameters of the constructor to be invoked. If the parameterless constructor is desired, args must be an empty array or null.
culture An instance of CultureInfo used to govern the coercion of types. If this is null, the System.Globalization.CultureInfo for the current thread is used. (This is necessary to convert a string that represents 1000 to a System.Double value, for example, since 1000 is represented differently by different cultures.)
activationAttributes An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object that specifies the URL that is required to activate a remote object. This parameter is related to client-activated objects. Client activation is a legacy technology that is retained for backward compatibility but is not recommended for new development. Distributed applications should instead use Windows Communication Foundation.

Returns

An instance of the specified type, or null if typeName is not found. The supplied arguments are used to resolve the type, and to bind the constructor that is used to create the instance.

System.Reflection.Assembly.CreateQualifiedName()

Creates the name of a type qualified by the display name of its assembly.

Parameters

NameDescriptionDefault
assemblyName The display name of an assembly.
typeName The full name of a type.

Returns

The full name of the type qualified by the display name of the assembly.

System.Reflection.Assembly.Equals()

Determines whether this assembly and the specified object are equal.

Parameters

NameDescriptionDefault
o The object to compare with this instance.

Returns

true if o is equal to this instance; otherwise, false.

System.Reflection.Assembly.GetAssembly()

Gets the currently loaded assembly in which the specified type is defined.

Parameters

NameDescriptionDefault
type An object representing a type in the assembly that will be returned.

Returns

The assembly in which the specified type is defined.

System.Reflection.Assembly.GetCallingAssembly

Returns the System.Reflection.Assembly of the method that invoked the currently executing method.

Returns

The Assembly object of the method that invoked the currently executing method.

System.Reflection.Assembly.GetCustomAttributes()

Gets all the custom attributes for this assembly.

Parameters

NameDescriptionDefault
inherit This argument is ignored for objects of type System.Reflection.Assembly.

Returns

An array that contains the custom attributes for this assembly.

System.Reflection.Assembly.GetCustomAttributes()

Gets the custom attributes for this assembly as specified by type.

Parameters

NameDescriptionDefault
attributeType The type for which the custom attributes are to be returned.
inherit This argument is ignored for objects of type System.Reflection.Assembly.

Returns

An array that contains the custom attributes for this assembly as specified by attributeType.

System.Reflection.Assembly.GetCustomAttributesData

Returns information about the attributes that have been applied to the current System.Reflection.Assembly, expressed as System.Reflection.CustomAttributeData objects.

Returns

A generic list of System.Reflection.CustomAttributeData objects representing data about the attributes that have been applied to the current assembly.

System.Reflection.Assembly.GetEntryAssembly

Gets the process executable in the default application domain. In other application domains, this is the first executable that was executed by System.AppDomain.ExecuteAssembly().

Returns

The assembly that is the process executable in the default application domain, or the first executable that was executed by System.AppDomain.ExecuteAssembly(). Can return null when called from unmanaged code.

System.Reflection.Assembly.GetExecutingAssembly

Gets the assembly that contains the code that is currently executing.

Returns

The assembly that contains the code that is currently executing.

System.Reflection.Assembly.GetExportedTypes

Gets the public types defined in this assembly that are visible outside the assembly.

Returns

An array that represents the types defined in this assembly that are visible outside the assembly.

System.Reflection.Assembly.GetFile()

Gets a System.IO.FileStream for the specified file in the file table of the manifest of this assembly.

Parameters

NameDescriptionDefault
name The name of the specified file. Do not include the path to the file.

Returns

A stream that contains the specified file, or null if the file is not found.

System.Reflection.Assembly.GetFiles

Gets the files in the file table of an assembly manifest.

Returns

An array of streams that contain the files.

System.Reflection.Assembly.GetFiles()

Gets the files in the file table of an assembly manifest, specifying whether to include resource modules.

Parameters

NameDescriptionDefault
getResourceModules true to include resource modules; otherwise, false.

Returns

An array of streams that contain the files.

System.Reflection.Assembly.GetForwardedTypes

System.Reflection.Assembly.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Reflection.Assembly.GetLoadedModules

Gets all the loaded modules that are part of this assembly.

Returns

An array of modules.

System.Reflection.Assembly.GetLoadedModules()

Gets all the loaded modules that are part of this assembly, specifying whether to include resource modules.

Parameters

NameDescriptionDefault
getResourceModules true to include resource modules; otherwise, false.

Returns

An array of modules.

System.Reflection.Assembly.GetManifestResourceInfo()

Returns information about how the given resource has been persisted.

Parameters

NameDescriptionDefault
resourceName The case-sensitive name of the resource.

Returns

An object that is populated with information about the resource's topology, or null if the resource is not found.

System.Reflection.Assembly.GetManifestResourceNames

Returns the names of all the resources in this assembly.

Returns

An array that contains the names of all the resources.

System.Reflection.Assembly.GetManifestResourceStream()

Loads the specified manifest resource from this assembly.

Parameters

NameDescriptionDefault
name The case-sensitive name of the manifest resource being requested.

Returns

The manifest resource; or null if no resources were specified during compilation or if the resource is not visible to the caller.

System.Reflection.Assembly.GetManifestResourceStream()

Loads the specified manifest resource, scoped by the namespace of the specified type, from this assembly.

Parameters

NameDescriptionDefault
type The type whose namespace is used to scope the manifest resource name.
name The case-sensitive name of the manifest resource being requested.

Returns

The manifest resource; or null if no resources were specified during compilation or if the resource is not visible to the caller.

System.Reflection.Assembly.GetModule()

Gets the specified module in this assembly.

Parameters

NameDescriptionDefault
name The name of the module being requested.

Returns

The module being requested, or null if the module is not found.

System.Reflection.Assembly.GetModules

Gets all the modules that are part of this assembly.

Returns

An array of modules.

System.Reflection.Assembly.GetModules()

Gets all the modules that are part of this assembly, specifying whether to include resource modules.

Parameters

NameDescriptionDefault
getResourceModules true to include resource modules; otherwise, false.

Returns

An array of modules.

System.Reflection.Assembly.GetName

Gets an System.Reflection.AssemblyName for this assembly.

Returns

An object that contains the fully parsed display name for this assembly.

System.Reflection.Assembly.GetName()

Gets an System.Reflection.AssemblyName for this assembly, setting the codebase as specified by copiedName.

Parameters

NameDescriptionDefault
copiedName true to set the System.Reflection.Assembly.CodeBase to the location of the assembly after it was shadow copied; false to set System.Reflection.Assembly.CodeBase to the original location.

Returns

An object that contains the fully parsed display name for this assembly.

System.Reflection.Assembly.GetObjectData()

Gets serialization information with all of the data needed to reinstantiate this assembly.

Parameters

NameDescriptionDefault
info The object to be populated with serialization information.
context The destination context of the serialization.

System.Reflection.Assembly.GetReferencedAssemblies

Gets the System.Reflection.AssemblyName objects for all the assemblies referenced by this assembly.

Returns

An array that contains the fully parsed display names of all the assemblies referenced by this assembly.

System.Reflection.Assembly.GetSatelliteAssembly()

Gets the satellite assembly for the specified culture.

Parameters

NameDescriptionDefault
culture The specified culture.

Returns

The specified satellite assembly.

System.Reflection.Assembly.GetSatelliteAssembly()

Gets the specified version of the satellite assembly for the specified culture.

Parameters

NameDescriptionDefault
culture The specified culture.
version The version of the satellite assembly.

Returns

The specified satellite assembly.

System.Reflection.Assembly.GetType()

Gets the System.Type object with the specified name in the assembly instance.

Parameters

NameDescriptionDefault
name The full name of the type.

Returns

An object that represents the specified class, or null if the class is not found.

System.Reflection.Assembly.GetType()

Gets the System.Type object with the specified name in the assembly instance and optionally throws an exception if the type is not found.

Parameters

NameDescriptionDefault
name The full name of the type.
throwOnError true to throw an exception if the type is not found; false to return null.

Returns

An object that represents the specified class.

System.Reflection.Assembly.GetType()

Gets the System.Type object with the specified name in the assembly instance, with the options of ignoring the case, and of throwing an exception if the type is not found.

Parameters

NameDescriptionDefault
name The full name of the type.
throwOnError true to throw an exception if the type is not found; false to return null.
ignoreCase true to ignore the case of the type name; otherwise, false.

Returns

An object that represents the specified class.

System.Reflection.Assembly.GetTypes

Gets all types defined in this assembly.

Returns

An array that contains all the types that are defined in this assembly.

System.Reflection.Assembly.IsDefined()

Indicates whether or not a specified attribute has been applied to the assembly.

Parameters

NameDescriptionDefault
attributeType The type of the attribute to be checked for this assembly.
inherit This argument is ignored for objects of this type.

Returns

true if the attribute has been applied to the assembly; otherwise, false.

System.Reflection.Assembly.Load()

Loads the assembly with a common object file format (COFF)-based image containing an emitted assembly. The assembly is loaded into the application domain of the caller.

Parameters

NameDescriptionDefault
rawAssembly A byte array that is a COFF-based image containing an emitted assembly.

Returns

The loaded assembly.

System.Reflection.Assembly.Load()

Loads the assembly with a common object file format (COFF)-based image containing an emitted assembly, optionally including symbols for the assembly. The assembly is loaded into the application domain of the caller.

Parameters

NameDescriptionDefault
rawAssembly A byte array that is a COFF-based image containing an emitted assembly.
rawSymbolStore A byte array that contains the raw bytes representing the symbols for the assembly.

Returns

The loaded assembly.

System.Reflection.Assembly.Load()

Loads an assembly given its System.Reflection.AssemblyName.

Parameters

NameDescriptionDefault
assemblyRef The object that describes the assembly to be loaded.

Returns

The loaded assembly.

System.Reflection.Assembly.Load()

Loads an assembly with the specified name.

Parameters

NameDescriptionDefault
assemblyString The long or short form of the assembly name.

Returns

The loaded assembly.

System.Reflection.Assembly.LoadFile()

Loads the contents of an assembly file on the specified path.

Parameters

NameDescriptionDefault
path The fully qualified path of the file to load.

Returns

The loaded assembly.

System.Reflection.Assembly.LoadFrom()

Loads an assembly given its file name or path.

Parameters

NameDescriptionDefault
assemblyFile The name or path of the file that contains the manifest of the assembly.

Returns

The loaded assembly.

System.Reflection.Assembly.LoadFrom()

Loads an assembly given its file name or path, hash value, and hash algorithm.

Parameters

NameDescriptionDefault
assemblyFile The name or path of the file that contains the manifest of the assembly.
hashValue The value of the computed hash code.
hashAlgorithm The hash algorithm used for hashing files and for generating the strong name.

Returns

The loaded assembly.

System.Reflection.Assembly.LoadModule()

Loads the module, internal to this assembly, with a common object file format (COFF)-based image containing an emitted module, or a resource file.

Parameters

NameDescriptionDefault
moduleName The name of the module. This string must correspond to a file name in this assembly's manifest.
rawModule A byte array that is a COFF-based image containing an emitted module, or a resource.

Returns

The loaded module.

System.Reflection.Assembly.LoadModule()

Loads the module, internal to this assembly, with a common object file format (COFF)-based image containing an emitted module, or a resource file. The raw bytes representing the symbols for the module are also loaded.

Parameters

NameDescriptionDefault
moduleName The name of the module. This string must correspond to a file name in this assembly's manifest.
rawModule A byte array that is a COFF-based image containing an emitted module, or a resource.
rawSymbolStore A byte array containing the raw bytes representing the symbols for the module. Must be null if this is a resource file.

Returns

The loaded module.

System.Reflection.Assembly.LoadWithPartialName()

Loads an assembly from the application directory or from the global assembly cache using a partial name.

Parameters

NameDescriptionDefault
partialName The display name of the assembly.

Returns

The loaded assembly. If partialName is not found, this method returns null.

System.Reflection.Assembly.op_Equality()

Indicates whether two System.Reflection.Assembly objects are equal.

Parameters

NameDescriptionDefault
left The assembly to compare to right.
right The assembly to compare to left.

Returns

true if left is equal to right; otherwise, false.

System.Reflection.Assembly.op_Inequality()

Indicates whether two System.Reflection.Assembly objects are not equal.

Parameters

NameDescriptionDefault
left The assembly to compare to right.
right The assembly to compare to left.

Returns

true if left is not equal to right; otherwise, false.

System.Reflection.Assembly.ReflectionOnlyLoad()

Loads the assembly from a common object file format (COFF)-based image containing an emitted assembly. The assembly is loaded into the reflection-only context of the caller's application domain.

Parameters

NameDescriptionDefault
rawAssembly A byte array that is a COFF-based image containing an emitted assembly.

Returns

The loaded assembly.

System.Reflection.Assembly.ReflectionOnlyLoad()

Loads an assembly into the reflection-only context, given its display name.

Parameters

NameDescriptionDefault
assemblyString The display name of the assembly, as returned by the System.Reflection.AssemblyName.FullName property.

Returns

The loaded assembly.

System.Reflection.Assembly.ReflectionOnlyLoadFrom()

Loads an assembly into the reflection-only context, given its path.

Parameters

NameDescriptionDefault
assemblyFile The path of the file that contains the manifest of the assembly.

Returns

The loaded assembly.

System.Reflection.Assembly.ToString

Returns the full name of the assembly, also known as the display name.

Returns

The full name of the assembly, or the class name if the full name of the assembly cannot be determined.

System.Reflection.Assembly.UnsafeLoadFrom()

Loads an assembly into the load-from context, bypassing some security checks.

Parameters

NameDescriptionDefault
assemblyFile The name or path of the file that contains the manifest of the assembly.

Returns

The loaded assembly.

System.Reflection.Assembly.CodeBase

Gets the location of the assembly as specified originally, for example, in an System.Reflection.AssemblyName object.

Returns

The location of the assembly as specified originally.

System.Reflection.Assembly.CustomAttributes

Gets a collection that contains this assembly's custom attributes.

Returns

A collection that contains this assembly's custom attributes.

System.Reflection.Assembly.DefinedTypes

Gets a collection of the types defined in this assembly.

Returns

A collection of the types defined in this assembly.

System.Reflection.Assembly.EntryPoint

Gets the entry point of this assembly.

Returns

An object that represents the entry point of this assembly. If no entry point is found (for example, the assembly is a DLL), null is returned.

System.Reflection.Assembly.EscapedCodeBase

Gets the URI, including escape characters, that represents the codebase.

Returns

A URI with escape characters.

System.Reflection.Assembly.ExportedTypes

Gets a collection of the public types defined in this assembly that are visible outside the assembly.

Returns

A collection of the public types defined in this assembly that are visible outside the assembly.

System.Reflection.Assembly.FullName

Gets the display name of the assembly.

Returns

The display name of the assembly.

System.Reflection.Assembly.GlobalAssemblyCache

Gets a value indicating whether the assembly was loaded from the global assembly cache (.NET Framework only).

Returns

.NET Framework only: true if the assembly was loaded from the global assembly cache; otherwise, false. .NET Core and .NET 5 and later: false in all cases.

System.Reflection.Assembly.HostContext

Gets the host context with which the assembly was loaded.

Returns

An System.Int64 value that indicates the host context with which the assembly was loaded, if any.

System.Reflection.Assembly.ImageRuntimeVersion

Gets a string representing the version of the common language runtime (CLR) saved in the file containing the manifest.

Returns

The CLR version folder name. This is not a full path.

System.Reflection.Assembly.IsCollectible

Gets a value that indicates whether this assembly is held in a collectible System.Runtime.Loader.AssemblyLoadContext.

Returns

true if this assembly is held in a collectible System.Runtime.Loader.AssemblyLoadContext; otherwise, false.

System.Reflection.Assembly.IsDynamic

Gets a value that indicates whether the current assembly was generated dynamically in the current process by using reflection emit.

Returns

true if the current assembly was generated dynamically in the current process; otherwise, false.

System.Reflection.Assembly.IsFullyTrusted

Gets a value that indicates whether the current assembly is loaded with full trust.

Returns

true if the current assembly is loaded with full trust; otherwise, false.

System.Reflection.Assembly.Location

Gets the full path or UNC location of the loaded file that contains the manifest.

Returns

The location of the loaded file that contains the manifest. If the assembly is loaded from a byte array, such as when using System.Reflection.Assembly.Load(), the value returned is an empty string ("").

System.Reflection.Assembly.ManifestModule

Gets the module that contains the manifest for the current assembly.

Returns

The module that contains the manifest for the assembly.

System.Reflection.Assembly.Modules

Gets a collection that contains the modules in this assembly.

Returns

A collection that contains the modules in this assembly.

System.Reflection.Assembly.ReflectionOnly

Gets a System.Boolean value indicating whether this assembly was loaded into the reflection-only context.

Returns

true if the assembly was loaded into the reflection-only context, rather than the execution context; otherwise, false.

System.Reflection.Assembly.SecurityRuleSet

Gets a value that indicates which set of security rules the common language runtime (CLR) enforces for this assembly.

Returns

The security rule set that the CLR enforces for this assembly.

System.Reflection.AssemblyAlgorithmIdAttribute

Specifies an algorithm to hash all files in an assembly. This class cannot be inherited.

System.Reflection.AssemblyAlgorithmIdAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyAlgorithmIdAttribute class with the specified hash algorithm, using one of the members of System.Configuration.Assemblies.AssemblyHashAlgorithm to represent the hash algorithm.

Parameters

NameDescriptionDefault
algorithmId A member of AssemblyHashAlgorithm that represents the hash algorithm.

System.Reflection.AssemblyAlgorithmIdAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyAlgorithmIdAttribute class with the specified hash algorithm, using an unsigned integer to represent the hash algorithm.

Parameters

NameDescriptionDefault
algorithmId An unsigned integer representing the hash algorithm.

System.Reflection.AssemblyAlgorithmIdAttribute.AlgorithmId

Gets the hash algorithm of an assembly manifest's contents.

Returns

An unsigned integer representing the assembly hash algorithm.

System.Reflection.AssemblyCompanyAttribute

Defines a company name custom attribute for an assembly manifest.

System.Reflection.AssemblyCompanyAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyCompanyAttribute class.

Parameters

NameDescriptionDefault
company The company name information.

System.Reflection.AssemblyCompanyAttribute.Company

Gets company name information.

Returns

A string containing the company name.

System.Reflection.AssemblyConfigurationAttribute

Specifies the build configuration, such as retail or debug, for an assembly.

System.Reflection.AssemblyConfigurationAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyConfigurationAttribute class.

Parameters

NameDescriptionDefault
configuration The assembly configuration.

System.Reflection.AssemblyConfigurationAttribute.Configuration

Gets assembly configuration information.

Returns

A string containing the assembly configuration information.

System.Reflection.AssemblyContentType

Provides information about the type of code contained in an assembly.

System.Reflection.AssemblyContentType.Default

The assembly contains .NET code.

System.Reflection.AssemblyContentType.WindowsRuntime

The assembly contains Windows Runtime code.

System.Reflection.AssemblyCopyrightAttribute

Defines a copyright custom attribute for an assembly manifest.

System.Reflection.AssemblyCopyrightAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyCopyrightAttribute class.

Parameters

NameDescriptionDefault
copyright The copyright information.

System.Reflection.AssemblyCopyrightAttribute.Copyright

Gets copyright information.

Returns

A string containing the copyright information.

System.Reflection.AssemblyCultureAttribute

Specifies which culture the assembly supports.

System.Reflection.AssemblyCultureAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyCultureAttribute class with the culture supported by the assembly being attributed.

Parameters

NameDescriptionDefault
culture The culture supported by the attributed assembly.

System.Reflection.AssemblyCultureAttribute.Culture

Gets the supported culture of the attributed assembly.

Returns

A string containing the name of the supported culture.

System.Reflection.AssemblyDefaultAliasAttribute

Defines a friendly default alias for an assembly manifest.

System.Reflection.AssemblyDefaultAliasAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyDefaultAliasAttribute class.

Parameters

NameDescriptionDefault
defaultAlias The assembly default alias information.

System.Reflection.AssemblyDefaultAliasAttribute.DefaultAlias

Gets default alias information.

Returns

A string containing the default alias information.

System.Reflection.AssemblyDelaySignAttribute

Specifies that the assembly is not fully signed when created.

System.Reflection.AssemblyDelaySignAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyDelaySignAttribute class.

Parameters

NameDescriptionDefault
delaySign true if the feature this attribute represents is activated; otherwise, false.

System.Reflection.AssemblyDelaySignAttribute.DelaySign

Gets a value indicating the state of the attribute.

Returns

true if this assembly has been built as delay-signed; otherwise, false.

System.Reflection.AssemblyDescriptionAttribute

Provides a text description for an assembly.

System.Reflection.AssemblyDescriptionAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyDescriptionAttribute class.

Parameters

NameDescriptionDefault
description The assembly description.

System.Reflection.AssemblyDescriptionAttribute.Description

Gets assembly description information.

Returns

A string containing the assembly description.

System.Reflection.AssemblyFileVersionAttribute

Instructs a compiler to use a specific version number for the Win32 file version resource. The Win32 file version is not required to be the same as the assembly's version number.

System.Reflection.AssemblyFileVersionAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyFileVersionAttribute class, specifying the file version.

Parameters

NameDescriptionDefault
version The file version.

System.Reflection.AssemblyFileVersionAttribute.Version

Gets the Win32 file version resource name.

Returns

A string containing the file version resource name.

System.Reflection.AssemblyFlagsAttribute

Specifies a bitwise combination of System.Reflection.AssemblyNameFlags flags for an assembly, describing just-in-time (JIT) compiler options, whether the assembly is retargetable, and whether it has a full or tokenized public key. This class cannot be inherited.

System.Reflection.AssemblyFlagsAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyFlagsAttribute class with the specified combination of System.Reflection.AssemblyNameFlags flags, cast as an integer value.

Parameters

NameDescriptionDefault
assemblyFlags A bitwise combination of System.Reflection.AssemblyNameFlags flags, cast as an integer value, representing just-in-time (JIT) compiler options, longevity, whether an assembly is retargetable, and whether it has a full or tokenized public key.

System.Reflection.AssemblyFlagsAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyFlagsAttribute class with the specified combination of System.Reflection.AssemblyNameFlags flags.

Parameters

NameDescriptionDefault
assemblyFlags A bitwise combination of System.Reflection.AssemblyNameFlags flags representing just-in-time (JIT) compiler options, longevity, whether an assembly is retargetable, and whether it has a full or tokenized public key.

System.Reflection.AssemblyFlagsAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyFlagsAttribute class with the specified combination of System.Reflection.AssemblyNameFlags flags, cast as an unsigned integer value.

Parameters

NameDescriptionDefault
flags A bitwise combination of System.Reflection.AssemblyNameFlags flags, cast as an unsigned integer value, representing just-in-time (JIT) compiler options, longevity, whether an assembly is retargetable, and whether it has a full or tokenized public key.

System.Reflection.AssemblyFlagsAttribute.AssemblyFlags

Gets an integer value representing the combination of System.Reflection.AssemblyNameFlags flags specified when this attribute instance was created.

Returns

An integer value representing a bitwise combination of System.Reflection.AssemblyNameFlags flags.

System.Reflection.AssemblyFlagsAttribute.Flags

Gets an unsigned integer value representing the combination of System.Reflection.AssemblyNameFlags flags specified when this attribute instance was created.

Returns

An unsigned integer value representing a bitwise combination of System.Reflection.AssemblyNameFlags flags.

System.Reflection.AssemblyInformationalVersionAttribute

Defines additional version information for an assembly manifest.

System.Reflection.AssemblyInformationalVersionAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyInformationalVersionAttribute class.

Parameters

NameDescriptionDefault
informationalVersion The assembly version information.

System.Reflection.AssemblyInformationalVersionAttribute.InformationalVersion

Gets version information.

Returns

A string containing the version information.

System.Reflection.AssemblyKeyFileAttribute

Specifies the name of a file containing the key pair used to generate a strong name.

System.Reflection.AssemblyKeyFileAttribute.#ctor()

Initializes a new instance of the AssemblyKeyFileAttribute class with the name of the file containing the key pair to generate a strong name for the assembly being attributed.

Parameters

NameDescriptionDefault
keyFile The name of the file containing the key pair.

System.Reflection.AssemblyKeyFileAttribute.KeyFile

Gets the name of the file containing the key pair used to generate a strong name for the attributed assembly.

Returns

A string containing the name of the file that contains the key pair.

System.Reflection.AssemblyKeyNameAttribute

Specifies the name of a key container within the CSP containing the key pair used to generate a strong name.

System.Reflection.AssemblyKeyNameAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyKeyNameAttribute class with the name of the container holding the key pair used to generate a strong name for the assembly being attributed.

Parameters

NameDescriptionDefault
keyName The name of the container containing the key pair.

System.Reflection.AssemblyKeyNameAttribute.KeyName

Gets the name of the container having the key pair that is used to generate a strong name for the attributed assembly.

Returns

A string containing the name of the container that has the relevant key pair.

System.Reflection.AssemblyMetadataAttribute

Defines a key/value metadata pair for the decorated assembly.

System.Reflection.AssemblyMetadataAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyMetadataAttribute class by using the specified metadata key and value.

Parameters

NameDescriptionDefault
key The metadata key.
value The metadata value.

System.Reflection.AssemblyMetadataAttribute.Key

Gets the metadata key.

Returns

The metadata key.

System.Reflection.AssemblyMetadataAttribute.Value

Gets the metadata value.

Returns

The metadata value.

System.Reflection.AssemblyName

Describes an assembly's unique identity in full.

System.Reflection.AssemblyName.#ctor

Initializes a new instance of the System.Reflection.AssemblyName class.

System.Reflection.AssemblyName.#ctor()

Initializes a new instance of the System.Reflection.AssemblyName class with the specified display name.

Parameters

NameDescriptionDefault
assemblyName The display name of the assembly, as returned by the System.Reflection.AssemblyName.FullName property.

System.Reflection.AssemblyName.Clone

Makes a copy of this System.Reflection.AssemblyName object.

Returns

An object that is a copy of this System.Reflection.AssemblyName object.

System.Reflection.AssemblyName.GetAssemblyName()

Gets the System.Reflection.AssemblyName for a given file.

Parameters

NameDescriptionDefault
assemblyFile The path for the assembly whose System.Reflection.AssemblyName is to be returned.

Returns

An object that represents the given assembly file.

System.Reflection.AssemblyName.GetObjectData()

Gets serialization information with all the data needed to recreate an instance of this AssemblyName.

Parameters

NameDescriptionDefault
info The object to be populated with serialization information.
context The destination context of the serialization.

System.Reflection.AssemblyName.GetPublicKey

Gets the public key of the assembly.

Returns

A byte array that contains the public key of the assembly.

System.Reflection.AssemblyName.GetPublicKeyToken

Gets the public key token, which is the last 8 bytes of the SHA-1 hash of the public key under which the application or assembly is signed.

Returns

A byte array that contains the public key token.

System.Reflection.AssemblyName.OnDeserialization()

Implements the System.Runtime.Serialization.ISerializable interface and is called back by the deserialization event when deserialization is complete.

Parameters

NameDescriptionDefault
sender The source of the deserialization event.

System.Reflection.AssemblyName.ReferenceMatchesDefinition()

Returns a value indicating whether two assembly names are the same. The comparison is based on the simple assembly names.

Parameters

NameDescriptionDefault
reference The reference assembly name.
definition The assembly name that is compared to the reference assembly.

Returns

true if the simple assembly names are the same; otherwise, false.

System.Reflection.AssemblyName.SetPublicKey()

Sets the public key identifying the assembly.

Parameters

NameDescriptionDefault
publicKey A byte array containing the public key of the assembly.

System.Reflection.AssemblyName.SetPublicKeyToken()

Sets the public key token, which is the last 8 bytes of the SHA-1 hash of the public key under which the application or assembly is signed.

Parameters

NameDescriptionDefault
publicKeyToken A byte array containing the public key token of the assembly.

System.Reflection.AssemblyName.ToString

Returns the full name of the assembly, also known as the display name.

Returns

The full name of the assembly, or the class name if the full name cannot be determined.

System.Reflection.AssemblyName.CodeBase

Gets or sets the location of the assembly as a URL.

Returns

A string that is the URL location of the assembly.

System.Reflection.AssemblyName.ContentType

Gets or sets a value that indicates what type of content the assembly contains.

Returns

A value that indicates what type of content the assembly contains.

System.Reflection.AssemblyName.CultureInfo

Gets or sets the culture supported by the assembly.

Returns

An object that represents the culture supported by the assembly.

System.Reflection.AssemblyName.CultureName

Gets or sets the name of the culture associated with the assembly.

Returns

The culture name.

System.Reflection.AssemblyName.EscapedCodeBase

Gets the URI, including escape characters, that represents the codebase.

Returns

A URI with escape characters.

System.Reflection.AssemblyName.Flags

Gets or sets the attributes of the assembly.

Returns

A value that represents the attributes of the assembly.

System.Reflection.AssemblyName.FullName

Gets the full name of the assembly, also known as the display name.

Returns

A string that is the full name of the assembly, also known as the display name.

System.Reflection.AssemblyName.HashAlgorithm

Gets or sets the hash algorithm used by the assembly manifest.

Returns

The hash algorithm used by the assembly manifest.

System.Reflection.AssemblyName.KeyPair

Gets or sets the public and private cryptographic key pair that is used to create a strong name signature for the assembly.

Returns

The public and private cryptographic key pair to be used to create a strong name for the assembly.

System.Reflection.AssemblyName.Name

Gets or sets the simple name of the assembly. This is usually, but not necessarily, the file name of the manifest file of the assembly, minus its extension.

Returns

The simple name of the assembly.

System.Reflection.AssemblyName.ProcessorArchitecture

Gets or sets a value that identifies the processor and bits-per-word of the platform targeted by an executable.

Returns

One of the enumeration values that identifies the processor and bits-per-word of the platform targeted by an executable.

System.Reflection.AssemblyName.Version

Gets or sets the major, minor, build, and revision numbers of the assembly.

Returns

An object that represents the major, minor, build, and revision numbers of the assembly.

System.Reflection.AssemblyName.VersionCompatibility

Gets or sets the information related to the assembly's compatibility with other assemblies.

Returns

A value that represents information about the assembly's compatibility with other assemblies.

System.Reflection.AssemblyNameFlags

Provides information about an System.Reflection.Assembly reference.

System.Reflection.AssemblyNameFlags.EnableJITcompileOptimizer

Specifies that just-in-time (JIT) compiler optimization is disabled for the assembly. This is the exact opposite of the meaning that is suggested by the member name.

System.Reflection.AssemblyNameFlags.EnableJITcompileTracking

Specifies that just-in-time (JIT) compiler tracking is enabled for the assembly.

System.Reflection.AssemblyNameFlags.None

Specifies that no flags are in effect.

System.Reflection.AssemblyNameFlags.PublicKey

Specifies that a public key is formed from the full public key rather than the public key token.

System.Reflection.AssemblyNameFlags.Retargetable

Specifies that the assembly can be retargeted at runtime to an assembly from a different publisher. This value supports the .NET Framework infrastructure and is not intended to be used directly from your code.

System.Reflection.AssemblyNameProxy

Provides a remotable version of the AssemblyName.

System.Reflection.AssemblyNameProxy.#ctor

Initializes a new instance of the System.Reflection.AssemblyNameProxy class.

System.Reflection.AssemblyNameProxy.GetAssemblyName()

Gets the AssemblyName for a given file.

Parameters

NameDescriptionDefault
assemblyFile The assembly file for which to get the AssemblyName.

Returns

An AssemblyName object representing the given file.

System.Reflection.AssemblyProductAttribute

Defines a product name custom attribute for an assembly manifest.

System.Reflection.AssemblyProductAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyProductAttribute class.

Parameters

NameDescriptionDefault
product The product name information.

System.Reflection.AssemblyProductAttribute.Product

Gets product name information.

Returns

A string containing the product name.

System.Reflection.AssemblySignatureKeyAttribute

Provides migration from an older, simpler strong name key to a larger key with a stronger hashing algorithm.

System.Reflection.AssemblySignatureKeyAttribute.#ctor()

Creates a new instance of the System.Reflection.AssemblySignatureKeyAttribute class by using the specified public key and countersignature.

Parameters

NameDescriptionDefault
publicKey The public or identity key.
countersignature The countersignature, which is the signature key portion of the strong-name key.

System.Reflection.AssemblySignatureKeyAttribute.Countersignature

Gets the countersignature for the strong name for this assembly.

Returns

The countersignature for this signature key.

System.Reflection.AssemblySignatureKeyAttribute.PublicKey

Gets the public key for the strong name used to sign the assembly.

Returns

The public key for this assembly.

System.Reflection.AssemblyTitleAttribute

Specifies a description for an assembly.

System.Reflection.AssemblyTitleAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyTitleAttribute class.

Parameters

NameDescriptionDefault
title The assembly title.

System.Reflection.AssemblyTitleAttribute.Title

Gets assembly title information.

Returns

The assembly title.

System.Reflection.AssemblyTrademarkAttribute

Defines a trademark custom attribute for an assembly manifest.

System.Reflection.AssemblyTrademarkAttribute.#ctor()

Initializes a new instance of the System.Reflection.AssemblyTrademarkAttribute class.

Parameters

NameDescriptionDefault
trademark The trademark information.

System.Reflection.AssemblyTrademarkAttribute.Trademark

Gets trademark information.

Returns

A String containing trademark information.

System.Reflection.AssemblyVersionAttribute

Specifies the version of the assembly being attributed.

System.Reflection.AssemblyVersionAttribute.#ctor()

Initializes a new instance of the AssemblyVersionAttribute class with the version number of the assembly being attributed.

Parameters

NameDescriptionDefault
version The version number of the attributed assembly.

System.Reflection.AssemblyVersionAttribute.Version

Gets the version number of the attributed assembly.

Returns

A string containing the assembly version number.

System.Reflection.Binder

Selects a member from a list of candidates, and performs type conversion from actual argument type to formal argument type.

System.Reflection.Binder.#ctor

Initializes a new instance of the System.Reflection.Binder class.

System.Reflection.Binder.BindToField()

Selects a field from the given set of fields, based on the specified criteria.

Parameters

NameDescriptionDefault
bindingAttr A bitwise combination of System.Reflection.BindingFlags values.
match The set of fields that are candidates for matching. For example, when a System.Reflection.Binder object is used by System.Type.InvokeMember, this parameter specifies the set of fields that reflection has determined to be possible matches, typically because they have the correct member name. The default implementation provided by System.Type.DefaultBinder changes the order of this array.
value The field value used to locate a matching field.
culture An instance of System.Globalization.CultureInfo that is used to control the coercion of data types, in binder implementations that coerce types. If culture is null, the System.Globalization.CultureInfo for the current thread is used.

Returns

The matching field.

System.Reflection.Binder.BindToMethod()

Selects a method to invoke from the given set of methods, based on the supplied arguments.

Parameters

NameDescriptionDefault
bindingAttr A bitwise combination of System.Reflection.BindingFlags values.
match The set of methods that are candidates for matching. For example, when a System.Reflection.Binder object is used by System.Type.InvokeMember, this parameter specifies the set of methods that reflection has determined to be possible matches, typically because they have the correct member name. The default implementation provided by System.Type.DefaultBinder changes the order of this array.
args The arguments that are passed in. The binder can change the order of the arguments in this array; for example, the default binder changes the order of arguments if the names parameter is used to specify an order other than positional order. If a binder implementation coerces argument types, the types and values of the arguments can be changed as well.
modifiers An array of parameter modifiers that enable binding to work with parameter signatures in which the types have been modified. The default binder implementation does not use this parameter.
culture An instance of System.Globalization.CultureInfo that is used to control the coercion of data types, in binder implementations that coerce types. If culture is null, the System.Globalization.CultureInfo for the current thread is used.
names The parameter names, if parameter names are to be considered when matching, or null if arguments are to be treated as purely positional. For example, parameter names must be used if arguments are not supplied in positional order.
state After the method returns, state contains a binder-provided object that keeps track of argument reordering. The binder creates this object, and the binder is the sole consumer of this object. If state is not null when BindToMethod returns, you must pass state to the System.Reflection.Binder.ReorderArgumentArray() method if you want to restore args to its original order, for example, so that you can retrieve the values of ref parameters (ByRef parameters in Visual Basic).

Returns

The matching method.

System.Reflection.Binder.ChangeType()

Changes the type of the given Object to the given Type.

Parameters

NameDescriptionDefault
value The object to change into a new Type.
type The new Type that value will become.
culture An instance of System.Globalization.CultureInfo that is used to control the coercion of data types. If culture is null, the System.Globalization.CultureInfo for the current thread is used.

Returns

An object that contains the given value as the new type.

System.Reflection.Binder.ReorderArgumentArray()

Upon returning from System.Reflection.Binder.BindToMethod(), restores the args argument to what it was when it came from BindToMethod.

Parameters

NameDescriptionDefault
args The actual arguments that are passed in. Both the types and values of the arguments can be changed.
state A binder-provided object that keeps track of argument reordering.

System.Reflection.Binder.SelectMethod()

Selects a method from the given set of methods, based on the argument type.

Parameters

NameDescriptionDefault
bindingAttr A bitwise combination of System.Reflection.BindingFlags values.
match The set of methods that are candidates for matching. For example, when a System.Reflection.Binder object is used by System.Type.InvokeMember, this parameter specifies the set of methods that reflection has determined to be possible matches, typically because they have the correct member name. The default implementation provided by System.Type.DefaultBinder changes the order of this array.
types The parameter types used to locate a matching method.
modifiers An array of parameter modifiers that enable binding to work with parameter signatures in which the types have been modified.

Returns

The matching method, if found; otherwise, null.

System.Reflection.Binder.SelectProperty()

Selects a property from the given set of properties, based on the specified criteria.

Parameters

NameDescriptionDefault
bindingAttr A bitwise combination of System.Reflection.BindingFlags values.
match The set of properties that are candidates for matching. For example, when a System.Reflection.Binder object is used by System.Type.InvokeMember, this parameter specifies the set of properties that reflection has determined to be possible matches, typically because they have the correct member name. The default implementation provided by System.Type.DefaultBinder changes the order of this array.
returnType The return value the matching property must have.
indexes The index types of the property being searched for. Used for index properties such as the indexer for a class.
modifiers An array of parameter modifiers that enable binding to work with parameter signatures in which the types have been modified.

Returns

The matching property.

System.Reflection.BindingFlags

Specifies flags that control binding and the way in which the search for members and types is conducted by reflection.

System.Reflection.BindingFlags.CreateInstance

Specifies that reflection should create an instance of the specified type. Calls the constructor that matches the given arguments. The supplied member name is ignored. If the type of lookup is not specified, (Instance | Public) will apply. It is not possible to call a type initializer. This flag is passed to an InvokeMember method to invoke a constructor.

System.Reflection.BindingFlags.DeclaredOnly

Specifies that only members declared at the level of the supplied type's hierarchy should be considered. Inherited members are not considered.

System.Reflection.BindingFlags.Default

Specifies that no binding flags are defined.

System.Reflection.BindingFlags.DoNotWrapExceptions

System.Reflection.BindingFlags.ExactBinding

Specifies that types of the supplied arguments must exactly match the types of the corresponding formal parameters. Reflection throws an exception if the caller supplies a non-null Binder object, since that implies that the caller is supplying BindToXXX implementations that will pick the appropriate method. The default binder ignores this flag, while custom binders can implement the semantics of this flag.

System.Reflection.BindingFlags.FlattenHierarchy

Specifies that public and protected static members up the hierarchy should be returned. Private static members in inherited classes are not returned. Static members include fields, methods, events, and properties. Nested types are not returned.

System.Reflection.BindingFlags.GetField

Specifies that the value of the specified field should be returned. This flag is passed to an InvokeMember method to get a field value.

System.Reflection.BindingFlags.GetProperty

Specifies that the value of the specified property should be returned. This flag is passed to an InvokeMember method to invoke a property getter.

System.Reflection.BindingFlags.IgnoreCase

Specifies that the case of the member name should not be considered when binding.

System.Reflection.BindingFlags.IgnoreReturn

Used in COM interop to specify that the return value of the member can be ignored.

System.Reflection.BindingFlags.Instance

Specifies that instance members are to be included in the search.

System.Reflection.BindingFlags.InvokeMethod

Specifies that a method is to be invoked. This must not be a constructor or a type initializer. This flag is passed to an InvokeMember method to invoke a method.

System.Reflection.BindingFlags.NonPublic

Specifies that non-public members are to be included in the search.

System.Reflection.BindingFlags.OptionalParamBinding

Returns the set of members whose parameter count matches the number of supplied arguments. This binding flag is used for methods with parameters that have default values and methods with variable arguments (varargs). This flag should only be used with System.Type.InvokeMember().

Parameters with default values are used only in calls where trailing arguments are omitted. They must be the last arguments.

System.Reflection.BindingFlags.Public

Specifies that public members are to be included in the search.

System.Reflection.BindingFlags.PutDispProperty

Specifies that the PROPPUT member on a COM object should be invoked. PROPPUT specifies a property-setting function that uses a value. Use PutDispProperty if a property has both PROPPUT and PROPPUTREF and you need to distinguish which one is called.

System.Reflection.BindingFlags.PutRefDispProperty

Specifies that the PROPPUTREF member on a COM object should be invoked. PROPPUTREF specifies a property-setting function that uses a reference instead of a value. Use PutRefDispProperty if a property has both PROPPUT and PROPPUTREF and you need to distinguish which one is called.

System.Reflection.BindingFlags.SetField

Specifies that the value of the specified field should be set. This flag is passed to an InvokeMember method to set a field value.

System.Reflection.BindingFlags.SetProperty

Specifies that the value of the specified property should be set. For COM properties, specifying this binding flag is equivalent to specifying PutDispProperty and PutRefDispProperty. This flag is passed to an InvokeMember method to invoke a property setter.

System.Reflection.BindingFlags.Static

Specifies that static members are to be included in the search.

System.Reflection.BindingFlags.SuppressChangeType

Not implemented.

System.Reflection.CallingConventions

Defines the valid calling conventions for a method.

System.Reflection.CallingConventions.Any

Specifies that either the Standard or the VarArgs calling convention may be used.

System.Reflection.CallingConventions.ExplicitThis

Specifies that the signature is a function-pointer signature, representing a call to an instance or virtual method (not a static method). If ExplicitThis is set, HasThis must also be set. The first argument passed to the called method is still a this pointer, but the type of the first argument is now unknown. Therefore, a token that describes the type (or class) of the this pointer is explicitly stored into its metadata signature.

System.Reflection.CallingConventions.HasThis

Specifies an instance or virtual method (not a static method). At run-time, the called method is passed a pointer to the target object as its first argument (the this pointer). The signature stored in metadata does not include the type of this first argument, because the method is known and its owner class can be discovered from metadata.

System.Reflection.CallingConventions.Standard

Specifies the default calling convention as determined by the common language runtime. Use this calling convention for static methods. For instance or virtual methods use HasThis.

System.Reflection.CallingConventions.VarArgs

Specifies the calling convention for methods with variable arguments.

System.Reflection.ConstructorInfo

Discovers the attributes of a class constructor and provides access to constructor metadata.

System.Reflection.ConstructorInfo.ConstructorName

Represents the name of the class constructor method as it is stored in metadata. This name is always ".ctor". This field is read-only.

System.Reflection.ConstructorInfo.TypeConstructorName

Represents the name of the type constructor method as it is stored in metadata. This name is always ".cctor". This property is read-only.

System.Reflection.ConstructorInfo.#ctor

Initializes a new instance of the System.Reflection.ConstructorInfo class.

System.Reflection.ConstructorInfo.Equals()

Returns a value that indicates whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance, or null.

Returns

true if obj equals the type and value of this instance; otherwise, false.

System.Reflection.ConstructorInfo.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Reflection.ConstructorInfo.Invoke()

Invokes the constructor reflected by the instance that has the specified parameters, providing default values for the parameters not commonly used.

Parameters

NameDescriptionDefault
parameters An array of values that matches the number, order and type (under the constraints of the default binder) of the parameters for this constructor. If this constructor takes no parameters, then use either an array with zero elements or null, as in Object[] parameters = new Object[0]. Any object in this array that is not explicitly initialized with a value will contain the default value for that object type. For reference-type elements, this value is null. For value-type elements, this value is 0, 0.0, or false, depending on the specific element type.

Returns

An instance of the class associated with the constructor.

System.Reflection.ConstructorInfo.Invoke()

When implemented in a derived class, invokes the constructor reflected by this ConstructorInfo with the specified arguments, under the constraints of the specified Binder.

Parameters

NameDescriptionDefault
invokeAttr One of the BindingFlags values that specifies the type of binding.
binder A Binder that defines a set of properties and enables the binding, coercion of argument types, and invocation of members using reflection. If binder is null, then Binder.DefaultBinding is used.
parameters An array of type Object used to match the number, order and type of the parameters for this constructor, under the constraints of binder. If this constructor does not require parameters, pass an array with zero elements, as in Object[] parameters = new Object[0]. Any object in this array that is not explicitly initialized with a value will contain the default value for that object type. For reference-type elements, this value is null. For value-type elements, this value is 0, 0.0, or false, depending on the specific element type.
culture A System.Globalization.CultureInfo used to govern the coercion of types. If this is null, the System.Globalization.CultureInfo for the current thread is used.

Returns

An instance of the class associated with the constructor.

System.Reflection.ConstructorInfo.op_Equality()

Indicates whether two System.Reflection.ConstructorInfo objects are equal.

Parameters

NameDescriptionDefault
left The first System.Reflection.ConstructorInfo to compare.
right The second System.Reflection.ConstructorInfo to compare.

Returns

true if left is equal to right; otherwise false.

System.Reflection.ConstructorInfo.op_Inequality()

Indicates whether two System.Reflection.ConstructorInfo objects are not equal.

Parameters

NameDescriptionDefault
left The first System.Reflection.ConstructorInfo to compare.
right The second System.Reflection.ConstructorInfo to compare.

Returns

true if left is not equal to right; otherwise false.

System.Reflection.ConstructorInfo.MemberType

Gets a System.Reflection.MemberTypes value indicating that this member is a constructor.

Returns

A System.Reflection.MemberTypes value indicating that this member is a constructor.

System.Reflection.ConstructorInvoker

Provides methods to invoke the method specified by the provided System.Reflection.ConstructorInfo.

System.Reflection.ConstructorInvoker.Create()

Creates a new instance of System.Reflection.ConstructorInvoker.

Parameters

NameDescriptionDefault
constructor The constructor that will be invoked.

Returns

The new instance.

System.Reflection.ConstructorInvoker.Invoke

Invokes the constructor.

Returns

An instance of the class associated with the constructor.

System.Reflection.ConstructorInvoker.Invoke()

Invokes the constructor using the specified arguments.

Parameters

NameDescriptionDefault
arg1 The first argument for the invoked method.

Returns

An instance of the class associated with the constructor.

System.Reflection.ConstructorInvoker.Invoke()

Invokes the constructor using the specified arguments.

Parameters

NameDescriptionDefault
arg1 The first argument for the invoked method.
arg2 The second argument for the invoked method.

Returns

An instance of the class associated with the constructor.

System.Reflection.ConstructorInvoker.Invoke()

Invokes the constructor using the specified arguments.

Parameters

NameDescriptionDefault
arg1 The first argument for the invoked method.
arg2 The second argument for the invoked method.
arg3 The third argument for the invoked method.

Returns

An instance of the class associated with the constructor.

System.Reflection.ConstructorInvoker.Invoke()

Invokes the constructor using the specified arguments.

Parameters

NameDescriptionDefault
arg1 The first argument for the invoked method.
arg2 The second argument for the invoked method.
arg3 The third argument for the invoked method.
arg4 The fourth argument for the invoked method.

Returns

An instance of the class associated with the constructor.

System.Reflection.ConstructorInvoker.Invoke()

Invokes the constructor using the specified arguments.

Parameters

NameDescriptionDefault
arguments The arguments for the invoked constructor.

Returns

An instance of the class associated with the constructor.

System.Reflection.CustomAttributeData

Provides access to custom attribute data for assemblies, modules, types, members and parameters that are loaded into the reflection-only context.

System.Reflection.CustomAttributeData.#ctor

Initializes a new instance of the System.Reflection.CustomAttributeData class.

System.Reflection.CustomAttributeData.Equals()

Returns a value that indicates whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance, or null.

Returns

true if obj is equal to the current instance; otherwise, false.

System.Reflection.CustomAttributeData.GetCustomAttributes()

Returns a list of System.Reflection.CustomAttributeData objects representing data about the attributes that have been applied to the target assembly.

Parameters

NameDescriptionDefault
target The assembly whose custom attribute data is to be retrieved.

Returns

A list of objects that represent data about the attributes that have been applied to the target assembly.

System.Reflection.CustomAttributeData.GetCustomAttributes()

Returns a list of System.Reflection.CustomAttributeData objects representing data about the attributes that have been applied to the target member.

Parameters

NameDescriptionDefault
target The member whose attribute data is to be retrieved.

Returns

A list of objects that represent data about the attributes that have been applied to the target member.

System.Reflection.CustomAttributeData.GetCustomAttributes()

Returns a list of System.Reflection.CustomAttributeData objects representing data about the attributes that have been applied to the target module.

Parameters

NameDescriptionDefault
target The module whose custom attribute data is to be retrieved.

Returns

A list of objects that represent data about the attributes that have been applied to the target module.

System.Reflection.CustomAttributeData.GetCustomAttributes()

Returns a list of System.Reflection.CustomAttributeData objects representing data about the attributes that have been applied to the target parameter.

Parameters

NameDescriptionDefault
target The parameter whose attribute data is to be retrieved.

Returns

A list of objects that represent data about the attributes that have been applied to the target parameter.

System.Reflection.CustomAttributeData.GetHashCode

Serves as a hash function for a particular type.

Returns

A hash code for the current System.Object.

System.Reflection.CustomAttributeData.ToString

Returns a string representation of the custom attribute.

Returns

A string value that represents the custom attribute.

System.Reflection.CustomAttributeData.AttributeType

Gets the type of the attribute.

Returns

The type of the attribute.

System.Reflection.CustomAttributeData.Constructor

Gets a System.Reflection.ConstructorInfo object that represents the constructor that would have initialized the custom attribute.

Returns

An object that represents the constructor that would have initialized the custom attribute represented by the current instance of the System.Reflection.CustomAttributeData class.

System.Reflection.CustomAttributeData.ConstructorArguments

Gets the list of positional arguments specified for the attribute instance represented by the System.Reflection.CustomAttributeData object.

Returns

A collection of structures that represent the positional arguments specified for the custom attribute instance.

System.Reflection.CustomAttributeData.NamedArguments

Gets the list of named arguments specified for the attribute instance represented by the System.Reflection.CustomAttributeData object.

Returns

A collection of structures that represent the named arguments specified for the custom attribute instance.

System.Reflection.CustomAttributeExtensions

Contains static methods for retrieving custom attributes.

System.Reflection.CustomAttributeExtensions.GetCustomAttribute()

Retrieves a custom attribute of a specified type that is applied to a specified assembly.

Parameters

NameDescriptionDefault
element The assembly to inspect.
attributeType The type of attribute to search for.

Returns

A custom attribute that matches attributeType, or null if no such attribute is found.

System.Reflection.CustomAttributeExtensions.GetCustomAttribute()

Retrieves a custom attribute of a specified type that is applied to a specified member.

Parameters

NameDescriptionDefault
element The member to inspect.
attributeType The type of attribute to search for.

Returns

A custom attribute that matches attributeType, or null if no such attribute is found.

System.Reflection.CustomAttributeExtensions.GetCustomAttribute()

Retrieves a custom attribute of a specified type that is applied to a specified member, and optionally inspects the ancestors of that member.

Parameters

NameDescriptionDefault
element The member to inspect.
attributeType The type of attribute to search for.
inherit true to inspect the ancestors of element; otherwise, false.

Returns

A custom attribute that matches attributeType, or null if no such attribute is found.

System.Reflection.CustomAttributeExtensions.GetCustomAttribute()

Retrieves a custom attribute of a specified type that is applied to a specified module.

Parameters

NameDescriptionDefault
element The module to inspect.
attributeType The type of attribute to search for.

Returns

A custom attribute that matches attributeType, or null if no such attribute is found.

System.Reflection.CustomAttributeExtensions.GetCustomAttribute()

Retrieves a custom attribute of a specified type that is applied to a specified parameter.

Parameters

NameDescriptionDefault
element The parameter to inspect.
attributeType The type of attribute to search for.

Returns

A custom attribute that matches attributeType, or null if no such attribute is found.

System.Reflection.CustomAttributeExtensions.GetCustomAttribute()

Retrieves a custom attribute of a specified type that is applied to a specified parameter, and optionally inspects the ancestors of that parameter.

Parameters

NameDescriptionDefault
element The parameter to inspect.
attributeType The type of attribute to search for.
inherit true to inspect the ancestors of element; otherwise, false.

Returns

A custom attribute matching attributeType, or null if no such attribute is found.

System.Reflection.CustomAttributeExtensions.GetCustomAttribute``1()

Retrieves a custom attribute of a specified type that is applied to a specified assembly.

Parameters

NameDescriptionDefault
element The assembly to inspect.

Returns

A custom attribute that matches T, or null if no such attribute is found.

System.Reflection.CustomAttributeExtensions.GetCustomAttribute``1()

Retrieves a custom attribute of a specified type that is applied to a specified member.

Parameters

NameDescriptionDefault
element The member to inspect.

Returns

A custom attribute that matches T, or null if no such attribute is found.

System.Reflection.CustomAttributeExtensions.GetCustomAttribute``1()

Retrieves a custom attribute of a specified type that is applied to a specified member, and optionally inspects the ancestors of that member.

Parameters

NameDescriptionDefault
element The member to inspect.
inherit true to inspect the ancestors of element; otherwise, false.

Returns

A custom attribute that matches T, or null if no such attribute is found.

System.Reflection.CustomAttributeExtensions.GetCustomAttribute``1()

Retrieves a custom attribute of a specified type that is applied to a specified module.

Parameters

NameDescriptionDefault
element The module to inspect.

Returns

A custom attribute that matches T, or null if no such attribute is found.

System.Reflection.CustomAttributeExtensions.GetCustomAttribute``1()

Retrieves a custom attribute of a specified type that is applied to a specified parameter.

Parameters

NameDescriptionDefault
element The parameter to inspect.

Returns

A custom attribute that matches T, or null if no such attribute is found.

System.Reflection.CustomAttributeExtensions.GetCustomAttribute``1()

Retrieves a custom attribute of a specified type that is applied to a specified parameter, and optionally inspects the ancestors of that parameter.

Parameters

NameDescriptionDefault
element The parameter to inspect.
inherit true to inspect the ancestors of element; otherwise, false.

Returns

A custom attribute that matches T, or null if no such attribute is found.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes()

Retrieves a collection of custom attributes that are applied to a specified assembly.

Parameters

NameDescriptionDefault
element The assembly to inspect.

Returns

A collection of the custom attributes that are applied to element, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes()

Retrieves a collection of custom attributes of a specified type that are applied to a specified assembly.

Parameters

NameDescriptionDefault
element The assembly to inspect.
attributeType The type of attribute to search for.

Returns

A collection of the custom attributes that are applied to element and that match attributeType, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes()

Retrieves a collection of custom attributes that are applied to a specified member.

Parameters

NameDescriptionDefault
element The member to inspect.

Returns

A collection of the custom attributes that are applied to element, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes()

Retrieves a collection of custom attributes that are applied to a specified member, and optionally inspects the ancestors of that member.

Parameters

NameDescriptionDefault
element The member to inspect.
inherit true to inspect the ancestors of element; otherwise, false.

Returns

A collection of the custom attributes that are applied to element that match the specified criteria, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes()

Retrieves a collection of custom attributes of a specified type that are applied to a specified member.

Parameters

NameDescriptionDefault
element The member to inspect.
attributeType The type of attribute to search for.

Returns

A collection of the custom attributes that are applied to element and that match attributeType, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes()

Retrieves a collection of custom attributes of a specified type that are applied to a specified member, and optionally inspects the ancestors of that member.

Parameters

NameDescriptionDefault
element The member to inspect.
attributeType The type of attribute to search for.
inherit true to inspect the ancestors of element; otherwise, false.

Returns

A collection of the custom attributes that are applied to element and that match attributeType, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes()

Retrieves a collection of custom attributes that are applied to a specified module.

Parameters

NameDescriptionDefault
element The module to inspect.

Returns

A collection of the custom attributes that are applied to element, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes()

Retrieves a collection of custom attributes of a specified type that are applied to a specified module.

Parameters

NameDescriptionDefault
element The module to inspect.
attributeType The type of attribute to search for.

Returns

A collection of the custom attributes that are applied to element and that match attributeType, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes()

Retrieves a collection of custom attributes that are applied to a specified parameter.

Parameters

NameDescriptionDefault
element The parameter to inspect.

Returns

A collection of the custom attributes that are applied to element, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes()

Retrieves a collection of custom attributes that are applied to a specified parameter, and optionally inspects the ancestors of that parameter.

Parameters

NameDescriptionDefault
element The parameter to inspect.
inherit true to inspect the ancestors of element; otherwise, false.

Returns

A collection of the custom attributes that are applied to element, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes()

Retrieves a collection of custom attributes of a specified type that are applied to a specified parameter.

Parameters

NameDescriptionDefault
element The parameter to inspect.
attributeType The type of attribute to search for.

Returns

A collection of the custom attributes that are applied to element and that match attributeType, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes()

Retrieves a collection of custom attributes of a specified type that are applied to a specified parameter, and optionally inspects the ancestors of that parameter.

Parameters

NameDescriptionDefault
element The parameter to inspect.
attributeType The type of attribute to search for.
inherit true to inspect the ancestors of element; otherwise, false.

Returns

A collection of the custom attributes that are applied to element and that match attributeType, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes``1()

Retrieves a collection of custom attributes of a specified type that are applied to a specified assembly.

Parameters

NameDescriptionDefault
element The assembly to inspect.

Returns

A collection of the custom attributes that are applied to element and that match T, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes``1()

Retrieves a collection of custom attributes of a specified type that are applied to a specified member.

Parameters

NameDescriptionDefault
element The member to inspect.

Returns

A collection of the custom attributes that are applied to element and that match T, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes``1()

Retrieves a collection of custom attributes of a specified type that are applied to a specified member, and optionally inspects the ancestors of that member.

Parameters

NameDescriptionDefault
element The member to inspect.
inherit true to inspect the ancestors of element; otherwise, false.

Returns

A collection of the custom attributes that are applied to element and that match T, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes``1()

Retrieves a collection of custom attributes of a specified type that are applied to a specified module.

Parameters

NameDescriptionDefault
element The module to inspect.

Returns

A collection of the custom attributes that are applied to element and that match T, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes``1()

Retrieves a collection of custom attributes of a specified type that are applied to a specified parameter.

Parameters

NameDescriptionDefault
element The parameter to inspect.

Returns

A collection of the custom attributes that are applied to element and that match T, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.GetCustomAttributes``1()

Retrieves a collection of custom attributes of a specified type that are applied to a specified parameter, and optionally inspects the ancestors of that parameter.

Parameters

NameDescriptionDefault
element The parameter to inspect.
inherit true to inspect the ancestors of element; otherwise, false.

Returns

A collection of the custom attributes that are applied to element and that match T, or an empty collection if no such attributes exist.

System.Reflection.CustomAttributeExtensions.IsDefined()

Indicates whether custom attributes of a specified type are applied to a specified assembly.

Parameters

NameDescriptionDefault
element The assembly to inspect.
attributeType The type of the attribute to search for.

Returns

true if an attribute of the specified type is applied to element; otherwise, false.

System.Reflection.CustomAttributeExtensions.IsDefined()

Indicates whether custom attributes of a specified type are applied to a specified member.

Parameters

NameDescriptionDefault
element The member to inspect.
attributeType The type of attribute to search for.

Returns

true if an attribute of the specified type is applied to element; otherwise, false.

System.Reflection.CustomAttributeExtensions.IsDefined()

Indicates whether custom attributes of a specified type are applied to a specified member, and, optionally, applied to its ancestors.

Parameters

NameDescriptionDefault
element The member to inspect.
attributeType The type of the attribute to search for.
inherit true to inspect the ancestors of element; otherwise, false.

Returns

true if an attribute of the specified type is applied to element; otherwise, false.

System.Reflection.CustomAttributeExtensions.IsDefined()

Indicates whether custom attributes of a specified type are applied to a specified module.

Parameters

NameDescriptionDefault
element The module to inspect.
attributeType The type of attribute to search for.

Returns

true if an attribute of the specified type is applied to element; otherwise, false.

System.Reflection.CustomAttributeExtensions.IsDefined()

Indicates whether custom attributes of a specified type are applied to a specified parameter.

Parameters

NameDescriptionDefault
element The parameter to inspect.
attributeType The type of attribute to search for.

Returns

true if an attribute of the specified type is applied to element; otherwise, false.

System.Reflection.CustomAttributeExtensions.IsDefined()

Indicates whether custom attributes of a specified type are applied to a specified parameter, and, optionally, applied to its ancestors.

Parameters

NameDescriptionDefault
element The parameter to inspect.
attributeType The type of attribute to search for.
inherit true to inspect the ancestors of element; otherwise, false.

Returns

true if an attribute of the specified type is applied to element; otherwise, false.

System.Reflection.CustomAttributeFormatException

The exception that is thrown when the binary format of a custom attribute is invalid.

System.Reflection.CustomAttributeFormatException.#ctor

Initializes a new instance of the System.Reflection.CustomAttributeFormatException class with the default properties.

System.Reflection.CustomAttributeFormatException.#ctor()

Initializes a new instance of the System.Reflection.CustomAttributeFormatException class with the specified serialization and context information.

Parameters

NameDescriptionDefault
info The data for serializing or deserializing the custom attribute.
context The source and destination for the custom attribute.

System.Reflection.CustomAttributeFormatException.#ctor()

Initializes a new instance of the System.Reflection.CustomAttributeFormatException class with the specified message.

Parameters

NameDescriptionDefault
message The message that indicates the reason this exception was thrown.

System.Reflection.CustomAttributeFormatException.#ctor()

Initializes a new instance of the System.Reflection.CustomAttributeFormatException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
inner The exception that is the cause of the current exception. If the inner parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.Reflection.CustomAttributeNamedArgument

Represents a named argument of a custom attribute in the reflection-only context.

System.Reflection.CustomAttributeNamedArgument.#ctor()

Initializes a new instance of the System.Reflection.CustomAttributeNamedArgument class, which represents the specified field or property of the custom attribute, and specifies the value of the field or property.

Parameters

NameDescriptionDefault
memberInfo A field or property of the custom attribute. The new System.Reflection.CustomAttributeNamedArgument object represents this member and its value.
value The value of the field or property of the custom attribute.

System.Reflection.CustomAttributeNamedArgument.#ctor()

Initializes a new instance of the System.Reflection.CustomAttributeNamedArgument class, which represents the specified field or property of the custom attribute, and specifies a System.Reflection.CustomAttributeTypedArgument object that describes the type and value of the field or property.

Parameters

NameDescriptionDefault
memberInfo A field or property of the custom attribute. The new System.Reflection.CustomAttributeNamedArgument object represents this member and its value.
typedArgument An object that describes the type and value of the field or property.

System.Reflection.CustomAttributeNamedArgument.Equals()

Returns a value that indicates whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance, or null.

Returns

true if obj equals the type and value of this instance; otherwise, false.

System.Reflection.CustomAttributeNamedArgument.Equals()

Indicates whether the current instance is equal to another instance of the same type.

Parameters

NameDescriptionDefault
other An instance to compare with this instance.

Returns

true if the current instance is equal to the other instance; otherwise, false.

System.Reflection.CustomAttributeNamedArgument.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Reflection.CustomAttributeNamedArgument.op_Equality()

Tests whether two System.Reflection.CustomAttributeNamedArgument structures are equivalent.

Parameters

NameDescriptionDefault
left The structure to the left of the equality operator.
right The structure to the right of the equality operator.

Returns

true if the two System.Reflection.CustomAttributeNamedArgument structures are equal; otherwise, false.

System.Reflection.CustomAttributeNamedArgument.op_Inequality()

Tests whether two System.Reflection.CustomAttributeNamedArgument structures are different.

Parameters

NameDescriptionDefault
left The structure to the left of the inequality operator.
right The structure to the right of the inequality operator.

Returns

true if the two System.Reflection.CustomAttributeNamedArgument structures are different; otherwise, false.

System.Reflection.CustomAttributeNamedArgument.ToString

Returns a string that consists of the argument name, the equal sign, and a string representation of the argument value.

Returns

A string that consists of the argument name, the equal sign, and a string representation of the argument value.

System.Reflection.CustomAttributeNamedArgument.IsField

Gets a value that indicates whether the named argument is a field.

Returns

true if the named argument is a field; otherwise, false.

System.Reflection.CustomAttributeNamedArgument.MemberInfo

Gets the attribute member that would be used to set the named argument.

Returns

The attribute member that would be used to set the named argument.

System.Reflection.CustomAttributeNamedArgument.MemberName

Gets the name of the attribute member that would be used to set the named argument.

Returns

The name of the attribute member that would be used to set the named argument.

System.Reflection.CustomAttributeNamedArgument.TypedValue

Gets a System.Reflection.CustomAttributeTypedArgument structure that can be used to obtain the type and value of the current named argument.

Returns

A structure that can be used to obtain the type and value of the current named argument.

System.Reflection.CustomAttributeTypedArgument

Represents an argument of a custom attribute in the reflection-only context, or an element of an array argument.

System.Reflection.CustomAttributeTypedArgument.#ctor()

Initializes a new instance of the System.Reflection.CustomAttributeTypedArgument class with the specified value.

Parameters

NameDescriptionDefault
value The value of the custom attribute argument.

System.Reflection.CustomAttributeTypedArgument.#ctor()

Initializes a new instance of the System.Reflection.CustomAttributeTypedArgument class with the specified type and value.

Parameters

NameDescriptionDefault
argumentType The type of the custom attribute argument.
value The value of the custom attribute argument.

System.Reflection.CustomAttributeTypedArgument.Equals()

Indicates whether this instance and a specified object are equal.

Parameters

NameDescriptionDefault
obj Another object to compare to.

Returns

true if obj and this instance are the same type and represent the same value; otherwise, false.

System.Reflection.CustomAttributeTypedArgument.Equals()

Indicates whether the current instance is equal to another instance of the same type.

Parameters

NameDescriptionDefault
other An instance to compare with this instance.

Returns

true if the current instance is equal to the other instance; otherwise, false.

System.Reflection.CustomAttributeTypedArgument.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer that is the hash code for this instance.

System.Reflection.CustomAttributeTypedArgument.op_Equality()

Tests whether two System.Reflection.CustomAttributeTypedArgument structures are equivalent.

Parameters

NameDescriptionDefault
left The System.Reflection.CustomAttributeTypedArgument structure to the left of the equality operator.
right The System.Reflection.CustomAttributeTypedArgument structure to the right of the equality operator.

Returns

true if the two System.Reflection.CustomAttributeTypedArgument structures are equal; otherwise, false.

System.Reflection.CustomAttributeTypedArgument.op_Inequality()

Tests whether two System.Reflection.CustomAttributeTypedArgument structures are different.

Parameters

NameDescriptionDefault
left The System.Reflection.CustomAttributeTypedArgument structure to the left of the inequality operator.
right The System.Reflection.CustomAttributeTypedArgument structure to the right of the inequality operator.

Returns

true if the two System.Reflection.CustomAttributeTypedArgument structures are different; otherwise, false.

System.Reflection.CustomAttributeTypedArgument.ToString

Returns a string consisting of the argument name, the equal sign, and a string representation of the argument value.

Returns

A string consisting of the argument name, the equal sign, and a string representation of the argument value.

System.Reflection.CustomAttributeTypedArgument.ArgumentType

Gets the type of the argument or of the array argument element.

Returns

A System.Type object representing the type of the argument or of the array element.

System.Reflection.CustomAttributeTypedArgument.Value

Gets the value of the argument for a simple argument or for an element of an array argument; gets a collection of values for an array argument.

Returns

An object that represents the value of the argument or element, or a generic System.Collections.ObjectModel.ReadOnlyCollection`1 of System.Reflection.CustomAttributeTypedArgument objects that represent the values of an array-type argument.

System.Reflection.DefaultMemberAttribute

Defines the member of a type that is the default member used by System.Type.InvokeMember().

System.Reflection.DefaultMemberAttribute.#ctor()

Initializes a new instance of the System.Reflection.DefaultMemberAttribute class.

Parameters

NameDescriptionDefault
memberName A String containing the name of the member to invoke. This may be a constructor, method, property, or field. A suitable invocation attribute must be specified when the member is invoked. The default member of a class can be specified by passing an empty String as the name of the member. The default member of a type is marked with the DefaultMemberAttribute custom attribute or marked in COM in the usual way.

System.Reflection.DefaultMemberAttribute.MemberName

Gets the name from the attribute.

Returns

A string representing the member name.

System.Reflection.EventAttributes

Specifies the attributes of an event.

System.Reflection.EventAttributes.None

Specifies that the event has no attributes.

System.Reflection.EventAttributes.ReservedMask

Specifies a reserved flag for common language runtime use only.

System.Reflection.EventAttributes.RTSpecialName

Specifies that the common language runtime should check name encoding.

System.Reflection.EventAttributes.SpecialName

Specifies that the event is special in a way described by the name.

System.Reflection.EventInfo

Discovers the attributes of an event and provides access to event metadata.

System.Reflection.EventInfo.#ctor

Initializes a new instance of the EventInfo class.

System.Reflection.EventInfo.AddEventHandler()

Adds an event handler to an event source.

Parameters

NameDescriptionDefault
target The event source.
handler Encapsulates a method or methods to be invoked when the event is raised by the target.

System.Reflection.EventInfo.Equals()

Returns a value that indicates whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance, or null.

Returns

true if obj equals the type and value of this instance; otherwise, false.

System.Reflection.EventInfo.GetAddMethod

Returns the method used to add an event handler delegate to the event source.

Returns

A System.Reflection.MethodInfo object representing the method used to add an event handler delegate to the event source.

System.Reflection.EventInfo.GetAddMethod()

When overridden in a derived class, retrieves the MethodInfo object for the System.Reflection.EventInfo.AddEventHandler() method of the event, specifying whether to return non-public methods.

Parameters

NameDescriptionDefault
nonPublic true if non-public methods can be returned; otherwise, false.

Returns

A System.Reflection.MethodInfo object representing the method used to add an event handler delegate to the event source.

System.Reflection.EventInfo.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Reflection.EventInfo.GetOtherMethods

Returns the public methods that have been associated with an event in metadata using the .other directive.

Returns

An array representing the public methods that have been associated with the event in metadata by using the .other directive. If there are no such public methods, an empty array is returned.

System.Reflection.EventInfo.GetOtherMethods()

Returns the methods that have been associated with the event in metadata using the .other directive, specifying whether to include non-public methods.

Parameters

NameDescriptionDefault
nonPublic true to include non-public methods; otherwise, false.

Returns

An array representing methods that have been associated with an event in metadata by using the .other directive. If there are no methods matching the specification, an empty array is returned.

System.Reflection.EventInfo.GetRaiseMethod

Returns the method that is called when the event is raised.

Returns

The method that is called when the event is raised.

System.Reflection.EventInfo.GetRaiseMethod()

When overridden in a derived class, returns the method that is called when the event is raised, specifying whether to return non-public methods.

Parameters

NameDescriptionDefault
nonPublic true if non-public methods can be returned; otherwise, false.

Returns

A MethodInfo object that was called when the event was raised.

System.Reflection.EventInfo.GetRemoveMethod

Returns the method used to remove an event handler delegate from the event source.

Returns

A System.Reflection.MethodInfo object representing the method used to remove an event handler delegate from the event source.

System.Reflection.EventInfo.GetRemoveMethod()

When overridden in a derived class, retrieves the MethodInfo object for removing a method of the event, specifying whether to return non-public methods.

Parameters

NameDescriptionDefault
nonPublic true if non-public methods can be returned; otherwise, false.

Returns

A System.Reflection.MethodInfo object representing the method used to remove an event handler delegate from the event source.

System.Reflection.EventInfo.op_Equality()

Indicates whether two System.Reflection.EventInfo objects are equal.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left is equal to right; otherwise, false.

System.Reflection.EventInfo.op_Inequality()

Indicates whether two System.Reflection.EventInfo objects are not equal.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left is not equal to right; otherwise, false.

System.Reflection.EventInfo.RemoveEventHandler()

Removes an event handler from an event source.

Parameters

NameDescriptionDefault
target The event source.
handler The delegate to be disassociated from the events raised by target.

System.Reflection.EventInfo.AddMethod

Gets the System.Reflection.MethodInfo object for the System.Reflection.EventInfo.AddEventHandler() method of the event, including non-public methods.

Returns

System.Reflection.EventInfo.Attributes

Gets the attributes for this event.

Returns

The read-only attributes for this event.

System.Reflection.EventInfo.EventHandlerType

Gets the Type object of the underlying event-handler delegate associated with this event.

Returns

A read-only Type object representing the delegate event handler.

System.Reflection.EventInfo.IsMulticast

Gets a value indicating whether the event is multicast.

Returns

true if the delegate is an instance of a multicast delegate; otherwise, false.

System.Reflection.EventInfo.IsSpecialName

Gets a value indicating whether the EventInfo has a name with a special meaning.

Returns

true if this event has a special name; otherwise, false.

System.Reflection.EventInfo.MemberType

Gets a System.Reflection.MemberTypes value indicating that this member is an event.

Returns

A System.Reflection.MemberTypes value indicating that this member is an event.

System.Reflection.EventInfo.RaiseMethod

Gets the method that is called when the event is raised, including non-public methods.

Returns

The method that is called when the event is raised.

System.Reflection.EventInfo.RemoveMethod

Gets the MethodInfo object for removing a method of the event, including non-public methods.

Returns

The MethodInfo object for removing a method of the event.

System.Reflection.ExceptionHandlingClause

Represents a clause in a structured exception-handling block.

System.Reflection.ExceptionHandlingClause.#ctor

Initializes a new instance of the System.Reflection.ExceptionHandlingClause class.

System.Reflection.ExceptionHandlingClause.ToString

A string representation of the exception-handling clause.

Returns

A string that lists appropriate property values for the filter clause type.

System.Reflection.ExceptionHandlingClause.CatchType

Gets the type of exception handled by this clause.

Returns

System.Reflection.ExceptionHandlingClause.FilterOffset

Gets the offset within the method body, in bytes, of the user-supplied filter code.

Returns

The offset within the method body, in bytes, of the user-supplied filter code. The value of this property has no meaning if the System.Reflection.ExceptionHandlingClause.Flags property has any value other than System.Reflection.ExceptionHandlingClauseOptions.Filter.

System.Reflection.ExceptionHandlingClause.Flags

Gets a value indicating whether this exception-handling clause is a finally clause, a type-filtered clause, or a user-filtered clause.

Returns

An System.Reflection.ExceptionHandlingClauseOptions value that indicates what kind of action this clause performs.

System.Reflection.ExceptionHandlingClause.HandlerLength

Gets the length, in bytes, of the body of this exception-handling clause.

Returns

An integer that represents the length, in bytes, of the MSIL that forms the body of this exception-handling clause.

System.Reflection.ExceptionHandlingClause.HandlerOffset

Gets the offset within the method body, in bytes, of this exception-handling clause.

Returns

An integer that represents the offset within the method body, in bytes, of this exception-handling clause.

System.Reflection.ExceptionHandlingClause.TryLength

The total length, in bytes, of the try block that includes this exception-handling clause.

Returns

The total length, in bytes, of the try block that includes this exception-handling clause.

System.Reflection.ExceptionHandlingClause.TryOffset

The offset within the method, in bytes, of the try block that includes this exception-handling clause.

Returns

An integer that represents the offset within the method, in bytes, of the try block that includes this exception-handling clause.

System.Reflection.ExceptionHandlingClauseOptions

Identifies kinds of exception-handling clauses.

System.Reflection.ExceptionHandlingClauseOptions.Clause

The clause accepts all exceptions that derive from a specified type.

System.Reflection.ExceptionHandlingClauseOptions.Fault

The clause is executed if an exception occurs, but not on completion of normal control flow.

System.Reflection.ExceptionHandlingClauseOptions.Filter

The clause contains user-specified instructions that determine whether the exception should be ignored (that is, whether normal execution should resume), be handled by the associated handler, or be passed on to the next clause.

System.Reflection.ExceptionHandlingClauseOptions.Finally

The clause is executed whenever the try block exits, whether through normal control flow or because of an unhandled exception.

System.Reflection.FieldAttributes

Specifies flags that describe the attributes of a field.

System.Reflection.FieldAttributes.Assembly

Specifies that the field is accessible throughout the assembly.

System.Reflection.FieldAttributes.FamANDAssem

Specifies that the field is accessible only by subtypes in this assembly.

System.Reflection.FieldAttributes.Family

Specifies that the field is accessible only by type and subtypes.

System.Reflection.FieldAttributes.FamORAssem

Specifies that the field is accessible by subtypes anywhere, as well as throughout this assembly.

System.Reflection.FieldAttributes.FieldAccessMask

Specifies the access level of a given field.

System.Reflection.FieldAttributes.HasDefault

Specifies that the field has a default value.

System.Reflection.FieldAttributes.HasFieldMarshal

Specifies that the field has marshaling information.

System.Reflection.FieldAttributes.HasFieldRVA

Specifies that the field has a relative virtual address (RVA). The RVA is the location of the method body in the current image, as an address relative to the start of the image file in which it is located.

System.Reflection.FieldAttributes.InitOnly

Specifies that the field is initialized only, and can be set only in the body of a constructor.

System.Reflection.FieldAttributes.Literal

Specifies that the field's value is a compile-time (static or early bound) constant. Any attempt to set it throws a System.FieldAccessException.

System.Reflection.FieldAttributes.NotSerialized

Specifies that the field does not have to be serialized when the type is remoted.

System.Reflection.FieldAttributes.PinvokeImpl

Reserved for future use.

System.Reflection.FieldAttributes.Private

Specifies that the field is accessible only by the parent type.

System.Reflection.FieldAttributes.PrivateScope

Specifies that the field cannot be referenced.

System.Reflection.FieldAttributes.Public

Specifies that the field is accessible by any member for whom this scope is visible.

System.Reflection.FieldAttributes.ReservedMask

Reserved.

System.Reflection.FieldAttributes.RTSpecialName

Specifies that the common language runtime (metadata internal APIs) should check the name encoding.

System.Reflection.FieldAttributes.SpecialName

Specifies a special method, with the name describing how the method is special.

System.Reflection.FieldAttributes.Static

Specifies that the field represents the defined type, or else it is per-instance.

System.Reflection.FieldInfo

Discovers the attributes of a field and provides access to field metadata.

System.Reflection.FieldInfo.#ctor

Initializes a new instance of the FieldInfo class.

System.Reflection.FieldInfo.Equals()

Returns a value that indicates whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance, or null.

Returns

true if obj equals the type and value of this instance; otherwise, false.

System.Reflection.FieldInfo.GetFieldFromHandle()

Gets a System.Reflection.FieldInfo for the field represented by the specified handle.

Parameters

NameDescriptionDefault
handle A System.RuntimeFieldHandle structure that contains the handle to the internal metadata representation of a field.

Returns

A System.Reflection.FieldInfo object representing the field specified by handle.

System.Reflection.FieldInfo.GetFieldFromHandle()

Gets a System.Reflection.FieldInfo for the field represented by the specified handle, for the specified generic type.

Parameters

NameDescriptionDefault
handle A System.RuntimeFieldHandle structure that contains the handle to the internal metadata representation of a field.
declaringType A System.RuntimeTypeHandle structure that contains the handle to the generic type that defines the field.

Returns

A System.Reflection.FieldInfo object representing the field specified by handle, in the generic type specified by declaringType.

System.Reflection.FieldInfo.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Reflection.FieldInfo.GetModifiedFieldType

Gets the modified type of this field object.

Returns

A modified type.

System.Reflection.FieldInfo.GetOptionalCustomModifiers

Gets an array of types that identify the optional custom modifiers of the field.

Returns

An array of System.Type objects that identify the optional custom modifiers of the current field, such as System.Runtime.CompilerServices.IsConst.

System.Reflection.FieldInfo.GetRawConstantValue

Returns a literal value associated with the field by a compiler.

Returns

An System.Object that contains the literal value associated with the field. If the literal value is a class type with an element value of zero, the return value is null.

System.Reflection.FieldInfo.GetRequiredCustomModifiers

Gets an array of types that identify the required custom modifiers of the property.

Returns

An array of System.Type objects that identify the required custom modifiers of the current property, such as System.Runtime.CompilerServices.IsConst or System.Runtime.CompilerServices.IsImplicitlyDereferenced.

System.Reflection.FieldInfo.GetValue()

When overridden in a derived class, returns the value of a field supported by a given object.

Parameters

NameDescriptionDefault
obj The object whose field value will be returned.

Returns

An object containing the value of the field reflected by this instance.

System.Reflection.FieldInfo.GetValueDirect()

Returns the value of a field supported by a given object.

Parameters

NameDescriptionDefault
obj A System.TypedReference structure that encapsulates a managed pointer to a location and a runtime representation of the type that might be stored at that location.

Returns

An Object containing a field value.

System.Reflection.FieldInfo.op_Equality()

Indicates whether two System.Reflection.FieldInfo objects are equal.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left is equal to right; otherwise, false.

System.Reflection.FieldInfo.op_Inequality()

Indicates whether two System.Reflection.FieldInfo objects are not equal.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left is not equal to right; otherwise, false.

System.Reflection.FieldInfo.SetValue()

Sets the value of the field supported by the given object.

Parameters

NameDescriptionDefault
obj The object whose field value will be set.
value The value to assign to the field.

System.Reflection.FieldInfo.SetValue()

When overridden in a derived class, sets the value of the field supported by the given object.

Parameters

NameDescriptionDefault
obj The object whose field value will be set.
value The value to assign to the field.
invokeAttr A field of Binder that specifies the type of binding that is desired (for example, Binder.CreateInstance or Binder.ExactBinding).
binder A set of properties that enables the binding, coercion of argument types, and invocation of members through reflection. If binder is null, then Binder.DefaultBinding is used.
culture The software preferences of a particular culture.

System.Reflection.FieldInfo.SetValueDirect()

Sets the value of the field supported by the given object.

Parameters

NameDescriptionDefault
obj A System.TypedReference structure that encapsulates a managed pointer to a location and a runtime representation of the type that can be stored at that location.
value The value to assign to the field.

System.Reflection.FieldInfo.Attributes

Gets the attributes associated with this field.

Returns

The FieldAttributes for this field.

System.Reflection.FieldInfo.FieldHandle

Gets a RuntimeFieldHandle, which is a handle to the internal metadata representation of a field.

Returns

A handle to the internal metadata representation of a field.

System.Reflection.FieldInfo.FieldType

Gets the type of this field object.

Returns

The type of this field object.

System.Reflection.FieldInfo.IsAssembly

Gets a value indicating whether the potential visibility of this field is described by System.Reflection.FieldAttributes.Assembly; that is, the field is visible at most to other types in the same assembly, and is not visible to derived types outside the assembly.

Returns

true if the visibility of this field is exactly described by System.Reflection.FieldAttributes.Assembly; otherwise, false.

System.Reflection.FieldInfo.IsFamily

Gets a value indicating whether the visibility of this field is described by System.Reflection.FieldAttributes.Family; that is, the field is visible only within its class and derived classes.

Returns

true if access to this field is exactly described by System.Reflection.FieldAttributes.Family; otherwise, false.

System.Reflection.FieldInfo.IsFamilyAndAssembly

Gets a value indicating whether the visibility of this field is described by System.Reflection.FieldAttributes.FamANDAssem; that is, the field can be accessed from derived classes, but only if they are in the same assembly.

Returns

true if access to this field is exactly described by System.Reflection.FieldAttributes.FamANDAssem; otherwise, false.

System.Reflection.FieldInfo.IsFamilyOrAssembly

Gets a value indicating whether the potential visibility of this field is described by System.Reflection.FieldAttributes.FamORAssem; that is, the field can be accessed by derived classes wherever they are, and by classes in the same assembly.

Returns

true if access to this field is exactly described by System.Reflection.FieldAttributes.FamORAssem; otherwise, false.

System.Reflection.FieldInfo.IsInitOnly

Gets a value indicating whether the field can only be set in the body of the constructor.

Returns

true if the field has the InitOnly attribute set; otherwise, false.

System.Reflection.FieldInfo.IsLiteral

Gets a value indicating whether the value is written at compile time and cannot be changed.

Returns

true if the field has the Literal attribute set; otherwise, false.

System.Reflection.FieldInfo.IsNotSerialized

Gets a value indicating whether this field has the NotSerialized attribute.

Returns

true if the field has the NotSerialized attribute set; otherwise, false.

System.Reflection.FieldInfo.IsPinvokeImpl

Gets a value indicating whether the corresponding PinvokeImpl attribute is set in System.Reflection.FieldAttributes.

Returns

true if the PinvokeImpl attribute is set in System.Reflection.FieldAttributes; otherwise, false.

System.Reflection.FieldInfo.IsPrivate

Gets a value indicating whether the field is private.

Returns

true if the field is private; otherwise; false.

System.Reflection.FieldInfo.IsPublic

Gets a value indicating whether the field is public.

Returns

true if this field is public; otherwise, false.

System.Reflection.FieldInfo.IsSecurityCritical

Gets a value that indicates whether the current field is security-critical or security-safe-critical at the current trust level.

Returns

true if the current field is security-critical or security-safe-critical at the current trust level; false if it is transparent.

System.Reflection.FieldInfo.IsSecuritySafeCritical

Gets a value that indicates whether the current field is security-safe-critical at the current trust level.

Returns

true if the current field is security-safe-critical at the current trust level; false if it is security-critical or transparent.

System.Reflection.FieldInfo.IsSecurityTransparent

Gets a value that indicates whether the current field is transparent at the current trust level.

Returns

true if the field is security-transparent at the current trust level; otherwise, false.

System.Reflection.FieldInfo.IsSpecialName

Gets a value indicating whether the corresponding SpecialName attribute is set in the System.Reflection.FieldAttributes enumerator.

Returns

true if the SpecialName attribute is set in System.Reflection.FieldAttributes; otherwise, false.

System.Reflection.FieldInfo.IsStatic

Gets a value indicating whether the field is static.

Returns

true if this field is static; otherwise, false.

System.Reflection.FieldInfo.MemberType

Gets a System.Reflection.MemberTypes value indicating that this member is a field.

Returns

A System.Reflection.MemberTypes value indicating that this member is a field.

System.Reflection.GenericParameterAttributes

Describes the constraints on a generic type parameter of a generic type or method.

System.Reflection.GenericParameterAttributes.Contravariant

The generic type parameter is contravariant. A contravariant type parameter can appear as a parameter type in method signatures.

System.Reflection.GenericParameterAttributes.Covariant

The generic type parameter is covariant. A covariant type parameter can appear as the result type of a method, the type of a read-only field, a declared base type, or an implemented interface.

System.Reflection.GenericParameterAttributes.DefaultConstructorConstraint

A type can be substituted for the generic type parameter only if it has a parameterless constructor.

System.Reflection.GenericParameterAttributes.None

There are no special flags.

System.Reflection.GenericParameterAttributes.NotNullableValueTypeConstraint

A type can be substituted for the generic type parameter only if it is a value type and is not nullable.

System.Reflection.GenericParameterAttributes.ReferenceTypeConstraint

A type can be substituted for the generic type parameter only if it is a reference type.

System.Reflection.GenericParameterAttributes.SpecialConstraintMask

Selects the combination of all special constraint flags. This value is the result of using logical OR to combine the following flags: System.Reflection.GenericParameterAttributes.DefaultConstructorConstraint, System.Reflection.GenericParameterAttributes.ReferenceTypeConstraint, and System.Reflection.GenericParameterAttributes.NotNullableValueTypeConstraint.

System.Reflection.GenericParameterAttributes.VarianceMask

Selects the combination of all variance flags. This value is the result of using logical OR to combine the following flags: System.Reflection.GenericParameterAttributes.Contravariant and System.Reflection.GenericParameterAttributes.Covariant.

System.Reflection.ICustomAttributeProvider

Provides custom attributes for reflection objects that support them.

System.Reflection.ICustomAttributeProvider.GetCustomAttributes()

Returns an array of all of the custom attributes defined on this member, excluding named attributes, or an empty array if there are no custom attributes.

Parameters

NameDescriptionDefault
inherit When true, look up the hierarchy chain for the inherited custom attribute.

Returns

An array of Objects representing custom attributes, or an empty array.

System.Reflection.ICustomAttributeProvider.GetCustomAttributes()

Returns an array of custom attributes defined on this member, identified by type, or an empty array if there are no custom attributes of that type.

Parameters

NameDescriptionDefault
attributeType The type of the custom attributes.
inherit When true, look up the hierarchy chain for the inherited custom attribute.

Returns

An array of Objects representing custom attributes, or an empty array.

System.Reflection.ICustomAttributeProvider.IsDefined()

Indicates whether one or more instance of attributeType is defined on this member.

Parameters

NameDescriptionDefault
attributeType The type of the custom attributes.
inherit When true, look up the hierarchy chain for the inherited custom attribute.

Returns

true if the attributeType is defined on this member; false otherwise.

System.Reflection.ImageFileMachine

Identifies the platform targeted by an executable.

System.Reflection.ImageFileMachine.AMD64

Targets a 64-bit AMD processor.

System.Reflection.ImageFileMachine.ARM

Targets an ARM processor.

System.Reflection.ImageFileMachine.I386

Targets a 32-bit Intel processor.

System.Reflection.ImageFileMachine.IA64

Targets a 64-bit Intel processor.

System.Reflection.InterfaceMapping

Retrieves the mapping of an interface into the actual methods on a class that implements that interface.

System.Reflection.InterfaceMapping.InterfaceMethods

Shows the methods that are defined on the interface.

System.Reflection.InterfaceMapping.InterfaceType

Shows the type that represents the interface.

System.Reflection.InterfaceMapping.TargetMethods

Shows the methods that implement the interface.

System.Reflection.InterfaceMapping.TargetType

Represents the type that was used to create the interface mapping.

System.Reflection.IntrospectionExtensions

Contains methods for converting System.Type objects.

System.Reflection.IntrospectionExtensions.GetTypeInfo()

Returns the System.Reflection.TypeInfo representation of the specified type.

Parameters

NameDescriptionDefault
type The type to convert.

Returns

The converted object.

System.Reflection.InvalidFilterCriteriaException

The exception that is thrown in System.Type.FindMembers() when the filter criteria is not valid for the type of filter you are using.

System.Reflection.InvalidFilterCriteriaException.#ctor

Initializes a new instance of the System.Reflection.InvalidFilterCriteriaException class with the default properties.

System.Reflection.InvalidFilterCriteriaException.#ctor()

Initializes a new instance of the System.Reflection.InvalidFilterCriteriaException class with the specified serialization and context information.

Parameters

NameDescriptionDefault
info A SerializationInfo object that contains the information required to serialize this instance.
context A StreamingContext object that contains the source and destination of the serialized stream associated with this instance.

System.Reflection.InvalidFilterCriteriaException.#ctor()

Initializes a new instance of the System.Reflection.InvalidFilterCriteriaException class with the given HRESULT and message string.

Parameters

NameDescriptionDefault
message The message text for the exception.

System.Reflection.InvalidFilterCriteriaException.#ctor()

Initializes a new instance of the System.Reflection.InvalidFilterCriteriaException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters

NameDescriptionDefault
message The error message that explains the reason for the exception.
inner The exception that is the cause of the current exception. If the inner parameter is not null, the current exception is raised in a catch block that handles the inner exception.

System.Reflection.IReflect

Interoperates with the IDispatch interface.

System.Reflection.IReflect.GetField()

Returns the System.Reflection.FieldInfo object that corresponds to the specified field and binding flag.

Parameters

NameDescriptionDefault
name The name of the field to find.
bindingAttr The binding attributes used to control the search.

Returns

A System.Reflection.FieldInfo object containing the field information for the named object that meets the search constraints specified in bindingAttr.

System.Reflection.IReflect.GetFields()

Returns an array of System.Reflection.FieldInfo objects that correspond to all fields of the current class.

Parameters

NameDescriptionDefault
bindingAttr The binding attributes used to control the search.

Returns

An array of System.Reflection.FieldInfo objects containing all the field information for this reflection object that meets the search constraints specified in bindingAttr.

System.Reflection.IReflect.GetMember()

Retrieves an array of System.Reflection.MemberInfo objects corresponding to all public members or to all members that match a specified name.

Parameters

NameDescriptionDefault
name The name of the member to find.
bindingAttr The binding attributes used to control the search.

Returns

An array of System.Reflection.MemberInfo objects matching the name parameter.

System.Reflection.IReflect.GetMembers()

Retrieves an array of System.Reflection.MemberInfo objects that correspond either to all public members or to all members of the current class.

Parameters

NameDescriptionDefault
bindingAttr The binding attributes used to control the search.

Returns

An array of System.Reflection.MemberInfo objects containing all the member information for this reflection object.

System.Reflection.IReflect.GetMethod()

Retrieves a System.Reflection.MethodInfo object that corresponds to a specified method under specified search constraints.

Parameters

NameDescriptionDefault
name The name of the member to find.
bindingAttr The binding attributes used to control the search.

Returns

A System.Reflection.MethodInfo object containing the method information, with the match being based on the method name and search constraints specified in bindingAttr.

System.Reflection.IReflect.GetMethod()

Retrieves a System.Reflection.MethodInfo object corresponding to a specified method, using a System.Type array to choose from among overloaded methods.

Parameters

NameDescriptionDefault
name The name of the member to find.
bindingAttr The binding attributes used to control the search.
binder An object that implements System.Reflection.Binder, containing properties related to this method.
types An array used to choose among overloaded methods.
modifiers An array of parameter modifiers used to make binding work with parameter signatures in which the types have been modified.

Returns

The requested method that matches all the specified parameters.

System.Reflection.IReflect.GetMethods()

Retrieves an array of System.Reflection.MethodInfo objects with all public methods or all methods of the current class.

Parameters

NameDescriptionDefault
bindingAttr The binding attributes used to control the search.

Returns

An array of System.Reflection.MethodInfo objects containing all the methods defined for this reflection object that meet the search constraints specified in bindingAttr.

System.Reflection.IReflect.GetProperties()

Retrieves an array of System.Reflection.PropertyInfo objects corresponding to all public properties or to all properties of the current class.

Parameters

NameDescriptionDefault
bindingAttr The binding attribute used to control the search.

Returns

An array of System.Reflection.PropertyInfo objects for all the properties defined on the reflection object.

System.Reflection.IReflect.GetProperty()

Retrieves a System.Reflection.PropertyInfo object corresponding to a specified property under specified search constraints.

Parameters

NameDescriptionDefault
name The name of the property to find.
bindingAttr The binding attributes used to control the search.

Returns

A System.Reflection.PropertyInfo object for the located property that meets the search constraints specified in bindingAttr, or null if the property was not located.

System.Reflection.IReflect.GetProperty()

Retrieves a System.Reflection.PropertyInfo object that corresponds to a specified property with specified search constraints.

Parameters

NameDescriptionDefault
name The name of the member to find.
bindingAttr The binding attribute used to control the search.
binder An object that implements System.Reflection.Binder, containing properties related to this method.
returnType The type of the property.
types An array used to choose among overloaded methods with the same name.
modifiers An array used to choose the parameter modifiers.

Returns

A System.Reflection.PropertyInfo object for the located property, if a property with the specified name was located in this reflection object, or null if the property was not located.

System.Reflection.IReflect.InvokeMember()

Invokes a specified member.

Parameters

NameDescriptionDefault
name The name of the member to find.
invokeAttr One of the System.Reflection.BindingFlags invocation attributes. The invokeAttr parameter may be a constructor, method, property, or field. A suitable invocation attribute must be specified. Invoke the default member of a class by passing the empty string ("") as the name of the member.
binder One of the System.Reflection.BindingFlags bit flags. Implements System.Reflection.Binder, containing properties related to this method.
target The object on which to invoke the specified member. This parameter is ignored for static members.
args An array of objects that contains the number, order, and type of the parameters of the member to be invoked. This is an empty array if there are no parameters.
modifiers An array of System.Reflection.ParameterModifier objects. This array has the same length as the args parameter, representing the invoked member's argument attributes in the metadata. A parameter can have the following attributes: pdIn, pdOut, pdRetval, pdOptional, and pdHasDefault. These represent [In], [Out], [retval], [optional], and a default parameter, respectively. These attributes are used by various interoperability services.
culture An instance of System.Globalization.CultureInfo used to govern the coercion of types. For example, culture converts a string that represents 1000 to a System.Double value, since 1000 is represented differently by different cultures. If this parameter is null, the System.Globalization.CultureInfo for the current thread is used.
namedParameters A string array of parameters.

Returns

The specified member.

System.Reflection.IReflect.UnderlyingSystemType

Gets the underlying type that represents the System.Reflection.IReflect object.

Returns

The underlying type that represents the System.Reflection.IReflect object.

System.Reflection.IReflectableType

Represents a type that you can reflect over.

System.Reflection.IReflectableType.GetTypeInfo

Retrieves an object that represents this type.

Returns

An object that represents this type.

System.Reflection.LocalVariableInfo

Discovers the attributes of a local variable and provides access to local variable metadata.

System.Reflection.LocalVariableInfo.#ctor

Initializes a new instance of the System.Reflection.LocalVariableInfo class.

System.Reflection.LocalVariableInfo.ToString

Returns a user-readable string that describes the local variable.

Returns

A string that displays information about the local variable, including the type name, index, and pinned status.

System.Reflection.LocalVariableInfo.IsPinned

Gets a System.Boolean value that indicates whether the object referred to by the local variable is pinned in memory.

Returns

true if the object referred to by the variable is pinned in memory; otherwise, false.

System.Reflection.LocalVariableInfo.LocalIndex

Gets the index of the local variable within the method body.

Returns

An integer value that represents the order of declaration of the local variable within the method body.

System.Reflection.LocalVariableInfo.LocalType

Gets the type of the local variable.

Returns

The type of the local variable.

System.Reflection.ManifestResourceInfo

Provides access to manifest resources, which are XML files that describe application dependencies.

System.Reflection.ManifestResourceInfo.#ctor()

Initializes a new instance of the System.Reflection.ManifestResourceInfo class for a resource that is contained by the specified assembly and file, and that has the specified location.

Parameters

NameDescriptionDefault
containingAssembly The assembly that contains the manifest resource.
containingFileName The name of the file that contains the manifest resource, if the file is not the same as the manifest file.
resourceLocation A bitwise combination of enumeration values that provides information about the location of the manifest resource.

System.Reflection.ManifestResourceInfo.FileName

Gets the name of the file that contains the manifest resource, if it is not the same as the manifest file.

Returns

The manifest resource's file name.

System.Reflection.ManifestResourceInfo.ReferencedAssembly

Gets the containing assembly for the manifest resource.

Returns

The manifest resource's containing assembly.

System.Reflection.ManifestResourceInfo.ResourceLocation

Gets the manifest resource's location.

Returns

A bitwise combination of System.Reflection.ResourceLocation flags that indicates the location of the manifest resource.

System.Reflection.MemberFilter

Represents a delegate that is used to filter a list of members represented in an array of System.Reflection.MemberInfo objects.

Parameters

NameDescriptionDefault
m The System.Reflection.MemberInfo object to which the filter is applied.
filterCriteria An arbitrary object used to filter the list.

Returns

true to include the member in the filtered list; otherwise false.

System.Reflection.MemberInfo

Obtains information about the attributes of a member and provides access to member metadata.

System.Reflection.MemberInfo.#ctor

Initializes a new instance of the System.Reflection.MemberInfo class.

System.Reflection.MemberInfo.Equals()

Returns a value that indicates whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance, or null.

Returns

true if obj equals the type and value of this instance; otherwise, false.

System.Reflection.MemberInfo.GetCustomAttributes()

When overridden in a derived class, returns an array of all custom attributes applied to this member.

Parameters

NameDescriptionDefault
inherit true to search this member's inheritance chain to find the attributes; otherwise, false. This parameter is ignored for properties and events.

Returns

An array that contains all the custom attributes applied to this member, or an array with zero elements if no attributes are defined.

System.Reflection.MemberInfo.GetCustomAttributes()

When overridden in a derived class, returns an array of custom attributes applied to this member and identified by System.Type.

Parameters

NameDescriptionDefault
attributeType The type of attribute to search for. Only attributes that are assignable to this type are returned.
inherit true to search this member's inheritance chain to find the attributes; otherwise, false. This parameter is ignored for properties and events.

Returns

An array of custom attributes applied to this member, or an array with zero elements if no attributes assignable to attributeType have been applied.

System.Reflection.MemberInfo.GetCustomAttributesData

Returns a list of System.Reflection.CustomAttributeData objects representing data about the attributes that have been applied to the target member.

Returns

A generic list of System.Reflection.CustomAttributeData objects representing data about the attributes that have been applied to the target member.

System.Reflection.MemberInfo.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Reflection.MemberInfo.HasSameMetadataDefinitionAs()

Parameters

NameDescriptionDefault
other

System.Reflection.MemberInfo.IsDefined()

When overridden in a derived class, indicates whether one or more attributes of the specified type or of its derived types is applied to this member.

Parameters

NameDescriptionDefault
attributeType The type of custom attribute to search for. The search includes derived types.
inherit true to search this member's inheritance chain to find the attributes; otherwise, false. This parameter is ignored for properties and events.

Returns

true if one or more instances of attributeType or any of its derived types is applied to this member; otherwise, false.

System.Reflection.MemberInfo.op_Equality()

Indicates whether two System.Reflection.MemberInfo objects are equal.

Parameters

NameDescriptionDefault
left The System.Reflection.MemberInfo to compare to right.
right The System.Reflection.MemberInfo to compare to left.

Returns

true if left is equal to right; otherwise false.

System.Reflection.MemberInfo.op_Inequality()

Indicates whether two System.Reflection.MemberInfo objects are not equal.

Parameters

NameDescriptionDefault
left The System.Reflection.MemberInfo to compare to right.
right The System.Reflection.MemberInfo to compare to left.

Returns

true if left is not equal to right; otherwise false.

System.Reflection.MemberInfo.CustomAttributes

Gets a collection that contains this member's custom attributes.

Returns

A collection that contains this member's custom attributes.

System.Reflection.MemberInfo.DeclaringType

Gets the class that declares this member.

Returns

The Type object for the class that declares this member.

System.Reflection.MemberInfo.IsCollectible

Gets a value that indicates whether this System.Reflection.MemberInfo object is part of an assembly held in a collectible System.Runtime.Loader.AssemblyLoadContext.

Returns

true if the System.Reflection.MemberInfo is part of an assembly held in a collectible assembly load context; otherwise, false.

System.Reflection.MemberInfo.MemberType

When overridden in a derived class, gets a System.Reflection.MemberTypes value indicating the type of the member - method, constructor, event, and so on.

Returns

A System.Reflection.MemberTypes value indicating the type of member.

System.Reflection.MemberInfo.MetadataToken

Gets a value that identifies a metadata element.

Returns

A value which, in combination with System.Reflection.MemberInfo.Module, uniquely identifies a metadata element.

System.Reflection.MemberInfo.Module

Gets the module in which the type that declares the member represented by the current System.Reflection.MemberInfo is defined.

Returns

The System.Reflection.Module in which the type that declares the member represented by the current System.Reflection.MemberInfo is defined.

System.Reflection.MemberInfo.Name

Gets the name of the current member.

Returns

A System.String containing the name of this member.

System.Reflection.MemberInfo.ReflectedType

Gets the class object that was used to obtain this instance of MemberInfo.

Returns

The Type object through which this MemberInfo object was obtained.

System.Reflection.MemberTypes

Marks each type of member that is defined as a derived class of System.Reflection.MemberInfo.

System.Reflection.MemberTypes.All

Specifies all member types.

System.Reflection.MemberTypes.Constructor

Specifies that the member is a constructor.

System.Reflection.MemberTypes.Custom

Specifies that the member is a custom member type.

System.Reflection.MemberTypes.Event

Specifies that the member is an event.

System.Reflection.MemberTypes.Field

Specifies that the member is a field.

System.Reflection.MemberTypes.Method

Specifies that the member is a method.

System.Reflection.MemberTypes.NestedType

Specifies that the member is a nested type.

System.Reflection.MemberTypes.Property

Specifies that the member is a property.

System.Reflection.MemberTypes.TypeInfo

Specifies that the member is a type.

System.Reflection.MethodAttributes

Specifies flags for method attributes. These flags are defined in the corhdr.h file.

System.Reflection.MethodAttributes.Abstract

Indicates that the class does not provide an implementation of this method.

System.Reflection.MethodAttributes.Assembly

Indicates that the method is accessible to any class of this assembly.

System.Reflection.MethodAttributes.CheckAccessOnOverride

Indicates that the method can only be overridden when it is also accessible.

System.Reflection.MethodAttributes.FamANDAssem

Indicates that the method is accessible to members of this type and its derived types that are in this assembly only.

System.Reflection.MethodAttributes.Family

Indicates that the method is accessible only to members of this class and its derived classes.

System.Reflection.MethodAttributes.FamORAssem

Indicates that the method is accessible to derived classes anywhere, as well as to any class in the assembly.

System.Reflection.MethodAttributes.Final

Indicates that the method cannot be overridden.

System.Reflection.MethodAttributes.HasSecurity

Indicates that the method has security associated with it. Reserved flag for runtime use only.

System.Reflection.MethodAttributes.HideBySig

Indicates that the method hides by name and signature; otherwise, by name only.

System.Reflection.MethodAttributes.MemberAccessMask

Retrieves accessibility information.

System.Reflection.MethodAttributes.NewSlot

Indicates that the method always gets a new slot in the vtable.

System.Reflection.MethodAttributes.PinvokeImpl

Indicates that the method implementation is forwarded through PInvoke (Platform Invocation Services).

System.Reflection.MethodAttributes.Private

Indicates that the method is accessible only to the current class.

System.Reflection.MethodAttributes.PrivateScope

Indicates that the member cannot be referenced.

System.Reflection.MethodAttributes.Public

Indicates that the method is accessible to any object for which this object is in scope.

System.Reflection.MethodAttributes.RequireSecObject

Indicates that the method calls another method containing security code. Reserved flag for runtime use only.

System.Reflection.MethodAttributes.ReservedMask

Indicates a reserved flag for runtime use only.

System.Reflection.MethodAttributes.ReuseSlot

Indicates that the method will reuse an existing slot in the vtable. This is the default behavior.

System.Reflection.MethodAttributes.RTSpecialName

Indicates that the common language runtime checks the name encoding.

System.Reflection.MethodAttributes.SpecialName

Indicates that the method is special. The name describes how this method is special.

System.Reflection.MethodAttributes.Static

Indicates that the method is defined on the type; otherwise, it is defined per instance.

System.Reflection.MethodAttributes.UnmanagedExport

Indicates that the managed method is exported by thunk to unmanaged code.

System.Reflection.MethodAttributes.Virtual

Indicates that the method is virtual.

System.Reflection.MethodAttributes.VtableLayoutMask

Retrieves vtable attributes.

System.Reflection.MethodBase

Provides information about methods and constructors.

System.Reflection.MethodBase.#ctor

Initializes a new instance of the System.Reflection.MethodBase class.

System.Reflection.MethodBase.Equals()

Returns a value that indicates whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance, or null.

Returns

true if obj equals the type and value of this instance; otherwise, false.

System.Reflection.MethodBase.GetCurrentMethod

Returns a MethodBase object representing the currently executing method.

Returns

System.Reflection.MethodBase.GetCurrentMethod is a static method that is called from within an executing method and that returns information about that method. A MethodBase object representing the currently executing method.

System.Reflection.MethodBase.GetGenericArguments

Returns an array of System.Type objects that represent the type arguments of a generic method or the type parameters of a generic method definition.

Returns

An array of System.Type objects that represent the type arguments of a generic method or the type parameters of a generic method definition. Returns an empty array if the current method is not a generic method.

System.Reflection.MethodBase.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Reflection.MethodBase.GetMethodBody

When overridden in a derived class, gets a System.Reflection.MethodBody object that provides access to the MSIL stream, local variables, and exceptions for the current method.

Returns

A System.Reflection.MethodBody object that provides access to the MSIL stream, local variables, and exceptions for the current method.

System.Reflection.MethodBase.GetMethodFromHandle()

Gets method information by using the method's internal metadata representation (handle).

Parameters

NameDescriptionDefault
handle The method's handle.

Returns

A MethodBase containing information about the method.

System.Reflection.MethodBase.GetMethodFromHandle()

Gets a System.Reflection.MethodBase object for the constructor or method represented by the specified handle, for the specified generic type.

Parameters

NameDescriptionDefault
handle A handle to the internal metadata representation of a constructor or method.
declaringType A handle to the generic type that defines the constructor or method.

Returns

A System.Reflection.MethodBase object representing the method or constructor specified by handle, in the generic type specified by declaringType.

System.Reflection.MethodBase.GetMethodImplementationFlags

When overridden in a derived class, returns the System.Reflection.MethodImplAttributes flags.

Returns

System.Reflection.MethodBase.GetParameters

When overridden in a derived class, gets the parameters of the specified method or constructor.

Returns

An array of type ParameterInfo containing information that matches the signature of the method (or constructor) reflected by this MethodBase instance.

System.Reflection.MethodBase.Invoke()

Invokes the method or constructor represented by the current instance, using the specified parameters.

Parameters

NameDescriptionDefault
obj The object on which to invoke the method or constructor. If a method is static, this argument is ignored. If a constructor is static, this argument must be null or an instance of the class that defines the constructor.
parameters An argument list for the invoked method or constructor. This is an array of objects with the same number, order, and type as the parameters of the method or constructor to be invoked. If there are no parameters, parameters should be null. If the method or constructor represented by this instance takes a ref parameter (ByRef in Visual Basic), no special attribute is required for that parameter in order to invoke the method or constructor using this function. Any object in this array that is not explicitly initialized with a value will contain the default value for that object type. For reference-type elements, this value is null. For value-type elements, the default value is 0, 0.0, or false, depending on the specific element type.

Returns

An object containing the return value of the invoked method, or null in the case of a constructor.

System.Reflection.MethodBase.Invoke()

When overridden in a derived class, invokes the reflected method or constructor with the given parameters.

Parameters

NameDescriptionDefault
obj The object on which to invoke the method or constructor. If a method is static, this argument is ignored. If a constructor is static, this argument must be null or an instance of the class that defines the constructor.
invokeAttr A bitmask that is a combination of 0 or more bit flags from System.Reflection.BindingFlags. If binder is null, this parameter is assigned the value System.Reflection.BindingFlags.Default; thus, whatever you pass in is ignored.
binder An object that enables the binding, coercion of argument types, invocation of members, and retrieval of MemberInfo objects via reflection. If binder is null, the default binder is used.
parameters An argument list for the invoked method or constructor. This is an array of objects with the same number, order, and type as the parameters of the method or constructor to be invoked. If there are no parameters, this should be null. If the method or constructor represented by this instance takes a ByRef parameter, there is no special attribute required for that parameter in order to invoke the method or constructor using this function. Any object in this array that is not explicitly initialized with a value will contain the default value for that object type. For reference-type elements, this value is null. For value-type elements, this value is 0, 0.0, or false, depending on the specific element type.
culture An instance of CultureInfo used to govern the coercion of types. If this is null, the System.Globalization.CultureInfo for the current thread is used. (This is necessary to convert a string that represents 1000 to a System.Double value, for example, since 1000 is represented differently by different cultures.)

Returns

An Object containing the return value of the invoked method, or null in the case of a constructor, or null if the method's return type is void. Before calling the method or constructor, Invoke checks to see if the user has access permission and verifies that the parameters are valid.

System.Reflection.MethodBase.op_Equality()

Indicates whether two System.Reflection.MethodBase objects are equal.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left is equal to right; otherwise, false.

System.Reflection.MethodBase.op_Inequality()

Indicates whether two System.Reflection.MethodBase objects are not equal.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left is not equal to right; otherwise, false.

System.Reflection.MethodBase.Attributes

Gets the attributes associated with this method.

Returns

System.Reflection.MethodBase.CallingConvention

Gets a value indicating the calling conventions for this method.

Returns

System.Reflection.MethodBase.ContainsGenericParameters

Gets a value indicating whether the generic method contains unassigned generic type parameters.

Returns

true if the current System.Reflection.MethodBase object represents a generic method that contains unassigned generic type parameters; otherwise, false.

System.Reflection.MethodBase.IsAbstract

Gets a value indicating whether the method is abstract.

Returns

true if the method is abstract; otherwise, false.

System.Reflection.MethodBase.IsAssembly

Gets a value indicating whether the potential visibility of this method or constructor is described by System.Reflection.MethodAttributes.Assembly; that is, the method or constructor is visible at most to other types in the same assembly, and is not visible to derived types outside the assembly.

Returns

true if the visibility of this method or constructor is exactly described by System.Reflection.MethodAttributes.Assembly; otherwise, false.

System.Reflection.MethodBase.IsConstructedGenericMethod

System.Reflection.MethodBase.IsConstructor

Gets a value indicating whether the method is a constructor.

Returns

true if this method is a constructor represented by a System.Reflection.ConstructorInfo object (see note in Remarks about System.Reflection.Emit.ConstructorBuilder objects); otherwise, false.

System.Reflection.MethodBase.IsFamily

Gets a value indicating whether the visibility of this method or constructor is described by System.Reflection.MethodAttributes.Family; that is, the method or constructor is visible only within its class and derived classes.

Returns

true if access to this method or constructor is exactly described by System.Reflection.MethodAttributes.Family; otherwise, false.

System.Reflection.MethodBase.IsFamilyAndAssembly

Gets a value indicating whether the visibility of this method or constructor is described by System.Reflection.MethodAttributes.FamANDAssem; that is, the method or constructor can be called by derived classes, but only if they are in the same assembly.

Returns

true if access to this method or constructor is exactly described by System.Reflection.MethodAttributes.FamANDAssem; otherwise, false.

System.Reflection.MethodBase.IsFamilyOrAssembly

Gets a value indicating whether the potential visibility of this method or constructor is described by System.Reflection.MethodAttributes.FamORAssem; that is, the method or constructor can be called by derived classes wherever they are, and by classes in the same assembly.

Returns

true if access to this method or constructor is exactly described by System.Reflection.MethodAttributes.FamORAssem; otherwise, false.

System.Reflection.MethodBase.IsFinal

Gets a value indicating whether this method is final.

Returns

true if this method is final; otherwise, false.

System.Reflection.MethodBase.IsGenericMethod

Gets a value indicating whether the method is generic.

Returns

true if the current System.Reflection.MethodBase represents a generic method; otherwise, false.

System.Reflection.MethodBase.IsGenericMethodDefinition

Gets a value indicating whether the method is a generic method definition.

Returns

true if the current System.Reflection.MethodBase object represents the definition of a generic method; otherwise, false.

System.Reflection.MethodBase.IsHideBySig

Gets a value indicating whether only a member of the same kind with exactly the same signature is hidden in the derived class.

Returns

true if the member is hidden by signature; otherwise, false.

System.Reflection.MethodBase.IsPrivate

Gets a value indicating whether this member is private.

Returns

true if access to this method is restricted to other members of the class itself; otherwise, false.

System.Reflection.MethodBase.IsPublic

Gets a value indicating whether this is a public method.

Returns

true if this method is public; otherwise, false.

System.Reflection.MethodBase.IsSecurityCritical

Gets a value that indicates whether the current method or constructor is security-critical or security-safe-critical at the current trust level, and therefore can perform critical operations.

Returns

true if the current method or constructor is security-critical or security-safe-critical at the current trust level; false if it is transparent.

System.Reflection.MethodBase.IsSecuritySafeCritical

Gets a value that indicates whether the current method or constructor is security-safe-critical at the current trust level; that is, whether it can perform critical operations and can be accessed by transparent code.

Returns

true if the method or constructor is security-safe-critical at the current trust level; false if it is security-critical or transparent.

System.Reflection.MethodBase.IsSecurityTransparent

Gets a value that indicates whether the current method or constructor is transparent at the current trust level, and therefore cannot perform critical operations.

Returns

true if the method or constructor is security-transparent at the current trust level; otherwise, false.

System.Reflection.MethodBase.IsSpecialName

Gets a value indicating whether this method has a special name.

Returns

true if this method has a special name; otherwise, false.

System.Reflection.MethodBase.IsStatic

Gets a value indicating whether the method is static.

Returns

true if this method is static; otherwise, false.

System.Reflection.MethodBase.IsVirtual

Gets a value indicating whether the method is virtual.

Returns

true if this method is virtual; otherwise, false.

System.Reflection.MethodBase.MethodHandle

Gets a handle to the internal metadata representation of a method.

Returns

System.Reflection.MethodBase.MethodImplementationFlags

Gets the System.Reflection.MethodImplAttributes flags that specify the attributes of a method implementation.

Returns

The method implementation flags.

System.Reflection.MethodBody

Provides access to the metadata and MSIL for the body of a method.

System.Reflection.MethodBody.#ctor

Initializes a new instance of the System.Reflection.MethodBody class.

System.Reflection.MethodBody.GetILAsByteArray

Returns the MSIL for the method body, as an array of bytes.

Returns

An array of type System.Byte that contains the MSIL for the method body.

System.Reflection.MethodBody.ExceptionHandlingClauses

Gets a list that includes all the exception-handling clauses in the method body.

Returns

An System.Collections.Generic.IList`1 of System.Reflection.ExceptionHandlingClause objects representing the exception-handling clauses in the body of the method.

System.Reflection.MethodBody.InitLocals

Gets a value indicating whether local variables in the method body are initialized to the default values for their types.

Returns

true if the method body contains code to initialize local variables to null for reference types, or to the zero-initialized value for value types; otherwise, false.

System.Reflection.MethodBody.LocalSignatureMetadataToken

Gets a metadata token for the signature that describes the local variables for the method in metadata.

Returns

An integer that represents the metadata token.

System.Reflection.MethodBody.LocalVariables

Gets the list of local variables declared in the method body.

Returns

An System.Collections.Generic.IList`1 of System.Reflection.LocalVariableInfo objects that describe the local variables declared in the method body.

System.Reflection.MethodBody.MaxStackSize

Gets the maximum number of items on the operand stack when the method is executing.

Returns

The maximum number of items on the operand stack when the method is executing.

System.Reflection.MethodImplAttributes

Specifies flags for the attributes of a method implementation.

System.Reflection.MethodImplAttributes.AggressiveInlining

Specifies that the method should be inlined wherever possible.

System.Reflection.MethodImplAttributes.AggressiveOptimization

Specifies that the method should be optimized whenever possible.

System.Reflection.MethodImplAttributes.CodeTypeMask

Specifies flags about code type.

System.Reflection.MethodImplAttributes.ForwardRef

Specifies that the method is not defined.

System.Reflection.MethodImplAttributes.IL

Specifies that the method implementation is in Microsoft intermediate language (MSIL).

System.Reflection.MethodImplAttributes.InternalCall

Specifies an internal call.

System.Reflection.MethodImplAttributes.Managed

Specifies that the method is implemented in managed code.

System.Reflection.MethodImplAttributes.ManagedMask

Specifies whether the method is implemented in managed or unmanaged code.

System.Reflection.MethodImplAttributes.MaxMethodImplVal

Specifies a range check value.

System.Reflection.MethodImplAttributes.Native

Specifies that the method implementation is native.

System.Reflection.MethodImplAttributes.NoInlining

Specifies that the method cannot be inlined.

System.Reflection.MethodImplAttributes.NoOptimization

Specifies that the method is not optimized by the just-in-time (JIT) compiler or by native code generation (see Ngen.exe) when debugging possible code generation problems.

System.Reflection.MethodImplAttributes.OPTIL

Specifies that the method implementation is in Optimized Intermediate Language (OPTIL).

System.Reflection.MethodImplAttributes.PreserveSig

Specifies that the method signature is exported exactly as declared.

System.Reflection.MethodImplAttributes.Runtime

Specifies that the method implementation is provided by the runtime.

System.Reflection.MethodImplAttributes.Synchronized

Specifies that the method is single-threaded through the body. Static methods (Shared in Visual Basic) lock on the type, whereas instance methods lock on the instance. You can also use the C# lock statement or the Visual Basic SyncLock statement for this purpose.

System.Reflection.MethodImplAttributes.Unmanaged

Specifies that the method is implemented in unmanaged code.

System.Reflection.MethodInfo

Discovers the attributes of a method and provides access to method metadata.

System.Reflection.MethodInfo.#ctor

Initializes a new instance of the System.Reflection.MethodInfo class.

System.Reflection.MethodInfo.CreateDelegate()

Creates a delegate of the specified type from this method.

Parameters

NameDescriptionDefault
delegateType The type of the delegate to create.

Returns

The delegate for this method.

System.Reflection.MethodInfo.CreateDelegate()

Creates a delegate of the specified type with the specified target from this method.

Parameters

NameDescriptionDefault
delegateType The type of the delegate to create.
target The object targeted by the delegate.

Returns

The delegate for this method.

System.Reflection.MethodInfo.CreateDelegate``1

Creates a delegate of type from this method.

Returns

The delegate for this method.

System.Reflection.MethodInfo.CreateDelegate``1()

Creates a delegate of type with the specified target from this method.

Parameters

NameDescriptionDefault
target The object targeted by the delegate.

Returns

The delegate for this method.

System.Reflection.MethodInfo.Equals()

Returns a value that indicates whether this instance is equal to a specified object.

Parameters

NameDescriptionDefault
obj An object to compare with this instance, or null.

Returns

true if obj equals the type and value of this instance; otherwise, false.

System.Reflection.MethodInfo.GetBaseDefinition

When overridden in a derived class, returns the System.Reflection.MethodInfo object for the method on the direct or indirect base class in which the method represented by this instance was first declared.

Returns

A System.Reflection.MethodInfo object for the first implementation of this method.

System.Reflection.MethodInfo.GetGenericArguments

Returns an array of System.Type objects that represent the type arguments of a generic method or the type parameters of a generic method definition.

Returns

An array of System.Type objects that represent the type arguments of a generic method or the type parameters of a generic method definition. Returns an empty array if the current method is not a generic method.

System.Reflection.MethodInfo.GetGenericMethodDefinition

Returns a System.Reflection.MethodInfo object that represents a generic method definition from which the current method can be constructed.

Returns

A System.Reflection.MethodInfo object representing a generic method definition from which the current method can be constructed.

System.Reflection.MethodInfo.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Reflection.MethodInfo.MakeGenericMethod()

Substitutes the elements of an array of types for the type parameters of the current generic method definition, and returns a System.Reflection.MethodInfo object representing the resulting constructed method.

Parameters

NameDescriptionDefault
typeArguments An array of types to be substituted for the type parameters of the current generic method definition.

Returns

A System.Reflection.MethodInfo object that represents the constructed method formed by substituting the elements of typeArguments for the type parameters of the current generic method definition.

System.Reflection.MethodInfo.op_Equality()

Indicates whether two System.Reflection.MethodInfo objects are equal.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left is equal to right; otherwise, false.

System.Reflection.MethodInfo.op_Inequality()

Indicates whether two System.Reflection.MethodInfo objects are not equal.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left is not equal to right; otherwise, false.

System.Reflection.MethodInfo.MemberType

Gets a System.Reflection.MemberTypes value indicating that this member is a method.

Returns

A System.Reflection.MemberTypes value indicating that this member is a method.

System.Reflection.MethodInfo.ReturnParameter

Gets a System.Reflection.ParameterInfo object that contains information about the return type of the method, such as whether the return type has custom modifiers.

Returns

A System.Reflection.ParameterInfo object that contains information about the return type.

System.Reflection.MethodInfo.ReturnType

Gets the return type of this method.

Returns

The return type of this method.

System.Reflection.MethodInfo.ReturnTypeCustomAttributes

Gets the custom attributes for the return type.

Returns

An ICustomAttributeProvider object representing the custom attributes for the return type.

System.Reflection.MethodInvoker

Provides methods to invoke the method specified by the provided System.Reflection.MethodBase.

System.Reflection.MethodInvoker.Create()

Creates a new instance of System.Reflection.MethodInvoker.

Parameters

NameDescriptionDefault
method The method that will be invoked.

Returns

The new instance.

System.Reflection.MethodInvoker.Invoke()

Invokes the method using the specified arguments.

Parameters

NameDescriptionDefault
obj The object on which to invoke the method. If the method is static, this argument is ignored.

Returns

An object containing the return value of the invoked method, or null if the invoked method does not have a return value.

System.Reflection.MethodInvoker.Invoke()

Invokes the method using the specified arguments.

Parameters

NameDescriptionDefault
obj The object on which to invoke the method. If the method is static, this argument is ignored.
arg1 The first argument for the invoked method.

Returns

An object containing the return value of the invoked method, or
null
if the invoked method does not have a return value.

System.Reflection.MethodInvoker.Invoke()

Invokes the method using the specified arguments.

Parameters

NameDescriptionDefault
obj The object on which to invoke the method. If the method is static, this argument is ignored.
arg1 The first argument for the invoked method.
arg2 The second argument for the invoked method.

Returns

An object containing the return value of the invoked method, or
null
if the invoked method does not have a return value.

System.Reflection.MethodInvoker.Invoke()

Invokes the method using the specified arguments.

Parameters

NameDescriptionDefault
obj The object on which to invoke the method. If the method is static, this argument is ignored.
arg1 The first argument for the invoked method.
arg2 The second argument for the invoked method.
arg3 The third argument for the invoked method.

Returns

An object containing the return value of the invoked method, or
null
if the invoked method does not have a return value.

System.Reflection.MethodInvoker.Invoke()

Invokes the method using the specified arguments.

Parameters

NameDescriptionDefault
obj The object on which to invoke the method. If the method is static, this argument is ignored.
arg1 The first argument for the invoked method.
arg2 The second argument for the invoked method.
arg3 The third argument for the invoked method.
arg4 The fourth argument for the invoked method.

Returns

An object containing the return value of the invoked method, or
null
if the invoked method does not have a return value.

System.Reflection.MethodInvoker.Invoke()

Invokes the method using the specified arguments.

Parameters

NameDescriptionDefault
obj The object on which to invoke the method. If the method is static, this argument is ignored.
arguments The arguments for the invoked method.

Returns

An object containing the return value of the invoked method, or
null
if the invoked method does not have a return value.

System.Reflection.Missing

Represents a missing System.Object. This class cannot be inherited.

System.Reflection.Missing.Value

Represents the sole instance of the System.Reflection.Missing class.

System.Reflection.Missing.System#Runtime#Serialization#ISerializable#GetObjectData()

Sets a System.Runtime.Serialization.SerializationInfo object with the logical context information needed to recreate the sole instance of the System.Reflection.Missing object.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo object to be populated with serialization information.
context The System.Runtime.Serialization.StreamingContext object representing the destination context of the serialization.

System.Reflection.Module

Performs reflection on a module.

System.Reflection.Module.FilterTypeName

A TypeFilter object that filters the list of types defined in this module based upon the name. This field is case-sensitive and read-only.

System.Reflection.Module.FilterTypeNameIgnoreCase

A TypeFilter object that filters the list of types defined in this module based upon the name. This field is case-insensitive and read-only.

System.Reflection.Module.#ctor

Initializes a new instance of the System.Reflection.Module class.

System.Reflection.Module.Equals()

Determines whether this module and the specified object are equal.

Parameters

NameDescriptionDefault
o The object to compare with this instance.

Returns

true if o is equal to this instance; otherwise, false.

System.Reflection.Module.FindTypes()

Returns an array of classes accepted by the given filter and filter criteria.

Parameters

NameDescriptionDefault
filter The delegate used to filter the classes.
filterCriteria An Object used to filter the classes.

Returns

An array of type Type containing classes that were accepted by the filter.

System.Reflection.Module.GetCustomAttributes()

Returns all custom attributes.

Parameters

NameDescriptionDefault
inherit This argument is ignored for objects of this type.

Returns

An array of type Object containing all custom attributes.

System.Reflection.Module.GetCustomAttributes()

Gets custom attributes of the specified type.

Parameters

NameDescriptionDefault
attributeType The type of attribute to get.
inherit This argument is ignored for objects of this type.

Returns

An array of type Object containing all custom attributes of the specified type.

System.Reflection.Module.GetCustomAttributesData

Returns a list of System.Reflection.CustomAttributeData objects for the current module, which can be used in the reflection-only context.

Returns

A generic list of System.Reflection.CustomAttributeData objects representing data about the attributes that have been applied to the current module.

System.Reflection.Module.GetField()

Returns a field having the specified name.

Parameters

NameDescriptionDefault
name The field name.

Returns

A FieldInfo object having the specified name, or null if the field does not exist.

System.Reflection.Module.GetField()

Returns a field having the specified name and binding attributes.

Parameters

NameDescriptionDefault
name The field name.
bindingAttr One of the BindingFlags bit flags used to control the search.

Returns

A FieldInfo object having the specified name and binding attributes, or null if the field does not exist.

System.Reflection.Module.GetFields

Returns the global fields defined on the module.

Returns

An array of System.Reflection.FieldInfo objects representing the global fields defined on the module; if there are no global fields, an empty array is returned.

System.Reflection.Module.GetFields()

Returns the global fields defined on the module that match the specified binding flags.

Parameters

NameDescriptionDefault
bindingFlags A bitwise combination of System.Reflection.BindingFlags values that limit the search.

Returns

An array of type System.Reflection.FieldInfo representing the global fields defined on the module that match the specified binding flags; if no global fields match the binding flags, an empty array is returned.

System.Reflection.Module.GetHashCode

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

System.Reflection.Module.GetMethod()

Returns a method having the specified name.

Parameters

NameDescriptionDefault
name The method name.

Returns

A MethodInfo object having the specified name, or null if the method does not exist.

System.Reflection.Module.GetMethod()

Returns a method having the specified name, binding information, calling convention, and parameter types and modifiers.

Parameters

NameDescriptionDefault
name The method name.
bindingAttr One of the BindingFlags bit flags used to control the search.
binder An object that implements Binder, containing properties related to this method.
callConvention The calling convention for the method.
types The parameter types to search for.
modifiers An array of parameter modifiers used to make binding work with parameter signatures in which the types have been modified.

Returns

A MethodInfo object in accordance with the specified criteria, or null if the method does not exist.

System.Reflection.Module.GetMethod()

Returns a method having the specified name and parameter types.

Parameters

NameDescriptionDefault
name The method name.
types The parameter types to search for.

Returns

A MethodInfo object in accordance with the specified criteria, or null if the method does not exist.

System.Reflection.Module.GetMethodImpl()

Returns the method implementation in accordance with the specified criteria.

Parameters

NameDescriptionDefault
name The method name.
bindingAttr One of the BindingFlags bit flags used to control the search.
binder An object that implements Binder, containing properties related to this method.
callConvention The calling convention for the method.
types The parameter types to search for.
modifiers An array of parameter modifiers used to make binding work with parameter signatures in which the types have been modified.

Returns

A MethodInfo object containing implementation information as specified, or null if the method does not exist.

System.Reflection.Module.GetMethods

Returns the global methods defined on the module.

Returns

An array of System.Reflection.MethodInfo objects representing all the global methods defined on the module; if there are no global methods, an empty array is returned.

System.Reflection.Module.GetMethods()

Returns the global methods defined on the module that match the specified binding flags.

Parameters

NameDescriptionDefault
bindingFlags A bitwise combination of System.Reflection.BindingFlags values that limit the search.

Returns

An array of type System.Reflection.MethodInfo representing the global methods defined on the module that match the specified binding flags; if no global methods match the binding flags, an empty array is returned.

System.Reflection.Module.GetObjectData()

Provides an System.Runtime.Serialization.ISerializable implementation for serialized objects.

Parameters

NameDescriptionDefault
info The information and data needed to serialize or deserialize an object.
context The context for the serialization.

System.Reflection.Module.GetPEKind()

Gets a pair of values indicating the nature of the code in a module and the platform targeted by the module.

Parameters

NameDescriptionDefault
peKind When this method returns, a combination of the System.Reflection.PortableExecutableKinds values indicating the nature of the code in the module.
machine When this method returns, one of the System.Reflection.ImageFileMachine values indicating the platform targeted by the module.

System.Reflection.Module.GetType()

Returns the specified type, performing a case-sensitive search.

Parameters

NameDescriptionDefault
className The name of the type to locate. The name must be fully qualified with the namespace.

Returns

A Type object representing the given type, if the type is in this module; otherwise, null.

System.Reflection.Module.GetType()

Returns the specified type, searching the module with the specified case sensitivity.

Parameters

NameDescriptionDefault
className The name of the type to locate. The name must be fully qualified with the namespace.
ignoreCase true for case-insensitive search; otherwise, false.

Returns

A Type object representing the given type, if the type is in this module; otherwise, null.

System.Reflection.Module.GetType()

Returns the specified type, specifying whether to make a case-sensitive search of the module and whether to throw an exception if the type cannot be found.

Parameters

NameDescriptionDefault
className The name of the type to locate. The name must be fully qualified with the namespace.
throwOnError true to throw an exception if the type cannot be found; false to return null.
ignoreCase true for case-insensitive search; otherwise, false.

Returns

A System.Type object representing the specified type, if the type is declared in this module; otherwise, null.

System.Reflection.Module.GetTypes

Returns all the types defined within this module.

Returns

An array of type Type containing types defined within the module that is reflected by this instance.

System.Reflection.Module.IsDefined()

Returns a value that indicates whether the specified attribute type has been applied to this module.

Parameters

NameDescriptionDefault
attributeType The type of custom attribute to test for.
inherit This argument is ignored for objects of this type.

Returns

true if one or more instances of attributeType have been applied to this module; otherwise, false.

System.Reflection.Module.IsResource

Gets a value indicating whether the object is a resource.

Returns

true if the object is a resource; otherwise, false.

System.Reflection.Module.op_Equality()

Indicates whether two System.Reflection.Module objects are equal.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left is equal to right; otherwise, false.

System.Reflection.Module.op_Inequality()

Indicates whether two System.Reflection.Module objects are not equal.

Parameters

NameDescriptionDefault
left The first object to compare.
right The second object to compare.

Returns

true if left is not equal to right; otherwise, false.

System.Reflection.Module.ResolveField()

Returns the field identified by the specified metadata token.

Parameters

NameDescriptionDefault
metadataToken A metadata token that identifies a field in the module.

Returns

A System.Reflection.FieldInfo object representing the field that is identified by the specified metadata token.

System.Reflection.Module.ResolveField()

Returns the field identified by the specified metadata token, in the context defined by the specified generic type parameters.

Parameters

NameDescriptionDefault
metadataToken A metadata token that identifies a field in the module.
genericTypeArguments An array of System.Type objects representing the generic type arguments of the type where the token is in scope, or null if that type is not generic.
genericMethodArguments An array of System.Type objects representing the generic type arguments of the method where the token is in scope, or null if that method is not generic.

Returns

A System.Reflection.FieldInfo object representing the field that is identified by the specified metadata token.

System.Reflection.Module.ResolveMember()

Returns the type or member identified by the specified metadata token.

Parameters

NameDescriptionDefault
metadataToken A metadata token that identifies a type or member in the module.

Returns

A System.Reflection.MemberInfo object representing the type or member that is identified by the specified metadata token.

System.Reflection.Module.ResolveMember()

Returns the type or member identified by the specified metadata token, in the context defined by the specified generic type parameters.

Parameters

NameDescriptionDefault
metadataToken A metadata token that identifies a type or member in the module.
genericTypeArguments An array of System.Type objects representing the generic type arguments of the type where the token is in scope, or null if that type is not generic.
genericMethodArguments An array of System.Type objects representing the generic type arguments of the method where the token is in scope, or null if that method is not generic.

Returns

A System.Reflection.MemberInfo object representing the type or member that is identified by the specified metadata token.

System.Reflection.Module.ResolveMethod()

Returns the method or constructor identified by the specified metadata token.

Parameters

NameDescriptionDefault
metadataToken A metadata token that identifies a method or constructor in the module.

Returns

A System.Reflection.MethodBase object representing the method or constructor that is identified by the specified metadata token.

System.Reflection.Module.ResolveMethod()

Returns the method or constructor identified by the specified metadata token, in the context defined by the specified generic type parameters.

Parameters

NameDescriptionDefault
metadataToken A metadata token that identifies a method or constructor in the module.
genericTypeArguments An array of System.Type objects representing the generic type arguments of the type where the token is in scope, or null if that type is not generic.
genericMethodArguments An array of System.Type objects representing the generic type arguments of the method where the token is in scope, or null if that method is not generic.

Returns

A System.Reflection.MethodBase object representing the method that is identified by the specified metadata token.

System.Reflection.Module.ResolveSignature()

Returns the signature blob identified by a metadata token.

Parameters

NameDescriptionDefault
metadataToken A metadata token that identifies a signature in the module.

Returns

An array of bytes representing the signature blob.

System.Reflection.Module.ResolveString()

Returns the string identified by the specified metadata token.

Parameters

NameDescriptionDefault
metadataToken A metadata token that identifies a string in the string heap of the module.

Returns

A System.String containing a string value from the metadata string heap.

System.Reflection.Module.ResolveType()

Returns the type identified by the specified metadata token.

Parameters

NameDescriptionDefault
metadataToken A metadata token that identifies a type in the module.

Returns

A System.Type object representing the type that is identified by the specified metadata token.

System.Reflection.Module.ResolveType()

Returns the type identified by the specified metadata token, in the context defined by the specified generic type parameters.

Parameters

NameDescriptionDefault
metadataToken A metadata token that identifies a type in the module.
genericTypeArguments An array of System.Type objects representing the generic type arguments of the type where the token is in scope, or null if that type is not generic.
genericMethodArguments An array of System.Type objects representing the generic type arguments of the method where the token is in scope, or null if that method is not generic.

Returns

A System.Type object representing the type that is identified by the specified metadata token.

System.Reflection.Module.ToString

Returns the name of the module.

Returns

A String representing the name of this module.

System.Reflection.Module.Assembly

Gets the appropriate System.Reflection.Assembly for this instance of System.Reflection.Module.

Returns

An Assembly object.

System.Reflection.Module.CustomAttributes

Gets a collection that contains this module's custom attributes.

Returns

A collection that contains this module's custom attributes.

System.Reflection.Module.FullyQualifiedName

Gets a string representing the fully qualified name and path to this module.

Returns

The fully qualified module name.

System.Reflection.Module.MDStreamVersion

Gets the metadata stream version.

Returns

A 32-bit integer representing the metadata stream version. The high-order two bytes represent the major version number, and the low-order two bytes represent the minor version number.

System.Reflection.Module.MetadataToken

Gets a token that identifies the module in metadata.

Returns

An integer token that identifies the current module in metadata.

System.Reflection.Module.ModuleHandle

Gets a handle for the module.

Returns

A System.ModuleHandle structure for the current module.

System.Reflection.Module.ModuleVersionId

Gets a universally unique identifier (UUID) that can be used to distinguish between two versions of a module.

Returns

A System.Guid that can be used to distinguish between two versions of a module.

System.Reflection.Module.Name

Gets a String representing the name of the module with the path removed.

Returns

The module name with no path.

System.Reflection.Module.ScopeName

Gets a string representing the name of the module.

Returns

The module name.

System.Reflection.ModuleResolveEventHandler

Represents the method that will handle the System.Reflection.Assembly.ModuleResolve event of an System.Reflection.Assembly.

Parameters

NameDescriptionDefault
sender The assembly that was the source of the event.
e The arguments supplied by the object describing the event.

Returns

The module that satisfies the request.

System.Reflection.NullabilityInfo

Represents nullability information.

System.Reflection.NullabilityInfo.ElementType

Gets the nullability information for the element type of the array.

Returns

If the member type is an array, the System.Reflection.NullabilityInfo of the elements of the array; otherwise, null.

System.Reflection.NullabilityInfo.GenericTypeArguments

Gets the nullability information for each type parameter.

Returns

If the member type is a generic type, the nullability information for each type parameter.

System.Reflection.NullabilityInfo.ReadState

Gets the nullability read state of the member.

System.Reflection.NullabilityInfo.Type

Gets the type of the member or generic parameter to which this instance belongs.

System.Reflection.NullabilityInfo.WriteState

Gets the nullability write state of the member.

System.Reflection.NullabilityInfoContext

Provides APIs for populating nullability information and context from reflection members: System.Reflection.ParameterInfo, System.Reflection.FieldInfo, System.Reflection.PropertyInfo, and System.Reflection.EventInfo.

System.Reflection.NullabilityInfoContext.#ctor

Initializes a new instance of the System.Reflection.NullabilityInfoContext class.

System.Reflection.NullabilityInfoContext.Create()

Populates a System.Reflection.NullabilityInfo for the given System.Reflection.EventInfo. If the nullablePublicOnly feature is set for an assembly, like it does in the .NET SDK, the private and/or internal member's nullability attributes are omitted, and the API will return the System.Reflection.NullabilityState.Unknown state.

Parameters

NameDescriptionDefault
eventInfo The event for which to populate nullability information.

Returns

System.Reflection.NullabilityInfoContext.Create()

Populates a System.Reflection.NullabilityInfo for the given System.Reflection.FieldInfo. If the nullablePublicOnly feature is set for an assembly, like it does in the .NET SDK, the private and/or internal member's nullability attributes are omitted, and the API will return the System.Reflection.NullabilityState.Unknown state.

Parameters

NameDescriptionDefault
fieldInfo The field for which to populate the nullability information.

Returns

System.Reflection.NullabilityInfoContext.Create()

Populates a System.Reflection.NullabilityInfo for the given System.Reflection.ParameterInfo. If the nullablePublicOnly feature is set for an assembly, like it does in the .NET SDK, the private and/or internal member's nullability attributes are omitted, and the API will return the System.Reflection.NullabilityState.Unknown state.

Parameters

NameDescriptionDefault
parameterInfo The parameter for which to populate the nullability information.

Returns

System.Reflection.NullabilityInfoContext.Create()

Populates a System.Reflection.NullabilityInfo for the given System.Reflection.PropertyInfo. If the nullablePublicOnly feature is set for an assembly, like it does in the .NET SDK, the private and/or internal member's nullability attributes are omitted, and the API will return the System.Reflection.NullabilityState.Unknown state.

Parameters

NameDescriptionDefault
propertyInfo The property for which to populate the nullability information.

Returns

System.Reflection.NullabilityState

Describes nullability states.

System.Reflection.NullabilityState.NotNull

Non-nullable value or reference type.

System.Reflection.NullabilityState.Nullable

Nullable value or reference type.

System.Reflection.NullabilityState.Unknown

Nullability context not enabled (oblivious).

System.Reflection.ObfuscateAssemblyAttribute

Instructs obfuscation tools to use their standard obfuscation rules for the appropriate assembly type.

System.Reflection.ObfuscateAssemblyAttribute.#ctor()

Initializes a new instance of the System.Reflection.ObfuscateAssemblyAttribute class, specifying whether the assembly to be obfuscated is public or private.

Parameters

NameDescriptionDefault
assemblyIsPrivate true if the assembly is used within the scope of one application; otherwise, false.

System.Reflection.ObfuscateAssemblyAttribute.AssemblyIsPrivate

Gets a System.Boolean value indicating whether the assembly was marked private.

Returns

true if the assembly was marked private; otherwise, false.

System.Reflection.ObfuscateAssemblyAttribute.StripAfterObfuscation

Gets or sets a System.Boolean value indicating whether the obfuscation tool should remove the attribute after processing.

Returns

true if the obfuscation tool should remove the attribute after processing; otherwise, false. The default value for this property is true.

System.Reflection.ObfuscationAttribute

Instructs obfuscation tools to take the specified actions for an assembly, type, or member.

System.Reflection.ObfuscationAttribute.#ctor

Initializes a new instance of the System.Reflection.ObfuscationAttribute class.

System.Reflection.ObfuscationAttribute.ApplyToMembers

Gets or sets a System.Boolean value indicating whether the attribute of a type is to apply to the members of the type.

Returns

true if the attribute is to apply to the members of the type; otherwise, false. The default is true.

System.Reflection.ObfuscationAttribute.Exclude

Gets or sets a System.Boolean value indicating whether the obfuscation tool should exclude the type or member from obfuscation.

Returns

true if the type or member to which this attribute is applied should be excluded from obfuscation; otherwise, false. The default is true.

System.Reflection.ObfuscationAttribute.Feature

Gets or sets a string value that is recognized by the obfuscation tool, and which specifies processing options.

Returns

A string value that is recognized by the obfuscation tool, and which specifies processing options. The default is "all".

System.Reflection.ObfuscationAttribute.StripAfterObfuscation

Gets or sets a System.Boolean value indicating whether the obfuscation tool should remove this attribute after processing.

Returns

true if an obfuscation tool should remove the attribute after processing; otherwise, false. The default is true.

System.Reflection.ParameterAttributes

Defines the attributes that can be associated with a parameter. These are defined in CorHdr.h.

System.Reflection.ParameterAttributes.HasDefault

Specifies that the parameter has a default value.

System.Reflection.ParameterAttributes.HasFieldMarshal

Specifies that the parameter has field marshaling information.

System.Reflection.ParameterAttributes.In

Specifies that the parameter is an input parameter.

System.Reflection.ParameterAttributes.Lcid

Specifies that the parameter is a locale identifier (lcid).

System.Reflection.ParameterAttributes.None

Specifies that there is no parameter attribute.

System.Reflection.ParameterAttributes.Optional

Specifies that the parameter is optional.

System.Reflection.ParameterAttributes.Out

Specifies that the parameter is an output parameter.

System.Reflection.ParameterAttributes.Reserved3

Reserved.

System.Reflection.ParameterAttributes.Reserved4

Reserved.

System.Reflection.ParameterAttributes.ReservedMask

Specifies that the parameter is reserved.

System.Reflection.ParameterAttributes.Retval

Specifies that the parameter is a return value.

System.Reflection.ParameterInfo

Discovers the attributes of a parameter and provides access to parameter metadata.

System.Reflection.ParameterInfo.AttrsImpl

The attributes of the parameter.

System.Reflection.ParameterInfo.ClassImpl

The Type of the parameter.

System.Reflection.ParameterInfo.DefaultValueImpl

The default value of the parameter.

System.Reflection.ParameterInfo.MemberImpl

The member in which the field is implemented.

System.Reflection.ParameterInfo.NameImpl

The name of the parameter.

System.Reflection.ParameterInfo.PositionImpl

The zero-based position of the parameter in the parameter list.

System.Reflection.ParameterInfo.#ctor

Initializes a new instance of the ParameterInfo class.

System.Reflection.ParameterInfo.GetCustomAttributes()

Gets all the custom attributes defined on this parameter.

Parameters

NameDescriptionDefault
inherit This argument is ignored for objects of this type.

Returns

An array that contains all the custom attributes applied to this parameter.

System.Reflection.ParameterInfo.GetCustomAttributes()

Gets the custom attributes of the specified type or its derived types that are applied to this parameter.

Parameters

NameDescriptionDefault
attributeType The custom attributes identified by type.
inherit This argument is ignored for objects of this type.

Returns

An array that contains the custom attributes of the specified type or its derived types.

System.Reflection.ParameterInfo.GetCustomAttributesData

Returns a list of System.Reflection.CustomAttributeData objects for the current parameter, which can be used in the reflection-only context.

Returns

A generic list of System.Reflection.CustomAttributeData objects representing data about the attributes that have been applied to the current parameter.

System.Reflection.ParameterInfo.GetModifiedParameterType

Gets the modified type of this parameter object.

Returns

A modified type.

System.Reflection.ParameterInfo.GetOptionalCustomModifiers

Gets the optional custom modifiers of the parameter.

Returns

An array of System.Type objects that identify the optional custom modifiers of the current parameter, such as System.Runtime.CompilerServices.IsConst or System.Runtime.CompilerServices.IsImplicitlyDereferenced.

System.Reflection.ParameterInfo.GetRealObject()

Returns the real object that should be deserialized instead of the object that the serialized stream specifies.

Parameters

NameDescriptionDefault
context The serialized stream from which the current object is deserialized.

Returns

The actual object that is put into the graph.

System.Reflection.ParameterInfo.GetRequiredCustomModifiers

Gets the required custom modifiers of the parameter.

Returns

An array of System.Type objects that identify the required custom modifiers of the current parameter, such as System.Runtime.CompilerServices.IsConst or System.Runtime.CompilerServices.IsImplicitlyDereferenced.

System.Reflection.ParameterInfo.IsDefined()

Determines whether the custom attribute of the specified type or its derived types is applied to this parameter.

Parameters

NameDescriptionDefault
attributeType The Type object to search for.
inherit This argument is ignored for objects of this type.

Returns

true if one or more instances of attributeType or its derived types are applied to this parameter; otherwise, false.

System.Reflection.ParameterInfo.ToString

Gets the parameter type and name represented as a string.

Returns

A string containing the type and the name of the parameter.

System.Reflection.ParameterInfo.Attributes

Gets the attributes for this parameter.

Returns

A ParameterAttributes object representing the attributes for this parameter.

System.Reflection.ParameterInfo.CustomAttributes

Gets a collection that contains this parameter's custom attributes.

Returns

A collection that contains this parameter's custom attributes.

System.Reflection.ParameterInfo.DefaultValue

Gets a value indicating the default value if the parameter has a default value.

Returns

The default value of the parameter, or System.DBNull.Value if the parameter has no default value.

System.Reflection.ParameterInfo.HasDefaultValue

Gets a value that indicates whether this parameter has a default value.

Returns

true if this parameter has a default value; otherwise, false.

System.Reflection.ParameterInfo.IsIn

Gets a value indicating whether this is an input parameter.

Returns

true if the parameter is an input parameter; otherwise, false.

System.Reflection.ParameterInfo.IsLcid

Gets a value indicating whether this parameter is a locale identifier (lcid).

Returns

true if the parameter is a locale identifier; otherwise, false.

System.Reflection.ParameterInfo.IsOptional

Gets a value indicating whether this parameter is optional.

Returns

true if the parameter is optional; otherwise, false.

System.Reflection.ParameterInfo.IsOut

Gets a value indicating whether this is an output parameter.

Returns

true if the parameter is an output parameter; otherwise, false.

System.Reflection.ParameterInfo.IsRetval

Gets a value indicating whether this is a Retval parameter.

Returns

true if the parameter is a Retval; otherwise, false.

System.Reflection.ParameterInfo.Member

Gets a value indicating the member in which the parameter is implemented.

Returns

The member which implanted the parameter represented by this System.Reflection.ParameterInfo.

System.Reflection.ParameterInfo.MetadataToken

Gets a value that identifies this parameter in metadata.

Returns

A value which, in combination with the module, uniquely identifies this parameter in metadata.

System.Reflection.ParameterInfo.Name

Gets the name of the parameter.

Returns

The simple name of this parameter.

System.Reflection.ParameterInfo.ParameterType

Gets the Type of this parameter.

Returns

The Type object that represents the Type of this parameter.

System.Reflection.ParameterInfo.Position

Gets the zero-based position of the parameter in the formal parameter list.

Returns

An integer representing the position this parameter occupies in the parameter list.

System.Reflection.ParameterInfo.RawDefaultValue

Gets a value indicating the default value if the parameter has a default value.

Returns

The default value of the parameter, or System.DBNull.Value if the parameter has no default value.

System.Reflection.ParameterModifier

Attaches a modifier to parameters so that binding can work with parameter signatures in which the types have been modified.

System.Reflection.ParameterModifier.#ctor()

Initializes a new instance of the System.Reflection.ParameterModifier structure representing the specified number of parameters.

Parameters

NameDescriptionDefault
parameterCount The number of parameters.

System.Reflection.ParameterModifier.Item()

Gets or sets a value that specifies whether the parameter at the specified index position is to be modified by the current System.Reflection.ParameterModifier.

Parameters

NameDescriptionDefault
index The index position of the parameter whose modification status is being examined or set.

Returns

true if the parameter at this index position is to be modified by this System.Reflection.ParameterModifier; otherwise, false.

System.Reflection.Pointer

Provides a wrapper class for pointers.

System.Reflection.Pointer.Box()

Boxes the supplied unmanaged memory pointer and the type associated with that pointer into a managed System.Reflection.Pointer wrapper object. The value and the type are saved so they can be accessed from the native code during an invocation.

Parameters

NameDescriptionDefault
ptr The supplied unmanaged memory pointer.
type The type associated with the ptr parameter.

Returns

A pointer object.

System.Reflection.Pointer.Equals()

Returns a value that indicates whether the current object is equal to a specified object.

Parameters

NameDescriptionDefault
obj The object to compare with this instance.

Returns

true if the current instance is equal to the specified object; otherwise, false.

System.Reflection.Pointer.GetHashCode

Returns the hash code for the current object.

Returns

A 32-bit signed integer hash code.

System.Reflection.Pointer.System#Runtime#Serialization#ISerializable#GetObjectData()

Sets the System.Runtime.Serialization.SerializationInfo object with the file name, fusion log, and additional exception information.

Parameters

NameDescriptionDefault
info The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.
context The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.

System.Reflection.Pointer.Unbox()

Returns the stored pointer.

Parameters

NameDescriptionDefault
ptr The stored pointer.

Returns

This method returns void.

System.Reflection.PortableExecutableKinds

Identifies the nature of the code in an executable file.

System.Reflection.PortableExecutableKinds.ILOnly

The executable contains only Microsoft intermediate language (MSIL), and is therefore neutral with respect to 32-bit or 64-bit platforms.

System.Reflection.PortableExecutableKinds.NotAPortableExecutableImage

The file is not in portable executable (PE) file format.

System.Reflection.PortableExecutableKinds.PE32Plus

The executable requires a 64-bit platform.

System.Reflection.PortableExecutableKinds.Preferred32Bit

The executable is platform-agnostic but should be run on a 32-bit platform whenever possible.

System.Reflection.PortableExecutableKinds.Required32Bit

The executable can be run on a 32-bit platform, or in the 32-bit Windows on Windows (WOW) environment on a 64-bit platform.

System.Reflection.PortableExecutableKinds.Unmanaged32Bit

The executable contains pure unmanaged code.

System.Reflection.ProcessorArchitecture

Identifies the processor and bits-per-word of the platform targeted by an executable.

System.Reflection.ProcessorArchitecture.Amd64

A 64-bit processor based on the x64 architecture.

System.Reflection.ProcessorArchitecture.Arm

An ARM processor.

System.Reflection.ProcessorArchitecture.IA64

A 64-bit Intel Itanium processor only.

System.Reflection.ProcessorArchitecture.MSIL

Neutral with respect to processor and bits-per-word.

System.Reflection.ProcessorArchitecture.None

An unknown or unspecified combination of processor and bits-per-word.

System.Reflection.ProcessorArchitecture.X86

A 32-bit Intel processor, either native or in the Windows on Windows environment on a 64-bit platform (WOW64).

System.Reflection.PropertyAttributes

Defines the attributes that can be associated with a property. These attribute values are defined in corhdr.h.

System.Reflection.PropertyAttributes.HasDefault

Specifies that the property has a default value.

System.Reflection.PropertyAttributes.None

Specifies that no attributes are associated with a property.

System.Reflection.PropertyAttributes.Reserved2

Reserved.

System.Reflection.PropertyAttributes.Reserved3

Reserved.

System.Reflection.PropertyAttributes.Reserved4

Reserved.

System.Reflection.PropertyAttributes.ReservedMask

Specifies a flag reserved for runtime use only.

System.Reflection.PropertyAttributes.RTSpecialName

Specifies that the metadata internal APIs check the name encoding.

System.Reflection.PropertyAttributes.SpecialName

Specifies that the property is special, with the name describing how the property is special.

System.Reflection.PropertyInfo

Discovers the attributes of a property and provides access to property metadata.