Patent Application
20050240943
This invention relates to network software, such as Web applications, and to computer software development of such network software. More particularly, this invention relates to an application program interface (API) that facilitates use of a network software platform by application programs and computer hardware.
Very early on, computer software came to be categorized as “operating system” software or “application” software. Broadly speaking, an application is software meant to perform a specific task for the computer user such as solving a mathematical equation or supporting word processing. The operating system is the software that manages and controls the computer hardware. The goal of the operating system is to make the computer resources available to the application programmer while at the same time, hiding the complexity necessary to actually control the hardware.
The operating system makes the resources available via functions that are collectively known as the Application Program Interface or API. The term API is also used in reference to a single one of these functions. The functions are often grouped in terms of what resource or service they provide to the application programmer. Application software requests resources by calling individual API functions. API functions also serve as the means by which messages and information provided by the operating system are relayed back to the application software.
In addition to changes in hardware, another factor driving the evolution of operating system software has been the desire to simplify and speed application software development. Application software development can be a daunting task, sometimes requiring years of developer time to create a sophisticated program with millions of lines of code. For a popular operating system such as Microsoft Windows®, application software developers write thousands of different applications each year that utilize the operating system. A coherent and usable operating system base is required to support so many diverse application developers.
Often, development of application software can be made simpler by making the operating system more complex. That is, if a function may be useful to several different application programs, it may be better to write it once for inclusion in the operating system, than requiring dozens of software developers to write it dozens of times for inclusion in dozens of different applications. In this manner, if the operating system supports a wide range of common functionality required by a number of applications, significant savings in applications software development costs and time can be achieved.
Regardless of where the line between operating system and application software is drawn, it is clear that for a useful operating system, the API between the operating system and the computer hardware and application software is as important as efficient internal operation of the operating system itself.
Over the past few years, the universal adoption of the Internet, and networking technology in general, has changed the landscape for computer software developers. Traditionally, software developers focused on single-site software applications for standalone desktop computers, or LAN-based computers that were connected to a limited number of other computers via a local area network (LAN). Such software applications were typically referred to as “shrink wrapped” products because the software was marketed and sold in a shrink-wrapped package. The applications utilized well-defined APIs to access the underlying operating system of the computer.
As the Internet evolved and gained widespread acceptance, the industry began to recognize the power of hosting applications at various sites on the World Wide Web (or simply the “Web”). In the networked world, clients from anywhere could submit requests to server-based applications hosted at diverse locations and receive responses back in fractions of a second. These Web applications, however, were typically developed using the same operating system platform that was originally developed for standalone computing machines or locally networked computers. Unfortunately, in some instances, these applications do not adequately transfer to the distributed computing regime. The underlying platform was simply not constructed with the idea of supporting limitless numbers of interconnected computers.
To accommodate the shift to the distributed computing environment being ushered in by the Internet, Microsoft Corporation is developing a network software platform known as the “.NET” platform (read as “Dot Net”). The platform allows developers to create Web services that will execute over the Internet. Such a dynamic shift requires a new ground-up design of an entirely new API.
In response to this challenge, the inventors developed a unique set of API functions for Microsoft's .NET™ platform.
An application program interface (API) provides a set of functions, including a set of base classes and types that are used in substantially all applications accessing the API, for application developers who build Web applications on a network platform, such as Microsoft Corporation's .NET™ platform.
The same numbers are used throughout the drawings to reference like features.
Accompanying the specification in the parent case, U.S. patent application Ser. No. 09/902,811, is a compact disc that stores a compiled HTML help file identifying the API (application program interface) for Microsoft's .NET™ network platform. The file is named “cpref.chm” and was created on Jun. 8, 2001. It is 30.81 Mbytes in size. The file can be executed on a Windows®-based computing device (e.g., IBM-PC, or equivalent) that executes a Windows®-brand operating system (e.g., Windows® NT, Windows® 98, Windows® 2000, etc.). The compiled HTML help file stored on the compact disk is hereby incorporated by reference.
Additionally, the APIs contained in the compiled HTML help file are also provided in approximately 100 separate text files named “NamespaceName.txt”. The text files comply with the ASCII format.
The compact disc itself is a CD-ROM, and conforms to the ISO 9660 standard.
This disclosure addresses an application program interface (API) for a network platform upon which developers can build Web applications and services. More particularly, an exemplary API is described for the .NET™ platform created by Microsoft Corporation. The .NET™ platform is a software platform for Web services and Web applications implemented in the distributed computing environment. It represents the next generation of Internet computing, using open communication standards to communicate among loosely coupled Web services that are collaborating to perform a particular task.
In the described implementation, the .NET™ platform utilizes XML (extensible markup language), an open standard for describing data. XML is managed by the World Wide Web Consortium (W3C). XML is used for defining data elements on a Web page and business-to-business documents. XML uses a similar tag structure as HTML; however, whereas HTML defines how elements are displayed, XML defines what those elements contain. HTML uses predefined tags, but XML allows tags to be defined by the developer of the page. Thus, virtually any data items can be identified, allowing Web pages to function like database records. Through the use of XML and other open protocols, such as Simple Object Access Protocol (SOAP), the .NET™ platform allows integration of a wide range of services that can be tailored to the needs of the user. Although the embodiments described herein are described in conjunction with XML and other open standards, such are not required for the operation of the claimed invention. Other equally viable technologies will suffice to implement the inventions described herein.
Exemplary Network Environment
Web services 102 are accessible directly by other services (as represented by communication link 106) or a software application, such as Web application 110 (as represented by communication links 112 and 114). Each Web service 102 is illustrated as including one or more servers that execute software to handle requests for particular services. Such services often maintain databases that store information to be served back to requesters. Web services may be configured to perform any one of a variety of different services. Examples of Web services include login verification, notification, database storage, stock quoting, location directories, mapping, music, electronic wallet, calendar/scheduler, telephone listings, news and information, games, ticketing, and so on. The Web services can be combined with each other and with other applications to build intelligent interactive experiences.
The network environment 100 also includes representative client devices 120(1), 120(2), 120(3), 120(4), . . . , 120(M) that utilize the Web services 102 (as represented by communication link 122) and/or the Web application 110 (as represented by communication links 124, 126, and 128). The clients may communicate with one another using standard protocols as well, as represented by an exemplary XML link 130 between clients 120(3) and 120(4).
The client devices, referenced generally as number 120, can be implemented many different ways. Examples of possible client implementations include, without limitation, portable computers, stationary computers, tablet PCs, televisions/set-top boxes, wireless communication devices, personal digital assistants, gaming consoles, printers, photocopiers, and other smart devices.
The Web application 110 is an application designed to run on the network platform and may utilize the Web services 102 when handling and servicing requests from clients 120. The Web application 110 is composed of one or more software applications 130 that run atop a programming framework 132, which are executing on one or more servers 134 or other computer systems. Note that a portion of Web application 110 may actually reside on one or more of clients 120. Alternatively, Web application 110 may coordinate with other software on clients 120 to actually accomplish its tasks.
The programming framework 132 is the structure that supports the applications and services developed by application developers. It permits multi-language development and seamless integration by supporting multiple languages. It supports open protocols, such as SOAP, and encapsulates the underlying operating system and object model services. The framework provides a robust and secure execution environment for the multiple programming languages and offers secure, integrated class libraries.
The framework 132 is a multi-tiered architecture that includes an application program interface (API) layer 142, a common language runtime (CLR) layer 144, and an operating system/services layer 146. This layered architecture allows updates and modifications to various layers without impacting other portions of the framework. A common language specification (CLS) 140 allows designers of various languages to write code that is able to access underlying library functionality. The specification 140 functions as a contract between language designers and library designers. By adhering to the CLS, libraries written in one language can be directly accessible to code modules written in other languages to achieve seamless integration between code modules written in one language and code modules written in another language.
The API layer 142 presents groups of functions that the applications 130 can call to access the resources and services provided by layer 146. By exposing the API functions for a network platform, application developers can create Web applications for distributed computing systems that make full use of the network resources and other Web services, without needing to understand the complex interworkings of how those network resources actually operate or are made available. Moreover, the Web applications can be written in any number of programming languages, and translated into an intermediate language supported by the common language runtime 144 and included as part of the common language specification 140. In this way, the API layer 142 can provide methods for a wide and diverse variety of applications.
Additionally, the framework 132 can be configured to support API calls placed by remote applications executing remotely from the servers 134 that host the framework. Representative applications 148(1) and 148(2) residing on clients 120(3) and 120(M), respectively, can use the API functions by making calls directly, or indirectly, to the API layer 142 over the network 104.
The framework may also be implemented at the clients. Client 120(3) represents the situation where a framework 150 is implemented at the client. This framework may be identical to server-based framework 132, or modified for client purposes. Alternatively, the client-based framework may be condensed in the event that the client is a limited or dedicated function device, such as a cellular phone, personal digital assistant, handheld computer, or other communication/computing device.
Developers' Programming Framework
The framework 132 encapsulates the operating system 146(1) (e.g., Windows®-brand operating systems) and object model services 146(2) (e.g., Component Object Model (COM) or Distributed COM). The operating system 146(1) provides conventional functions, such as file management, notification, event handling, user interfaces (e.g., windowing, menus, dialogs, etc.), security, authentication, verification, processes and threads, memory management, and so on. The object model services 146(2) provide interfacing with other objects to perform various tasks. Calls made to the API layer 142 are handed to the common language runtime layer 144 for local execution by the operating system 146(1) and/or object model services 146(2).
The API 142 groups API functions into multiple namespaces. Namespaces essentially define a collection of classes, interfaces, delegates, enumerations, and structures, which are collectively called “types”, that provide a specific set of related functionality. A class represents managed heap allocated data that has reference assignment semantics. A delegate is an object oriented function pointer. An enumeration is a special kind of value type that represents named constants. A structure represents static allocated data that has value assignment semantics. An interface defines a contract that other types can implement.
By using namespaces, a designer can organize a set of types into a hierarchical namespace. The designer is able to create multiple groups from the set of types, with each group containing at least one type that exposes logically related functionality. In the exemplary implementation, the API 142 is organized into four root namespaces: a first namespace 200 for Web applications, a second namespace 202 for client applications, a third namespace 204 for data and XML, and a fourth namespace 206 for base class libraries (BCLs). Each group can then be assigned a name. For instance, types in the Web applications namespace 200 are assigned the name “Web”, and types in the data and XML namespace 204 can be assigned names “Data” and “XML” respectively. The named groups can be organized under a single “global root” namespace for system level APIs, such as an overall System namespace. By selecting and prefixing a top level identifier, the types in each group can be easily referenced by a hierarchical name that includes the selected top level identifier prefixed to the name of the group containing the type. For instance, types in the Web applications namespace 200 can be referenced using the hierarchical name “System.Web”. In this way, the individual namespaces 200, 202, 204, and 206 become major branches off of the System namespace and can carry a designation where the individual namespaces are prefixed with a designator, such as a “System.” prefix.
The Web applications namespace 200 pertains to Web based functionality, such as dynamically generated Web pages (e.g., Microsoft's Active Server Pages (ASP)). It supplies types that enable browser/server communication. The client applications namespace 202 pertains to drawing and client side UI functionality. It supplies types that enable drawing of two-dimensional (2D) and three-dimensional (3D) drawings, imaging, and printing, as well as the ability to construct window forms, menus, boxes, and so on.
The data and XML namespace 204 relates to connectivity to data sources and XML functionality. It supplies classes, interfaces, delegates, and enumerations that enable security, specify data types, and serialize objects into XML format documents or streams. The base class libraries (BCL) namespace 206 pertains to basic system and runtime functionality. It contains the fundamental types and base classes that define commonly-used value and reference data types, events and event handlers, interfaces, attributes, and processing exceptions.
In addition to the framework 132, programming tools 210 are provided to assist the developer in building Web services and/or applications. One example of the programming tools 200 is Visual Studio™, a multi-language suite of programming tools offered by Microsoft Corporation.
Root API Namespaces
The Web applications namespace 200 (“System.Web”) defines additional namespaces, including:
The client applications namespace 202 is composed of two namespaces:
A drawing namespace 328 (“System.Drawing”) containing classes for graphics functionality. The drawing namespace 328 includes a 2D drawing namespace 330 (“System.Drawing.Drawing2D”) that contains classes and enumerations to provide advanced 2-dimmensional and vector graphics functionality, an imaging namespace 332 (“System.Drawing.Imaging”) that contains classes for advanced imaging functionality, a printing namespace 334 (“System. Drawing.Printing”) that contains classes to permit developers to customize printing, and a text namespace 336 (“System.Drawing.Text”) that contains classes for advanced typography functionality.
The data and XML namespace 204 is composed of two namespaces:
The base class library namespace 206 (“System”) includes the following namespaces:
A diagnostics namespace 364 (“System.Diagnostics”) containing classes that are used to debug applications and to trace code execution. The namespace allows developers to start system processes, read and write to event logs, and monitor system performance using performance counters.
A globalization namespace 366 (“System.Globalization”) containing classes that define culture-related information, including the language, the country/region, the calendars in use, the format patterns for dates, currency and numbers, and the sort order for strings.
Portions of the base class library namespace 206 (“System”) are discussed in additional detail below.
System Namespace
The System namespace is the root namespace; it offers common functionality that is needed by a wide variety of application types. The System namespace includes common base classes, types and utility classes that will be needed in substantially all applications (that is, in nearly every application).
The System namespace provides commonly used base types. It includes Object, which is the ultimate base class for all types in the system. Object defines the base set of services that any type in the system is able to provide. Not surprisingly, Object provides default implementations for all of these services. The ValueType class is a reference type that serves as the base class for all value types. It customizes the implementations of the virtual methods on Object so that they are more appropriate for value types. Enum is a reference type that derives from ValueType and is the base class for all enums in the system. It further customizes the virtual methods from ValueType to make them specific to deal with exactly one integral field of instance data. Enum also offers utility methods for formatting and parsing of enum values. The ultimate base class for all exceptions in the system, the Exception class, is also in the System namespace. All custom attributes derive from the Attribute base class that contains utility methods for reading custom attribute off of reflection elements.
In addition, the base data types are also found in the system namespace. These are types that are so commonly used that languages typically use key words as aliases for them. These classes represent those types and provide formatting and parsing, comparing and coercion support.
NET Framework Built-In Value Types
Other classes provide services including supervision of managed and unmanaged applications, mathematics, remote and local program invocation, data type conversion, and application environment management.
The following is a more detailed description of the System namespace, identifying various classes, interfaces, enumerations, and so forth contained in the System namespace.
System
This namespace contains fundamental classes and base classes that define commonly-used value and reference data types, events and event handlers, interfaces, attributes, and processing exceptions.
Description
This namespace contains fundamental classes and base classes that define commonly-used value and reference data types, events and event handlers, interfaces, attributes, and processing exceptions.
_AppDomain interface (System)
Description
Properties:
BaseDirectory
DynamicDirectory
Evidence
FriendlyName
RelativeSearchPath
ShadowCopyFiles
Methods:
AppendPrivatePath
ClearPrivatePath
ClearShadowCopyPath
CreateInstance
CreateInstance
CreateInstance
CreateInstanceFrom
CreateInstanceFrom
CreateInstanceFrom
DefineDynamicAssembly
DefineDynamicAssembly
DefineDynamicAssembly
DefineDynamicAssembly
DefineDynamicAssembly
DefineDynamicAssembly
DefineDynamicAssembly
DefineDynamicAssembly
DefineDynamicAssembly
DoCallBack
Equals
ExecuteAssembly
ExecuteAssembly
ExecuteAssembly
GetAssemblies
GetData
GetHashCode
GetLifetimeService
GetType
InitializeLifetimeService
Load
Load
Load
Load
Load
Load
Load
Load
Load
SetAppDomainPolicy
SetCachePath
SetData
SetPrincipalPolicy
SetShadowCopyPath
SetThreadPrincipal
ToString
Activator class (System)
ToString
Description
Contains methods to create types of objects locally or remotely, or obtain references to existing remote objects.
The
System.Activator.CreateInstance(System.Type,System.Reflection.BindingFlags, System.Reflection.Binder,System.Object[ ],System.Globalization.CultureInfo) method creates an instance of a type defined in an assembly by invoking the constructor that best matches the specified arguments. If no arguments are specified, the constructor that takes no parameters, that is, the default constructor, is invoked.
CreateComInstanceFrom
Creates an instance of the COM object whose name is specified, using the named assembly file and the constructor that best matches the specified parameters.
Return Value: A handle, which must be unwrapped to access the newly created instance.
This method allows types to be created remotely without having to load the type locally. The name of a file that contains an assembly where the type named typeName is sought. The name of the desired type.
CreateInstance
Creates an instance of the specified type using the constructor that best matches the specified parameter.
Return Value: A reference to the newly created object.
The constructor to be invoked must be accessible. The type of object to create.
CreateInstance
Creates an instance of the type whose name is specified, using the named assembly and the constructor that best matches the specified parameters.
Return Value: A handle, which must be unwrapped to access the newly created instance.
This method allows types to be created remotely without having to load the type locally. The name of the assembly where the type named typeName is sought. If assemblyName is null, the executing assembly is searched. The name of the desired type.
CreateInstance
Creates an instance of the specified type using the constructor that best matches the specified parameters.
Return Value: A reference to the newly created object.
The constructor to be invoked must be accessible and provide the most specific match with the specified argument list. The type of object to create. 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 default constructor) is invoked.
CreateInstance
Creates an instance of the type whose name is specified, using the named assembly and the constructor that best matches the specified parameters.
Return Value: A handle, which must be unwrapped to access the newly created instance.
This method allows types to be created remotely without having to load the type locally. The name of the assembly where the type named typeName is sought. If assemblyName is null, the executing assembly is searched. The name of the desired type. An array of one or more attributes that can participate in activation.
CreateInstance
Creates an instance of the specified type using the constructor that best matches the specified parameters.
Return Value: A reference to the newly created object.
The constructor to be invoked must be accessible and provide the most specific match with the specified argument list. The type of object to create. 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 default constructor) is invoked. An array of one or more attributes that can participate in activation.
CreateInstance
Creates an instance of the specified type using the constructor that best matches the specified parameters.
Return Value: A reference to the newly created object.
The constructor to be invoked must be accessible and provide the most specific match with the specified argument list under the constraints of the specified binder and binding attributes. The type of object to create. 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 properties is conducted. An object that uses bindingAttr and args to seek and identify the type constructor. If binder is null, the default binder is used. 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 default constructor) is invoked. 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.
CreateInstance
Creates an instance of the specified type using the constructor that best matches the specified parameters.
Return Value: A reference to the newly created object.
The constructor to be invoked must be accessible and provide the most specific match with the specified argument list under the constraints of the specified binder and binding attributes. The type of object to create. 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 properties is conducted. An object that uses bindingAttr and args to seek and identify the type constructor. If binder is null, the default binder is used. 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 default constructor) is invoked. 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. An array of one or more attributes that can participate in activation.
CreateInstance
Creates an instance of the type whose name is specified, using the named assembly and the constructor that best matches the specified parameters.
Return Value: A handle, which must be unwrapped to access the newly created instance.
This method allows types to be created remotely without having to load the type locally. The name of the assembly where the type named typeName is sought. If assemblyName is null, the executing assembly is searched. The name of the desired type. A Boolean that specifies whether the search for typeName is case-sensitive. If ignoreCase is true, the search is not case-sensitive. 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 properties is conducted. An object that uses bindingAttr and args to seek and identify the typeName constructor. If binder is null, the default binder is used. 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 default constructor) is invoked. 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. An array of one or more attributes that can participate in activation. Information used to make security policy decisions and grant code permissions.
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.
Return Value: A handle, which must be unwrapped to access the newly created instance.
This method allows types to be created remotely without having to load the type locally. The name of a file that contains an assembly where the type named typeName is sought. The name of the desired type.
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.
Return Value: A handle, which must be unwrapped to access the newly created instance.
This method allows types to be created remotely without having to load the type locally. The name of a file that contains an assembly where the type named typeName is sought. The name of the desired type. An array of one or more attributes that can participate in activation.
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.
Return Value: A handle, which must be unwrapped to access the newly created instance.
This method allows types to be created remotely without having to load the type locally. The name of a file that contains an assembly where the type named typeName is sought. The name of the desired type. A Boolean that specifies whether the search for typeName is case-sensitive. If ignoreCase is true, the search is not case-sensitive. 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 properties is conducted. An object that uses bindingAttr and args to seek and identify the typeName constructor. If binder is null, the default binder is used. 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 default constructor) is invoked. 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. An array of one or more attributes that can participate in activation. Information used to make security policy decisions and grant code permissions.
GetObject
Creates a proxy for the well-known object indicated by the specified type and URL.
Return Value: A proxy that points to an endpoint served by the requested well-known object. Call the proxy to send messages to the remote object. No messages are sent over the network until a method is called on the proxy. The type of the well-known object to which you want to connect. The URL of the well-known object.
GetObject
Creates a proxy for the well-known object indicated by the specified type, URL, and channel data.
Return Value: A proxy that points to an endpoint served by the requested well-known object.
Call the proxy to send messages to the remote object. No messages are sent over the network until a method is called on the proxy. The type of the well-known object to which you want to connect. The URL of the well-known object. Channel-specific data or null.
AppDomain class (System)
ToString
Description
Represents an application domain, which is an isolated environment where applications execute. This class cannot be inherited.
Application domains isolate executing applications from one another. One or more applications can run in a single application domain.
BaseDirectory
ToString
Gets the base directory that the assembly resolver used to probe for assemblies.
This property corresponds to the assembly resolver's APPBASE.
CurrentDomain
ToString
Gets the current application domain for the current System.Threading.Thread.
DynamicDirectory
ToString
Gets the directory that the assembly resolver used to probe for dynamically-created assemblies.
Only available once an attempt has been made to load an assembly into this domain.
Evidence
ToString
Gets the System.Security.Policy.Evidence associated with this application domain that is used as input to security policy.
FriendlyName
ToString
Gets the friendly name of this application domain.
The friendly name of the default application domain is the name of the assembly file loaded in the application domain. The friendly name is formed by stripping the directory specification from the assembly's codebase. For example, if an assembly with the file name “c:MyAppDirectoryMyAssembly.exe” is loaded in the default application domain, the friendly name of that application domain is “MyAssembly.exe”.
RelativeSearchPath
ToString
Gets the path relative to the base directory where the assembly resolver should probe for private assemblies.
Private assemblies are deployed in the same directory structure as the application.
SetupInformation
ToString
Gets the application domain configuration information for this instance.
ShadowCopyFiles
ToString
Gets an indication whether all assemblies that are loaded in the application domain are shadow copied.
This method sets the System.AppDomainSetup.ShadowCopyFiles property of the internal System.AppDomainSetup object associated with this instance.
ToString
Occurs when an assembly is loaded.
The System.AssemblyLoadEventHandler for this event can attempt to locate the assembly and load it.
ToString
Occurs when the resolution of an assembly fails.
The System.ResolveEventHandler for this event can attempt to locate the assembly and load it.
ToString
Occurs when an System.AppDomain is about to be unloaded.
The System.EventHandler for this event can attempt to locate the assembly and load it.
ToString
Occurs when a process is about to exit.
The System.EventHandler for this event can perform termination activities, such as closing files, releasing storage and so on, before the process ends.
ToString
Occurs when the resolution of a resource fails.
The System.ResolveEventHandler for this event can attempt to locate the resource and load it.
ToString
Occurs when the resolution of a type fails.
The System.ResolveEventHandler for this event can attempt to locate the type and load it.
ToString
Occurs when an exception is not caught by an event handler.
For more information about handling events, see.
AppendPrivatePath
Appends the specified name of the directory to the private path.
The private path, or relative search path, is the path relative to the base directory where the assembly resolver probes for private assemblies. The name of the directory to be appended to the private path.
ClearPrivatePath
Resets the System.AppDomainSetup.PrivateBinPath for this instance to null.
ClearShadowCopyPath
Resets the System.AppDomainSetup.ShadowCopyDirectories property for this instance to null
CreateComInstanceFrom
Creates an instance of a COM object. Parameters specify the name of the assembly that can create the object and the name of the type of the object.
Return Value: An object that is a wrapper for the new instance.
Use this method to create types remotely without having to load the type locally. The return value must to be unwrapped in order to access the real object. The name of the assembly in which this object type resides. The type name of the desired object.
CreateDomain
Creates a new application domain with the specified name.
Return Value: The newly created application domain.
friendlyName can be displayed in user interfaces to identify the domain. The friendly name of the domain.
CreateDomain
Creates a new application domain with the given name using the supplied evidence.
Return Value: The newly created application domain. The friendly name of the domain. This friendly name can be displayed in user interfaces to identify the domain. See the description of System.AppDomain.FriendlyName. Evidence mapped through security policy to establish a top-of-stack permission set.
CreateDomain
Creates a new application domain using the specified name, evidence, application domain setup information.
Return Value: The newly created application domain. The friendly name of the domain. This friendly name can be displayed in user interfaces to identify the domain. See the description of System.AppDomain.FriendlyName. Evidence mapped through security policy to establish a top-of-stack permission set. An object that contains application domain initialization information.
CreateDomain
Creates a new application domain with the given name using, evidence, application base path, relative search path, and a parameter that specifies whether a shadow copy of an assembly is to be loaded in to the application domain.
Return Value: The newly created application domain. The friendly name of the domain. This friendly name can be displayed in user interfaces to identify the domain. See the description of System.AppDomain.FriendlyName. Evidence mapped through security policy to establish a top-of-stack permission set. The base directory that the assembly resolver uses to probe for assemblies. See the
Description of System.AppDomain.BaseDirectory. The path relative to the base directory where the assembly resolver should probe for private assemblies. See the
Description of System.AppDomain.RelativeSearchPath. If true, a shadow copy of an assembly is loaded into this application domain.
CreateInstance
Creates a new instance of the specified type defined in the specified assembly.
Return Value: 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.
This is a convenience method that calls the default constructor for typeName. The display name of the assembly. See the description of System.Reflection.AssemblyName for the format of the display name. The full name of the type.
CreateInstance
Creates an instance using the name of the type and the assembly where it exists.
Return Value: A handle to the requested object.
This method allows types to be created remotely without having to load the type locally. This will return an System.Runtime.Remoting.ObjectHandle that needs to be unwrapped in order to access the real object. The name of the assembly in which this object type resides. The type name of the desired object. One or more attributes that can participate in activation.
CreateInstance
Creates an instance using the name of the type and the assembly where it exists.
Return Value: A handle to the requested object.
This method allows types to be created remotely without having to load the type locally. This will return an System.Runtime.Remoting.ObjectHandle that needs to be unwrapped in order to access the real object. The name of the assembly in which this object type resides. The type name of the desired object. A Boolean value specifying whether to perform a case-sensitive search or not. This bitmask affects the way in which the search is conducted. The value is a combination of zero or more bit flags from System.Reflection.BindingFlags, such as NonPublic and OABinding. 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. 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 default constructor is desired, args must be an empty array or null. An instance of System.Globalization.CultureInfo used to govern the coercion of types. If this is null, the CultureInfo for the current thread is used. (Note that this is necessary to, for example, convert a String that represents 1000 to a Double value, since 1000 is represented differently by different cultures.) One or more attributes that can participate in activation.
CreateInstanceAndUnwrap
Creates a new instance of the specified type. Parameters specify the assembly where the type is defined, and the name of the type.
Return Value: An instance of typeName, or null if typeName is not found.
This a convenience method that combines System.AppDomain.CreateInstance(System.String,System.String) and System.Runtime.Remoting.ObjectHandle.Unwrap. This method calls the default constructor for typeName. The name of the assembly. The fully qualified name of the type.
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.
Return Value: An instance of typeName, or null if typeName is not found.
This a convenience method that combines System.AppDomain.CreateInstance(System.String,System.String) and System.Runtime.Remoting.ObjectHandle.Unwrap. This method calls the default constructor for typeName. The name of the assembly. The fully qualified name of the type. An array containing one or more attributes that can participate in activation.
CreateInstanceAndUnwrap
Creates a new instance of the specified type. Parameters specify the name of the type and how it is found and created.
Return Value: An System.Object, which is an instance of typeName, or null if typeName is not found.
This a convenience method that combines System.AppDomain.CreateInstance(System.String,System.String) and System.Runtime.Remoting.ObjectHandle.Unwrap. The name of the assembly. The fully qualified name of the type. A Boolean value specifying whether to perform a case-sensitive search or not. This bitmask affects the way in which the search is conducted. The value is a combination of zero or more bit flags from System.Reflection.BindingFlags, such as NonPublicand OABinding. 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. 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 default constructor is desired, args must be an empty array or null. A culture-specific object used to govern the coercion of types. If culture is null, the CultureInfo for the current thread is used. (Note that this is necessary to, for example, convert a String that represents 1000 to a Double value, since 1000 is represented differently by different cultures.) An System.Object array containing one or more attributes that can participate in activation. An System.Security.Policy.Evidence object used to verify that typeName is allowed to be created.
CreateInstanceFrom
Creates a new instance of the specified type defined in the specified assembly file.
Return Value: 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.
This is a convenience method that calls the default constructor for typeName. The assembly file name. The full name of the type.
CreateInstanceFrom
Creates a new instance of the specified type defined in the specified assembly file.
Return Value: A handle to the requested object.
This method allows types to be created remotely without having to load the type locally. This will return an System.Runtime.Remoting.ObjectHandle that needs to be unwrapped in order to access the real object. The file containing the desired object's assembly. The type name of the desired object. One or more attributes that can participate in activation.
CreateInstanceFrom
Creates a new instance of the specified type defined in the specified assembly file.
Return Value: A handle to the requested object.
This method allows types to be created remotely without having to load the type locally. This will return an System.Runtime.Remoting.ObjectHandle that needs to be unwrapped in order to access the real object. The file for the assembly in which this object type resides. The type name of the desired object. A Boolean value specifying whether to perform a case-sensitive search or not. This bitmask affects the way in which the search is conducted. The value is a combination of zero or more bit flags from System.Reflection.BindingFlags, such as NonPublicand OABinding. 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. 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 default constructor is desired, args must be an empty array or null. An instance of System.Globalization.CultureInfo used to govern the coercion of types. If this is null, the CultureInfo for the current thread is used. (Note that this is necessary to, for example, convert a String that represents 1000 to a Double value, since 1000 is represented differently by different cultures.) One or more attributes that can participate in activation.
CreateInstanceFromAndUnwrap
Creates a new instance of the specified type defined in the specified assembly file.
Return Value: Returns an System.Runtime.Remoting.ObjectHandle object that is a wrapper for the new instance. Returns null if the type is not found.
This a convenience method that combines System.AppDomain.CreateInstance(System.String,System.String) and System.Runtime.Remoting.ObjectHandle.Unwrap. This method calls the default constructor for typeName. The assembly file name. The full name of the type.
CreateInstanceFromAndUnwrap
Creates an instance using the name of the type and the assembly where it exists. This allows types to be created remotely without having to load the type locally. This will return an ObjectHandle that needs to be unwrapped in order to access the real object.
Return Value: A handle to the desired object.
This a convenience method that combines System.AppDomain.CreateInstance(System.String,System.String) and System.Runtime.Remoting.ObjectHandle.Unwrap. This method calls the Is default constructor for typeName. The file containing the desired object's assembly. The type name of the desired object. One or more attributes that can participate in activation.
CreateInstanceFromAndUnwrap
Creates an instance using the name of the type and the assembly where it exists. This allows types to be created remotely without having to load the type locally. This will return an ObjectHandle that needs to be unwrapped in order to access the real object.
Return Value: A handle to the requested object.
This a convenience method that combines System.AppDomain.CreateInstance(System.String,System.String) and System.Runtime.Remoting.ObjectHandle.Unwrap. The file for the assembly in which this object type resides. The type name of the desired object. A Boolean value specifying whether to perform a case-sensitive search or not. This bitmask affects the way in which the search is conducted. The value is a combination of zero or more bit flags from System.Reflection.BindingFlags, such as NonPublicand OABinding. 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. 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 default constructor is desired, args must be an empty array or null. An instance of System.Globalization.CultureInfo used to govern the coercion of types. If culture is null, the CultureInfo for the current thread is used. (Note that this is necessary to, for example, convert a String that represents 1000 to a Double value, since 1000 is represented differently by different cultures.) One or more attributes that can participate in activation.
DefineDynamicAssembly
Defines a dynamic assembly with the given name and the given access.
Return Value: Represents the dynamic assembly created.
You can specify partial signing of the assembly by specifying AssemblyName.Originator. You can specify full signing of the assembly by specifying AssemblyName.Originator and AssemblyName.KeyPair. The “strong name”, or unique identity of the dynamic assembly. The access mode for the dynamic assembly.
DefineDynamicAssembly
Defines a dynamic assembly with the given name, the given access, and the supplied evidence.
Return Value: Represents the dynamic assembly created.
Only fully trusted callers can supply evidence when defining a dynamic assembly. The runtime will map the supplied evidence through policy to determine the granted permissions. Semi-trusted callers must supply a null evidence. If evidence is null, the runtime copies the permission sets, that is, the current grant and deny sets, from the caller's assembly to the dynamic assembly being defined and marks policy as resolved. If the dynamic assembly is saved to disk, subsequent loads will get grants based on policies associated with the location where the assembly was saved. The unique identity of the dynamic assembly. The mode in which the dynamic assembly will be accessed. The evidence supplied for the dynamic assembly.
DefineDynamicAssembly
Defines a dynamic assembly with the given name, the given access, and the name of the directory for saving the assembly.
Return Value: Represents the dynamic assembly created.
You can specify partial signing of the assembly by specifying AssemblyName.Originator. You can specify full signing of the assembly by specifying AssemblyName.Originator and AssemblyName.KeyPair. The unique identity of the dynamic assembly. The mode in which the dynamic assembly will be accessed. The name of the directory in which the assembly will be saved. If dir is null, the directory defaults to the current directory.
DefineDynamicAssembly
Defines a dynamic assembly with the given name, given access, the name of the directory for saving the assembly, and the supplied evidence.
Return Value: Represents the dynamic assembly created.
Only fully trusted callers can supply their evidence when defining a dynamic assembly. The runtime will map the evidence through policy to determine the granted permissions. Semi-trusted callers must supply a null evidence. If evidence is null, the runtime copies the permission sets, that is, the current grant and deny sets, from the caller's assembly to the dynamic assembly being defined and marks policy as resolved. If the dynamic assembly is saved to disk, subsequent loads will get grants based on policies associated with the location where the assembly was saved. The unique identity of the dynamic assembly. The mode in which the dynamic assembly will be accessed. The name of the directory in which the assembly will be saved. If dir is null, the directory defaults to the current directory. The evidence supplied for the dynamic assembly.
DefineDynamicAssembly
Defines a dynamic assembly with the given name, the given access, and the given permission requests.
Return Value: Represents the dynamic assembly created.
You can specify partial signing of the assembly by specifying AssemblyName.Originator. You can specify full signing of the assembly by specifying AssemblyName.Originator and AssemblyName.KeyPair. The unique identity of the dynamic assembly. The mode in which the dynamic assembly will be accessed. The required permission request. The optional permission request. The refused permission request.
DefineDynamicAssembly
Defines a dynamic assembly with the given name, given access, supplied evidence, and the permission requests.
Return Value: Represents the dynamic assembly created.
Only fully trusted callers can supply their evidence when defining a dynamic assembly. The runtime will map the evidence through policy to determine the granted permissions. Semi-trusted callers must supply a null evidence. If evidence is null, the runtime copies the permission sets (that is, the current grant and deny sets) from the caller's assembly to the dynamic assembly being defined and marks policy as resolved. The unique identity of the dynamic assembly. The mode in which the dynamic assembly will be accessed. The evidence supplied for the dynamic assembly. The required permission request. The optional permission request. The refused permission request.
DefineDynamicAssembly
Defines a dynamic assembly with the given name, given access, the name of the directory for saving the assembly, and the permission requests.
Return Value: Represents the dynamic assembly created.
You can specify partial signing of the assembly by specifying AssemblyName.Originator. You can specify full signing of the assembly by specifying AssemblyName.Originator and AssemblyName.KeyPair. The unique identity of the dynamic assembly. The mode in which the dynamic assembly will be accessed. The name of the directory in which the assembly will be saved. If dir is null, the directory defaults to the current directory. The required permission request. The optional permission request. The refused permission request.
DefineDynamicAssembly
Defines a dynamic assembly with the given name, given access, the name of the directory for saving the assembly, supplied evidence, and the permission requests.
Return Value: Represents the dynamic assembly created.
Only fully trusted callers can supply their evidence when defining a dynamic assembly. The runtime will map the evidence through policy to determine the granted permissions. Semi-trusted callers must supply a null evidence. If evidence is null, the runtime copies the permission sets, that is, the current grant and deny sets, from the caller's assembly to the dynamic assembly being defined and marks policy as resolved. The unique identity of the dynamic assembly. The mode in which the dynamic assembly will be accessed. The name of the directory in which the assembly will be saved. If dir is null, the directory defaults to the current directory. The evidence supplied for the dynamic assembly. The required permission request. The optional permission request. The refused permission request.
DefineDynamicAssembly
Defines a dynamic assembly using the specified name, access mode, storage directory, evidence, permission requests, and synchronization option.
Return Value: Represents the dynamic assembly created.
Only fully trusted callers can supply their evidence when defining a dynamic System.Reflection.Assembly. The runtime will map the System.Security.Policy.Evidence through policy to determine the granted permissions. Semi-trusted callers must supply an System.Security.Policy.Evidence. If evidence is null, the runtime copies the permission sets, that is, the current grant and deny sets, from the caller's System.Reflection.Assembly to the dynamic System.Reflection.Assembly being defined and marks policy as resolved. The unique identity of the dynamic assembly. The mode in which the dynamic assembly will be accessed. The name of the directory in which the dynamic assembly will be saved. If dir is null, the directory defaults to the current directory. The evidence supplied for the dynamic assembly. The required permission request. The optional permission request. The refused permission request. If true, the creation of modules, types, and members in the dynamic assembly are synchronized.
DoCallBack
Executes the code in another application domain that is identified by the specified delegate.
ExecuteAssembly
Execute the System.Reflection.Assembly given its file name. The method specified in the .NET Framework header is called.
Return Value: The value returned by the entry point of the assembly.
The method does not spawn a new process, create a new application domain, or execute the entry point method on a new thread. The name of the file from which the assembly is to be loaded.
ExecuteAssembly
Execute the System.Reflection.Assembly given its file name and supplied evidence.
Return Value: The value returned by the entry point of the assembly.
The method does not spawn a new process, create a new application domain, or execute the entry point method on a new thread. The name of the file from which the assembly is to be loaded. Evidence for loading the assembly.
ExecuteAssembly
Execute the System.Reflection.Assembly given its file name and supplied System.Security.Policy.Evidence. Optionally, the System.Reflection.Assembly can be loaded into the domain-neutral code area for use by multiple AppDomains.
Return Value: The value returned by the entry point of the assembly.
The method does not spawn a new process, create a new application domain, or execute the entry point method on a new thread. The name of the file from which the assembly is to be loaded. The supplied evidence for the assembly. The arguments to the entry point of the assembly.
GetAssemblies
Gets the assemblies that have been loaded into this application domain.
Return Value: An array of assemblies in this application domain.
GetCurrentThreadId
Gets the current thread identifier.
Return Value: A 32-bit signed integer that is the identifier of the current thread.
GetData
Gets the value stored in the current application domain for the specified data name.
Return Value: The value of the name property.
name can be the value of one of the System.AppDomainSetup properties. The name of an application domain property.
GetType
Gets the type of the current instance.
Return Value: A System.Type object.
Description
Gets the type of the current instance.
Return Value: A System.Type object.
InitializeLifetimeService
Gives the System.AppDomain an infinite lifetime by preventing a lease from being created.
Return Value: Always null.
IsFinalizingForUnload
Indicates whether the common language runtime has started forcing objects to finalize.
Return Value: true if the common language runtime has started invoking finalizers, forcing objects to finalize; otherwise, false.
Some of the System.AppDomain infrastructure might have been garbage collected before the finalizers started running.
Load
Loads an System.Reflection.Assembly given its System.Reflection.AssemblyName.
Return Value: The loaded assembly.
This method should only be used to load an assembly into the current application domain. This method is defined for interoperability callers who cannot call the static Assembly.Load method. An object that describes the assembly to be loaded.
Load
Loads the System.Reflection.Assembly with a COFF based image containing an emitted System.Reflection.Assembly.
Return Value: The loaded assembly.
This method should only be used to load an assembly into the current application domain. This method is defined for interoperability callers who cannot call the static Assembly.Load method. An array of type byte that is a COFF-based image containing an emitted assembly.
Load
Loads an System.Reflection.Assembly given its display name.
Return Value: The loaded assembly.
This method should only be used to load an assembly into the current application domain. This method is defined for interoperability callers who cannot call the static Assembly.Load method. The display name of the assembly.
Load
Loads an System.Reflection.Assembly given its System.Reflection.AssemblyName.
Return Value: The loaded assembly. An object that describes the assembly to be loaded. Evidence for loading the assembly.
Load
Loads the System.Reflection.Assembly with a COFF based image containing an emitted System.Reflection.Assembly. The raw bytes representing the symbols for the System.Reflection.Assembly are also loaded.
Return Value: The loaded assembly.
This method should only be used to load an assembly into the current application domain. This method is defined for interoperability callers who cannot call the static Assembly.Load method. An array of type byte that is a COFF-based image containing an emitted assembly. An array of type byte containing the raw bytes representing the symbols for the assembly. Load
Loads an System.Reflection.Assembly given its display name.
Return Value: The loaded assembly. The display name of the assembly. Evidence for loading the assembly.
Load
Loads the System.Reflection.Assembly with a COFF based image containing an emitted System.Reflection.Assembly. The raw bytes representing the symbols for the System.Reflection.Assembly are also loaded.
Return Value: The loaded assembly.
This method should only be used to load an assembly into the current application domain. This method is defined for interoperability callers who cannot call the static Assembly.Load method. An array of type byte that is a COFF-based image containing an emitted assembly. An array of type byte containing the raw bytes representing the symbols for the assembly. Evidence for loading the assembly.
SetAppDomainPolicy
Establishes the security policy level for this application domain. The security policy level.
SetCachePath
Establishes the specified directory path as the location where assemblies are shadow copied. The fully qualified path to the shadow copy location.
SetData
Assigns the specified value to the specified application domain property.
This method has been superseded by properties of the System.AppDomainSetup class. The following table shows the System.AppDomainSetup property that corresponds to a value of name. The name of an application domain property. The value to set the name property.
SetDynamicBase
Establishes the specified directory path as the location where dynamically generated files are stored and accessed.
This method sets the System.AppDomainSetup.DynamicBase property of the internal System.AppDomnainSetup object associated with this instance. The fully qualified path to where dynamic assemblies are stored.
SetPrincipalPolicy
Set the class of the default principal object to be attached to threads if they attempt to bind to a principal while executing in this application domain. The class of the principal object to be attached to threads.
SetShadowCopyFiles
Turns on shadow copying.
SetShadowCopyPath
Establishes the specified directory path as the location of assemblies to be “shadow copied”.
This method sets the System.AppDomainSetup.ShadowCopyDirectories property of the internal System.AppDomainSetup object associated with this instance. A list of directory names, where each name is separated by a semicolon.
SetThreadPrincipal
Set the default principal object to be attached to threads if they attempt to bind to a principal while executing in this application domain. The principal object to be attached to threads.
ToString
Obtains the System.String representation of the application domain.
Return Value: The friendly name, loader name, and loader context policy of the application domain.
The string representation specifies the friendly name of the application domain.
Unload
Removes the specified application domain.
A long period of time can pass before domain unloads because it might be difficult to terminate executing threads. An application domain to be unloaded.
AppDomainSetup class (System)
Unload
Constructors:
AppDomainSetup
Example Syntax: Unload
ApplicationBase
Unload
ApplicationName
Unload
CachePath
Unload
ConfigurationFile
Unload
DynamicBase
Unload
LicenseFile
Unload
LoaderOptimization
Unload
PrivateBinPath
Unload
PrivateBin PathProbe
Unload
ShadowCopyDirectories
Unload
ShadowCopyFiles
Unload
AppDomainUnloadedException class (System)
ToString
Description
The exception that is thrown when an attempt is made to access an unloaded application domain.
System.AppDomainUnloadedException uses the HRESULT COR_E_APPDOMAINUNLOADED, which has the value 0x80131014.
AppDomainUnloadedException
Example Syntax:
ToString
Initializes a new instance of the System.AppDomainUnloadedException class with default properties.
The following table shows the initial property values for an instance of System.AppDomainUnloadedException.
AppDomainUnloadedException
Example Syntax:
ToString
Initializes a new instance of the System.AppDomainUnloadedException class with a specified error message.
The following table shows the initial property values for an instance of System.AppDomainUnloadedException. The error message that explains the reason for the exception.
AppDomainUnloadedException
Example Syntax:
ToString
Initializes a new instance of the System.AppDomainUnloadedException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
AppDomainUnloadedException
Example Syntax:
ToString
Initializes a new instance of the System.AppDomainUnloadedException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
ApplicationException class (System)
ToString
Description
The exception that is thrown when a non-fatal application error occurs.
System.ApplicationException is thrown by a user program, not by the common language runtime. If you are designing an application that needs to create its own exceptions, derive from the System.ApplicationException class.
ApplicationException
Example Syntax:
ToString
Initializes a new instance of the System.ApplicationException class with default properties.
The following table shows the initial property values for an instance of System.ApplicationException.
ApplicationException
Example Syntax:
ToString
Initializes a new instance of the System.ApplicationException class with a specified error message.
The following table shows the initial property values for an instance of System.ApplicationException. The error message that explains the reason for the exception.
Example Syntax:
ToString
Initializes a new instance of the System.ApplicationException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
ApplicationException
Example Syntax:
ToString
Initializes a new instance of the System.ApplicationException class with a specified error message and a reference to the inner exception that is the root cause It of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
ArgIterator structure (System)
ToString
Description
Represents a variable-length argument list; that is, the parameters of a function that takes a variable number of arguments.
Typically, you use this class for writing compilers. The methods in this class are not generally useful in other kinds of applications.
ArgIterator
Example Syntax:
ToString
Initializes a new instance of the ArgIterator class using the specified argument list. An argument list consisting of both required and optional items.
ArgIterator
Example Syntax:
ToString
End
Moves the iterator to the end of the variable-length argument list; that is, it invalidates the iterator.
Conceptually, this method moves the iterator to the end of the list so that the next call to System.ArgIterator.GetNextArg generates an exception.
Equals
This method is not supported, and always throws NotSupportedException An object to be compared to this instance.
GetHashCode
Returns the hash code of this object.
Return Value: A 32-bit signed integer hash code.
GetNextArg
Returns the next argument in a variable-length argument list.
Return Value: The next argument as a System.TypedReference object. The iterator is automatically advanced to the next argument.
GetNextArg
Returns the next argument in a variable-length argument list that has a specified type.
Return Value: The next argument as a System.TypedReference object.
The iterator is automatically advanced to the next argument. A runtime type handle that identifies the type of the argument to retrieve.
GetNextArgType
Returns the type of the next argument.
Return Value: The type of the next argument.
This method does not advance the iterator to the next argument.
GetRemainingCount
Returns the number of arguments remaining in the argument list.
Return Value: The number of remaining arguments.
ArgumentException class (System)
ToString
Description
The exception that is thrown when one of the arguments provided to a method is not valid.
System.ArgumentException is thrown when a method is invoked and at least one of the passed arguments does not meet the parameter specification of the called method. All instances of System.ArgumentException should carry a meaningful error message describing the invalid argument, as well as the expected range of values for the argument.
ArgumentException
Example Syntax:
ToString
Initializes a new instance of the System.ArgumentException class with default properties.
The following table shows the initial property values for an instance of System.ArgumentException.
ArgumentException
Example Syntax:
ToString
Initializes a new instance of the System.ArgumentException class with a specified error message.
The following table shows the initial property values for an instance of System.ArgumentException. The error message that explains the reason for the exception.
ArgumentException
Example Syntax:
ToString
Initializes a new instance of the System.ArgumentException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
ArgumentException
Example Syntax:
ToString
Initializes a new instance of the System.ArgumentException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y. Is the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
ArgumentException
Example Syntax:
ToString
Initializes a new instance of the System.ArgumentException class with a specified error message and the name of the parameter that causes this exception.
The following table shows the initial property values for an instance of System.ArgumentException. The error message that explains the reason for the exception. The name of the invalid parameter.
ArgumentException
Example Syntax:
ToString
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 root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. The name of the invalid parameter. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
ToString
Description
Gets the error message and the parameter name, or only the error message if no parameter name is s et.
This property overrides System.Exception.Message. The error message should be localized.
ParamName
ToString
Gets the name of the parameter that causes this exception.
Every System.ArgumentException should carry the name of the parameter that causes this exception. The parameter name should not be localized.
Source
StackTrace
TargetSite
GetObjectData
Sets the System.Runtime.Serialization.SerializationInfo object with the parameter name and additional exception information.
System.ArgumentException.GetObjectData(System.Runtime.Serialization. SerializationInfo,System.Runtime.Serialization.StreamingContext) sets a System.Runtime.Serialization.SerializationInfo with all the exception object data targeted for serialization. During deserialization, the exception object is reconstituted from the System.Runtime.Serialization.SerializationInfo transmitted over the stream. The object that holds the serialized object data. The contextual information about the source or destination.
ArgumentNullException class (System)
ToString
Description
The exception that is thrown when null is passed to a method that does not accept it as a valid argument.
System.ArgumentNullException uses the HRESULT E_POINTER, which has the value 0x80004003.
ArgumentNullException
Example Syntax:
ToString
Initializes a new instance of the System.ArgumentNullException class with default properties.
The following table shows the initial property values for an instance of System.ArgumentNullException
ArgumentNullException
Example Syntax:
ToString
Initializes a new instance of the System.ArgumentNullException class with the name of the parameter that causes this exception.
The following table shows the initial property values for an instance of System.ArgumentNullException. The name of the parameter that is assigned null.
ArgumentNullException
Example Syntax:
ToString
Initializes a new instance of the System.ArgumentNullException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
ArgumentNullException
Example Syntax:
ToString
Initializes an instance of the System.ArgumentNullException class with a specified error message and the name of the parameter that causes this exception.
The following table shows the initial property values for an instance of System.ArgumentNullException. The name of the parameter that is assigned null. The error message that explains the reason for the exception.
HelpLink
HResult
InnerException
Message
ParamName
Source
StackTrace
TargetSite
ArgumentOutOfRangeException class (System)
ToString
Description
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 is used extensively by: Classes in the System.Collections and System.IO namespaces.
ArgumentOutOfRangeException
Example Syntax:
ToString
Initializes a new instance of the System.ArgumentOutOfRangeException class with default properties. The following table shows the initial property values for an instance of System.ArgumentOutOfRangeException.
ArgumentOutOfRangeException
Example Syntax:
ToString
Initializes a new instance of the System.ArgumentOutOfRangeException class with the name of the parameter that causes this exception.
The following table shows the initial property values for an instance of System.ArgumentOutOfRangeException. The name of the invalid parameter.
ArgumentOutOfRangeException
Example Syntax:
ToString
Initializes a new instance of the System.ArgumentOutOfRangeException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
ArgumentOutOfRangeException
Example Syntax:
ToString
Initializes a new instance of the System.ArgumentOutOfRangeException class with a specified error message and the name of the parameter that causes this exception.
The following table shows the initial property values for an instance of System.ArgumentOutOfRangeException. The name of the invalid parameter. The error message that explains the reason for the exception.
ArgumentOutOfRangeException
Example Syntax:
ToString
Initializes a new instance of the System.ArgumentOutOfRangeException class with a specified error message, the parameter name, and the value of the argument.
This constructor with the additional argument actualValue is not used within the .NET Framework class library. The System.ArgumentOutOfRangeException.ActualValue property is provided so that applications can make use of the available argument value. The name of the invalid parameter. The value of the argument that causes this exception. The error message that explains the reason for the exception.
ActualValue
ToString
Gets the argument value that causes this exception.
The System.ArgumentOutOfRangeException.ActualValue property is assigned a value at the time of object construction. If the System.ArgumentOutOfRangeException.ActualValue property value is not null, a string representation of the value is then appended to the message string held by the System.ArgumentOutOfRangeException.Message property.
HelpLink
HResult
InnerException
Message
ToString
Description
Gets the error message and the string representation of the invalid argument value, or only the error message if the argument value is null.
This property overrides System.ArgumentException.Message.
ParamName
Source
StackTrace
TargetSite
GetObjectData
Sets the System.Runtime.Serialization.SerializationInfo object with the invalid argument value and additional exception information.
System.ArgumentOutOfRangeException.GetObjectData(System.Runtime. Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext) sets a System.Runtime.Serialization.SerializationInfo with all the exception object data targeted for serialization. During deserialization, the exception object is reconstituted from the System.Runtime.Serialization.SerializationInfo transmitted over the stream. The object that holds the serialized object data. The contextual information about the source or destination.
ArithmeticException class (System)
ToString
Description
The exception that is thrown for errors in an arithmetic, casting, or conversion operation. System.ArithmeticException is the base class for System.DivideByZeroException, System.NotFiniteNumberException, and System.OverflowException. In general, use one of the derived classes of System.ArithmeticException to more precisely indicate the exact nature of the error. Throw an System.ArithmeticException if you are only interested in capturing a general arithmetic error.
ArithmeticException
Example Syntax:
ToString
Initializes a new instance of the System.ArithmeticException class with
The following table shows initial property values for an instance of System.ArithmeticException.
ArithmeticException
Example Syntax:
ToString
Initializes a new instance of the System.ArithmeticException class with a specified error message.
The following table shows initial property values for an instance of System.ArithmeticException. The error message that explains the reason for the exception.
ArithmeticException
Example Syntax:
ToString
Initializes a new instance of the System.ArithmeticException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
ArithmeticException
Example Syntax:
ToString
Initializes a new instance of the System.ArithmeticException class with a specified error message and a reference to the exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
Array class (System)
ToString
Description
Provides methods for creating, manipulating, searching and sorting arrays, thereby serving as the base class for all arrays in the common language runtime.
An element is a value in the System.Array. The length of an System.Array is the total number of elements it can contain. The rank of an System.Array is the number of dimensions in the System.Array. The lower bound or lowbound of a dimension of an System.Array is the starting index of that dimension of the System.Array; a multidimensional System.Array can have different bounds for each dimension.
Array
Example Syntax:
ToString
IsFixedSize
ToString
Gets a value indicating whether the System.Array has a fixed size.
This method implements the System.Collections.IList interface. It can be overridden by a derived class.
IsReadOnly
ToString
Gets a value indicating whether the System.Array is read-only.
This method implements the System.Collections.IList interface. It can be overridden by a derived class.
IsSynchronized
ToString
Gets a value indicating whether access to the System.Array is synchronized (thread-safe).
This property implements the System.Collections.ICollection interface.
Length
ToString
Gets the total number of elements in all the dimensions of the System.Array.
Rank
ToString
Gets the rank (number of dimensions) of the System.Array.
SyncRoot
ToString
Gets an object that can be used to synchronize access to the System.Array
This property implements the System.Collections.ICollection interface.
BinarySearch
Searches a one-dimensional sorted System.Array for a specific element, using the System.IComparable interface implemented by each element of the System.Array and by the specified System.Object.
Return Value: The index of value in the System.Array, if value is found; otherwise, a negative number, which is the bitwise complement of the index of the first element that is larger than value.
The value parameter and each element of array must implement the System.IComparable interface, which is used for comparisons. If array's elements are not already sorted in increasing value according to the System.IComparable implementation, the result might be incorrect. Duplicate elements are allowed. The one-dimensional System.Array to search. The System.Object to search for.
BinarySearch
Searches a one-dimensional sorted System.Array for a value, using the specified System.Collections.IComparer interface.
Return Value: The index of value in the System.Array, if value is found; otherwise, a negative number, which is the bitwise complement of the index of the first element that is larger than value.
The comparer customizes how the elements are compared. For example, you can use a System.Collections.CaseInsensitiveComparer instance as the comparer to perform case-insensitive string searches. The one-dimensional System.Array to search. The System.Object to search for. The System.Collections.IComparer implementation to use when comparing elements.
BinarySearch
Searches a section of a one-dimensional sorted System.Array for a value, using the System.IComparable interface implemented by each element of the System.Array and by the specified value.
Return Value: The index of value in the System.Array, if value is found; otherwise, a negative number, which is the bitwise complement of the index of the first element that is larger than value.
The value parameter and each element of array must implement the System.IComparable interface, which is used for comparisons. If array's elements are not already sorted in increasing value according to the System.IComparable implementation, the result might be incorrect. Duplicate elements are allowed. The one-dimensional System.Array to search. The starting index of the range to search. The length of the range to search. The System.Object to search for.
BinarySearch
Searches a section of a one-dimensional sorted System.Array for a value, using the specified System.Collections.IComparer interface.
Return Value: The index of value in the System.Array, if value is found; otherwise, a negative number, which is the bitwise complement of the index of the first element that is larger than value.
The comparer customizes how the elements are compared. For example, you can use a System.Collections.CaseInsensitiveComparer instance as the comparer to perform case-insensitive string searches. The one-dimensional System.Array to search. The starting index of the range to search. The length of the range to search. The System.Object to search for. The System.Collections.IComparer implementation to use when comparing elements.
Clear
Sets a range of elements in the System.Array to zero or to null.
Reference-type elements are set to null. Value-type elements are set to zero. The System.Array whose elements need to be cleared. The starting index of the range of elements to clear. The number of elements to clear.
Clone
Creates a shallow copy of the System.Array
Return Value: A shallow copy of the System.Array.
This method can be overridden by a derived class.
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.
sourceArray and destinationArray must have the same number of dimensions. The System.Array that contains the data to copy. The System.Array that receives the data. The number of elements to copy.
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.
sourceArray and destinationArray must have the same number of dimensions. The System.Array that contains the data to copy. The index in the sourceArray at which copying begins. The System.Array that receives the data. The index in the destinationArray at which storing begins. The number of elements to copy.
CopyTo
Copies all the elements of the current one-dimensional System.Array to the specified one-dimensional System.Array starting at the specified destination System.Array index.
This method can be overridden by a derived class. The one-dimensional System.Array that is the destination of the elements copied from the current System.Array. The zero-based relative index in array at which copying begins.
CreateInstance
Creates a one-dimensional System.Array of the specified System.Type and length, with zero-based indexing.
Return Value: A new one-dimensional System.Array of the specified System.Type with the specified length, using zero-based indexing.
Unlike most classes, System.Array provides the System.Array.CreateInstance(System.Type,System.Int32) method, instead of public constructors, to allow for late bound access. The System.Type of System.Array to create. The size of the System.Array to create.
CreateInstance
Creates a multidimensional System.Array of the specified System.Type and dimension lengths, with zero-based indexing.
Return Value: A new multidimensional System.Array of the specified System.Type with the specified length for each dimension, using zero-based indexing.
Unlike most classes, System.Array provides the System.Array.CreateInstance(System.Type,System.Int32) method, instead of public constructors, to allow for late bound access. The System.Type of System.Array to create. An array that contains the size of each dimension of the System.Array to create.
CreateInstance
Creates a two-dimensional System.Array of the specified System.Type and dimension lengths, with zero-based indexing.
Return Value: A new two-dimensional System.Array of the specified System.Type with the specified length for each dimension, using zero-based indexing.
Unlike most classes, System.Array provides the System.Array.CreateInstance(System.Type,System.Int32) method, instead of public constructors, to allow for late bound access. The System.Type of System.Array to create. The size of the first dimension of the System.Array to create. The size of the second dimension of the System.Array to create.
CreateInstance
Creates a multidimensional System.Array of the specified System.Type and dimension lengths, with the specified lower bounds.
Return Value: A new multidimensional System.Array of the specified System.Type with the specified length and lower bound for each dimension.
Unlike most classes, System.Array provides the System.Array.CreateInstance(System.Type,System.Int32) method, instead of public constructors, to allow for late bound access. The System.Type of System.Array to create. A one-dimensional array that contains the size of each dimension of the System.Array to create. A one-dimensional array that contains the lower bound (starting index) of each dimension of the System.Array to create.
CreateInstance
Creates a three-dimensional System.Array of the specified System.Type and dimension lengths, with zero-based indexing.
Return Value: A new three-dimensional System.Array of the specified System.Type with the specified length for each dimension, using zero-based indexing.
Unlike most classes, System.Array provides the System.Array.CreateInstance(System.Type,System.Int32) method, instead of public constructors, to allow for late bound access. The System.Type of System.Array to create. The size of the first dimension of the System.Array to create. The size of the second dimension of the System.Array to create. The size of the third dimension of the System.Array to create.
GetEnumerator
Returns an System.Collections.IEnumerator for the System.Array.
Return Value: An System.Collections.IEnumerator for the System.Array.
This method can be overridden by a derived class.
GetLength
Gets the number of elements in the specified dimension of the System.Array.
Return Value: The number of elements in the specified dimension.
For example, GetLength(0) returns the number of elements in the first dimension of the System.Array. A zero-based dimension of the System.Array whose length needs to be determined.
GetLowerBound
Gets the lower bound of the specified dimension in the System.Array
Return Value: The lower bound of the specified dimension in the System.Array. For example, GetLowerBound(0) returns the lower bound for the indexes of the first dimension of the System.Array, and GetLowerBound(Rank−1) returns the lower bound of the last dimension of the System.Array. A zero-based dimension of the System.Array whose lower bound needs to be determined.
GetUpperBound
Gets the upper bound of the specified dimension in the System.Array.
Return Value: The upper bound of the specified dimension in the System.Array.
For example, GetUpperBound(0) returns the upper bound for the indexes of the first dimension of the System.Array and GetUpperBound(Rank−1) returns the upper bound of the last dimension of the System.Array. A zero-based dimension of the System.Array whose upper bound needs to be determined.
GetValue
Gets the value at the specified position in a one-dimensional System.Array
Return Value: The value at the specified position in the one-dimensional System.Array.
The System.Array.GetLowerBound(System.Int32) and ISystem.Array.GetUpperBound(System.Int32) methods can determine whether the value of index is out of bounds. The position of the value to get from the System.Array.
GetValue
Gets the value at the specified position in a multidimensional System.Array.
Return Value: The value at the specified position in the System.Array.
The number of elements in indices must equal the number of dimensions in the System.Array. All elements in the indices array must collectively specify the position of the desired element in the multidimensional System.Array. A one-dimensional array of indexes that specifies the position of the element to get from the System.Array.
GetValue
Gets the value at the specified position in a two-dimensional System.Array
Return Value: The value at the specified position in the System.Array.
The System.Array.GetLowerBound(System.Int32) and System.Array.GetUpperBound(System.Int32) methods can determine whether any of the indexes is out of bounds. The first-dimension index of the System.Array element to get. The second-dimension index of the System.Array element to get.
GetValue
Gets the value at the specified position in a three-dimensional System.Array.
Return Value: The value at the specified position in the System.Array.
The System.Array.GetLowerBound(System.Int32) and System.Array.GetUpperBound(System.Int32) methods can determine whether any of the indexes is out of bounds. The first-dimension index of the System.Array element to get. The second-dimension index of the System.Array element to get. The third-dimension index of the System.Array element to get.
IndexOf
Searches for the specified System.Object and returns the index of the first occurrence within the entire one-dimensional System.Array.
Return Value: The index of the first occurrence of value within the entire array, if found; otherwise, the lower bound of the array−1.
The one-dimensional System.Array is searched forward starting at the first element and ending at the last element. The elements are compared to the specified value using the System.Object.Equals(System.Object) method. The one-dimensional System.Array to search. The System.Object to locate in array.
IndexOf
Searches for the specified System.Object and returns the index of the first occurrence within the section of the one-dimensional System.Array that extends from the specified index to the last element.
Return Value: The index of the first occurrence of value within the section of array that extends from startIndex to the last element, if found; otherwise, the lower bound of the array−1.
The one-dimensional System.Array is searched forward starting at startIndex and ending at the last element. The elements are compared to the specified value using the System.Object.Equals(System.Object) method. The one-dimensional System.Array to search. The System.Object to locate in array. The starting index of the search.
IndexOf
Searches for the specified System.Object and returns the index of the first occurrence within the section of the one-dimensional System.Array that starts at g the specified index and contains the specified number of elements.
Return Value: The index of the first occurrence of value within the section of array that starts at startIndex and contains count number of elements, if found; otherwise, the lower bound of the array−1.
The one-dimensional System.Array is searched forward starting at startIndex and ending at startIndex+count−1. The elements are compared to the specified value using the System.Object.Equals(System.Object) method. The one-dimensional System.Array to search. The System.Object to locate in array. The starting index of the search. The number of elements in the section to search.
Initialize
Initializes every element of the value-type System.Array by calling the default constructor of the value type.
This method must not be used on reference-type arrays.
LastIndexOf
Searches for the specified System.Object and returns the index of the last occurrence within the entire one-dimensional System.Array.
Return Value: The index of the last occurrence of value within the entire array, if found; otherwise, the lower bound of the array−1.
The one-dimensional System.Array is searched backward starting at the last element and ending at the first element. The elements are compared to the specified value using the System.Object.Equals(System.Object) method. The one-dimensional System.Array to search. The System.Object to locate in array.
LastIndexOf
Searches for the specified System.Object and returns the index of the last occurrence within the section of the one-dimensional System.Array that extends from the first element to the specified index.
Return Value: The index of the last occurrence of value within the section of array that extends from the first element to startIndex, if found; otherwise, the lower bound of the array−1.
The one-dimensional System.Array is searched backward starting at startIndex and ending at the first element. The elements are compared to the specified value using the System.Object.Equals(System.Object) method. The one-dimensional System.Array to search. The System.Object to locate in array. The starting index of the backward search.
LastIndexOf
Searches for the specified System.Object and returns the index of the last occurrence within the section of the one-dimensional System.Array that contains the specified number of elements and ends at the specified index.
Return Value: The index of the last occurrence of value within the section of array that contains count number of elements and ends at startIndex, if found; otherwise, the lower bound of the array−1.
The one-dimensional System.Array is searched backward starting at startIndex and ending at startIndex−count+1. The elements are compared to the specified value using the System.Object.Equals(System.Object) method. The one-dimensional System.Array to search. The System.Object to locate in array. The starting index of the backward search. The number of elements in the section to search.
Reverse
Reverses the sequence of the elements in the entire one-dimensional System.Array.
After a call to this method, the element at myArray[i], where i is any index in the array, moves to myArray[j], where j equals (myArray.Length+myArray.GetLowerBound(0))−(i−myArray.GetLowerBound(0))−1. The one-dimensional System.Array to reverse.
Reverse
Reverses the sequence of the elements in a section of the one-dimensional System.Array.
After a call to this method, the element at myArray[i], where i is any index in the array, moves to myArray[j], where j equals (myArray.Length+myArray.GetLowerBound(0))−(i−myArray.GetLowerBound(0))−1. The one-dimensional System.Array to reverse. The starting index of the section to reverse. The number of elements in the section to reverse.
SetValue
Sets a value to the element at the specified position in a one-dimensional System.Array.
The System.Array.GetLowerBound(System.Int32) and System.Array.GetUpperBound(System.Int32) methods can determine whether the value of index is out of bounds. The new value for the specified element. The position of the System.Array element to set.
SetValue
Sets a value to the element at the specified position in a multidimensional System.Array.
The number of elements in indices must equal the number of dimensions in the System.Array. All elements in the indices array must collectively specify the Is position of the desired element in the multidimensional System.Array. The new value for the specified element. A one-dimensional array of indexes that specifies the position of the element to set.
SetValue
Sets a value to the element at the specified position in a two-dimensional System.Array.
The System.Array.GetLowerBound(System.Int32) and System.Array.GetUpperBound(System.Int32) methods can determine whether any of the indexes is out of bounds. The new value for the specified element. The first-dimension index of the System.Array element to set. The second-dimension index of the System.Array element to set.
SetValue
Sets a value to the element at the specified position in a three-dimensional System.Array.
The System.Array.GetLowerBound(System.Int32) and System.Array.GetUpperBound(System.Int32) methods can determine whether any of the indexes is out of bounds. The new value for the specified element. The first-dimension index of the System.Array element to set. The second-dimension index of the System.Array element to set. The third-dimension index of the System.Array element to set.
Sort
Sorts the elements in an entire one-dimensional System.Array using the System.IComparable interface implemented by each element of the System.Array.
Each element of array must implement the System.IComparable interface to be capable of comparisons with every other element in array. The one-dimensional System.Array to sort.
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 interface implemented by each key.
Each key in the keysSystem.Array has a corresponding item in the itemsSystem.Array. When a key is repositioned during the sorting, the corresponding item in the itemsSystem.Array is similarly repositioned. Therefore, the itemsSystem.Array is sorted according to the arrangement of the corresponding keys in the keysSystem.Array. The one-dimensional System.Array that contains the keys to sort. The one-dimensional System.Array that contains the items that correspond to each of the keys in the keysSystem.Array.
Sort
Sorts the elements in a one-dimensional System.Array using the specified System.Collections.IComparer interface.
If comparer is null, each element of array must implement the System.IComparable interface to be capable of comparisons with every other element in array. The one-dimensional System.Array to sort. The System.Collections.IComparer implementation to use when comparing elements.
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 interface.
Each key in the keysSystem.Array has a corresponding item in the itemsSystem.Array. When a key is repositioned during the sorting, the corresponding item in the itemsSystem.Array is similarly repositioned. Therefore, the itemsSystem.Array is sorted according to the arrangement of the corresponding keys in the keysSystem.Array. The one-dimensional System.Array that contains the keys to sort. The one-dimensional System.Array that contains the items that correspond to each of the keys in the keysSystem.Array. The System.Collections.IComparer implementation to use when comparing elements.
Sort
Sorts the elements in a section of a one-dimensional System.Array using the System.IComparable interface implemented by each element of the System.Array.
Each element within the specified section of array must implement the System.IComparable interface to be capable of comparisons with every other element in array. The one-dimensional System.Array to sort. The starting index of the range to sort. The number of elements in the range to sort.
Sort
Sorts a section of 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 interface implemented by each key.
Each key in the keysSystem.Array has a corresponding item in the itemsSystem.Array. When a key is repositioned during the sorting, the corresponding item in the itemsSystem.Array is similarly repositioned. Therefore, the itemsSystem.Array is sorted according to the arrangement of the corresponding keys in the keysSystem.Array. The one-dimensional System.Array that contains the keys to sort. The one-dimensional System.Array that contains the items that correspond to each of the keys in the keysSystem.Array. The starting index of the range to sort. The number of elements in the range to sort.
Sort
Sorts the elements in a section of a one-dimensional System.Array using the specified System.Collections.IComparer interface.
If comparer is null, each element within the specified section of array must implement the System.IComparable interface to be capable of comparisons with every other element in array. The one-dimensional System.Array to sort. The starting index of the range to sort. The number of elements in the range to sort. The System.Collections.IComparer implementation to use when comparing elements.
Sort
Sorts a section of 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 interface.
Each key in the keysSystem.Array has a corresponding item in the itemsSystem.Array. When a key is repositioned during the sorting, the corresponding item in the itemsSystem.Array is similarly repositioned. Therefore, the itemsSystem.Array is sorted according to the arrangement of the corresponding keys in the keysSystem.Array. The one-dimensional System.Array that contains the keys to sort. The one-dimensional System.Array that contains the items that correspond to each of the keys in the keysSystem.Array. The starting index of the range to sort. The number of elements in the range to sort. The System.Collections.IComparer implementation to use when comparing elements.
IList.Add
IList.Clear
IList.Contains
IList.IndexOf
IList.Insert
IList.Remove
IList.RemoveAt
ArrayTypeMismatchException class (System)
ToString
Description
The exception that is thrown when an attempt is made to store an element of the wrong type within an array.
System.ArrayTypeMismatchException uses the HRESULT COR_E_ARRAYTYPEMISMATCH, which has the value 0x80131503.
ArrayTypeMismatchException
Example Syntax:
ToString
Initializes a new instance of the System.ArrayTypeMismatchException class with default properties.
The following table shows the initial property values for an instance of System.ArrayTypeMismatchException.
ArrayTypeMismatchException
Example Syntax:
ToString
Initializes a new instance of the System.ArrayTypeMismatchException class with a specified error message.
The following table shows the initial property values for an instance of System.ArrayTypeMismatchException. The error message that explains the reason for the exception.
ArrayTypeMismatchException
Example Syntax:
ToString
Initializes a new instance of the System.ArrayTypeMismatchException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
ArrayTypeMismatchException
Example Syntax:
ToString
Initializes a new instance of the System.ArrayTypeMismatchException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
AssemblyLoadEventArgs class (System)
ToString
Description
Provides data for the System.AppDomain.AssemblyLoad event.
AssemblyLoadEventArgs
Example Syntax:
ToString
Initializes a new instance of the System.AssemblyLoadEventArgs.AssemblyLoadEventArgs class, using the specified System.Reflection.Assembly object. An instance that represents the currently loaded assembly.
LoadedAssembly
ToString
Gets an System.Reflection.Assembly object that represents the currently loaded assembly.
AssemblyLoadEventHandler delegate (System)
ToString
Description
Represents the method that will handle the System.AppDomain.AssemblyLoad event of an System.AppDomain. The source of the event. An System.AssemblyLoadEventArgs that contains the event data.
AsyncCallback delegate (System)
ToString
Description
References the callback method to be called when the asynchronous operation is completed. The result of the asynchronous operation.
System.AsyncCallback provides a way for client applications to complete an asynchronous operation. This callback delegate is supplied to the client when the asynchronous operation is initiated. The event handler referenced by System.AsyncCallback contains program logic to finish processing the asynchronous task for the client.
Attribute class (System)
ToString
Description
Base class for custom attributes.
The Attribute class contains convenience methods to access and test custom attributes. While any user-defined type can be used as an attribute, it is expected that most attributes will be instances of types derived from Attribute.
Attribute
Example Syntax:
ToString
Initializes a new instance of the Attribute class.
TypeId
ToString
When implemented in a derived class, gets a unique identifier for this Attribute.
As implemented, this identifier is merely the System.Type of the attribute. However, it is intended that the unique identifier be used to identify two attributes of the same type.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if obj equals the type and value of this instance; otherwise, false. An System.Object to compare with this instance or null.
GetCustomAttribute
Retrieves a custom attribute of a specified type applied to a specified assembly and its ancestors.
Return Value: null, if no custom attribute of type attributeType is applied to element. An object derived from class System.Reflection.Assembly that describes a reusable, versionable, collection of modules. The System.Type object to which the custom attributes are applied. GetCustomAttribute
Retrieves a custom attribute of a specified type applied to a specified member of a class and its ancestors.
Return Value: null, if no custom attribute of type attributeType is applied to element. An object derived from class System.Reflection.MemberInfo that describes a constructor, event, field, method, or property member of a class. The System.Type object to which the custom attributes are applied.
It GetCustomAttribute
Retrieves a custom attribute of a specified type applied to a specified module and its ancestors.
Return Value: null, if no custom attribute of type attributeType is applied to element. An object derived from class System.Reflection.Module that describes a portable executable file. The System.Type object to which the custom attributes are applied.
GetCustomAttribute
Retrieves a custom attribute of a specified type applied to a specified parameter of a member of a class and its ancestors.
Return Value: null, if no custom attribute of type attributeType is applied to element. An object derived from class System.Reflection.ParameterInfo that describes a parameter of a member of a class. The System.Type object to which the custom attributes are applied.
GetCustomAttribute
Retrieves a custom attribute of a specified type applied to a specified assembly and optionally its ancestors.
Return Value: null, if no custom attribute of type attributeType is applied to element. An object derived from class System.Reflection.Assembly that describes a reusable, versionable, collection of modules. The System.Type object to which the custom attributes are applied. If true, specifies to also search the ancestors of element for custom attributes.
GetCustomAttribute
Retrieves a custom attribute of a specified type applied to a specified member of a class and optionally its ancestors.
Return Value: null, if no custom attribute of type attributeType is applied to element. An object derived from class System.Reflection.MemberInfo that describes a constructor, event, field, method, or property member of a class. The System.Type object to which the custom attributes are applied. If true, specifies to also search the ancestors of element for custom attributes.
GetCustomAttribute
Retrieves a custom attribute of a specified type applied to a specified module and optionally its ancestors.
Return Value: null, if no custom attribute of type attributeType is applied to element. An object derived from class System.Reflection.Module that describes a portable executable file. The System.Type object to which the custom attributes are applied. If true, specifies to also search the ancestors of element for custom attributes.
GetCustomAttribute
Retrieves a custom attribute of a specified type applied to a specified parameter of a member of a class and optionally its ancestors.
Return Value: null, if no custom attribute of type attributeType is applied to element. An object derived from class System.Reflection.ParameterInfo that describes a parameter of a member of a class. The System.Type object to which the custom attributes are applied. If true, specifies to also search the ancestors of element for custom attributes.
GetCustomAttributes
Retrieves an array of the custom attributes of a specified type applied to a specified assembly and its ancestors.
Return Value: An System.Attribute array containing the custom attributes applied to element.—or—An empty array if no such custom attributes exist.
Return value contains the custom attributes for ancestors of element. An object derived from class System.Reflection.Assembly that describes a reusable, versionable, collection of modules.
GetCustomAttributes
Retrieves an array of the custom attributes applied to a specified member of a class and its ancestors.
Return Value: An System.Attribute array containing the custom attributes applied to element.—or—An empty array if no such custom attributes exist.
Return value contains the custom attributes for ancestors of element. An object derived from class System.Reflection.MemberInfo that describes a constructor, event, field, method, or property member of a class.
GetCustomAttributes
Retrieves an array of the custom attributes of a specified type applied to a specified module and its ancestors.
Return Value: An System.Attribute array containing the custom attributes applied to element.—or—An empty array if no such custom attributes exist.
Return value contains the custom attributes for ancestors of element. An object derived from class System.Reflection.Module that describes a portable executable file.
GetCustomAttributes
Retrieves an array of the custom attributes of a specified type applied to a specified parameter of a member of a class and its ancestors.
Return Value: An System.Attribute array containing the custom attributes applied to element.—or—An empty array if no such custom attributes exist.
Return value contains the custom attributes for ancestors of element. An object derived from class System.Reflection.ParameterInfo that describes a parameter of a member of a class.
GetCustomAttributes
Retrieves an array of the custom attributes of a specified type applied to a specified assembly and optionally its ancestors.
Return Value: An System.Attribute array containing the custom attributes applied to element.—or—An empty array if no such custom attributes exist.
Return value contains the custom attributes for ancestors of element if inherit is true. An object derived from class System.Reflection.Assembly that describes a reusable, versionable, collection of modules. If true, specifies to also search the ancestors of element for custom attributes.
GetCustomAttributes
Retrieves an array of the custom attributes of a specified type applied to a specified assembly and its ancestors.
Return Value: An System.Attribute array containing the custom attributes of type attributeType applied to element.—or—An empty array if no such custom attributes exist.
Return value contains the custom attributes for ancestors of element. An object derived from class System.Reflection.Assembly that describes a reusable, versionable, collection of modules. The System.Type object to which the custom attributes are applied.
GetCustomAttributes
Retrieves an array of the custom attributes of a specified member of a class and its ancestors.
Return Value: An System.Attribute array containing the custom attributes applied to element.—or—An empty array if no such custom attributes exist.
Return value contains the custom attributes for ancestors of element if inherit is true. An object derived from class System.Reflection.MemberInfo that describes a constructor, event, field, method, or property member of a class. If true, specifies to also search the ancestors of element for custom attributes.
GetCustomAttributes
Retrieves an array of the custom attributes of a specified type applied to a specified member of a class and its ancestors.
Return Value: An System.Attribute array containing the custom attributes of type type applied to element.—or—An empty array if no such custom attributes exist.
Return value contains the custom attributes for ancestors of element. An object derived from class System.Reflection.MemberInfo that describes a constructor, event, field, method, or property member of a class. The System.Type object to which the custom attributes are applied.
GetCustomAttributes
Retrieves an array of the custom attributes of a specified type applied to a specified module and optionally its ancestors.
Return Value: An System.Attribute array containing the custom attributes applied to element.—or—An empty array if no such custom attributes exist.
Return value contains the custom attributes for ancestors of element if inherit is true. An object derived from class System.Reflection.Module that describes a portable executable file. If true, specifies to also search the ancestors of element for custom attributes.
GetCustomAttributes
Retrieves an array of the custom attributes of a specified type applied to a specified module and its ancestors.
Return Value: An System.Attribute array containing the custom attributes of type attributeType applied to element.—or—An empty array if no such custom attributes exist.
Return value contains the custom attributes for ancestors of element. An is object derived from class System.Reflection.Module that describes a portable executable file. The System.Type object to which the custom attributes are applied.
GetCustomAttributes
Retrieves an array of the custom attributes of a specified type applied to a specified parameter of a member of a class and optionally its ancestors.
Return Value: An System.Attribute array containing the custom attributes applied to element.—or—An empty array if no such custom attributes exist.
Return value contains the custom attributes for ancestors of element if inherit is true. An object derived from class System.Reflection.ParameterInfo that describes a parameter of a member of a class. If true, specifies to also search the ancestors of element for custom attributes.
GetCustomAttributes
Retrieves an array of the custom attributes of a specified type applied to a specified parameter of a member of a class and its ancestors.
Return Value: An System.Attribute array containing the custom attributes of type attributeType applied to element.—or—An empty array if no such custom attributes exist.
Return value contains the custom attributes for ancestors of element. An object derived from class System.Reflection.ParameterInfo that describes a parameter of a member of a class. The System.Type object to which the custom attributes are applied.
GetCustomAttributes
Retrieves an array of the custom attributes of a specified type applied to a specified assembly and optionally its ancestors.
Return Value: An System.Attribute array containing the custom attributes of type attributeType applied to element.—or—An empty array if no such custom attributes exist.
Return value contains the custom attributes for ancestors of element if inherit is true. An object derived from class System.Reflection.Assembly that describes a reusable, versionable, collection of modules. The System.Type object to which the custom attributes are applied. If true, specifies to also search the ancestors of element for custom attributes.
GetCustomAttributes
Retrieves an array of the custom attributes of a specified type applied to a specified member of a class and optionally its ancestors.
Return Value: An System.Attribute array containing the custom attributes of type type applied to element.—or—An empty array if no such custom attributes exist.
Return value contains the custom attributes for ancestors of element if inherit is true. An object derived from class System.Reflection.MemberInfo that describes a constructor, event, field, method, or property member of a class. The System.Type object to which the custom attributes are applied. If true, specifies to also search the ancestors of element for custom attributes.
GetCustomAttributes
Retrieves an array of the custom attributes of a specified type applied to a specified module and optionally its ancestors.
Return Value: An System.Attribute array containing the custom attributes of type attributeType applied to element.—or—An empty array if no such custom attributes exist.
Return value contains the custom attributes for ancestors of element if inherit is true. An object derived from class System.Reflection.Module that describes a portable executable file. The System.Type object to which the custom attributes are applied. If true, specifies to also search the ancestors of element for custom attributes.
GetCustomAttributes
Retrieves an array of the custom attributes of a specified type applied to a specified parameter of a member of a class and optionally its ancestors.
Return Value: An System.Attribute array containing the custom attributes of type attributeType applied to element.—or—An empty array if no such custom attributes exist.
Return value contains the custom attributes for ancestors of element if inherit is true. An object derived from class System.Reflection.ParameterInfo that describes a parameter of a member of a class. The System.Type object to which the custom attributes are applied. If true, specifies to also search the ancestors of element for custom attributes.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
IsDefaultAttribute
When overridden in a derived class, returns an indication whether the value of this instance is the default value for the derived class.
Return Value: true if this instance is the default attribute for the class; otherwise, false.
The default implementation of this class returns false, and must be implemented in the derived class to be useful to that class.
IsDefined
Determines whether any custom attributes of a specified type are applied to a specified assembly.
Return Value: true if a custom attribute of type attributeType is applied to element; otherwise, false.
The ancestors of element are not searched for custom attributes. An object derived from class System.Reflection.Assembly that describes a reusable, versionable, collection of modules. The System.Type object to which the custom attributes are applied.
IsDefined
Determines whether any custom attributes of a specified type are applied to a specified member of a class and its ancestors.
Return Value: true if a custom attribute of type attributeType is applied to element; otherwise, false.
The ancestors of element are searched for custom attributes if element is a method or a type. An object derived from class System.Reflection.MemberInfo that describes a constructor, event, field, method, type, or property member of a class. The System.Type object to which the custom attributes are applied.
IsDefined
Determines whether any custom attributes of a specified type are applied to a specified module.
Return Value: true if a custom attribute of type attributeType is applied to element; otherwise, false.
The ancestors of element are not searched for custom attributes. An object derived from class System.Reflection.Module that describes a portable executable file. The System.Type object to which the custom attributes are applied.
IsDefined
Determines whether any custom attributes of a specified type are applied to a specified parameter of a member of a class and its ancestors.
Return Value: true if a custom attribute of type attributeType is applied to element; otherwise, false.
The ancestors of element are searched for custom attributes. An object derived from class System.Reflection.ParameterInfo that describes a parameter of a member of a class. The System.Type object to which the custom attributes are applied.
IsDefined
Determines whether any custom attributes of a specified type are applied to a specified assembly.
Return Value: true if a custom attribute of type attributeType is applied to element; otherwise, false.
This method ignores the value of parameter inherit. The ancestors of element are not searched for custom attributes. An object derived from class System.Reflection.Assembly that describes a reusable, versionable, collection of modules. The System.Type object to which the custom attributes are applied. If true, specifies to also search the ancestors of element for custom attributes.
IsDefined
Determines whether any custom attributes of a specified type are applied to a specified member of a class and optionally its ancestors.
Return Value: true if a custom attribute of type attributeType is applied to element otherwise, false.
The ancestors of element are searched for custom attributes if inherit is true and element is a method or a type. An object derived from class System.Reflection.MemberInfo that describes a constructor, event, field, method, type, or property member of a class. The System.Type object to which the custom attributes are applied. If true, specifies to also search the ancestors of element for custom attributes.
IsDefined
Determines whether any custom attributes of a specified type are applied to a specified module.
Return Value: true if a custom attribute of type attributeType is applied to element; otherwise, false.
This method ignores the value of parameter inherit. The ancestors of element are not searched for custom attributes. An object derived from class System.Reflection.Module that describes a portable executable file. The System.Type object to which the custom attributes are applied. If true, specifies to also search the ancestors of element for custom attributes.
IsDefined
Determines whether any custom attributes of a specified type are applied to a specified parameter of a member of a class and optionally its ancestors.
Return Value: true if a custom attribute of type attributeType is applied to element; otherwise, false.
The ancestors of element are searched for custom attributes if inherit is true and element is a method. An object derived from class System.Reflection.ParameterInfo that describes a parameter of a member of a class. The System.Type object to which the custom attributes are applied. If true, specifies to also search the ancestors of element for custom attributes.
Match
When overridden in a derived class, returns a value indicating whether this instance equals a specified object.
Return Value: true if this instance equals obj; otherwise, false.
This method determines if one Attribute equals another. Its default implementation is the same as System.Attribute.Equals(System.Object), which performs a value and reference comparison. Override this method to implement support for attribute values, such as flags or bitfields, that consist of components that are meaningful in themselves. An System.Object to compare with this instance of Attribute.
AttributeTargets enumeration (System)
ToString
Description
Specifies the elements to which it is valid to apply an attribute.
AttributeTargets enumeration values can be combined with a bitwise OR operation to get the desired combination.
ToString
Attribute can be applied to any element.
ToString
Attribute can be applied to an assembly.
ToString
Attribute can be applied to a class.
ToString
Attribute can be applied to a constructor.
ToString
Attribute can be applied to a delegate.
ToString
Attribute can be applied to an enumeration.
ToString
Attribute can be applied to an event.
ToString
Attribute can be applied to a field.
ToString
Attribute can be applied to an interface.
ToString
Attribute can be applied to a method.
ToString
Attribute can be applied to a module.
ToString
Attribute can be applied to a parameter.
ToString
Attribute can be applied to a property.
ToString
Attribute can be applied to a Return value.
ToString
Attribute can be applied to a value type.
AttributeUsageAttribute class (System)
ToString
Description
Specifies the usage of another attribute class. This class cannot be inherited.
When you are defining your own attribute class, you can control the manner in which it is used by placing an System.AttributeUsageAttribute on your attribute class. The indicated attribute class must derive from System.Attribute, either directly or indirectly.
AttributeUsageAttribute
Example Syntax:
ToString
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.
You can combine several System.AttributeTargets values using a bitwise OR operation to get the desired combination of valid program elements. The set of values combined using a bitwise OR operation to indicate which program elements are valid.
AllowMultiple
ToString
Gets or sets a Boolean value indicating whether more than one instances of the indicated attribute can be specified for a single program element.
An attribute that can be specified more than once for a program element is called a multi-use attribute. An attribute that can be specified only once is called a single-use attribute.
Inherited
ToString
Gets or sets a Boolean value indicating whether the indicated attribute is inherited by derived classes or overridden members.
TypeId
ValidOn
ToString
Description
Gets a set of values identifying which program elements that the indicated attribute can be applied to.
BadImageFormatException class (System)
ToString
Description
The exception that is thrown when the file image of a DLL or an executable program is invalid.
System.BadImageFormatException uses the HRESULT COR_E_BADIMAGEFORMAT, which has the value 0x8007000B.
BadImageFormatException
Example Syntax:
ToString
Initializes a new instance of the System.BadImageFormatException class with default properties.
The following table shows the initial property values for an instance of System.BadImageFormatException.
BadImageFormatException
Example Syntax:
ToString
Initializes a new instance of the System.BadImageFormatException class with a specified error message.
The following table shows the initial property values for an instance of System.BadImageFormatException. The error message that explains the reason for the exception.
BadImageFormatException
Example Syntax:
ToString
Initializes a new instance of the System.BadImageFormatException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
BadImageFormatException
Example Syntax:
ToString
Initializes a new instance of the System.BadImageFormatException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If inner is non-null, then the current Exception is raised in a catch block handling inner.
BadImageFormatException
Example Syntax:
ToString
Initializes a new instance of the System.BadImageFormatException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. A reference to the inner exception.
BadImageFormatException
Example Syntax:
ToString
Initializes a new instance of the System.BadImageFormatException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If inner is non-null, then the current Exception is raised in a catch block handling inner.
FileName
ToString
Gets the name of the file that causes this exception.
FusionLog
ToString
Gets the log file that describes why loading of an assembly failed.
HelpLink
HResult
InnerException
Message
ToString
Description
Gets the error message and the name of the file that caused this exception.
Source
StackTrace
TargetSite
GetObjectData
Sets the System.Runtime.Serialization.SerializationInfo object with the file name, fusion log, and additional exception information.
ToString
Returns the fully qualified name of this exception and possibly the error message, the name of the inner exception, and the stack trace.
Return Value: 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.
BitConverter class (System)
ToString
Description
Converts base data types to an array of bytes, and an array of bytes to base data types.
This class facilitates manipulating value types in their fundamental form. A byte is defined as an 8-bit unsigned integer.
ToString
Indicates the byte order (“endianess”) in which data is stored in this computer architecture.
This value is true if the architecture is little-endian; false if it is big-endian.
DoubleToInt64 Bits
Converts the specified double-precision floating point number to a 64-bit signed integer.
Return Value: A 64-bit signed integer whose value is equivalent to value. The number to convert.
GetBytes
Returns the specified Boolean value as an array of bytes.
Return Value: An array of bytes with length 1. A Boolean value.
GetBytes
Returns the specified Unicode character value as an array of bytes.
Return Value: An array of bytes with length 2. A character to convert.
GetBytes
Returns the specified double-precision floating point value as an array of bytes.
Return Value: An array of bytes with length 8. The number to convert.
GetBytes
Returns the specified 16-bit signed integer value as an array of bytes.
Return Value: An array of bytes with length 2. The number to convert.
GetBytes
Returns the specified 32-bit signed integer value as an array of bytes.
Return Value: An array of bytes with length 4. The number to convert.
GetBytes
Returns the specified 64-bit signed integer value as an array of bytes.
Return Value: An array of bytes with length 8. The number to convert.
GetBytes
Returns the specified single-precision floating point value as an array of bytes.
Return Value: An array of bytes with length 4. The number to convert.
GetBytes
Returns the specified 16-bit unsigned integer value as an array of bytes.
Return Value: An array of bytes with length 2. The number to convert.
GetBytes
Returns the specified 32-bit unsigned integer value as an array of bytes.
Return Value: An array of bytes with length 4. The number to convert.
GetBytes
Returns the specified 64-bit unsigned integer value as an array of bytes.
Return Value: An array of bytes with length 8. The number to convert.
Int64 BitsToDouble
Converts the specified 64-bit signed integer to a double-precision floating point number.
Return Value: A double-precision floating point number whose value is equivalent to value. The number to convert.
ToBoolean
Returns a Boolean value converted from one byte at a specified position in a byte array.
Return Value: true if the byte at startIndex in value is nonzero; otherwise, false. An array of bytes. The starting position within value.
ToChar
Returns a Unicode character converted from two bytes at a specified position in a byte array.
Return Value: A character formed by two bytes beginning at startIndex. An array. The starting position within value.
ToDouble
Returns a double-precision floating point number converted from eight bytes at a specified position in a byte array.
Return Value: A double precision floating point number formed by eight bytes beginning at startIndex. An array of bytes. The starting position within value.
ToInt16
Returns a 16-bit signed integer converted from two bytes at a specified position in a byte array.
Return Value: A 16-bit signed integer formed by two bytes beginning at startIndex. An array of bytes. The starting position within value.
ToInt32
Returns a 32-bit signed integer converted from four bytes at a specified position in a byte array.
Return Value: A 32-bit signed integer formed by four bytes beginning at startIndex.value is null. An array of bytes. The starting position within value.
ToInt64
Returns a 64-bit signed integer converted from eight bytes at a specified position in a byte array.,
Return Value: A 64-bit signed integer formed by eight bytes beginning at startIndex. An array of bytes. The starting position within value.
ToSingle
Returns a single-precision floating point number converted from four bytes at a specified position in a byte array.
Return Value: A single-precision floating point number formed by four bytes beginning at startIndex. An array of bytes. The starting position within value.
ToString
Returns a String converted from the elements of a byte array.
Return Value: A System.String of hexadecimal pairs separated by hyphens, where each pair represents the corresponding element in value; for example, “7F-2C-4A”.
All the elements of value are converted. An array of bytes.
ToString
Returns a String converted from the elements of a byte array starting at a specified array position.
Return Value: A System.String of hexadecimal pairs separated by hyphens, where each pair represents the corresponding element in value; for example, “7F-2C-4A”.
The elements from array position startIndex to the end of the array are converted. An array of bytes. The starting position within value.
ToString
Returns a String converted from a specified number of bytes at a specified position in a byte array.
Return Value: A System.String of hexadecimal pairs separated by hyphens, where each pair represents the corresponding element in value; for example, “7F-2C-4A”.
The length elements from array position startIndex are converted. An array of bytes. The starting position within value. The number of bytes to convert.
ToUInt16
Returns a 16-bit unsigned integer converted from two bytes at a specified position in a byte array.
Return Value: A 16-bit unsigned integer formed by two bytes beginning at startIndex. The array of bytes. The starting position within value.
ToUInt32
Returns a 32-bit unsigned integer converted from four bytes at a specified position in a byte array.
Return Value: A 32-bit unsigned integer formed by four bytes beginning at startIndex. An array of bytes. The starting position within value.
ToUInt64
Returns a 64-bit unsigned integer converted from eight bytes at a specified position in a byte array.
Return Value: A 64-bit unsigned integer formed by the eight bytes beginning at startIndex. An array of bytes. The starting position within value.
Boolean structure (System)
ToUInt64
Description
Represents a boolean value.
Instances of this type have values of either true or false.
ToUInt64
Represents the boolean value false as a System.String. This field is read-only.
This field is equal to the System.String “False”.
ToUInt64
Represents the boolean value true as a System.String. This field is read-only.
This field is equal to the System.String “True”.
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: A signed integer that indicates the relative order of this instance and obj.
obj must be null or an instance of Boolean; otherwise, an exception is thrown. An System.Object to compare to this instance. It may be a null reference.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if obj is a Boolean and has the same value as this instance; otherwise, false.
This method overrides System.Object.Equals(System.Object). An System.Object to compare to this instance.
GetHashCode
Returns the hash code for this instance.
Return Value: A hash code for the current System.Boolean.
The System.Boolean class implements true as the integer, one, and false as the integer, zero. However, a particular programming language might represent true and false with other values.
GetTypeCode
Returns the TypeCode for value type Boolean.
Return Value: The enumerated constant, System.TypeCode.Boolean.
Parse
Converts the specified System.String representation of a logical value to its System.Boolean equivalent.
Return Value: true if value is equivalent to System.Boolean.TrueString; otherwise false.value is a null reference.
The value parameter, optionally preceded or trailed by white space, must contain either TrueString or FalseString; otherwise, an exception is thrown. The comparison is case-insensitive. A System.String containing the value to convert.
IConvertible.ToBoolean
IConvertible.ToByte
IConvertible.ToChar
IConvertible.ToDateTime
IConvertible.ToDecimal
IConvertible.ToDouble
IConvertible.ToInt16
IConvertible.ToInt64
IConvertible.ToSByte
IConvertible.ToSingle
IConvertible.ToType
IS IConvertible.ToUInt16
IConvertible.ToUInt32
IConvertible.ToUInt64
Converts the value of this instance to its equivalent System.String representation.
Return Value: System.Boolean.TrueString if the value of this instance is true, or System.Boolean.FalseString if the value of this instance is false.
ToString
Converts the value of this instance to its equivalent String representation.
Return Value: System.Boolean.TrueString if the value of this instance is true, or System.Boolean.FalseString if the value of this instance is false.
The provider parameter is reserved. It does not participate in the execution of this method. (Reserved) An System.IFormatProvider object.
Buffer class (System)
ToString
Description
Manipulates unmanaged memory represented as arrays of bytes.
This class provides methods to copy bytes from one primitive array to another primitive array without respecting types, get a byte from an array, set a byte in an array, and obtain the length of an array.
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.
Copies count bytes from src, beginning at srcOffset, to dst, beginning at dstOffset. The source buffer. The byte offset into src. The destination buffer. The byte offset into dst. The number of bytes to copy.
ByteLength
Returns the number of bytes in the specified array.
Return Value: The number of bytes in the array. An array.
GetByte
Retrieves the byte at a specified location in a specified array.
Return Value: Returns the index byte in the array.
The GetByte method gets a particular byte out of the array. The array must be an array of primitives. An array. A location in the array.
SetByte
Assigns a specified value to a byte at a particular location in a specified array.
array must be an array of primitives. An array. A location in the array. A value to assign.
Byte structure (System)
ToString
Description
Represents an 8-bit unsigned integer.
The Byte value type represents unsigned integers with values ranging from 0 to 255.
ToString
A constant representing the largest possible value of Byte.
The value of this constant is 255; that is, hexadecimal 0xFF.
ToString
A constant representing the smallest possible value of Byte.
The value of this constant is.
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: A signed number indicating the relative values of this instance and value.
Any instance of Byte, regardless of its value, is considered greater than null. An object to compare, or null.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if obj is an instance of Byte and equals the value of this instance; otherwise, false. An object to compare with this instance or null.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
GetTypeCode
Returns the TypeCode for value type Byte.
Return Value: The enumerated constant, System.TypeCode.Byte.
Parse
Converts the String representation of a number to its 8-bit unsigned integer equivalent.
Return Value: An 8-bit unsigned integer equivalent to the number contained in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert.
Parse
Converts the String representation of a number in a specified culture-specific format to its 8-bit unsigned integer equivalent.
Return Value: An 8-bit unsigned integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and‘]’) are optional, and other items are as follows. A System.String containing a number to convert. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
Parse
Description
Converts the String representation of a number in a specified style to its 8-bit unsigned integer equivalent.
Return Value: An 8-bit unsigned integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStyles constants that indicate the permitted format of s.
Parse
Converts the String representation of a number in a specified style and culture-specific format to its 8-bit unsigned integer equivalent.
Return Value: An 8-bit unsigned integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStylesconstants that indicate the permitted format of s. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
IConvertible.ToBoolean
IConvertible.ToByte
IConvertible.ToDecimal
IConvertible.ToDouble
IConvertible.ToInt16
IConvertible.ToInt32
IConvertible.ToInt64
IConvertible.ToSByte
IConvertible.ToSingle
IConvertible.ToType
IConvertible.ToUInt16
IConvertible.ToUInt32
IConvertible.ToUInt64
ToString
Converts the numeric value of this instance to its equivalent String representation.
Return Value: The System.String representation of the value of this instance, consisting of a sequence of digits ranging from 0 to 9, without a sign or leading zeroes.
The return value is formatted with the general format specifier (“G”) and the System.Globalization.NumberFormatInfo for the current culture.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by provider.
This instance is formatted with the general format specifier (“G”). An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified format.
Return Value: The System.String representation of the value of this instance as specified by format.
If format is null or an empty string, the return value of this instance is formatted with the general format specifier (“G”). A format string.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified format and culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by format and provider.
If format is null or an empty string, the return value for this instance is formatted with the general format specifier (“G”). A format specification. An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
CannotUnloadAppDomainException class (System)
ToString
Description
The exception that is thrown when an attempt to unload an application domain fails.
System.CannotUnloadAppDomainException is thrown when there is an attempt to unload: The default application domain, which must remains loaded during the lifetime of the application.
CannotUnloadAppDomainException
Example Syntax:
ToString
Initializes a new instance of the System.CannotUnloadAppDomainException class with default properties.
The following table shows the initial property values for an instance of System.CannotUnloadAppDomainException.
CannotUnloadAppDomainException
Example Syntax:
ToString
Initializes a new instance of the System.CannotUnloadAppDomainException class with a specified error message.
The following table shows the initial property values for an instance of System.CannotUnloadAppDomainException. The error message that explains the reason for the exception.
CannotUnloadAppDomainException
Example Syntax:
ToString
Initializes a new instance of the System.CannotUnloadAppDomainException class from serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
CannotUnloadAppDomainException
Example Syntax:
ToString
Initializes a new instance of the System.CannotUnloadAppDomainException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
Char structure (System)
ToString
Description
Represents a Unicode character.
The Char value type represents Unicode characters with values ranging from hexadecimal 0x0000 to 0xFFFF.
ToString
A constant representing the largest possible value of Char.
The value of this constant is hexadecimal 0xFFFF.
ToString
A constant representing the smallest possible value of Char.
The value of this constant is hexadecimal 0x00.
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: A signed number indicating the relative values of this instance and value.
Any instance of Char, regardless of its value, is considered greater than null. An object to compare, or null.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if obj is an instance of Char and equals the value of this instance; otherwise, false. An object to compare with this instance or null.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
GetNumericValue
Converts the specified numeric Unicode character to a double-precision floating point number.
Return Value: The numeric value of c if that character represents a number; otherwise, −1.
For example, if c is ‘5’, the return value is 5. However, if c is ‘z’, the return value is −1. A Unicode character.
GetNumericValue
Converts the numeric Unicode character at the specified position in a specified System.String to a double-precision floating point number.
Return Value: The numeric value of the character at position index in s if that character represents a number; otherwise, −1.
For example, if the character at position index in s is ‘5’, the return value is 5. However, if the character at position index in s is ‘z’, the return value is −1. A System.String. A 32-bit signed integer that specifies a character position in s.
GetTypeCode
Returns the TypeCode for value type Char.
Return Value: The enumerated constant, System.TypeCode.Char.
GetUnicodeCategory
Categorizes a specified Unicode character into a group identified by a UnicodeCategory enumerated constant.
Return Value: A System.Globalization.UnicodeCategory enumerated constant that identifies the group that contains c. A Unicode character.
GetUnicodeCategory
Categorizes the character at the specified position in a specified String into a group identified by a UnicodeCategory enumerated constant.
Return Value: A System.Globalization.UnicodeCategory enumerated constant that identifies the group that contains the character at position index in s.
Character positions in a String are indexed starting from zero. A System.String. A 32-bit signed integer that specifies a character position in s.
IsControl
Indicates whether the specified Unicode character is categorized as a control character.
Return Value: true if c is a control character; otherwise, false. A Unicode character.
IsControl
Indicates whether the character at the specified position in a specified String is categorized as a control character.
Return Value: true if the character at position index in s is a control character; otherwise, false.
Character positions in a String are indexed starting from zero. A System.String. A 32-bit signed integer that specifies a character position in s.
IsDigit
Indicates whether the specified Unicode character is categorized as a decimal digit.
Return Value: true if c is a decimal digit; otherwise, false. A Unicode character.
IsDigit
Indicates whether the character at the specified position in a specified String is categorized as a decimal digit.
Return Value: true if the character at position index in s is a decimal digit; otherwise, false.
Character positions in a String are indexed starting from zero. A System.String. A 32-bit signed integer that specifies a character position in s.
IsLetter
Indicates whether the specified Unicode character is categorized as an alphabetic letter.
Return Value: true if c is an alphabetic letter; otherwise, false.
Valid letters are members of the following categories in System.Globalization.UnicodeCategory: UppercaseLetter, LowercaseLetter, TitlecaseLetter, ModifierLetter, and OtherLetter. A Unicode character.
IsLetter
Indicates whether the character at the specified position in a specified String is categorized as an alphabetic character.
Return Value: true if the character at position index in s is an alphabetic character; otherwise, false. Character positions in a String are indexed starting from zero. A System.String. A 32-bit signed integer that specifies a character position in s.
IsLetterOrDigit
Indicates whether the specified Unicode character is categorized as a letter or decimal digit.
Return Value: true if c is a letter or decimal digit; otherwise, false. A Unicode character.
IsLetterOrDigit
Indicates whether the character at the specified position in a specified String is categorized as an alphabetic character or a decimal digit.
Return Value: true if the character at position index in s is an alphabetic character or a decimal digit; otherwise, false.
Character positions in a String are indexed starting from zero. A System.String. A 32-bit signed integer that specifies a character position in s.
IsLower
Indicates whether the specified Unicode character is categorized as a lowercase letter.
Return Value: true if c is a lowercase letter; otherwise, false. A Unicode character.
IsLower
Indicates whether the character at the specified position in a specified String is categorized as a lowercase letter.
Return Value: true if the character at position index in s is a lowercase letter; otherwise, false.
Character positions in a String are indexed starting from zero. A System.String. A 32-bit signed integer that specifies a character position in s.
IsNumber
Indicates whether the specified Unicode character is categorized as a decimal digit or hexadecimal number.
Return Value: true if c is a decimal digit or hexadecimal number; otherwise, false A Unicode character.
IsNumber
Indicates whether the character at the specified position in a specified String is categorized as a decimal digit or hexadecimal number.
Return Value: true if the character at position index in s is a decimal digit or hexadecimal number; otherwise, false.
Character positions in a String are indexed starting from zero. A System.String. A 32-bit signed integer that specifies a character position in s.
IsPunctuation
Indicates whether the specified Unicode character is categorized as a punctuation mark.
Return Value: true if c is a punctuation mark; otherwise, false. A Unicode character.
IsPunctuation
Indicates whether the character at the specified position in a specified String is categorized as a punctuation mark.
Return Value: true if the character at position index in s is a punctuation mark; otherwise, false.
Character positions in a String are indexed starting from zero. A System.String. A 32-bit signed integer that specifies a character position in s.
IsSeparator
Indicates whether the specified Unicode character is categorized as a separator character.
Return Value: true if c is a separator character; otherwise, false. A Unicode character.
IsSeparator
Indicates whether the character at the specified position in a specified String is categorized as a separator character.
Return Value: true if the character at position index in s is a separator character; otherwise, false.
Character positions in a String are indexed starting from zero. A System.String. A 32-bit signed integer that specifies a character position in s.
IsSurrogate
Indicates whether the specified Unicode character is categorized as a surrogate character.
Return Value: true if c is a surrogate character; otherwise, false.
For more information about surrogate pairs, see the Unicode Standard at http://www.unicode.org. A Unicode character.
IsSurrogate
Indicates whether the character at the specified position in a specified String is categorized as a surrogate character.
Return Value: true if the character at position index in s is a surrogate character; otherwise, false.
Character positions in a String are indexed starting from zero. A System.String. A 32-bit signed integer that specifies a character position in s.
IsSymbol
Indicates whether the specified Unicode character is categorized as a symbol character.
Return Value: true if c is a symbol character; otherwise, false.
Valid symbols are members of the following categories in System.Globalization.UnicodeCategory: MathSymbol, CurrencySymbol, ModifierSymbol, and OtherSymbol. A Unicode character.
IsSymbol
Indicates whether the character at the specified position in a specified String is categorized as a symbol character.
Return Value: true if the character at position index in s is a symbol character; otherwise, false.
Character positions in a String are indexed starting from zero. A System.String. A 32-bit signed integer that specifies a character position in s.
IsUpper
Indicates whether the specified Unicode character is categorized as an uppercase letter.
Return Value: true if c is an uppercase letter; otherwise, false. A Unicode character.
IsUpper
Indicates whether the character at the specified position in a specified String is categorized as an uppercase letter.
Return Value: true if the character at position index in s is an uppercase letter; otherwise, false. Character positions in a String are indexed starting from zero. A System.String. A 32-bit signed integer that specifies a character position in s.
IsWhiteSpace
Indicates whether the specified Unicode character is categorized as white space.
Return Value: true if c is white space; otherwise, false.
Valid white space characters are members of the SpaceSeparator category in System.Globalization.UnicodeCategory, as well as these Unicode characters: hexadecimal 0x0009, 0x000a, 0x000b, 0x000c, 0x000d, 0x0085, 0x2028, and 0x2029. A Unicode character.
IsWhiteSpace
Indicates whether the character at the specified position in a specified String is categorized as white space.
Return Value: true if the character at position index in s is white space; otherwise, false.
Character positions in a String are indexed starting from zero. A System.String. A 32-bit signed integer that specifies a character position in s.
Parse
Converts the value of the specified String to its equivalent Unicode character.
Return Value: A Unicode character equivalent to the sole character in s. A System.String containing a single character or null.
IConvertible.ToBoolean
IConvertible.ToByte
IConvertible.ToDateTime
IConvertible.ToDecimal
IConvertible.ToDouble
IConvertible.ToInt16
IConvertible.ToInt32
IConvertible.ToInt64
IConvertible.ToUInt16
IConvertible.ToUInt32
ToLower
Converts the value of a specified Unicode character to its lowercase equivalent using specified culture-specific formatting information.
Return Value: The lowercase equivalent of c.
Formatting information is obtained from the current culture. A Unicode character.
ToLower
Converts the value of a specified Unicode character to its lowercase equivalent using specified culture-specific formatting information.
Return Value: The lowercase equivalent of c, formatted according to culture.
Use System.String.ToLower to convert a string to lowercase. A Unicode character. A System.Globalization.CultureInfo object that supplies culture-specific formatting information, or null.
ToString
Converts the value of this instance to its equivalent String representation.
Return Value: The System.String representation of the value of this instance.
ToString
Converts the specified Unicode character to its equivalent String representation.
Return Value: The System.String representation of the value of c. A Unicode character.
ToString
Converts the value of this instance to its equivalent String representation using the specified culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by provider.
provider is ignored; it does not participate in this operation. (Reserved) An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToUpper
Converts the value of a specified Unicode character to its uppercase equivalent using specified culture-specific formatting information.
Return Value: The uppercase equivalent of c.
Formatting information is obtained from the current culture. A Unicode character.
ToUpper
Converts the value of a specified Unicode character to its uppercase equivalent using specified culture-specific formatting information.
Return Value: The uppercase equivalent of c, formatted according to culture.
Use System.String.ToUpper to convert a string to uppercase. A Unicode character. A System.Globalization.CultureInfo object that supplies culture-specific formatting information, or null.
CharEnumerator class (System)
ToUpper
Description
Supports iterating over a System.String and reading its individual characters.
A System.CharEnumerator provides read-only access to the characters in a referenced System.String object. For example, the for each statement of the Microsoft Visual Basic and C# programming languages, which iterates through the elements of a collection, retrieves a System.CharEnumerator from an instance of System.String in order to iterate through the characters in that instance.
Current
ToUpper
Gets the character in the enumerated string currently indexed by this instance.
This property should only be invoked when the index maintained by this instance is valid, otherwise, an exception is thrown. The index is always invalid for an empty string (“ ”)
Clone
Creates a copy of this instance.
Return Value: An System.Object that is a copy of this instance.
The return value is a copy of this instance of System.CharEnumerator and its current state. This is useful for saving your state while iterating through a System.String object.
MoveNext
Increments the index to the next character of the enumerated string.
Return Value: true if the index is successfully incremented and within the enumerated string; otherwise, false.
The System.CharEnumerator.MoveNext method increments the index by one. Call System.CharEnumerator.MoveNext after calling System.String.GetEnumerator or System.CharEnumerator.Reset to increment the current character position to the first character in the enumerated string. Check that the return value is true to determine that the current character position is valid.
Reset
Initializes the index to a position logically before the first character of the enumerated string.
The index is set to the invalid state.
CLSCompliantAttribute class (System)
ToString
Description
Indicates whether a program element is compliant with the Common Language Specification (CLS). This class cannot be inherited.
If no System.CLSCompliantAttribute is applied to a program element, by default: The assembly is not CLS-compliant.
CLSCompliantAttribute
Example Syntax:
ToString
Initializes an instance of the System.CLSCompliantAttribute class with a Boolean value indicating whether the indicated program element is CLS-compliant. true if CLS-compliant; otherwise, false.
IsCompliant
ToString
Gets the Boolean value indicating whether the indicated program element is CLS-compliant.
TypeId
Console class (System)
ToString
Description
Represents the standard input, output, and error streams for console applications.
The System.Console class provides basic support for applications that read characters from, and write characters to, the console. If the console does not exist, as in a Windows-based application, writes to the console are not displayed and no exception is raised.
Error
ToString
Gets the standard error output stream.
This property is set to the standard error stream by default. This property can be set to another stream with the System.Console.SetError(System.IO.TextWriter) method.
In
ToString
Gets the standard input stream.
This property is set to the standard input stream by default. This property can be set to another stream with the System.Console.SetIn(System.IO.TextReader) method.
Out
ToString
Gets the standard output stream.
This property is set to the standard output stream by default. This property can be set to another stream with the System.Console.SetOut(System.IO.TextWriter) method.
OpenStandardError
Acquires the standard error stream.
Return Value: A System.IO.TextWriter object that represents the standard error stream.
This method can be used to reacquire the standard error stream after it has been changed by the System.Console.SetError(System.IO.TextWriter) method.
OpenStandardError
Acquires the standard error stream, set to a specified buffer size.
Return Value: A System.IO.TextWriter object that represents the standard error stream.
This method can be used to reacquire the standard error stream after it has been changed by the System.Console.SetError(System.IO.TextWriter) method. The internal stream buffer size.
OpenStandardInput
Acquires the standard input stream.
Return Value: A System.IO.TextReader object that represents the standard input stream.
This method can be used to reacquire the standard input stream after it has been changed by the System.Console.SetIn(System.IO.TextReader) method.
OpenStandardInput
Acquires the standard input stream, set to a specified buffer size. Return Value: A System.IO.TextReader object that represents the standard output stream.
This method can be used to reacquire the standard output stream after it has been changed by the System.Console.SetIn(System.IO.TextReader) method. The internal stream buffer size.
OpenStandardOutput
Acquires the standard output stream.
Return Value: A System.IO.TextWriter object that represents the standard output stream.
This method can be used to reacquire the standard output stream after it has been changed by the System.Console.SetOut(System.IO.TextWriter) method.
OpenStandardOutput
Acquires the standard output stream, set to a specified buffer size.
Return Value: A System.IO.TextWriter object that represents the standard output stream.
This method can be used to reacquire the standard output stream after it has been changed by the System.Console.SetOut(System.IO.TextWriter) method. The internal stream buffer size.
Read
Reads the next character from the standard input stream.
Return Value: The next character from the input stream, or negative one if no more characters are available.
This method will not return until the read operation is terminated (for example, by the user pressing the enter key). If data is available, the input stream contains what the user entered, suffixed with a carriage-return character followed by a linefeed character (“\r\n”).
ReadLine
Reads the next line of characters from the standard input stream.
Return Value: The next line from the input stream, or null if no more characters are available. A line is defined as a sequence of characters followed by a carriage return (‘\r’), a line feed (‘\n’), or a carriage return immediately followed by a line feed (‘\r\n’). The string that is returned does not contain the terminating carriage return and/or line feed.
SetError
Sets the System.Console.Error property to the specified output stream.
By default, the System.Console.Error property is set to the standard error output stream. A System.IO.TextWriter stream that is the new standard error output.
SetIn
Sets the System.Console.In property to the specified input stream.
By default, the System.Console.In property is set to the standard input stream. A System.IO.TextReader stream that is the new standard input.
SetOut
Sets the System.Console.Out property to the specified output stream.
By default, the System.Console.Out property is set to the standard output stream. A System.IO.TextWriter stream that is the new standard output.
Write
Writes the text representation of the specified Boolean value to the standard output stream.
The text representation of value is produced by calling System.Boolean.ToString. The value to write.
Write
Writes the specified Unicode character value to the standard output stream. The value to write.
Write
Writes the specified array of Unicode characters to the standard output stream. A Unicode character array.
Write
Writes the text representation of the specified System.Decimal value to the standard output stream.
The text representation of value is produced by calling System.Decimal.ToString. The value to write.
Write
Writes the text representation of the specified double-precision floating point value to the standard output stream.
The text representation of value is produced by calling System.Double.ToString. The value to write.
Write
Writes the text representation of the specified 32-bit signed integer value to the standard output stream.
The text representation of value is produced by calling System.Int32.ToString. The value to write.
Write
Writes the text representation of the specified 64-bit signed integer value to the standard output stream.
The text representation of value is produced by calling System.Int64.ToString. The value to write.
Write
Writes the text representation of the specified object to the standard output stream.
If value is null, nothing is written and no exception is thrown. Otherwise, the ToString method of value is called to produce its string representation, and the resulting string is written to the standard output stream. The value to write.
Write
Writes the text representation of the specified single-precision floating point value to the standard output stream.
The text representation of value is produced by calling System.Single.ToString. The value to write.
Write
Writes the specified string value to the standard output stream.
If value is null, nothing is written to the standard output stream. The value to write.
Write
Writes the text representation of the specified 32-bit unsigned integer value to the standard output stream.
The text representation of value is produced by calling System.UInt32.ToString. The value to write.
Write
Writes the text representation of the specified 64-bit unsigned integer value to the standard output stream.
The text representation of value is produced by calling System.UInt64.ToString. The value to write.
Write
Writes the specified object to the standard output stream using the specified format information.
This method uses the same semantics as
Is System.String.Format(System.String,System.Object). Format string. Object to write using format.
Write
Writes the specified array of objects to the standard output stream using the specified format information.
This method uses the same semantics as System.String.Format(System.String,System.Object). Format string. An array of objects to write using format.
Write
Writes the specified subarray of Unicode characters to the standard output stream.
This method writes count characters starting at position index of buffer to the standard output stream. An array of Unicode characters. The starting position in buffer. The number of characters to write.
Write
Writes the specified objects to the standard output stream using the specified format information.
This method uses the same semantics as
System.String.Format(System.String,System.Object). Format string. First object to write using format. Second object to write using format.
Write
Writes the specified objects to the standard output stream using the specified format information.
This method uses the same semantics as
System.String.Format(System.String,System.Object). Format string. First object to write using format. Second object to write using format. Third object to write using format.
Write
WriteLine
Writes the current line terminator to the standard output stream.
The default line terminator is a string whose value is a carriage return followed by a line feed (“\r\n”). Change the line terminator by setting the System.IO.TextWriter.NewLine property of the System.Console.Out property to another string.
WriteLine
Writes the text representation of the specified Boolean value, followed by the current line terminator, to the standard output stream.
The text representation of value is produced by calling System.Boolean.ToString. The value to write.
WriteLine
Writes the specified Unicode character, followed by the current line terminator, value to the standard output stream.
For more information about the line terminator, see the Remarks section of the System.Console.WriteLine method that takes no parameters. The value to write.
WriteLine
Writes the specified array of Unicode characters, followed by the current line terminator, to the standard output stream.
For more information about the line terminator, see the Remarks section of the System.Console.WriteLine method that takes no parameters. A Unicode character array.
WriteLine
Writes the text representation of the specified System.Decimal value, followed by the current line terminator, to the standard output stream.
The text representation of value is produced by calling System.Decimal.ToString. The value to write.
WriteLine
Writes the text representation of the specified double-precision floating point value, followed by the current line terminator, to the standard output stream.
The text representation of value is produced by calling System.Double.ToString. The value to write.
WriteLine
Writes the text representation of the specified 32-bit signed integer value, followed by the current line terminator, to the standard output stream.
The text representation of value is produced by calling System.Int32.ToString. The value to write.
WriteLine
Writes the text representation of the specified 64-bit signed integer value, followed by the current line terminator, to the standard output stream.
The text representation of value is produced by calling System.Int64.ToString. The value to write.
WriteLine
Writes the text representation of the specified object, followed by the current line terminator, to the standard output stream.
If value is null, nothing is written and no exception is thrown. Otherwise, the ToString method of value is called to produce its string representation, and the resulting string is written to the standard output stream. The value to write.
WriteLine
Writes the text representation of the specified single-precision floating point value, followed by the current line terminator, to the standard output stream.
The text representation of value is produced by calling System.Single.ToString. The value to write.
WriteLine
Writes the specified string value, followed by the current line terminator, to the standard output stream. If value is null, nothing is written to the standard output stream. The value to write.
WriteLine
Writes the text representation of the specified 32-bit unsigned integer value, followed by the current line terminator, to the standard output stream.
The text representation of value is produced by calling System.UInt32.ToString. The value to write.
WriteLine
Writes the text representation of the specified 64-bit unsigned integer value, followed by the current line terminator, to the standard output stream.
The text representation of value is produced by calling System.UInt64.ToString. The value to write.
WriteLine
Writes the specified object, followed by the current line terminator, to the standard output stream using the specified format information.
This method uses the same semantics as System.String.Format(System.String,System.Object). Format string. Object to write using format.
WriteLine
Writes the specified array of objects, followed by the current line terminator, to the standard output stream using the specified format information. This method uses the same semantics as System.String.Format(System.String,System.Object). Format string. An array of objects to write using format.
WriteLine
Writes the specified subarray of Unicode characters, followed by the current line terminator, to the standard output stream.
This method writes count characters starting at position index of buffer to the standard output stream. An array of Unicode characters. The starting position in buffer. The number of characters to write.
WriteLine
Writes the specified objects, followed by the current line terminator, to the standard output stream using the specified format information.
This method uses the same semantics as System.String.Format(System.String,System.Object). Format string. First object to write using format. Second object to write using format.
WriteLine
Writes the specified objects, followed by the current line terminator, to the standard output stream using the specified format information.
This method uses the same semantics as
System.String.Format(System.String,System.Object). Format string. First object to write using format. Second object to write using format. Third object to write using format.
WriteLine
ContextBoundObject class (System)
WriteLine
Description
Defines the base class for all context-bound classes.
Objects that reside in a context and are bound to the context rules are called context-bound objects. A context is a set of properties or usage rules that define an environment where a collection of objects resides. The rules are enforced when the objects are entering or leaving a context. Objects that are not context-bound are called agile objects.
ContextBoundObject
Example Syntax:
WriteLine
ToString
Description
The exception that is thrown when an attempt to marshal an object across a context boundary fails.
Objects can marshal by value or by reference. Any attempt to pass an instance of an unmarshallable type through a context boundary will result in a System.ContextMarshalException.
ContextMarshalException
Example Syntax:
ToString
Initializes a new instance of the System.ContextMarshalException class with default properties.
The following table shows the initial property values for an instance of System.ContextMarshalException.
ContextMarshalException
Example Syntax:
ToString
Initializes a new instance of the System.ContextMarshalException class with a specified error message.
The following table shows the initial property values for an instance of System.ContextMarshalException. The error message that explains the reason for the exception.
ContextMarshalException
Example Syntax:
ToString
Initializes a new instance of the System.ContextMarshalException class with serialized data. The object that holds the serialized object data. The contextual information about the source or destination.
ContextMarshalException
Example Syntax:
ToString
Initializes a new instance of the System.ContextMarshalException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If inner is non-null, then the current Exception is raised in a catch block handling inner.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
ContextStaticAttribute class (System)
ToString
Description
Indicates that the value of a static field is unique for a particular context.
A static field marked with System.ContextStaticAttribute is not shared between contexts. If the indicated static field is accessed on a different context, it will contain a different value.
ContextStaticAttribute
Example Syntax:
ToString
Initializes a new instance of the System.ContextStaticAttribute class.
TypeId
Convert class (System)
ToString
Description
Converts base data types to other base data types.
This class returns a base type that is equivalent to the value of a specified type.
ToString
A constant representing a database column absent of data; that is, database null.
ChangeType
Returns an Object with the specified Type and whose value is equivalent to the specified object.
Return Value: An object whose Type is conversionType and whose value is equivalent to value.
This method uses the current thread's culture for the conversion. An System.Object that implements the System.IConvertible interface. A System.Type.
ChangeType
Returns an Object with the specified TypeCode and whose value is equivalent to the specified object.
Return Value: An object whose underlying TypeCode is typeCode and whose value is equivalent to value. An System.Object that implements the System.IConvertible interface. A System.TypeCode
ChangeType
Returns an Object with the specified Type and whose value is equivalent to the specified object. A parameter supplies culture-specific formatting information.
Return Value: An object whose Type is conversionType and whose value is equivalent to value.
provider enables the user to specify culture-specific conversion information about the contents of value. For example, if value is a String that represents a number, provider could supply culture-specific information about the notation used to represent that number. An System.Object that implements the System.IConvertible interface. A System.Type. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ChangeType
Returns an Object with the specified TypeCode and whose value is equivalent to the specified object. A parameter supplies culture-specific formatting information.
Return Value: An object whose underlying TypeCode is typeCode and whose value is equivalent to value.
provider enables the user to specify culture-specific conversion information about the contents of value. For example, if value is a String that represents a number, provider could supply culture-specific information about the notation used to represent that number. An System.Object that implements the System.IConvertible interface. A System.TypeCode. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
FromBase64CharArray
Converts the specified subset of an array of Unicode characters consisting of base 64 digits to an equivalent array of 8-bit unsigned integers. Parameters specify the offset and number of elements in the input array.
Return Value: An array of 8-bit unsigned integers equivalent to length elements at position offset in in Array.
The subset in in Array is composed of base 64 digits. The base 64 digits in ascending order from zero are the uppercase characters ‘A’ to ‘Z’, lowercase characters ‘a’ to ‘z’, numerals ‘0’ to ‘9’, and the symbols ‘+’ and ‘/’. The valueless character, ‘=’, is used for trailing padding. A Unicode character array. A position within in Array. The number of elements in in Array to convert.
FromBase64String
Converts the specified String representation of a value consisting of base 64 digits to an equivalent array of 8-bit unsigned integers.
Return Value: An array of 8-bit unsigned integers equivalent to s.
s composed of base 64 digits. The base 64 digits in ascending order from zero are the uppercase characters ‘A’ to ‘Z’, lowercase characters ‘a’ to ‘z’, numerals ‘0’ to ‘9’, and the symbols ‘+’ and ‘/’. The valueless character, ‘=’, is used for trailing padding. A System.String.
GetTypeCode
Returns the TypeCode for the specified object.
Return Value: The System.TypeCode for value, or System.TypeCode.Empty if value is null. An System.Object that implements the System.IConvertible interface.
IsDBNull
Returns an indication whether the specified object is of type DBNull
Return Value: true if value is of type System.TypeCode.DBNull; otherwise, false. An object.
ToBase64CharArray
Converts the value of a subset of an 8-bit unsigned integer array to an equivalent subset of a Unicode character array consisting of base 64 digits. Parameters specify the subsets as offsets of the input and output arrays and the number of elements in the input array.
Return Value: A 32-bit signed integer containing the number of bytes in outArray.
The subset of length elements of inArray starting at position offsetIn, are taken as a numeric value and converted to a subset of elements in outArray starting at position offsetOut. The return value indicates the number of converted elements in outArray. The subset of outArray consists of base 64 digits. An input array of 8-bit unsigned integers. A position within in Array. The number of elements of in Array to convert. An output array of Unicode characters. A position within outArray.
ToBase64String
Converts the value of an array of 8-bit unsigned integers to its equivalent String representation consisting of base 64 digits.
Return Value: The System.String representation, in base 64, of the contents of in Array.
The elements of in Array are taken as a numeric value and converted to a String representation consisting of base 64 digits. An array of 8-bit unsigned integers.
ToBase64String
Converts the value of a subset of an array of 8-bit unsigned integers to its equivalent String representation consisting of base 64 digits. Parameters specify the subset as an offset and number of elements in the array.
Return Value: The System.String representation in base 64 of length elements of in Array starting at position offset.
The elements of in Array are taken as a numeric value and converted to a String representation in base 64. An array of 8-bit unsigned integers. An offset in in Array. The number of elements of in Array to convert.
ToBoolean
Returns the specified Boolean value; no actual conversion is performed.
Return Value: value is returned unchanged. A Boolean.
ToBoolean
Converts the value of the specified 8-bit unsigned integer to an equivalent Boolean value.
Return Value: true if value is non-zero; otherwise, false. An 8-bit unsigned integer.
ToBoolean
Conversion from Char to Boolean is not supported.
Return Value: (None) Attempt to convert Char to Boolean. A Unicode character.
ToBoolean
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A System.DateTime.
ToBoolean
Converts the value of the specified Decimal number to an equivalent Boolean value.
Return Value: true if value is non-zero; otherwise, false.
Description
Converts the value of the specified Decimal number to an equivalent Boolean value.
Return Value: true if value is non-zero; otherwise, false. A System.Decimal number.
ToBoolean
Converts the value of the specified double-precision floating point number to an equivalent Boolean value.
Return Value: true if value is non-zero; otherwise, false. A double-precision floating point number.
ToBoolean
Converts the value of the specified 16-bit signed integer to an equivalent Boolean value.
Return Value: true if value is non-zero; otherwise, false. A 16-bit signed integer.
ToBoolean
Converts the value of the specified 32-bit signed integer to an equivalent Is Boolean value.
Return Value: true if value is non-zero; otherwise, false. A 32-bit signed integer.
ToBoolean
Converts the value of the specified 64-bit signed integer to an equivalent Boolean value.
Return Value: true if value is non-zero; otherwise, false. A 64-bit signed integer.
ToBoolean
Converts the value of a specified Object to an equivalent Boolean value.
Return Value: false if value equals null. An System.Object that implements the System.IConvertible interface or null.
ToBoolean
Converts the value of the specified 8-bit signed integer to an equivalent Boolean value.
Return Value: true if value is non-zero; otherwise, false. An 8-bit signed integer.
ToBoolean
Converts the value of the specified single-precision floating point number to an equivalent Boolean value.
Return Value: true if value is non-zero; otherwise, false. A single-precision floating point number.
ToBoolean
Converts the specified String representation of a logical value to its Boolean equivalent.
Return Value: true if value equals System.Boolean.TrueString, or false if value equals System.Boolean.FalseString. A System.String that contains the value of either System.Boolean.TrueString or System.Boolean.FalseString.
ToBoolean
Converts the value of the specified 16-bit unsigned integer to an equivalent Boolean value.
Return Value: true if value is non-zero; otherwise, false. A 16-bit unsigned integer.
ToBoolean
Converts the value of the specified 32-bit unsigned integer to an equivalent Boolean value.
Return Value: true if value is non-zero; otherwise, false. A 32-bit unsigned integer.
ToBoolean
Converts the value of the specified 64-bit unsigned integer to an equivalent Boolean value.
Return Value: true if value is non-zero; otherwise, false. A 64-bit unsigned integer.
ToBoolean
Converts the value of the specified Object to an equivalent Boolean value using the specified culture-specific formatting information.
Return Value: false if value equals null.
provider enables the user to specify culture-specific conversion information about the contents of value. For example, if value is a String that represents a number, provider could supply culture-specific information about the notation used to represent that number. An System.Object that implements the System.IConvertible interface or null. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToBoolean
Converts the specified String representation of a logical value to its Boolean equivalent using the specified culture-specific formatting information.
Return Value: true if value equals System.Boolean.TrueString, or false if value equals System.Boolean.FalseString.
provider is ignored; it does not participate in this operation. A string that contains the value of either System.Boolean.TrueString or System.Boolean.FalseString. (Reserved) An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToByte
Converts the value of the specified Boolean value to the equivalent 8-bit unsigned integer.
Return Value: The number 1 if value is true; otherwise, 0. A Boolean value.
ToByte
Returns the specified 8-bit unsigned integer; no actual conversion is performed.
Return Value: value is returned unchanged. An 8-bit unsigned integer.
ToByte
Converts the value of the specified Unicode character to the equivalent 8-bit unsigned integer.
Return Value: The 8-bit unsigned integer equivalent to value. A Unicode character.
ToByte
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A System.DateTime.
ToByte
Converts the value of the specified Decimal number to an equivalent 8-bit unsigned integer.
Return Value: 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. A System.Decimal number.
ToByte
Converts the value of the specified double-precision floating point number to an equivalent 8-bit unsigned integer.
Return Value: 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. A double-precision floating point number.
ToByte
Converts the value of the specified 16-bit signed integer to an equivalent 8-bit unsigned integer.
Return Value: An 8-bit unsigned integer equivalent to the value of value. A 16-bit signed integer.
ToByte
Converts the value of the specified 32-bit signed integer to an equivalent 8-bit unsigned integer.
Return Value: An 8-bit unsigned integer equivalent to the value of value. A 32-bit signed integer.
ToByte
Converts the value of the specified 64-bit signed integer to an equivalent 8-bit unsigned integer.
Return Value: An 8-bit unsigned integer equivalent to the value of value. A 64-bit signed integer.
ToByte
Converts the value of the specified Object to an 8-bit unsigned integer.
Return Value: An 8-bit unsigned integer equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToByte method of the underlying type of value. An System.Object that implements the System.IConvertible interface or null.
ToByte
Converts the value of the specified 8-bit signed integer to an equivalent 8-bit unsigned integer.
Return Value: An 8-bit unsigned integer equivalent to the value of value. An 8-bit signed integer.
ToByte
Converts the value of the specified single-precision floating point number to an equivalent 8-bit unsigned integer.
Return Value: 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. A single-precision floating point number.
ToByte
Converts the specified String representation of a number to an equivalent 8-bit unsigned integer.
Return Value: An 8-bit unsigned integer equivalent to the value of value. A System.String containing a number to convert. ToByte
Converts the value of the specified 16-bit unsigned integer to an equivalent 8-bit unsigned integer.
Return Value: An 8-bit unsigned integer equivalent to the value of value. A 16-bit unsigned integer.
ToByte
Converts the value of the specified 32-bit unsigned integer to an equivalent 8-bit unsigned integer.
Return Value: An 8-bit unsigned integer equivalent to the value of value. A 32-bit unsigned integer.
ToByte
Converts the value of the specified 64-bit unsigned integer to an equivalent 8-bit unsigned integer.
Return Value: An 8-bit unsigned integer equivalent to the value of value. A 64-bit unsigned integer.
ToByte
Converts the value of the specified Object to an 8-bit unsigned integer using the specified culture-specific formatting information.
Return Value: An 8-bit unsigned integer equivalent to the value of value, or zero if value is null.
provider enables the user to specify culture-specific conversion information about the contents of value. For example, if value is a String that represents a number, provider could supply culture-specific information about the notation used to represent that number. An System.Object that implements the System.IConvertible interface. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToByte
Converts the specified String representation of a number to an equivalent 8-bit signed integer using specified culture-specific formatting information.
Return Value: An 8-bit signed integer equivalent to the value of value.
provider is an IFormatProvider instance that obtains a System.Globalization.NumberFormatInfo object. The NumberFormatInfo object provides culture-specific information about the format of value. If provider is null, the NumberFormatInfo for the current culture is used. A System.String containing a number to convert. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToByte
Converts the String representation of a number in a specified base to an equivalent 8-bit unsigned integer.
Return Value: An 8-bit unsigned integer equivalent to the number in value. A System.String containing a number. The base of the number in value, which must be 2, 8, 10, or 16.
ToChar
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A System.Boolean value.
ToChar
Converts the value of the specified 8-bit unsigned integer to its equivalent Unicode character.
Return Value: The Unicode character equivalent to the value of value. An 8-bit unsigned integer.
ToChar
Returns the specified Unicode character value; no actual conversion is performed.
Return Value: value is returned unchanged. A Unicode character.
ToChar
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A System.DateTime.
ToChar
Converts the value of the specified Decimal number to its equivalent Unicode character.
Return Value: A Unicode character equivalent to the value of value.
The return value is the result of invoking the IConvertible.ToChar method of the underlying type of value. An System.Decimal number.
ToChar
Converts the value of the specified double-precision floating point number to its equivalent Unicode character.
Return Value: The Unicode character equivalent to the value of value.
The return value is the result of invoking the IConvertible.ToChar method of the underlying type of value. A double-precision floating point number.
ToChar
Converts the value of the specified 16-bit signed integer to its equivalent Unicode character.
Return Value: The Unicode character equivalent to the value of value. A 16-bit signed integer.
ToChar
Converts the value of the specified 32-bit signed integer to its equivalent Unicode character.
Return Value: The Unicode character equivalent to the value of value. A 32-bit signed integer.
ToChar
Converts the value of the specified 64-bit signed integer to its equivalent Unicode character.
Return Value: The Unicode character equivalent to the value of value. A 64-bit signed integer.
ToChar
Converts the value of the specified Object to a Unicode character.
Return Value: The Unicode character equivalent to the value of value.
The return value is the result of invoking the IConvertible.ToChar method of the underlying type of value. An System.Object that implements the System.IConvertible interface.
ToChar
Converts the value of the specified 8-bit signed integer to its equivalent Unicode character.
Return Value: The Unicode character equivalent to the value of value. An 8-bit signed integer.
ToChar
Converts the value of the specified single-precision floating point number to its equivalent Unicode character.
Return Value: The Unicode character equivalent to the value of value.
The return value is the result of invoking the IConvertible.ToChar method of the underlying type of value. An single-precision floating point number.
ToChar
Converts the first character of a String to a Unicode character.
Return Value: The Unicode character equivalent to the first and only character in value.value is null.
value must be null or a String containing a single character. A System.String of length 1 or null.
ToChar
Converts the value of the specified 16-bit unsigned integer to its equivalent Unicode character.
Return Value: The Unicode character equivalent to the value of value. A 16-bit unsigned integer.
ToChar
Converts the value of the specified 32-bit unsigned integer to its equivalent Unicode character.
Return Value: The Unicode character equivalent to the value of value. A 32-bit unsigned integer.
ToChar
Converts the value of the specified 64-bit unsigned integer to its equivalent Unicode character.
Return Value: The Unicode character equivalent to the value of value. A 64-bit unsigned integer.
ToChar
Converts the value of the specified Object to its equivalent Unicode character using the specified culture-specific formatting information.
Return Value: The Unicode character equivalent to the value of value.
The return value is the result of invoking the IConvertible.ToChar method of the underlying type of value. An System.Object that implements the System.IConvertible interface. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToChar
Converts the first character of a String to a Unicode character using specified culture-specific formatting information.
Return Value: The Unicode character equivalent to the first and only character in value.value is null.
value must be null or a String containing a single character. A System.String of length 1 or null. (Reserved) An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToDateTime
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A Boolean value.
ToDateTime
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. An 8-bit unsigned integer.
ToDateTime
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A Unicode character.
ToDateTime
Returns the specified DateTime; no actual conversion is performed. A System.DateTime.
ToDateTime
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A System.Decimal value.
ToDateTime
This method is reserved for future use. A double-precision floating point value.
ToDateTime
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A 16-bit signed integer.
ToDateTime
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A 32-bit signed integer.
ToDateTime
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A 64-bit signed integer.
ToDateTime
Converts the value of the specified Object to a DateTime.
Return Value: A DateTime equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToDateTime method of the underlying type of value. An System.Object that implements the System.IConvertible interface or null.
ToDateTime
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. An 8-bit signed integer.
ToDateTime
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A single-precision floating point value.
ToDateTime
Converts the specified String representation of a date and time to an equivalent DateTime.
Return Value: A DateTime equivalent to the value of value.
The return value is the result of invoking the System.DateTime.Parse(System.String) method on value. A System.String containing a date and time to convert.
ToDateTime
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A 16-bit unsigned integer.
ToDateTime
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A 32-bit unsigned integer.
ToDateTime
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A 64-bit unsigned integer.
ToDateTime
Converts the value of the specified Object to a DateTime using the specified culture-specific formatting information.
Return Value: A DateTime equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToDateTime method of the underlying type of value. An System.Object that implements the System.IConvertible interface. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToDateTime
Converts the specified String representation of a number to an equivalent DateTime using the specified culture-specific formatting information.
Return Value: A DateTime equivalent to the value of value.
The return value is the result of invoking the System.DateTime.Parse(System.String) method on value. A System.String containing a number to convert. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToDecimal
Converts the value of the specified Boolean value to the equivalent Decimal number.
Return Value: The number 1 if value is true; otherwise, 0. A Boolean value.
ToDecimal
Converts the value of the specified 8-bit unsigned integer to the equivalent Decimal number.
Return Value: The Decimal number equivalent to the value of value. An 8-bit unsigned integer.
ToDecimal
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A Unicode character.
ToDecimal
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A System.DateTime.
ToDecimal
Returns the specified Decimal number; no actual conversion is performed.
Return Value: value is returned unchanged. A Decimal number.
ToDecimal
Converts the value of the specified double-precision floating point number to an equivalent Decimal number.
Return Value: A Decimal number equivalent to the value of value. A double-precision floating point number.
ToDecimal
Converts the value of the specified 16-bit signed integer to an equivalent Decimal number.
Return Value: A Decimal number equivalent to the value of value. A 16-bit signed integer.
ToDecimal
Converts the value of the specified 32-bit signed integer to an equivalent Decimal number.
Return Value: A Decimal number equivalent to the value of value. A 32-bit signed integer.
ToDecimal
Converts the value of the specified 64-bit signed integer to an equivalent Decimal number.
Return Value: A Decimal number equivalent to the value of value. A 64-bit signed integer.
ToDecimal
Converts the value of the specified Object to a Decimal number.
Return Value: A Decimal number equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToDecimal method of the underlying type of value. An System.Object that implements the System.IConvertible interface or null.
ToDecimal
Converts the value of the specified 8-bit signed integer to the equivalent Decimal number.
Return Value: The 8-bit signed integer equivalent to the value of value. An 8-bit signed integer.
ToDecimal
Converts the value of the specified single-precision floating point number to the equivalent Decimal number.
Return Value: A Decimal number equivalent to the value of value. A single-precision floating point number.
ToDecimal
Converts the specified String representation of a number to an equivalent Decimal number.
Return Value: A Decimal number equivalent to the value of value.
The return value is the result of invoking the System.Decimal.Parse(System.String) method on value. A System.String containing a number to convert.
ToDecimal
Converts the value of the specified 16-bit unsigned integer to the equivalent Decimal number.
Return Value: The Decimal number equivalent to the value of value. A 16-bit unsigned integer.
ToDecimal
Converts the value of the specified 32-bit unsigned integer to an equivalent Decimal number.
Return Value: A Decimal number equivalent to the value of value. A 32-bit unsigned integer.
ToDecimal
Converts the value of the specified 64-bit unsigned integer to an equivalent Decimal number.
Return Value: A Decimal number equivalent to the value of value. A 64-bit unsigned integer.
ToDecimal
Converts the value of the specified Object to an Decimal number using the specified culture-specific formatting information.
Return Value: A Decimal number equivalent to the value of value, or zero if value is null
The return value is the result of invoking the IConvertible.ToDecimal method of the underlying type of value. An System.Object that implements the System.IConvertible interface. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToDecimal
Converts the specified String representation of a number to an equivalent Decimal number using the specified culture-specific formatting information.
Return Value: A Decimal number equivalent to the value of value.
The return value is the result of invoking the System.Decimal.Parse(System.String) method on value. A System.String containing a number to convert. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToDouble
Converts the value of the specified Boolean value to the equivalent double-precision floating point number.
Return Value: The number 1 if value is true; otherwise, 0. A Boolean value.
ToDouble
Converts the value of the specified 8-bit unsigned integer to the equivalent double-precision floating point number.
Return Value: The double-precision floating point number equivalent to the value of value. An 8-bit unsigned integer.
ToDouble
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A Unicode character.
ToDouble
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A System.DateTime.
ToDouble
Converts the value of the specified Decimal number to an equivalent double-precision floating point number.
Return Value: A double-precision floating point number equivalent to the value of value. A System.Decimal number.
ToDouble
Returns the specified double-precision floating point number; no actual conversion is performed.
Return Value: value is returned unchanged. A double-precision floating point number.
ToDouble
Converts the value of the specified 16-bit signed integer to an equivalent double-precision floating point number.
Return Value: A double-precision floating point number equivalent to the value of value. A 16-bit signed integer.
ToDouble
Converts the value of the specified 32-bit signed integer to an equivalent double-precision floating point number.
Return Value: A double-precision floating point number equivalent to the value of value. A 32-bit signed integer.
ToDouble
Converts the value of the specified 64-bit signed integer to an equivalent double-precision floating point number.
Return Value: A double-precision floating point number equivalent to the value of value. A 64-bit signed integer.
ToDouble
Converts the value of the specified Object to a double-precision floating point number.
Return Value: A double-precision floating point number equivalent to the value of value, or zero if value is null
The return value is the result of invoking the IConvertible.ToDouble method of the underlying type of value. An System.Object that implements the System.IConvertible interface or null.
ToDouble
Converts the value of the specified 8-bit signed integer to the equivalent double-precision floating point number.
Return Value: The 8-bit signed integer equivalent to the value of value. An 8-bit signed integer.
ToDouble
Converts the value of the specified single-precision floating point number to an equivalent double-precision floating point number.
Return Value: A double-precision floating point number equivalent to the value of value. A single-precision floating point number.
ToDouble
Converts the specified String representation of a number to an equivalent double-precision floating point number.
Return Value: A double-precision floating point number equivalent to the value of value.
The return value is the result of invoking the System.Double.Parse(System.String) method on value. A System.String containing a number to convert.
ToDouble
Converts the value of the specified 16-bit unsigned integer to the equivalent double-precision floating point number.
Return Value: The double-precision floating point number equivalent to the value of value. A 16-bit unsigned integer.
ToDouble
Converts the value of the specified 32-bit unsigned integer to an equivalent double-precision floating point number.
Return Value: A double-precision floating point number equivalent to the value of value. A 32-bit unsigned integer.
ToDouble
Converts the value of the specified 64-bit unsigned integer to an equivalent double-precision floating point number.
Return Value: A double-precision floating point number equivalent to the value of value. A 64-bit unsigned integer.
ToDouble
Converts the value of the specified Object to an double-precision floating point number using the specified culture-specific formatting information.
Return Value: A double-precision floating point number equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToDouble method of the underlying type of value. An System.Object that implements the System.IConvertible interface. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToDouble
Converts the specified String representation of a number to an equivalent double-precision floating point number using the specified culture-specific formatting information.
Return Value: A double-precision floating point number equivalent to the value of value.
The return value is the result of invoking the System.Double.Parse(System.String) method on value. A System.String containing a number to convert. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToInt16
Converts the value of the specified Boolean value to the equivalent 16-bit signed integer.
Return Value: The number 1 if value is true; otherwise, 0. A Boolean value.
ToInt16
Converts the value of the specified 8-bit unsigned integer to the equivalent 16-bit signed integer.
Return Value: The 16-bit signed integer equivalent to the value of value. An 8-bit unsigned integer.
ToInt16
Converts the value of the specified Unicode character to the equivalent 16-bit signed integer.
Return Value: The 16-bit signed integer equivalent to value. A Unicode character.
ToInt16
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A System.DateTime.
ToInt16
Converts the value of the specified Decimal number to an equivalent 16-bit signed integer.
Return Value: 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. A System.Decimal number.
ToInt16
Converts the value of the specified double-precision floating point number to an equivalent 16-bit signed integer.
Return Value: 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. A double-precision floating point number.
ToInt16
Returns the specified 16-bit signed integer; no actual conversion is performed.
Return Value: value is returned unchanged. A 16-bit signed integer.
ToInt16
Converts the value of the specified 32-bit signed integer to an equivalent 16-bit signed integer.
Return Value: The 16-bit signed integer equivalent of value. A 32-bit signed integer.
ToInt16
Converts the value of the specified 64-bit signed integer to an equivalent 16-bit signed integer.
Return Value: A 16-bit signed integer equivalent to the value of value. A 64-bit signed integer.
ToInt16
Converts the value of the specified Object to a 16-bit signed integer.
Return Value: A 16-bit signed integer equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToInt16 method of the underlying type of value. An System.Object that implements the System.IConvertible interface or null.
ToInt16
Converts the value of the specified 8-bit signed integer to the equivalent 16-bit signed integer.
Return Value: The 8-bit signed integer equivalent to the value of value. An 8-bit signed integer. ToInt16
Converts the value of the specified single-precision floating point number to an equivalent 16-bit signed integer.
Return Value: 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. A single-precision floating point number.
ToInt16
Converts the specified String representation of a number to an equivalent 16-bit signed integer.
Return Value: A 16-bit signed integer equivalent to the value of value. A System.String containing a number to convert.
ToInt16
Converts the value of the specified 16-bit unsigned integer to the equivalent 16-bit signed integer.
Return Value: The 16-bit signed integer equivalent to the value of value. A 16-bit unsigned integer.
ToInt16
Converts the value of the specified 32-bit unsigned integer to an equivalent 16-bit signed integer.
Return Value: A 16-bit signed integer equivalent to the value of value. A 32-bit unsigned integer.
ToInt16
Converts the value of the specified 64-bit unsigned integer to an equivalent 16-bit signed integer.
Return Value: A 16-bit signed integer equivalent to the value of value. A 64-bit unsigned integer. ToInt16
Converts the value of the specified Object to a 16-bit signed integer using the specified culture-specific formatting information.
Return Value: A 16-bit signed integer equivalent to the value of value, or zero if value is null.
provider enables the user to specify culture-specific conversion information about the contents of value. For example, if value is a String that represents a number, provider could supply culture-specific information about the notation used to represent that number. An System.Object that implements the System.IConvertible interface. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToInt16
Converts the specified String representation of a number to an equivalent 16-bit signed integer using specified culture-specific formatting information.
Return Value: A 16-bit signed integer equivalent to the value of value.
provider is an IFormatProvider instance that obtains a System.Globalization.NumberFormatInfo object. The NumberFormatInfo object provides culture-specific information about the format of value. If provider is null, the NumberFormatInfo for the current culture is used. A System.String containing a number to convert. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToInt16
Converts the String representation of a number in a specified base to an equivalent 16-bit signed integer.
Return Value: A 16-bit signed integer equivalent to the number in value. A System.String containing a number. The base of the number in value, which must be 2, 8, 10, or 16.
ToInt32
Converts the value of the specified Boolean value to the equivalent 32-bit signed integer.
Return Value: The number 1 if value is true; otherwise, 0. A Boolean value.
ToInt32
Converts the value of the specified 8-bit unsigned integer to the equivalent 32-bit signed integer.
Return Value: The 32-bit signed integer equivalent to the value of value. An 8-bit unsigned integer. ToInt32
Converts the value of the specified Unicode character to the equivalent 32-bit signed integer.
Return Value: The 32-bit signed integer equivalent to value. A Unicode character.
ToInt32
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A System.DateTime.
ToInt32
Converts the value of the specified Decimal number to an equivalent 32-bit signed integer.
Return Value: 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. A System.Decimal number.
ToInt32
Converts the value of the specified double-precision floating point number to an equivalent 32-bit signed integer.
Return Value: 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. A double-precision floating point number.
ToInt32
Converts the value of the specified 16-bit signed integer to an equivalent 32-bit signed integer.
Return Value: A 32-bit signed integer equivalent to the value of value. A 16-bit signed integer.
ToInt32
Returns the specified 32-bit signed integer; no actual conversion is performed.
Return Value: value is returned unchanged. A 32-bit signed integer.
ToInt32
Converts the value of the specified 64-bit signed integer to an equivalent 32-bit signed integer.
Return Value: A 32-bit signed integer equivalent to the value of value. A 64-bit signed integer.
ToInt32
Converts the value of the specified Object to a 32-bit signed integer.
Return Value: A 32-bit signed integer equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToInt32 method of the underlying type of value. An System.Object that implements the System.IConvertible interface or null.
ToInt32
Converts the value of the specified 8-bit signed integer to the equivalent 32-bit signed integer.
Return Value: The 8-bit signed integer equivalent to the value of value. An 8-bit signed integer.
ToInt32
Converts the value of the specified single-precision floating point number to an equivalent 32-bit signed integer.
Return Value: 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. A single-precision floating point number.
ToInt32
Converts the specified String representation of a number to an equivalent 32-bit signed integer.
Return Value: A 32-bit signed integer equivalent to the value of value.
The return value is the result of invoking the System.Int32.Parse(System.String) method on value. A System.String containing a number to convert.
ToInt32
Converts the value of the specified 16-bit unsigned integer to the equivalent 32-bit signed integer.
Return Value: The 32-bit signed integer equivalent to the value of value. A 16-bit unsigned integer.
ToInt32
Converts the value of the specified 32-bit unsigned integer to an equivalent 32-bit signed integer.
Return Value: A 32-bit signed integer equivalent to the value of value. A 32-bit unsigned integer. ToInt32
Converts the value of the specified 64-bit unsigned integer to an equivalent 32-bit signed integer.
Return Value: A 32-bit signed integer equivalent to the value of value. A 64-bit unsigned integer.
ToInt32
Converts the value of the specified Object to a 32-bit signed integer using the specified culture-specific formatting information.
Return Value: A 32-bit signed integer equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToInt32 method of the underlying type of value. An System.Object that implements the System.IConvertible interface. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToInt32
Converts the specified String representation of a number to an equivalent 32-bit signed integer using specified culture-specific formatting information.
Return Value: A 32-bit signed integer equivalent to the value of value.
The return value is the result of invoking the System.Int32.Parse(System.String) method on value. A System.String containing a number to convert. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToInt32
Converts the String representation of a number in a specified base to an equivalent 32-bit signed integer.
Return Value: A 32-bit signed integer equivalent to the number in value. A System.String containing a number. The base of the number in value, which must be 2, 8, 10, or 16.
ToInt64
Converts the value of the specified Boolean value to the equivalent 64-bit signed integer.
Return Value: The number 1 if value is true; otherwise, 0. A Boolean value.
ToInt64
Converts the value of the specified 8-bit unsigned integer to the equivalent 64-bit signed integer.
Return Value: The 64-bit signed integer equivalent to the value of value. An 8-bit unsigned integer.
ToInt64
Converts the value of the specified Unicode character to the equivalent 64-bit signed integer.
Return Value: The 64-bit signed integer equivalent to value. A Unicode character.
ToInt64
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A System.DateTime.
ToInt64
Converts the value of the specified Decimal number to an equivalent 64-bit signed integer.
Return Value: 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. A System.Decimal number.
ToInt64
Converts the value of the specified double-precision floating point number to an equivalent 64-bit signed integer.
Return Value: 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. A double-precision floating point number.
ToInt64
Converts the value of the specified 16-bit signed integer to an equivalent 64-bit signed integer.
Return Value: A 64-bit signed integer equivalent to the value of value. A 16-bit signed integer.
ToInt64
Converts the value of the specified 32-bit signed integer to an equivalent 64-bit signed integer.
Return Value: The 64-bit signed integer equivalent to the value of value. A 32-signed integer.
ToInt64
Returns the specified 64-bit signed integer; no actual conversion is performed.
Return Value: value is returned unchanged. A 64-bit signed integer.
ToInt64
Converts the value of the specified Object to a 64-bit signed integer.
Return Value: A 64-bit signed integer equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToInt64 method of the underlying type of value. An System.Object that implements the System.IConvertible interface or null.
ToInt64
Converts the value of the specified 8-bit signed integer to the equivalent 64-bit signed integer.
Return Value: The 8-bit signed integer equivalent to the value of value. An 8-bit signed integer.
ToInt64
Converts the value of the specified single-precision floating point number to an equivalent 64-bit signed integer.
Return Value: 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. A single-precision floating point number.
ToInt64
Converts the specified String representation of a number to an equivalent 64-bit signed integer.
Return Value: A 64-bit signed integer equivalent to the value of value.
The return value is the result of invoking the System.Int64.Parse(System.String) method on value. A System.String containing a number to convert.
ToInt64
Converts the value of the specified 16-bit unsigned integer to the equivalent 64-bit signed integer.
Return Value: The 64-bit signed integer equivalent to the value of value. A 16-bit unsigned integer.
ToInt64
Converts the value of the specified 32-bit unsigned integer to an equivalent 64-bit signed integer.
Return Value: A 64-bit signed integer equivalent to the value of value. A 32-bit unsigned integer.
ToInt64
Converts the value of the specified 64-bit unsigned integer to an equivalent 64-bit signed integer.
Return Value: A 64-bit signed integer equivalent to the value of value. A 64-bit unsigned integer.
ToInt64
Converts the value of the specified Object to a 64-bit signed integer using the specified culture-specific formatting information.
Return Value: A 64-bit signed integer equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToInt64 method of the underlying type of value. An System.Object that implements the System.IConvertible interface. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToInt64
Converts the specified String representation of a number to an equivalent 64-bit signed integer using the specified culture-specific formatting information.
Return Value: A 64-bit signed integer equivalent to the value of value.
The return value is the result of invoking the System.Int64.Parse(System.String) method on value. A System.String containing a number to convert. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToInt64
Converts the String representation of a number in a specified base to an equivalent 64-bit signed integer.
Return Value: A 64-bit signed integer equivalent to the number in value. A System.String containing a number. The base of the number in value, which must be 2, 8, 10, or 16.
ToSByte
Converts the value of the specified Boolean value to the equivalent 8-bit signed integer.
Return Value: The number 1 if value is true; otherwise, 0. A Boolean value.
ToSByte
Converts the value of the specified 8-bit unsigned integer to the equivalent 8-bit signed integer.
Return Value: The 8-bit signed integer equivalent to the value of value. An 8-bit unsigned integer.
ToSByte
Converts the value of the specified Unicode character to the equivalent 8-bit signed integer.
Return Value: The 8-bit signed integer equivalent to value. A Unicode character.
ToSByte
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A System.DateTime.
ToSByte
Converts the value of the specified Decimal number to an equivalent 8-bit signed integer.
Return Value: 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. A System.Decimal number.
ToSByte
Converts the value of the specified double-precision floating point number to an equivalent 8-bit signed integer.
Return Value: 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. A double-precision floating point number.
ToSByte
Converts the value of the specified 16-bit signed integer to the equivalent 8-bit signed integer.
Return Value: The 8-bit signed integer equivalent to the value of value. A 16-bit signed integer.
ToSByte
Converts the value of the specified 32-bit signed integer to an equivalent 8-bit signed integer.
Return Value: An 8-bit signed integer equivalent to the value of value.
Description
Converts the value of the specified 32-bit signed integer to an equivalent 8-bit signed integer.
Return Value: The 8-bit signed integer equivalent of value. A 32-signed integer.
ToSByte
Converts the value of the specified 64-bit signed integer to an equivalent 8-bit signed integer.
Return Value: An 8-bit signed integer equivalent to the value of value. A 64-bit signed integer.
ToSByte
Converts the value of the specified Object to an 8-bit signed integer.
Return Value: An 8-bit signed integer equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToSByte method of the underlying type of value. An System.Object that implements the System.IConvertible interface or null.
ToSByte
Returns the specified 8-bit signed integer; no actual conversion is performed.
Return Value: value is returned unchanged. An 8-bit signed integer.
ToSByte
Converts the value of the specified single-precision floating point number to an equivalent 8-bit signed integer.
Return Value: 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. A single-precision floating point number.
ToSByte
Converts the specified String representation of a number to an equivalent 8-bit signed integer.
Return Value: An 8-bit signed integer equivalent to the value of value. A System.String containing a number to convert.
ToSByte
Converts the value of the specified 16-bit unsigned integer to the equivalent 8-bit signed integer.
Return Value: The 8-bit signed integer equivalent to the value of value. A 16-bit unsigned integer.
ToSByte
Converts the value of the specified 32-bit unsigned integer to an equivalent 8-bit signed integer.
Return Value: An 8-bit signed integer equivalent to the value of value. A 32-bit unsigned integer.
ToSByte
Converts the value of the specified 64-bit unsigned integer to an equivalent 8-bit signed integer.
Return Value: An 8-bit signed integer equivalent to the value of value. A 64-bit unsigned integer.
ToSByte
Converts the value of the specified Object to an 8-bit signed integer using the specified culture-specific formatting information.
Return Value: An 8-bit signed integer equivalent to the value of value, or zero if value is null.
provider enables the user to specify culture-specific conversion information about the contents of value. For example, if value is a String that represents a number, provider could supply culture-specific information about the notation used to represent that number. An System.Object that implements the System.IConvertible interface. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToSByte
Converts the specified String representation of a number to an equivalent 8-bit signed integer using specified culture-specific formatting information.
Return Value: An 8-bit signed integer equivalent to the value of value.
provider is an IFormatProvider instance that obtains a System.Globalization.NumberFormatInfo object. The NumberFormatInfo object provides culture-specific information about the format of value. If provider is null, the NumberFormatInfo for the current culture is used. A System.String containing a number to convert. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToSByte
Converts the String representation of a number in a specified base to an equivalent 8-bit signed integer.
Return Value: An 8-bit signed integer equivalent to the number in value. A System.String containing a number. The base of the number in value, which must be 2, 8, 10, or 16.
ToSingle
Converts the value of the specified Boolean value to the equivalent single-precision floating point number.
Return Value: The number 1 if value is true; otherwise, 0. A Boolean value.
ToSingle
Converts the value of the specified 8-bit unsigned integer to the equivalent single-precision floating point number.
Return Value: The single-precision floating point number equivalent to the value of value. An 8-bit unsigned integer.
ToSingle
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A Unicode character.
ToSingle
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A System.DateTime.
ToSingle
Converts the value of the specified Decimal number to an equivalent single-precision floating point number.
Return Value: A single-precision floating point number equivalent to the value of value. A System.Decimal number.
ToSingle
Converts the value of the specified double-precision floating point number to an equivalent single-precision floating point number.
Return Value: A single-precision floating point number equivalent to the value of value. A double-precision floating point number.
ToSingle
Converts the value of the specified 16-bit signed integer to an equivalent single-precision floating point number.
Return Value: A single-precision floating point number equivalent to the value of value. A 16-bit signed integer.
ToSingle
Converts the value of the specified 32-bit signed integer to an equivalent single-precision floating point number.
Return Value: A single-precision floating point number equivalent to the value of value. A 32-bit signed integer.
ToSingle
Converts the value of the specified 64-bit signed integer to an equivalent single-precision floating point number.
Return Value: A single-precision floating point number equivalent to the value of value. A 64-bit signed integer.
ToSingle
Converts the value of the specified Object to a single-precision floating point number.
Return Value: A single-precision floating point number equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToSingle method of the underlying type of value. An System.Object that implements the System.IConvertible interface or null.
ToSingle
Converts the value of the specified 8-bit signed integer to the equivalent single-precision floating point number.
Return Value: The 8-bit signed integer equivalent to the value of value. An 8-bit signed integer.
ToSingle
Returns the specified single-precision floating point number; no actual conversion is performed.
Return Value: value is returned unchanged. A single-precision floating point number.
ToSingle
Converts the specified String representation of a number to an equivalent single-precision floating point number.
Return Value: A single-precision floating point number equivalent to the value of value.
The return value is the result of invoking the System.Single.Parse(System.String) method on value. A System.String containing a number to convert.
ToSingle
Converts the value of the specified 16-bit unsigned integer to the equivalent single-precision floating point number.
Return Value: The single-precision floating point number equivalent to the value of value. A 16-bit unsigned integer.
ToSingle
Converts the value of the specified 32-bit unsigned integer to an equivalent single-precision floating point number.
Return Value: A single-precision floating point number equivalent to the value of value. A 32-bit unsigned integer.
ToSingle
Converts the value of the specified 64-bit unsigned integer to an equivalent single-precision floating point number.
Return Value: A single-precision floating point number equivalent to the value of value. A 64-bit unsigned integer.
ToSingle
Converts the value of the specified Object to an single-precision floating point number using the specified culture-specific formatting information.
Return Value: A single-precision floating point number equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToSingle method of the underlying type of value. An System.Object that implements the System.IConvertible interface. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToSingle
Converts the specified String representation of a number to an equivalent single-precision floating point number using the specified culture-specific formatting information.
Return Value: A single-precision floating point number equivalent to the value of value.
The return value is the result of invoking the System.Single.Parse(System.String) method on value. A System.String containing a number to convert. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Converts the value of the specified Boolean to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Boolean.ToString. A Boolean value.
ToString
Converts the value of the specified 8-bit unsigned integer to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Byte.ToString. An 8-bit unsigned integer.
ToString
Converts the value of the specified Unicode character to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Char.ToString. A Unicode character.
ToString
Converts the value of the specified DateTime to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.DateTime.ToString. A DateTime.
ToString
Converts the value of the specified Decimal number to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Decimal.ToString. A Decimal number.
ToString
Converts the value of the specified double-precision floating point number to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Double.ToString. A double-precision floating point number:
ToString
Converts the value of the specified 16-bit signed integer to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Int16.ToString. A 16-bit signed integer.
ToString
Converts the value of the specified 32-bit signed integer to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Int32.ToString. A 32-bit signed integer.
ToString
Converts the value of the specified 64-bit signed integer to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Int64.ToString. A 64-bit signed integer.
ToString
Converts the value of the specified Object to its String representation.
Return Value: The System.String representation of the value of value, or System.String.Empty if value is null.
The return value is the result of invoking the ToString method of the underlying type of value. An System.Object or null.
ToString
Converts the value of the specified 8-bit signed integer to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.SByte.ToString. An 8-bit signed integer.
ToString
Converts the value of the specified single-precision floating point number to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Single.ToString. A single-precision floating point number.
ToString
Returns the specified instance of System.String; no actual conversion is performed.
Return Value: value is returned unchanged. A System.String.
ToString
Converts the value of the specified 16-bit unsigned integer to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.UInt16.ToString. A 16-bit unsigned integer.
ToString
Converts the value of the specified 32-bit unsigned integer to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.UInt32.ToString. A 32-bit unsigned integer.
ToString
Converts the value of the specified 64-bit unsigned integer to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.UInt64.ToString. A 64-bit unsigned integer.
ToString
Converts the value of the specified Boolean to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Boolean.ToString. A Boolean value. (Reserved) An instance of an System.IFormatProvider interface implementation.
ToString
Converts the value of the specified 8-bit unsigned integer to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Byte.ToString. An 8-bit unsigned integer. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Converts the value of an 8-bit unsigned integer to its equivalent String representation in a specified base.
Return Value: The String representation of value in base toBase. An 8-bit unsigned integer. The base of the return value, which must be 2, 8, 10, or 16.
ToString
Converts the value of the specified Unicode character to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Char.ToString. A Unicode character. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Converts the value of the specified DateTime to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.DateTime.ToString. A DateTime. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Converts the value of the specified Decimal number to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Decimal.ToString. A Decimal number. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Converts the value of the specified double-precision floating point number to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Double.ToString. A double-precision floating point number. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Converts the value of the specified 16-bit signed integer to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Int16.ToString. A 16-bit signed integer. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Converts the value of a 16-bit signed integer to its equivalent String representation in a specified base.
Return Value: The String representation of value in base toBase. A 16-bit signed integer. The base of the return value, which must be 2, 8, 10, or 16.
ToString
Converts the value of the specified 32-bit signed integer to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Int32.ToString. A 32-bit signed integer. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Converts the value of a 32-bit signed integer to its equivalent String representation in a specified base.
Return Value: The String representation of value in base toBase. A 32-bit signed integer. The base of the return value, which must be 2, 8, 10, or 16.
ToString
Converts the value of the specified 64-bit signed integer to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Int64.ToString. A 64-bit signed integer. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Converts the value of a 64-bit signed integer to its equivalent String representation in a specified base.
Return Value: The String representation of value in base toBase. A 64-bit signed integer. The base of the return value, which must be 2, 8, 10, or 16.
ToString
Converts the value of the specified Object to its equivalent String representation using the specified culture-specific formatting information.
Return Value: The System.String representation of the value of value, or System.String.Empty if value is null.
provider enables the user to specify culture-specific conversion information about the contents of value. For example, if value is a String that represents a number, provider could supply culture-specific information about the notation used to represent that number. An System.Object or null. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Converts the value of the specified 8-bit signed integer to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.SByte.ToString. An 8-bit signed integer. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Converts the value of the specified single-precision floating point number to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.Single.ToString. A single-precision floating point number. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Returns the specified instance of System.String; no actual conversion is performed.
Return Value: value is returned unchanged.
This method ignores the provider parameter. A System.String. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Converts the value of the specified 16-bit unsigned integer to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.UInt16.ToString. A 16-bit unsigned integer. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Converts the value of the specified 32-bit unsigned integer to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.UInt32.ToString. A 32-bit unsigned integer. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Converts the value of the specified 64-bit unsigned integer to its equivalent String representation.
Return Value: The System.String equivalent of the value of value.
This implementation is identical to System.UInt64.ToString. A 64-bit unsigned integer. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToUInt16
Converts the value of the specified Boolean value to the equivalent 16-bit unsigned integer.
Return Value: The number 1 if value is true; otherwise, 0. A Boolean value.
ToUInt16
Converts the value of the specified 8-bit unsigned integer to the equivalent 16-bit unsigned integer.
Return Value: The 16-bit unsigned integer equivalent to the value of value. An 8-bit unsigned integer.
ToUInt16
Converts the value of the specified Unicode character to the equivalent 16-bit unsigned integer.
Return Value: The 16-bit unsigned integer equivalent to value. A Unicode character.
ToUInt16
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A System.DateTime.
ToUInt16
Converts the value of the specified Decimal number to an equivalent 16-bit unsigned integer.
Return Value: 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. A System.Decimal number.
ToUInt16
Converts the value of the specified double-precision floating point number to an equivalent 16-bit unsigned integer.
Return Value: 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. A double-precision floating point number.
ToUInt16
Converts the value of the specified 16-bit signed integer to the equivalent 16-bit unsigned integer.
Return Value: The 16-bit unsigned integer equivalent to the value of value. A 16-bit signed integer.
ToUInt16
Converts the value of the specified 32-bit signed integer to an equivalent 16-bit unsigned integer.
Return Value: The 16-bit unsigned integer equivalent of value. A 32-bit signed integer.
ToUInt16
Converts the value of the specified 64-bit signed integer to an equivalent 16-bit unsigned integer.
Return Value: A 16-bit unsigned integer equivalent to the value of value. A 64-bit signed integer.
ToUInt16
Converts the value of the specified Object to a 16-bit unsigned integer.
Return Value: A 16-bit unsigned integer equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToUInt16 method of the underlying type of value. An System.Object that implements the System.IConvertible interface or null.
ToUInt16
Converts the value of the specified 8-bit signed integer to the equivalent 16-bit unsigned integer.
Return Value: The 8-bit unsigned integer equivalent to the value of value. An 8-bit signed integer.
ToUInt16
Converts the value of the specified single-precision floating point number to an equivalent 16-bit unsigned integer.
Return Value: 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. A single-precision floating point number.
ToUInt16
Converts the specified String representation of a number to an equivalent 16-bit unsigned integer.
Return Value: A 16-bit unsigned integer equivalent to the value of value.
The return value is the result of invoking System.UInt16.Parse(System.String) on value. A System.String containing a number to convert.
ToUInt16
Returns the specified 16-bit unsigned integer; no actual conversion is performed.
Return Value: value is returned unchanged. A 16-bit unsigned integer.
ToUInt16
Converts the value of the specified 32-bit unsigned integer to an equivalent 16-bit unsigned integer.
Return Value: A 16-bit unsigned integer equivalent to the value of value. A 32-bit unsigned integer.
ToUInt16
Converts the value of the specified 64-bit unsigned integer to an equivalent 16-bit unsigned integer.
Return Value: A 16-bit unsigned integer equivalent to the value of value. A 64-bit unsigned integer.
ToUInt16
Converts the value of the specified Object to a 16-bit unsigned integer using the specified culture-specific formatting information.
Return Value: A 16-bit unsigned integer equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToUInt16 method of the underlying type of value. An System.Object that implements the System.IConvertible interface. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToUInt16
Converts the specified String representation of a number to an equivalent 16-bit unsigned integer using specified culture-specific formatting information.
Return Value: A 16-bit unsigned integer equivalent to the value of value.
The return value is the result of invoking System.UInt16.Parse(System.String) on value. A System.String containing a number to convert. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToUInt16
Converts the String representation of a number in a specified base to an equivalent 16-bit unsigned integer.
Return Value: A 16-bit unsigned integer equivalent to the number in value. A System.String containing a number. The base of the number in value, which must be 2, 8, 10, or 16.
ToUInt32
Converts the value of the specified Boolean value to the equivalent 32-bit unsigned integer.
Return Value: The number 1 if value is true; otherwise, 0. A Boolean value. ToUInt32
CONVERTS the value of the specified 8-bit unsigned integer to the equivalent 32-bit signed integer.
Return Value: The 32-bit signed integer equivalent to the value of value. An 8-bit unsigned integer.
ToUInt32
Converts the value of the specified Unicode character to the equivalent 32-bit unsigned integer.
Return Value: The 32-bit unsigned integer equivalent to value. A Unicode character.
ToUInt32
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A System.DateTime.
ToUInt32
Converts the value of the specified Decimal number to an equivalent 32-bit unsigned integer.
Return Value: 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. A System.Decimal number.
ToUInt32
Converts the value of the specified double-precision floating point number to an equivalent 32-bit unsigned integer.
Return Value: 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. A double-precision floating point number.
ToUInt32
Converts the value of the specified 16-bit signed integer to the equivalent 32-bit unsigned integer.
Return Value: The 32-bit unsigned integer equivalent to the value of value. A 32-bit signed integer.
ToUInt32
Converts the value of the specified 32-bit signed integer to an equivalent 32-bit unsigned integer.
Return Value: The 32-bit unsigned integer equivalent of value. A 32-bit signed integer.
ToUInt32
Converts the value of the specified 64-bit signed integer to an equivalent 32-bit unsigned integer.
Return Value: A 32-bit unsigned integer equivalent to the value of value. A 64-bit signed integer.
ToUInt32
Converts the value of the specified Object to a 32-bit unsigned integer.
Return Value: A 32-bit unsigned integer equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToUInt32 method of the underlying type of value. An System.Object that implements the System.IConvertible interface or null.
ToUInt32
Converts the value of the specified 8-bit signed integer to the equivalent 32-bit unsigned integer.
Return Value: The 8-bit unsigned integer equivalent to the value of value. An 8-bit signed integer.
ToUInt32
Converts the value of the specified single-precision floating point number to an equivalent 32-bit unsigned integer.
Return Value: 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. A single-precision floating point number.
ToUInt32
Converts the specified String representation of a number to an equivalent 32-bit signed integer.
Return Value: A 32-bit signed integer equivalent to the value of value.
The return value is the result of invoking the System.Int32.Parse(System.String) method on value. A System.String containing a number to convert.
ToUInt32
Converts the value of the specified 16-bit unsigned integer to the equivalent 32-bit unsigned integer.
Return Value: The 32-bit unsigned integer equivalent to the value of value. A 32-bit signed integer.
ToUInt32
Returns the specified 32-bit unsigned integer; no actual conversion is performed.
Return Value: value is returned unchanged. A 32-bit unsigned integer.
ToUInt32
Converts the value of the specified 64-bit unsigned integer to an equivalent 32-bit unsigned integer.
Return Value: A 32-bit unsigned integer equivalent to the value of value. A 64-bit unsigned integer.
ToUInt32
Converts the value of the specified Object to a 32-bit unsigned integer using the specified culture-specific formatting information.
Return Value: A 32-bit unsigned integer equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToUInt32 method of the underlying type of value. An System.Object that implements the System.IConvertible interface. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToUInt32
Converts the specified String representation of a number to an equivalent 32-bit unsigned integer using the specified culture-specific formatting information.
Return Value: A 32-bit unsigned integer equivalent to the value of value.
The return value is the result of invoking System.UInt32.Parse(System.String) on value. A System.String containing a number to convert. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToUInt32
Converts the String representation of a number in a specified base to an equivalent 32-bit unsigned integer.
Return Value: A 32-bit unsigned integer equivalent to the number in value. A System.String containing a number. The base of the number in value, which must be 2, 8, 10, or 16.
ToUInt64
Converts the value of the specified Boolean value to the equivalent 64-bit unsigned integer.
Return Value: The number 1 if value is true; otherwise, 0. A Boolean value.
ToUInt64
Converts the value of the specified 8-bit unsigned integer to the equivalent 64-bit signed integer.
Return Value: The 64-bit signed integer equivalent to the value of value. An 8-bit unsigned integer.
ToUInt64
Converts the value of the specified Unicode character to the equivalent 64-bit unsigned integer.
Return Value: The 64-bit unsigned integer equivalent to value. A Unicode character.
ToUInt64
Calling this method always throws System.InvalidCastException.
This method is reserved for future use. A System.DateTime.
ToUInt64
Converts the value of the specified Decimal number to an equivalent 64-bit unsigned integer.
Return Value: 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. A System.Decimal number.
ToUInt64
Converts the value of the specified double-precision floating point number to an equivalent 64-bit unsigned integer.
Return Value: 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. A double-precision floating point number.
ToUInt64
Converts the value of the specified 16-bit signed integer to the equivalent 64-bit unsigned integer.
Return Value: The 64-bit unsigned integer equivalent to the value of value. A 64-bit signed integer.
ToUInt64
Converts the value of the specified 32-bit signed integer to an equivalent 64-bit unsigned integer.
Return Value: The 64-bit unsigned integer equivalent of value. A 32-bit signed integer.
ToUInt64
Converts the value of the specified 64-bit signed integer to an equivalent 64-bit unsigned integer.
Return Value: A 64-bit unsigned integer equivalent to the value of value. A 64-bit signed integer.
ToUInt64
Converts the value of the specified Object to a 64-bit unsigned integer.
Return Value: A 64-bit unsigned integer equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToUInt64 method of the underlying type of value. An System.Object that implements the System.IConvertible interface or null.
ToUInt64
Converts the value of the specified 8-bit signed integer to the equivalent 64-bit unsigned integer.
Return Value: The 8-bit unsigned integer equivalent to the value of value. An 8-bit signed integer.
ToUInt64
Converts the value of the specified single-precision floating point number to an equivalent 64-bit unsigned integer.
Return Value: 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. A single-precision floating point number. ToUInt64
Converts the specified String representation of a number to an equivalent 64-bit signed integer.
Return Value: A 64-bit signed integer equivalent to the value of value.
The return value is the result of invoking the System.Int64.Parse(System.String) method on value. A System.String containing a number to convert.
ToUInt64
Converts the value of the specified 16-bit unsigned integer to the equivalent 64-bit unsigned integer.
Return Value: The 64-bit unsigned integer equivalent to the value of value. A 16-bit unsigned integer.
ToUInt64
Converts the value of the specified 32-bit unsigned integer to an equivalent 64-bit unsigned integer.
Return Value: The 64-bit unsigned integer equivalent of value. A 32-bit unsigned integer.
ToUInt64
Returns the specified 64-bit unsigned integer; no actual conversion is performed.
Return Value: value is returned unchanged. A 64-bit unsigned integer.
ToUInt64
Converts the value of the specified Object to a 64-bit unsigned integer using the specified culture-specific formatting information.
Return Value: A 64-bit unsigned integer equivalent to the value of value, or zero if value is null.
The return value is the result of invoking the IConvertible.ToUInt64 method of the underlying type of value. An System.Object that implements the System.IConvertible interface. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToUInt64
Converts the specified String representation of a number to an equivalent 64-bit unsigned integer using the specified culture-specific formatting information.
Return Value: A 64-bit unsigned integer equivalent to the value of value.
The return value is the result of invoking System.UInt64.Parse(System.String) on value. A System.String containing a number to convert. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToUInt64
Converts the String representation of a number in a specified base to an equivalent 64-bit unsigned integer.
Return Value: A 64-bit unsigned integer equivalent to the number in value. A System.String containing a number. The base of the number in value, which must be 2, 8, 10, or 16.
CrossAppDomainDelegate delegate (System)
ToUInt64
Description
Used by System.AppDomain.DoCallBack(System.CrossAppDomainDelegate) for cross-application domain calls.
Every derived class of System.Delegate and System.MulticastDelegate has a constructor and an Invoke method. See the Managed Extensions for C++ code example given in the description for System.Delegate.
DateTime structure (System)
ToUInt64
Description
Represents an instant in time, typically expressed as a date and time of day.
The DateTime value type represents dates and times with values ranging from 12:00:00 AM, 1/1/0001 CE (Common Era) to 11:59:59 PM, 12/31/9999 CE.
ToUInt64
A constant representing the largest possible value of DateTime.
The value of this constant is 11:59:59 PM, 12/31/9999 CE.
ToUInt64
A constant representing the smallest possible value of DateTime.
The value of this constant is 12:00:00 AM, 1/1/0001 CE.
DateTime
Example Syntax:
ToUInt64
Initializes a new instance of the DateTime structure to a specified number of ticks. A date and time expressed in 100-nanosecond units.
DateTime
Example Syntax:
ToUInt64
Initializes a new instance of the DateTime structure to the specified year, month, and day.
The time of day for the resulting DateTime is midnight. The year (1 through 9999). The month (1 through 12). The day (1 through the number of days in month).
DateTime
Example Syntax:
ToUInt64
Initializes a new instance of the DateTime structure to the specified year, month, and day for the specified calendar.
The time of day for the resulting DateTime is midnight. The year (1 through 9999). The month (1 through the number of months in calendar). The day (I through the number of days in month). The calendar which applies to this DateTime.
DateTime
Example Syntax:
ToUInt64
Initializes a new instance of the DateTime structure to the specified year, month, day, hour, minute, and second. The year (1 through 9999) The month (1 through 12) The day (1 through the number of days in month) The hours (O through 23) The minutes (O through 59) The seconds (O through 59)
DateTime
Example Syntax:
ToUInt64
Initializes a new instance of the DateTime structure to the specified year, month, day, hour, minute, and second for the specified calendar.
The time of day for the resulting DateTime is midnight. The year (1 through 9999) The month (1 through the number of months in calendar) The day (1 through the number of days in month) The hours (0 through 23) The minutes (0 through 59) The seconds (O through 59) The calendar which applies to this DateTime
DateTime
Example Syntax:
ToUInt64
Initializes a new instance of the DateTime structure to the specified year, month, day, hour, minute, second, and millisecond. The year (1 through 9999) The month (1 through 12) The day (1 through the number of days in month) The hours (0 through 23) The minutes (0 through 59) The seconds (0 through 59) The milliseconds
DateTime
Example Syntax:
ToUInt64
Initializes a new instance of the DateTime structure to the specified year, month, day, hour, minute, second, and millisecond for the specified calendar.
The time of day for the resulting DateTime is midnight. The year (1 through 9999) The month (1 through the number of months in calendar) The day (I through the number of days in month) The hours (0 through 23) The minutes (0 through 59) The seconds (0 through 59) The milliseconds The calendar which applies to this System.DateTime
Date
ToUInt64
Gets the date component of this instance.
Day
ToUInt64
Gets the day of the month represented by this instance.
DayOfWeek
ToUInt64
Gets the day of the week represented by this instance.
DayOfYear
ToUInt64
Gets the day of the year represented by this instance.
Hour
ToUInt64
Gets the hour component of the date represented by this instance.
Millisecond
ToUInt64
Gets the milliseconds component of the date represented by this instance.
Minute
ToUInt64
Gets the minute component of the date represented by this instance.
Month
ToUInt64
Gets the month component of the date represented by this instance.
Now
ToUInt64
Gets a DateTime that is the current local time on this computer.
The resolution of this property depends on the system timer.
Second
ToUInt64
Retrieves the seconds component of the date represented by this instance.
Ticks
ToUInt64
Gets the number of 100-nanosecond ticks that represent the date and time of this instance.
The value of this property is the number of 100-nanosecond intervals that have elapsed since 1/1/0001, 12:00 am.
TimeOfDay
ToUInt64
Gets the time of day for this instance.
Today
ToUInt64
Gets the current date.
UtcNow
ToUInt64
Gets a DateTime that is the current local time on this computer expressed as the coordinated universal time (UTC).
The resolution of this property depends on the system timer.
Year
ToUInt64
Gets the year component of the date represented by this instance.
Add
Adds the value of the specified TimeSpan instance to the value of this instance.
Return Value: A DateTime whose value is the sum of the date and time represented by this instance and the time interval represented by value.
This method does not change the value of this DateTime instance. Instead, a new DateTime instance is returned whose value is the result of this operation. A time interval.
AddDays
Adds the specified number of days to the value of this instance.
Return Value: A DateTime whose value is the sum of the date and time represented by this instance and the number of days represented by value.
This method does not change the value of this DateTime instance. Instead, a new DateTime instance is returned whose value is the result of this operation. A number of whole and fractional days.
AddHours
Adds the specified number of hours to the value of this instance.
Return Value: A DateTime whose value is the sum of the date and time represented by this instance and the number of hours represented by value.
This method does not change the value of this DateTime instance. Instead, a new DateTime instance is returned whose value is the result of this operation. A number of whole and fractional hours.
AddMilliseconds
Adds the specified number of milliseconds to the value of this instance.
Return Value: A DateTime whose value is the sum of the date and time represented by this instance and the number of milliseconds represented by value.
This method does not change the value of this DateTime instance. Instead, a new DateTime instance is returned whose value is the result of this operation. A number of milliseconds.
AddMinutes
Adds the specified number of minutes to the value of this instance.
Return Value: A DateTime whose value is the sum of the date and time represented by this instance and the number of minutes represented by value.
This method does not change the value of this DateTime instance. Instead, a new DateTime instance is returned whose value is the result of this operation. A number of whole and fractional minutes.
AddMonths
Adds the specified number of months to the value of this instance.
Return Value: A DateTime whose value is the sum of the date and time represented by this instance and months.
This method does not change the value of this DateTime instance. Instead, a new DateTime instance is returned whose value is the result of this operation. A number of months.
AddSeconds
Adds the specified number of seconds to the value of this instance.
Return Value: A DateTime whose value is the sum of the date and time represented by this instance and the number of seconds represented by value.
This method does not change the value of this DateTime instance. Instead, a new DateTime instance is returned whose value is the result of this operation. A number of whole and fractional seconds.
AddTicks
Adds the specified number of ticks to the value of this instance.
Return Value: A DateTime whose value is the sum of the date and time represented by this instance and the time represented by value.
This method does not change the value of this DateTime instance. Instead, a new DateTime instance is returned whose value is the result of this operation. A number of 100-nanosecond ticks.
AddYears
Adds the specified number of years to the value of this instance.
Return Value: A DateTime whose value is the sum of the date and time represented by this instance and the number of years represented by value.
This method does not change the value of this DateTime instance. Instead, a new DateTime instance is returned whose value is the result of this operation. A number of years.
Compare
Compares two instances of DateTime and returns an indication of their relative values.
Return Value: A signed number indicating the relative values of t1 and t2. The first DateTime. The second DateTime.
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: A signed number indicating the relative values of this instance and value.
Any instance of DateTime, regardless of its value, is considered greater than null. An object to compare, or null.
DaysInMonth
Returns the number of days in the specified month of the specified year.
Return Value: The number of days in month for the specified year. The year. The month (a number ranging from 1 to 12).
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if value is an instance of DateTime and equals the value of this instance; otherwise, false. An object to compare with this instance.
Equals
Returns a value indicating whether two instances of System.DateTime are equal.
Return Value: true if the two DateTime values are equal; otherwise, false. The first DateTime. The second DateTime.
FromFileTime
DateTime
Returns a DateTime equivalent to the specified operating system file timestamp.
Return Value: A DateTime value representing the date and time of fileTime, adjusted to local time.
fileTime is a 64-bit signed integer value representing a Windows file timestamp. The timestamp is the number of 100-nanosecond intervals that have elapsed since 1/1/1601 12:00 AM coordinated universal time (UTC). A Windows file time.
FromOADate
Returns a DateTime equivalent to the specified OLE Automation Date.
Return Value: A DateTime that represents the same date and time as d.
d must be a value between negative 657435.0 through positive 2958466.0. It is stored as a double-precision floating point number. An OLE Automation Date value.
GetDateTimeFormats
Converts the value of this instance to all of the String representations supported by the standard DateTime format specifiers.
Return Value: A String array where each element is the representation of the value of this instance formatted with one of the standard DateTime formatting specifiers.
Each element of the return value is formatted using information from the current culture. For more information about culture-specific formatting information for the current culture, see System.Globalization.CultureInfo.CurrentCulture.
GetDateTimeFormats
Converts the value of this instance to all of the String representations supported by the specified standard DateTime format specifier.
Return Value: A String array where each element is the representation of the value of this instance formatted with the format standard DateTime formatting specifier.
Each element of the return value is formatted using information from the current culture. For more information about culture-specific formatting information for the current culture, see System.Globalization.CultureInfo.CurrentCulture. A Unicode character containing a format specifier.
GetDateTimeFormats
Converts the value of this instance to all of the String representations supported by the standard DateTime format specifiers and the specified culture-specific formatting information.
Return Value: A String array where each element is the representation of the value of this instance formatted with one of the standard DateTime formatting specifiers.
Each element of the return value is formatted using culture-specific information supplied by provider. An System.IFormatProvider interface implementation that supplies culture-specific formatting information about this instance.
GetDateTimeFormats
Converts the value of this instance to all of the String representations supported by the specified standard DateTime format specifier and culture-specific formatting information.
Return Value: A String array where each element is the representation of the value of this instance formatted with one of the standard DateTime formatting specifiers.
Each element of the return value is formatted using culture-specific information supplied by provider. A Unicode character containing a format specifier. An System.IFormatProvider interface implementation that supplies culture-specific formatting information about this instance.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
GetTypeCode
Returns the TypeCode for value type DateTime.
Return Value: The enumerated constant, System.TypeCode.DateTime.
IsLeapYear
Returns an indication whether the specified year is a leap year.
Return Value: true if the year is a leap year; otherwise, false.
year is specified as a 4-digit base 10 number; for example, 1996. A 4-digit year.
op_Addition
Adds a specified time interval to a specified date and time, yielding a new date and time.
Return Value: A DateTime that is the sum of the values of d and t. A date and time. A time interval.
op_Equality
Determines whether two specified instances of DateTime are equal.
Return Value: true if d1 and d2 represent the same date and time; otherwise, false. A DateTime. A DateTime.
op_GreaterThan
Determines whether one specified DateTime is greater than another specified DateTime.
Return Value: true if t1 is greater than t2; otherwise, false. A DateTime. A DateTime.
op_GreaterThanOrEqual
Determines whether one specified DateTime is greater than or equal to another specified DateTime.
Return Value: true if t1 is greater than or equal to t2; otherwise, false. A DateTime. A DateTime.
op_Inequality
Determines whether two specified instances of DateTime are not equal.
Return Value: true if d1 and d2 do not represent the same date and time; otherwise, false. A DateTime. A DateTime.
op_LessThan
Determines whether one specified DateTime is less than another specified DateTime.
Return Value: true if t1 is less than t2; otherwise, false. A DateTime. A DateTime.
op_LessThanOrEqual
Determines whether one specified DateTime is less than or equal to another specified DateTime.
Return Value: true if t1 is less than or equal to t2; otherwise, false. A DateTime. A DateTime.
op_Subtraction
Subtracts a specified date and time from another specified date and time, yielding a time interval.
Return Value: A System.TimeSpan that is the time interval between d1 and d2; that is, d1 minus d2. A DateTime (the minuend). A DateTime (the subtrahend).
op_Subtraction
Subtracts a specified time interval from a specified date and time, yielding a new date and time.
Return Value: A DateTime whose value is the value of d minus the value of t.
This method subtracts the ticks values of t from the ticks value of d. A DateTime. A System.TimeSpan.
Parse
Converts the specified String representation of a date and time to its DateTime equivalent.
Return Value: A DateTime equivalent to the date and time contained in s.
This method attempts to parse s completely and avoid throwing FormatException. It ignores unrecognized data if possible and fills in missing month, day, and year information with the current time. A System.String containing a date and time to convert.
Parse
Converts the specified String representation of a date and time to its DateTime equivalent using the specified culture-specific format information.
Return Value: A DateTime equivalent to the date and time contained in s as specified by provider.
This method attempts to parse s completely and avoid throwing FormatException. It ignores unrecognized data if possible and fills in missing month, day, and year information with the current time. A System.String containing a date and time to convert. An System.IFormatProvider object that supplies culture-specific format information about s.
Parse
Converts the specified String representation of a date and time to its DateTime equivalent using the specified culture-specific format information and formatting style.
Return Value: A DateTime equivalent to the date and time contained in s as specified by provider and styles.
This method attempts to parse s completely and avoid throwing FormatException. It ignores unrecognized data if possible and fills in missing month, day, and year information with the current time. A System.String containing a date and time to convert. An System.IFormatProvider interface implementation that supplies culture-specific formatting information about s. The combination of one or more System.Globalization.DateTimeStyles constants that indicate the permitted format of s.
ParseExact
Converts the specified String representation of a date and time to its DateTime equivalent using the specified format and culture-specific format information. The format of the String representation must match the specified format exactly.
Return Value: A DateTime equivalent to the date and time contained in s as specified by format and provider.
This method throws FormatException if the format of s is not exactly as specified by the format pattern in format. If format consists of a single standard format character, the format pattern that character represents is used. For more information, see the System.Globalization.DateTimeFormatInfo topic. A System.String containing a date and time to convert. The expected format of s. An System.IFormatProvider object that supplies culture-specific format information about s.
ParseExact
Converts the specified String representation of a date and time to its DateTime equivalent using the specified format, culture-specific format information, and style. The format of the String representation must match the specified format exactly.
Return Value: A DateTime equivalent to the date and time contained in s as specified by format, provider, and style.
This method throws FormatException if the format of s is not exactly as specified by the format pattern in format. If format consists of a single standard format character, the format pattern that character represents is used. For more information, see the System.Globalization.DateTimeFormatInfo topic. A System.String containing a date and time to convert. The expected format of s. An System.IFormatProvider interface implementation that supplies culture-specific formatting information about s. The combination of one or more System.Globalization.DateTimeStylesconstants that indicate the permitted format of s.
ParseExact
Converts the specified String representation of a date and time to its 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.
Return Value: A DateTime equivalent to the date and time contained in s as specified by formats, provider, and style.
This method throws FormatException if the format of s is not exactly as specified by at least one of the format patterns in formats. If an element of formats consists of a single standard format character, the format pattern that character represents is used. For more information, see the System.Globalization.DateTimeFormatInfo topic. A System.String containing one or more dates and times to convert. An array of expected formats of s. An System.IFormatProvider object that supplies culture-specific format information about s. The combination of one or more System.Globalization.DateTimeStylesconstants that indicate the permitted format of s.
Subtract
Subtracts the specified date and time from this instance.
Return Value: A System.TimeSpan interval equal to the date and time represented by this instance minus the date and time represented by value.
This method does not change the value of this DateTime instance. Instead, a new TimeSpan instance is returned whose value is the result of this operation. A instance of DateTime.
Subtract
Subtracts the specified TimeSpan from this instance.
Return Value: A new DateTime equal to the date and time represented by this instance minus time interval, value
This method does not change the value of this DateTime instance. Instead, a new DateTime instance is returned whose value is the result of this operation. An instance of System.TimeSpan.
IConvertible.ToBoolean
IConvertible.ToByte
IConvertible.ToChar
IConvertible.ToDateTime
IConvertible.ToDecimal
IConvertible.ToInt16
IConvertible.ToInt32
IConvertible.ToInt64
IConvertible.ToSByte
IConvertible.ToSingle
IConvertible.ToType
IConvertible.ToUInt16
IConvertible.ToUInt32
IConvertible.ToUInt64
ToFileTime
Converts the value of this instance to the format of the local system file time.
Return Value: The value of this DateTime in the format of the local system file time.
A system file time is a 64-bit unsigned value representing the date and time as the number of 100-nanosecond intervals that have elapsed since 111/1601 12:00 AM.
ToLocalTime
Converts the current coordinated universal time (UTC) to local time.
Return Value: The DateTime equivalent to the current UTC time, adjusted to the local time zone and daylight saving time.
This method always uses the local time zone when making calculations.
ToLongDateString
Converts the date denoted by this instance to its equivalent long date String representation.
Return Value: A String containing the name of the day of the week, the name of the month, the numeric day of the month, and the year equivalent to the date value of this instance.
The value of this instance is formatted using the long date format character, ‘D’.
ToLongTimeString
Converts the time denoted by this instance to its equivalent long time String representation.
Return Value: A String containing the name of the day of the week, the name of the month, the numeric day of the hours, minutes, and seconds equivalent to the time value of this instance.
The value of this instance is formatted using the long time format character, ‘T’.
ToOADate
Converts the value of this instance to the equivalent OLE Automation date.
Return Value: A double-precision floating point number that contains an OLE Automation date equivalent to the value of this instance.
An OLE Automation date is implemented as a floating-point number whose value is the number of days from midnight, 30 Dec. 1899. For example, midnight, 31 Dec. 1899 is represented by 1.0; 6 AM, 1 Jan. 1900 is represented by 2.25; midnight, 29 Dec. 1899 represented by −1.0; and 6 AM, 29 Dec. 1899 represented by −1.25.
ToShortDateString
Converts the date denoted by this instance to its equivalent short date String representation.
Return Value: A String containing the numeric month, the numeric day of the month, and the year equivalent to the date value of this instance.
The value of this instance is formatted using the short date format character, ‘d’.
ToShortTimeString
Converts the time denoted by this instance to its equivalent short time String representation.
Return Value: A String containing the name of the day of the week, the name of the month, the numeric day of the hours, minutes, and seconds equivalent to the time value of this instance.
The value of this instance is formatted using the short time format character, ‘t’.
ToString
Converts the value of this instance to its equivalent String.
Return Value: A String representation of value of this instance.
The value of this instance is formatted using the general format specifier, ‘G’, as described in the topic. The return value is of the following form: MM/dd/yyyy HH:mm:ss The items in the return value are as follows.
ToString
Converts the value of this instance to its equivalent String representation using the specified culture-specific format information.
Return Value: A String representation of value of this instance as specified by provider.
This instance is formatted with the general format specifier, ‘G’. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Converts the value of this instance to its equivalent String representation using the specified format.
Return Value: A String representation of value of this instance as specified by format.
The format parmeter should contain either a format specifier character or a custom format pattern. For more information, see the summary page for System.Globalization.DateTimeFormatInfo. A format string.
ToString
Converts the value of this instance to its equivalent String representation using the specified format and culture-specific format information.
Return Value: A String representation of value of this instance as specified by format and provider.
The format parameter should contain either a format specifier character or a custom format pattern. For more information, see the summary page for System.Globalization.DateTimeFormatInfo. A format string. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToUniversalTime
Converts the current local time to coordinated universal time (UTC).
Return Value: The UTC DateTime equivalent to the current local time.
The UTC time is equal to the local time minus the UTC offset. For more information about the UTC offset, see System.TimeZone.GetUtcOffset(System.DateTime).
DayOfWeek enumeration (System)
ToUniversalTime
Description
Specifies the day of the week.
The DayOfWeek enumeration represents the day of the week in calendars that have seven days per week. This enumeration ranges from zero, indicating Sunday, to six, indicating Saturday.
ToUniversalTime
Indicates Friday.
ToUniversalTime
Indicates Monday.
ToUniversalTime
Indicates Saturday.
ToUniversalTime
Indicates Sunday.
ToUniversalTime
Indicates Thursday.
ToUniversalTime
Indicates Tuesday.
ToUniversalTime
Indicates Wednesday.
DBNull class (System)
ToString
Description
Represents a null value.
This class is used to indicate the absence of a known value, typically in a database application.
ToString
Represents the sole instance of the System.DBNull class.
System.DBNull is a singleton class, which means only this instance of this class can exist.
GetObjectData
Implements the System.Runtime.Serialization.ISerializable interface and returns the data needed to serialize the System.DBNull object. A System.Runtime.Serialization.SerializationInfo object containing information required to serialize the System.DBNull object. A System.Runtime.Serialization.StreamingContext object containing the source and destination of the serialized stream associated with the System.DBNull object.
GetTypeCode
Gets the System.TypeCode value for System.DBNull.
Return Value: The System.TypeCode value for System.DBNull, which is System.TypeCode.DBNull.
IConvertible.ToBoolean
IConvertible.ToByte
IConvertible.ToChar
IConvertible.ToDateTime
IConvertible.ToDecimal
IConvertible.ToDouble
IConvertible.ToInt16
IConvertible.ToInt32
IConvertible.ToInt64
IConvertible.ToSByte
IConvertible.ToSingle
IConvertible.ToType
IConvertible.ToUInt16
IConvertible.ToUInt32
IConvertible.ToUInt64
ToString
Returns an empty string (System.String.Empty).
Return Value: An empty string (System.String.Empty).
ToString
Returns an empty string using the specified System.IFormatProvider
Return Value: An empty string (System.String.Empty). The System.IFormatProvider to be used to format the string.
Decimal structure (System)
ToString
Description
Represents a decimal number.
The Decimal value type represents decimal numbers ranging from positive 79,228,162,514,264,337,593,543,950,335 to negative 79,228,162,514,264,337,593,543,950,335. The Decimal value type is appropriate for financial calculations requiring large numbers of significant integral and fractional digits and no round-off errors.
ToString
A constant representing the largest possible value of Decimal The value of this constant is positive 79,228,162,514,264,337,593,543,950,335.
ToString
A constant representing the number, negative one.
ToString
A constant representing the smallest possible value of Decimal.
The value of this constant is negative 79,228,162,514,264,337,593,543,950,335.
ToString
A constant representing the number, one.
ToString
A constant representing the number, zero.
Decimal
Example Syntax:
ToString
Initializes a new instance of Decimal to the value of the specified double-precision floating point number. The value to represent as a Decimal.
Decimal
Example Syntax:
ToString
Initializes a new instance of Decimal to the value of the specified 32-bit signed integer. The value to represent as a Decimal.
Decimal
Example Syntax:
ToString
Initializes a new instance of Decimal to a decimal value represented in binary and contained in a specified array.
The binary representation of a Decimal number consists of a 1-bit sign, a 96-bit integer number, and a scaling factor used to divide the integer number and specify what portion of it is a decimal fraction. The scaling factor is implicitly the number 10, raised to an exponent ranging from 0 to 28. An array of 32-bit signed integers containing a representation of a decimal value.
Decimal
Example Syntax:
ToString
Initializes a new instance of Decimal to the value of the specified 64-bit signed integer. The value to represent as a Decimal.
Decimal
Example Syntax:
ToString
Initializes a new instance of Decimal to the value of the specified single-precision floating point number. The value to represent as a Decimal.
Decimal
Example Syntax:
ToString
Initializes a new instance of Decimal to the value of the specified 32-bit unsigned integer. The value to represent as a Decimal.
Decimal
Example Syntax:
ToString
Initializes a new instance of Decimal to the value of the specified 64-bit unsigned integer. The value to represent as a Decimal.
Decimal
Example Syntax:
ToString
Initializes a new instance of Decimal from parameters specifying the instance's constituent parts.
The binary representation of a Decimal number consists of a 1-bit sign, a 96-bit integer number, and a scaling factor used to divide the integer number and specify what portion of it is a decimal fraction. The scaling factor is implicitly the number 10, raised to an exponent ranging from 0 to 28. The low 32 bits of a 96-bit integer. The middle 32 bits of a 96-bit integer. The high 32 bits of a 96-bit integer. The sign; 1 is negative, 0 is positive. A power of 10 ranging from 0 to 28.
Add
Adds two specified Decimal values.
Return Value: A Decimal value that is the sum of d1 and d2. A Decimal. A Decimal.
Compare
Compares two specified Decimal values.
Return Value: A signed number indicating the relative values of d1 and d2. A Decimal. A Decimal.
CompareTo
Compares this instance to a specified Object.
Return Value: A signed number indicating the relative values of this instance and value.
Any instance of Decimal, regardless of its value, is considered greater than null. An System.Object or null.
Divide
Divides two specified Decimal values.
Return Value: The Decimal that is the result of dividing d1 by d2. A Decimal (the dividend). A Decimal (the divisor).
Equals
Returns a value indicating whether this instance and a specified Object are equal.
Return Value: true if value is a Decimal and equal to this instance; otherwise, false. An System.Object.
Equals
Returns a value indicating whether two specified instances of Decimal are equal.
Return Value: true if d1 and d2 are equal; otherwise, false. A Decimal. A Decimal.
Floor
Rounds a specified Decimal number to the next lower whole number.
Return Value: If d has a fractional part, the next whole Decimal number towards negative infinity that is less than d.—or—If d doesn't have a fractional part, d is returned unchanged. A Decimal.
FromOACurrency
Converts the specified 64-bit signed integer, which contains an OLE Automation Currency value, to the equivalent Decimal value.
Return Value: A Decimal that contains the equivalent of cy. An OLE Automation Currency value.
GetBits
Converts the value of a specified instance of Decimal to its equivalent binary representation, and returns that representation in an array of 32-bit signed integers.
Return Value: A 32-bit integer array with four elements that contain the binary representation of d.
The binary representation of a Decimal number consists of a 1-bit sign, a 96-bit integer number, and a scaling factor used to divide the integer number and specify what portion of it is a decimal fraction. The scaling factor is implicitly the number 10, raised to an exponent ranging from 0 to 28. A Decimal value.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
GetTypeCode
Returns the TypeCode for value type Decimal.
Return Value: The enumerated constant, System.TypeCode.Decimal.
Multiply
Multiplies two specified Decimal values.
Return Value: A Decimal that is the result of multiplying d1 and d2. A Decimal (the multiplicand). A Decimal (the multiplier).
Negate
Negates the value of a specified Decimal.
Return Value: A Decimal with the value of d, but the opposite sign.
The Negate method returns the negative of the specified Decimal value. For example: If d is non-zero, the result is −d. A Decimal.
op_Addition
Adds two specified Decimal values.
Return Value: The Decimal result of adding d1 and d2. A Decimal. A Decimal.
op_Decrement
Decrements the Decimal operand by 1.
Return Value: The value of d decremented by 1. The Decimal operand.
op_Division
Divides two specified Decimal values.
Return Value: The Decimal result of d1 by d2. A Decimal (the dividend). A Decimal (the divisor).
op_Equality
Returns a value indicating whether two instances of Decimal are equal.
Return Value: true if d1 and d2 are equal; otherwise, false. A Decimal. A Decimal.
op_Explicit
Converts a Decimal to a 16-bit unsigned integer.
Return Value: A 16-bit unsigned integer that represents the converted Decimal. A Decimal to convert.
op_Explicit
Converts a Decimal to a 32-bit signed integer.
Return Value: A 32-bit signed integer that represents the converted Decimal. A Decimal to convert.
op_Explicit
Converts a Decimal to an 8-bit unsigned integer.
Return Value: An 8-bit unsigned integer that represents the converted Decimal. A Decimal to convert.
op_Explicit
Converts a Decimal to an 8-bit signed integer.
Return Value: An 8-bit signed integer that represents the converted Decimal. A Decimal to convert.
op_Explicit
Converts a Decimal to a Unicode character.
Return Value: A Unicode character that represents the converted Decimal. A Decimal to convert.
op_Explicit
Converts a Decimal to a 16-bit signed integer.
Return Value: A 16-bit signed integer that represents the converted Decimal. A Decimal to convert.
op_Explicit
Converts a Decimal to a single-precision floating point number.
Return Value: A single-precision floating point number that represents the converted Decimal. A Decimal to convert.
op_Explicit
Converts a Decimal to a double-precision floating point number.
Return Value: A double-precision floating point number that represents the converted Decimal. A Decimal to convert.
op_Explicit
Converts a Decimal to a 64-bit unsigned integer.
Return Value: A 64-bit unsigned integer that represents the converted Decimal. A Decimal to convert.
op_Explicit
Converts a Decimal to a 32-bit unsigned integer.
Return Value: A 32-bit unsigned integer that represents the converted Decimal. A Decimal to convert.
op_Explicit
Converts a Decimal to a 64-bit signed integer.
Return Value: A 64-bit signed integer that represents the converted Decimal. A Decimal to convert.
op_Explicit
Converts a double-precision floating point number to a Decimal.
Return Value: A Decimal that represents the converted double-precision floating point number. A double-precision floating point number.
op_Explicit
Converts a single-precision floating point number to a Decimal.
Return Value: A Decimal that represents the converted single-precision floating point number. A single-precision floating point number.
op_GreaterThan
Returns a value indicating whether a specified Decimal is greater than another specified Decimal.
Return Value: true if d1 is greater than d2; otherwise, false. A Decimal. A Decimal.
op_GreaterThanOrEqual
Returns a value indicating whether a specified Decimal is greater than or equal to another specified Decimal.
Return Value: true if d1 is greater than or equal to d2; otherwise, false. A Decimal. A Decimal.
op_Implicit
Converts an 8-bit unsigned integer to a Decimal.
Return Value: A Decimal that represents the converted 8-bit unsigned integer. An 8-bit unsigned integer.
op_Implicit
Converts a Unicode character to a Decimal.
Return Value: A Decimal that represents the converted Unicode character. A Unicode character.
op_Implicit
Converts a 16-bit signed integer to a Decimal.
Return Value: A Decimal that represents the converted 16-bit signed integer. A 16-bit signed integer.
op_Implicit
Converts a 32-bit signed integer to a Decimal
Return Value: A Decimal that represents the converted 32-bit signed integer. A 32-bit signed integer.
op_Implicit
Converts a 64-bit signed integer to a Decimal.
Return Value: A Decimal that represents the converted 64-bit signed integer. A 64-bit signed integer.
op_Implicit
Converts an 8-bit signed integer to a Decimal.
Return Value: A Decimal that represents the converted 8-bit signed integer. An 8-bit signed integer.
op_Implicit
Converts a 16-bit unsigned integer to a Decimal.
Return Value: A Decimal that represents the converted 16-bit unsigned integer. A 16-bit unsigned integer.
op_Implicit
Converts a 32-bit unsigned integer to a Decimal.
Return Value: A Decimal that represents the converted 32-bit unsigned integer. A 32-bit unsigned integer.
op_Implicit
Converts a 64-bit unsigned integer to a Decimal.
Return Value: A Decimal that represents the converted 64-bit unsigned integer. A 64-bit unsigned integer.
op_Increment
Increments the Decimal operand by 1.
Return Value: The value of d incremented by 1. The Decimal operand.
op_Inequality
Returns a value indicating whether two instances of Decimal are not equal.
Return Value: true if d1 and d2 are not equal; otherwise, false. A Decimal. A Decimal.
op_LessThan
Returns a value indicating whether a specified Decimal is less than another specified Decimal.
Return Value: true if d1 is less than d2; otherwise, false. A Decimal. A Decimal.
op_LessThanOrEqual
Returns a value indicating whether a specified Decimal is less than or equal to another specified Decimal.
Return Value: true if d1 is less than or equal to d2; otherwise, false. A Decimal. A Decimal.
op_Modulus
Returns the remainder resulting from dividing two specified Decimal values.
Return Value: The Decimal remainder resulting from dividing d1 by d2. A Decimal (the dividend). A Decimal (the divisor).
op_Multiply
Multiplies two specified Decimal values.
Return Value: The Decimal result of multiplying d1 by d2. A Decimal. A Decimal.
op_Subtraction
Subtracts two specified Decimal values.
Return Value: The Decimal result of subtracting d2 from d1. A Decimal. A Decimal.
op_UnaryNegation
Negates the value of the Decimal operand.
Return Value: The negated value of the operand, d. The Decimal operand.
op_UnaryPlus
Returns the value of the Decimal operand (the sign of the operand is unchanged).
Return Value: The value of the operand, d. The Decimal operand.
Parse
Converts the String representation of a number to its Decimal equivalent.
Return Value: The Decimal number equivalent to the number contained in s.
s contains a number of the form: [ws][sign]digits[.fractional-digits][ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert.
Parse
Converts the String representation of a number in a specified style to its Decimal equivalent.
Return Value: A Decimal with the value represented by s.
s contains a number of the form: [ws][sign]digits[.fractional-digits][ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
Parse
Converts the String representation of a number in a specified style to its Decimal equivalent.
Return Value: A Decimal with the value represented by s.
s contains a number of the form: [ws][sign]digits[.fractional-digits][ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStyles constants that indicate the permitted format of s.
Parse
Converts the String representation of a number in a specified style and culture-specific format to its Decimal equivalent.
Return Value: A Decimal with the value represented by s.
s contains a number of the form: [ws][sign]digits[.fractional-digits][ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStyles constants that indicate the permitted format of s. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
Remainder
Round
Rounds a Decimal value to a specified number of decimal places.
Return Value: d rounded to decimals number of decimal places. A Decimal value to round. A value from 0 to 28 that specifies the number of decimal places to round to.
Subtract
Subtracts two specified Decimal values.
Return Value: The Decimal result of subtracting d2 from d1. A Decimal (the minuend). A Decimal (the subtrahend).
IConvertible.ToBoolean
IConvertible.ToByte
IConvertible.ToChar
IConvertible.ToDateTime
IConvertible.ToDecimal
IConvertible.ToDouble
IConvertible.ToInt16
IConvertible.ToInt32
IConvertible.ToInt64
IConvertible.ToSByte
IConvertible.ToSingle
IConvertible.ToType
IConvertible.ToUInt16
IConvertible.ToUInt32
IConvertible.ToUInt64
ToByte
Converts the value of the specified Decimal to the equivalent 8-bit unsigned integer.
Return Value: An 8-bit unsigned integer equivalent to value.
value is rounded to the nearest integer value towards zero, and that result is returned. The Decimal value.
ToDouble
Converts the value of the specified Decimal to the equivalent double-precision floating point number.
Return Value: A double-precision floating point number equivalent to d.
Since a Double has fewer significant digits than a Decimal, this operation can produce round-off errors. The Decimal value to convert.
ToInt16
Converts the value of the specified Decimal to the equivalent 16-bit signed integer.
Return Value: An 16-bit signed integer equivalent to value. A Decimal value.
ToInt32
Converts the value of the specified Decimal to the equivalent 32-bit signed integer.
Return Value: A 32-bit signed integer equivalent to the value of d.
The return value is the integral part of the decimal value; fractional digits are truncated. The Decimal value to convert.
ToInt64
Converts the value of the specified Decimal to the equivalent 64-bit signed integer.
Return Value: A 64-bit signed integer equivalent to the value of d.
The return value is the integral part of the decimal value; fractional digits are truncated. The Decimal value to convert.
ToOACurrency
Converts the specified Decimal value to the equivalent OLE Automation Currency value, which is contained in a 64-bit signed integer.
Return Value: A 64-bit signed integer that contains the OLE Automation equivalent of value. A Decimal value. ToSByte
Converts the value of the specified Decimal to the equivalent 8-bit signed integer.
Return Value: An 8-bit signed integer equivalent to value. A Decimal value.
ToSingle
Converts the value of the specified Decimal to the equivalent single-precision floating point number.
Return Value: A single-precision floating point number equivalent to the value of d.
This operation can produce round-off errors because a single-precision floating point number has fewer significant digits than a Decimal. A Decimal value to convert.
ToString
Converts the numeric value of this instance to its equivalent String representation.
Return Value: A String representing the value of this instance.
The return value is formatted with the general format specifier (“G”). That is, an optional minus sign symbol followed by a sequence of integral digits (“0” through “9”), optionally followed by a decimal point symbol and a sequence of fractional digits. No leading zeroes are prefixed to the returned value.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified culture-specific format information.
Return Value: The String representation of the value of this instance as specified by provider.
provider is an IFormatProvider instance that obtains a System.Globalization.NumberFormatInfo object. The NumberFormatInfo object provides culture-specific format information about this instance. If provider is null, the return value for this instance is formatted with the NumberFormatInfo for the current culture. An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
ToString
Converts the numeric value of this instance to its equivalent String representation, using the specified format specification.
Return Value: A String representation of the value of this instance as specified by format.
If format is null or an empty string, the return value of this instance is formatted with the general format specifier (“G”). A String containing a format specification.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified format and culture-specific format information.
Return Value: The String representation of the value of this instance as specified by format and provider.
If format is null or an empty string, the return value for this instance is formatted with the general format specifier (“G”). A format specification. An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
ToUInt16
Converts the value of the specified Decimal to the equivalent 16-bit unsigned integer.
Return Value: A 16-bit unsigned integer equivalent to the value of value.
The return value is the integral part of the decimal value; fractional digits are truncated. A Decimal value to convert.
ToUInt32
Converts the value of the specified Decimal to the equivalent 32-bit unsigned integer.
Return Value: A 32-bit unsigned integer equivalent to the value of d.
The return value is the integral part of the decimal value; fractional digits are truncated. A Decimal value to convert.
ToUInt64
Converts the value of the specified Decimal to the equivalent 64-bit unsigned integer.
Return Value: A 64-bit unsigned integer equivalent to the value of d.
The return value is the integral part of the decimal value; fractional digits are truncated. A Decimal value to convert.
Truncate
Returns the integral digits of the specified Decimal; any fractional digits are discarded.
Return Value: d rounded toward zero, to the nearest whole number.
This method rounds parameter d towards zero to the nearest whole number, which corresponds to discarding any digits after the decimal point. A Decimal to truncate.
Delegate class (System)
Truncate
Description
Represents a delegate, which is a data structure that refers to a static method or to an object instance and an instance method of that object.
The System.Delegate class is the base class for delegates.
Delegate
Example Syntax:
Truncate
Creates a System.Delegate to represent the specified target System.Object and the specified method.
This protected constructor is accessible only through this class or a derived class. The System.Object to be represented by the System.Delegate. The System.String containing the name of the method to be represented by the System.Delegate.
Delegate
Example Syntax:
Truncate
Creates a System.Delegate to represent the specified target System.Type and the specified method.
This protected constructor is accessible only through this class or a derived class. The System.Type to be represented by the System.Delegate. The System.String containing the name of the method to be represented by the System.Delegate.
Method
Truncate
Gets the static method of the class represented by the System.Delegate.
Target
Truncate
Gets the class instance from which the System.Delegate was created.
An instance method is a method that is associated with an instance of a class; whereas, a static method is a method that is associated with the class itself.
Clone
Creates a shallow copy of the System.Delegate.
Return Value: A shallow copy of the System.Delegate.
This method can be overridden by a derived class.
Combine
Combines the invocation lists of an array of multicast System.Delegate instances.
Return Value: A new multicast System.Delegate with an invocation list that concatenates the invocation lists of the delegates in the delegates array.
If the delegates array contains entries that are null, those entries are ignored. The array of multicast System.Delegate instances to combine.
Combine
Combines the invocation lists of two multicast System.Delegate instances.
Return Value: A new multicast System.Delegate with an invocation list that concatenates the invocation lists of a and b in that order.
The invocation list can contain duplicate entries; that is, entries that refer to the same method on the same object. The multicast System.Delegate whose invocation list comes first. The multicast System.Delegate whose invocation list comes last.
CombineImpl
When overridden in a derived class, combines the invocation lists of the specified multicast System.Delegate with the current multicast System.Delegate.
Return Value: When overridden in a derived class, a new System.Delegate with an invocation list that concatenates the invocation list of the current System.Delegate and the invocation list of d.
This method must be overridden by a derived class. The current implementation simply throws a System.MulticastNotSupportedException. This protected method is accessible only through this class or a derived class. The multicast System.Delegate whose invocation list to append to the end of the invocation list of the current multicast System.Delegate.
CreateDelegate
Creates a System.Delegate of the specified type to represent the specified static method.
Return Value: A System.Delegate of the specified type to represent the specified static method.
This method creates delegates for static methods only. A static method is a method that is associated with the class itself. The System.Type of System.Delegate to create. The System.Reflection.MethodInfo describing the static method for which the System.Delegate is to be created.
CreateDelegate
Creates a System.Delegate of the specified type to represent the specified instance method of the specified System.Object instance.
Return Value: A System.Delegate of the specified type to represent the specified instance method of the specified System.Object instance type is null.
This method creates delegates for instance methods only. An instance method is a method that is associated with an instance of a class. The System.Type of System.Delegate to create. The target System.Object instance that implements method. The name of the instance method for which the System.Delegate is to be created.
CreateDelegate
Creates a System.Delegate of the specified type to represent the specified static method of the specified System.Type.
Return Value: A System.Delegate of the specified type to represent the specified static method of the specified System.Type.
This method creates delegates for static methods only. A static method is a method that is associated with the class itself, not with any particular instance of the class. The System.Type of System.Delegate to create. The target System.Type that implements method. The name of the static method for which the delegate is to be created.
DynamicInvoke
Invokes the method, represented by the System.Delegate, dynamically (late-bound).
Return Value: The System.Object returned by the method represented by the System.Delegate.
This method calls the
System.Delegate.DynamicInvokeImpl(System.Object[ ]) method. An array of System.Object instances that are the arguments to pass to the method represented by the System.Delegate.
DynamicInvokeImpl
Invokes the method, represented by the System.Delegate, dynamically (late-bound).
Return Value: The System.Object returned by the method represented by the System.Delegate.
This method can be overridden by a derived class. This protected method is accessible only through this class or a derived class. An array of System.Object instances that are the arguments to pass to the method represented by the System.Delegate.
Equals
Determines whether the specified object and the singlecast System.Delegate share the same target, method and invocation list.
Return Value: true if obj and the current System.Delegate have the same target, method and invocation list; otherwise, false.
Two delegates with the same methods, the same targets and the same invocation lists are considered equal, even if they are not both singlecast or both multicast. The System.Object to compare with the singlecast System.Delegate.
GetHashCode
Returns a hash code for the delegate instance.
Return Value: A hash code for the delegate instance.
The return value from this method must not be persisted for two reasons. First, the hash function of a class might be altered to generate a better distribution, rendering any values from the old hash function useless. Second, the default implementation of this class does not guarantee that the same value will be returned by different instances.
GetInvocationList
Returns the invocation list of the System.Delegate
Return Value: An array of singlecast System.Delegate objects representing the invocation list of the current System.Delegate. If the current System.Delegate is singlecast, the array contains only one element. If the current System.Delegate is multicast, the array may contain more than one element.
This method can be overridden by a derived class.
GetMethodImpl
Gets the static method of the class represented by the System.Delegate.
Return Value: A System.Reflection.MethodInfo describing the static method represented by the System.Delegate.
This method can be overridden by a derived class. This protected method is accessible only through this class or a derived class.
GetObjectData
Implements the System.Runtime.Serialization.ISerializable interface and returns the data needed to serialize the System.Delegate.
This method can be overridden by a derived class. A System.Runtime.Serialization.SerializationInfo object containing information required to serialize the System.Delegate. A System.Runtime.Serialization.StreamingContext object containing the source and destination of the serialized stream associated with the System.Delegate.
op_Equality
Determines whether the specified System.Delegate objects are equal.
Return Value: true if d] is equal to d2; otherwise, false.
Two delegates with the same methods, the same targets and the same invocation lists are considered equal, even if they are not both singlecast or both multicast. The first System.Delegate to compare. The second System.Delegate to compare.
op_Inequality
Determines whether the specified System.Delegate objects are not equal.
Return Value: true if d1 is not equal to d2; otherwise, false.
Two delegates are considered not equal if they have different methods or different targets or different invocation lists. The first System.Delegate to compare. The second System.Delegate to compare.
Remove
Removes a System.Delegate from the invocation list of another System.Delegate.
Return Value: A new System.Delegate with an invocation list formed by taking the invocation list of source and removing the last occurrence of value, if value is found in the invocation list of source.
The System.Delegate removed from the invocation list is the last delegate for which the following expression is true: value. The System.Delegate from which to remove value. The System.Delegate to remove from the invocation list of source.
RemoveImpl
Removes a System.Delegate from the invocation list of another System.Delegate.
Return Value: source, if d is not equal to source; otherwise, null.
This method can be overridden by a derived class. This protected method is accessible only through this class or a derived class. The System.Delegate to remove from the invocation list of the current System.Delegate.
DivideByZeroException class (System)
ToString
Description
The exception that is thrown when there is an attempt to divide an integral or decimal value by zero.
Dividing a floating-point value by zero will result in either positive infinity, negative infinity, or Not-a-Number (NaN) according to the rules of IEEE 754 arithmetic. Floating-point operations never throw an exception. For more information, see System.Single and System.Double.
DivideByZeroException
Example Syntax:
ToString
Initializes a new instance of the System.DivideByZeroException class with default properties.
The following table shows the initial property values for an instance of System.DivideByZeroException.
DivideByZeroException
Example Syntax:
ToString
Initializes a new instance of the System.DivideByZeroException class with a specified error message.
The following table shows the initial property values for an instance of System.DivideByZeroException. The error message that explains the reason for the exception.
DivideByZeroException
Example Syntax:
ToString
Initializes a new instance of the System.DivideByZeroException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
DivideByZeroException
Example Syntax:
ToString
Initializes a new instance of the System.DivideByZeroException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
DllNotFoundException class (System)
ToString
Description
The exception that is thrown when a DLL specified in a DLL import cannot be found.
System.DllNotFoundException uses the HRESULT COR_E_DLLNOTFOUND, which has the value 0x80131524.
DllNotFoundException
Example Syntax:
ToString
Initializes a new instance of the System.DllNotFoundException class with default properties.
The following table shows the initial property values for an instance of System.DllNotFoundException.
DllNotFoundException
Example Syntax:
ToString
Initializes a new instance of the System.DllNotFoundException class with a specified error message.
The following table shows the initial property values for an instance of System.DllNotFoundException. The error message that explains the reason for the exception.
DllNotFoundException
Example Syntax:
ToString
Initializes a new instance of the System.DllNotFoundException class with serialized data. The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown. The System.Runtime.Serialization.StreaniingContext that contains contextual information about the source or destination.
DllNotFoundException
Example Syntax:
ToString
Initializes a new instance of the System.DllNotFoundException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If inner is non-null, then the current Exception is raised in a catch block handling inner.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
TypeName
Double structure (System)
ToString
Description
Represents a double-precision floating point number.
The Double value type represents a double-precision 64-bit number with values ranging from negative 1.79769313486232e308 to positive 1.79769313486232e308, as well as positive or negative zero, System.Double.PositiveInfinity, System.Double.NegativeInfinity, and Not-a-Number (System.Double.NaN).
ToString
A constant representing the smallest positive Double greater than zero.
The value of this constant is 4.94065645841247e-324.
ToString
A constant representing the largest possible value of Double.
The value of this constant is positive 1.79769313486232e308.
ToString
A constant representing the smallest possible value of Double.
The value of this constant is negative 1.79769313486232e308.
ToString
A constant representing Not-a-Number (NaN).
The value of this constant is the result of dividing zero by zero.
ToString
A constant representing negative infinity.
The value of this constant is the result of dividing a negative number by zero.
ToString
A constant representing positive infinity.
The value of this constant is the result of dividing a positive number by zero.
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: A signed number indicating the relative values of this instance and value.
Any instance of Double, regardless of its value, is considered greater than null. An object to compare, or null.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if obj is an instance of Double and equals the value of this instance; otherwise, false. An object to compare with this instance.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
GetTypeCode
Returns the TypeCode for value type Double.
Return Value: The enumerated constant, System.TypeCode.Double.
IsInfinity
Returns a value indicating whether the specified number evaluates to either negative or positive infinity.
Return Value: true if d evaluates to negative or positive infinity; otherwise, false. A double-precision floating point number.
IsNaN
Returns a value indicating whether the specified number evaluates to Not-a-Number (NaN).
Return Value: true if d evaluates to NaN; otherwise, false. A double-precision floating point number.
IsNegativeInfinity
Returns a value indicating whether the specified number evaluates to negative infinity.
Return Value: true if d evaluates to negative infinity; otherwise, false. A double-precision floating point number.
IsPositiveInfinity
Returns a value indicating whether the specified number evaluates to positive infinity.
Return Value: true if d evaluates to positive infinity; otherwise, false. A double-precision floating point number.
Parse
Converts the String representation of a number to its double-precision floating point number equivalent.
Return Value: A double-precision floating point number equivalent to the numeric value or symbol specified in s.
s can contain System.Globalization.NumberFormatInfo.PositiveInfinitySymbol, System.Globalization.NumberFormatInfo.NegativelnfInitySymbol, System.Globalization.NumberFormatInfo.NaNSymbol, or a string of the form: [ws][sign]integral-digits[.[fractional-digits]][e[sign]exponential-digits][ws] Optional items are framed in square brackets (‘[’ and ‘]’). Items containing the term “digits” consist of a series of numeric characters ranging from 0 to 9. A System.String containing a number to convert. Parse
Converts the String representation of a number in a specified culture-specific format to its double-precision floating point number equivalent.
Return Value: A double-precision floating point number equivalent to the numeric value or symbol specified in s.
s can contain System.Globalization.NumberFormatInfo.PositiveInfinitySymbol, System.Globalization.NumberFormatInfo.NegativelnfInitySymbol, System.Globalization.NumberFormatInfo.NaNSymbol, or a string of the form: [ws][sign]integral-digits[.[fractional-digits]][e[sign]exponential-digits][ws] Optional items are framed in square brackets (‘[’ and ‘]’). Items containing the term “digits” consist of a series of numeric characters ranging from 0 to 9. A System.String containing a number to convert. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
Parse
Converts the String representation of a number in a specified style to its double-precision floating point number equivalent.
Return Value: A double-precision floating point number equivalent to the numeric value or symbol specified in s.
s can contain System.Globalization.NumberFormatInfo.PositiveInfinitySymbol, System.Globalization.NumberFormatInfo.NegativelnfInitySymbol, System.Globalization.NumberFormatInfo.NaNSymbol, or a string of the form: [ws][sign]integral-digits [.[fractional-digits]][e[sign]exponential-digits] [ws] Optional items are framed in square brackets (‘[’ and ‘]’). Items containing the term “digits” consist of a series of numeric characters ranging from 0 to 9. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStylesconstants that indicate the permitted format of s.
Parse
Converts the String representation of a number in a specified style and culture-specific format to its double-precision floating point number equivalent.
Return Value: A double-precision floating point number equivalent to the numeric value or symbol specified in s.
s can contain System.Globalization.NumberFormatInfo.PositiveInfinitySymbol, System.Globalization.NumberFormatInfo.NegativeInfinitySymbol, System.Globalization.NumberFormatInfo.NaNSymbol, or a string of the form: [ws][sign]integral-digits[.[fractional-digits]][e[sign]exponential-digits][ws] Optional items are framed in square brackets (‘[’ and ‘]’). Items containing the term “digits” consist of a series of numeric characters ranging from 0 to 9. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStylesconstants that indicate the permitted format of s. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
IConvertible.ToBoolean
IConvertible.ToByte
IConvertible.ToChar
IConvertible.ToDateTime
IConvertible.ToDecimal
IConvertible.ToDouble
IConvertible.ToInt16
IConvertible.ToInt32
IConvertible.ToInt64
IConvertible.ToSByte
IConvertible.ToSingle
IConvertible.ToType
IConvertible.ToUInt16
IConvertible.ToUInt32
IConvertible.ToUInt64
ToString
Converts the numeric value of this instance to its equivalent String representation.
Return Value: The System.String representation of the value of this instance.
The return value can be System.Globalization.NumberFormatInfo.PositiveInfinitySymbol, System.Globalization.NumberFormatInfo.NegativeInfinitySymbol, System.Globalization.NumberFormatInfo.NaNSymbol, or a string of the form: [sign]integral-digits[.[fractional-digits]] [e[sign]exponential-digits] Optional items are framed in square brackets (‘[’ and ‘]’). Items containing the term “digits” consist of a series of numeric characters ranging from 0 to 9.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by provider.
The return value can be System.Globalization.NumberFormatInfo.PositiveInfinitySymbol, System.Globalization.NumberFormatInfo.NegativeInfinitySymbol, System.Globalization.NumberFormatInfo.NaNSymbol, or a string of the form: [sign]integral-digits[.[fractional-digits]] [e[sign]exponential-digits] Optional items are framed in square brackets (‘[’ and ‘]’). Items containing the term “digits” consist of a series of numeric characters ranging from 0 to 9. An System.IFormatProvider interface implementation which supplies culture-]9 specific formatting information.
ToString
Converts the numeric value of this instance to its equivalent String representation, using the specified format.
Return Value: The System.String representation of the value of this instance as specified by format.
The return value can be System.Globalization.NumberFormatInfo.PositiveInfinitySymbol, System.Globalization.NumberFormatInfo.NegativeInfinitySymbol, System.Globalization.NumberFormatInfo.NaNSymbol, or a string of the form: [sign]integral-digits[.[fractional-digits]][e[sign]exponential-digits] Optional items are framed in square brackets (‘[’ and ‘]’). Items containing the term “digits” consist of a series of numeric characters ranging from 0 to 9. A format string.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified format and culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by format and provider.
The return value can be System.Globalization.NumberFormatInfo.PositiveInfinitySymbol, System.Globalization.NumberFormatInfo.NegativeInfinitySymbol, System.Globalization.NumberFormatInfo.NaNSymbol, or a string of the form: [sign]integral-digits [.[fractional-digits]][e[sign]exponential-digits] Optional items are framed in square brackets (‘[’ and ‘]’). Items containing the term “digits” consist of a series of numeric characters ranging from 0 to 9. A format specification. An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
TryParse
Converts the String representation of a number in a specified style and culture-specific format to its double-precision floating point number equivalent.
Return Value: true if s is converted successfully; otherwise, false.
The system.Double.TryParse method is like the system.Double.Parse method, except this method does not throw an exception if the conversion fails. If the conversion succeeds, the return value is true and the result parameter is set to the outcome of the conversion. If the conversion fails, the return value is false and the result parameter is set to zero. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStylesconstants that indicate the permitted format of s. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s. A double-precision floating-point number equivalent to the numeric value or symbol specified in s. If the return value is false, result is set to zero. DuplicateWaitObjectException class (System)
TryParse
Description
The exception that is thrown when an object appears more than once in an array of synchronization objects.
The common language runtime provides a thread synchronization mechanism based on synchronization objects waiting for execution in an array of System.Threading.WaitHandle objects. If the array of System.Threading.WaitHandle objects passed to System.Threading.WaitHandle.WaitAll(System.Threading.WaitHandle[ ],System.Int32,System.Boolean) or System.Threading.WaitHandle.WaitAny(System.Threading.WaitHandle[ ],System.Int32,System.Boolean) contains any duplicate operating system handles, System.DuplicateWaitObjectException is thrown. For more information, see System.Threading.WaitHandle.
DuplicateWaitObjectException
Example Syntax:
TryParse
Initializes a new instance of the System.DuplicateWaitObjectException class with default properties.
The following table shows the initial property values for an instance of System.DuplicateWaitObjectException.
DuplicateWaitObjectException
Example Syntax:
TryParse
Initializes a new instance of the System.DuplicateWaitObjectException class with the name of the parameter that causes this exception.
The following table shows the initial property values for an instance of System.DuplicateWaitObjectException. The name of the invalid parameter.
DuplicateWaitObjectException
Example Syntax:
TryParse
Initializes a new instance of the System.DuplicateWaitObjectException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
DuplicateWaitObjectException
Example Syntax:
TryParse
Initializes a new instance of the System.DuplicateWaitObjectException class with a specified error message and the name of the parameter that causes this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The name of the invalid parameter. The error message that explains the reason for the exception.
HelpLink
HResult
InnerException
Message
ParamName
Source
StackTrace
TargetSite
EntryPointNotFoundException class (System)
ToString
Description
The exception that is thrown when an attempt to load a class fails due to the absence of an entry method.
For a list of initial property values for an instance of System.EntryPointNotFoundException, see the System.EntryPointNotFoundException.#ctor constructors.
EntryPointNotFoundException
Example Syntax:
ToString
Initializes a new instance of the System.EntryPointNotFoundException class with default properties.
The following table shows the initial property values for an instance of System.EntryPointNotFoundException.
EntryPointNotFoundException
Example Syntax:
ToString
Initializes a new instance of the System.EntryPointNotFoundException class with a specified error message.
The following table shows the initial property values for an instance of System.EntryPointNotFoundException. The error message that explains the reason for the exception.
EntryPointNotFoundException
Example Syntax:
ToString
Initializes a new instance of the System.EntryPointNotFoundException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
EntryPointNotFoundException
Example Syntax:
ToString
Initializes a new instance of the System.EntryPointNotFoundException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If inner is non-null, then the current Exception is raised in a catch block handling inner.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
TypeName
Enum class (System)
ToString
Description
Provides the base class for enumerations.
An enumeration type is a named constant whose underlying type is any integral type except System.Char. Programming languages typically provide syntax to declare an enumeration that consists of a set of named constants and their values.
Enum
Example Syntax:
ToString
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: A signed number indicating the relative values of this instance and target. An object to compare, or null.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if obj is an Enum with the same underlying type and value as this instance; otherwise, false. An object to compare with this instance.
Format
Converts the specified value of a specified enumerated type to its equivalent String representation according to the specified format.
Return Value: A string representation of value.
The valid format values are: Format Description “G” or “g” If value is equal to a named enumerated constant, the name of that constant is returned; otherwise, the decimal equivalent of value is returned. The enumeration type of the value to be converted. The value to be converted. The output format to use.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
GetName
Retrieves the name of the constant in the specified enumeration that has the specified value.
Return Value: A System.String containing the name of the enumerated constant in enumType whose value is value, or null if no such constant is found. An enumeration. The value of a particular enumerated constant in terms of its underlying type.
GetNames
Retrieves an array of the names of the constants in a specified enumeration.
Return Value: A System.String array of the names of the constants in enumType. The elements of the array are sorted by the values of the enumerated constants. An enumeration.
GetTypeCode
Returns the underlying TypeCode for this instance.
Return Value: The System.TypeCode for this instance.
GetUnderlyingType
Returns the underlying type of the specified enumeration.
Return Value: The underlying System.Type of enumType. An enumerated type.
GetValues
Retrieves an array of the values of the constants in a specified enumeration.
Return Value: An Array of the values of the constants in enumType. The elements of the array are sorted by the values of the enumeration constants. An enumeration.
IsDefined
Returns an indication whether a constant with a specified value exists in a specified enumeration.
Return Value: true if a constant in enumType has a value equal to value; otherwise, false. An enumeration. The value or name of a constant in enumType.
Parse
Converts the String representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object.
Return Value: An object of type enumType whose value is represented by value.
value contains a value, a named constant, or a list of named constants delimited by commas (“,”). One or more blanks (“ ”) can precede or follow each value, name, or comma in value. If value is a list, the return value is the value of the specified names combined with a bitwise OR operation. The System.Typeof the enumeration. A System.String containing the name or value to convert.
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-sensitive.
Return Value: An object of type enumType whose value is represented by value.
value contains a value, a named constant, or a list of named constants delimited by commas (“,”). One or more blanks (“ ”) can precede or follow each value, name, or comma in value. If value is a list, the return value is the value of the specified names combined with a bitwise OR operation. The System.Typeof the enumeration. A System.String containing the name or value to convert. If true, ignore case; otherwise, regard case.
IConvertible.ToBoolean
IConvertible.ToByte
IConvertible.ToByte
IConvertible.ToDateTime
IConvertible.ToDecimal
IConvertible.ToDouble
IConvertible.ToInt16
IConvertible.ToInt32
IConvertible.ToInt64
IConvertible.ToSByte
IConvertible.ToSingle
IConvertible.ToType
IConvertible.ToUInt16
IConvertible.ToUInt32
IConvertible.ToUInt64
ToObject
Returns an instance of the specified enumeration type set to the specified 8-bit unsigned integer value.
Return Value: An instance of the enumeration set to value. The enumeration for which to create a value. The value to set.
ToObject
Returns an instance of the specified enumeration type set to the specified 16-bit signed integer value.
Return Value: An instance of the enumeration set to value. The enumeration for which to create a value. The value to set.
ToObject
Returns an instance of the specified enumeration type set to the specified 32-bit signed integer value.
Return Value: An instance of the enumeration set to value. The enumeration for which to create a value. The value to set.
ToObject
Returns an instance of the specified enumeration type set to the specified 64-bit signed integer value.
Return Value: An instance of the enumeration set to value. The enumeration for which to create a value. The value to set.
ToObject
Returns an instance of the specified enumeration set to the specified value.
Return Value: An enumeration object whose value is value.
value is specified in terms of the underlying type of the enumeration. An enumeration. The value. ToObject
Returns an instance of the specified enumeration type set to the specified 8-bit signed integer value.
Return Value: An instance of the enumeration set to value. The enumeration for which to create a value. The value to set.
ToObject
Returns an instance of the specified enumeration type set to the specified 16-bit unsigned integer value.
Return Value: An instance of the enumeration set to value. The enumeration for which to create a value. The value to set.
ToObject
Returns an instance of the specified enumeration type set to the specified 32-bit unsigned integer value.
Return Value: An instance of the enumeration set to value. The enumeration for which to create a value. The value to set.
ToObject
Returns an instance of the specified enumeration type set to the specified 64-bit unsigned integer value.
Return Value: An instance of the enumeration set to value. The enumeration for which to create a value. The value to set.
ToString
Converts the value of this instance to its equivalent String representation.
Return Value: The String representation of the value of this instance.
This method behaves as if the general format character, “G”, were specified. That is, if the System.FlagsAttribute is not applied to this enumerated type and there is a named constant equal to the value of this instance, then the return value is a string containing the name of the constant. If the System.FlagsAttribute is applied and there is a combination of one or more named constants equal to the value of this instance, then the return value is a string containing a delimiter-separated list of the names of the constants. Otherwise, the return value is the string representation of the numeric value of this instance.
ToString
Converts the value of this instance to its equivalent String representation using the specified format information.
Return Value: The String representation of the name of the value of this instance as specified by provider.
provider is reserved; it does not participate in this operation and can be specified as null. Therefore, this method is equivalent to the System.Enum.ToString(System.String) method that takes no parameters. (Reserved) An System.IFormatProvider object that supplies format information about this instance.
ToString
Converts the value of this instance to its equivalent String representation using the specified format.
Return Value: The String representation of the value of this instance as specified by format.
format can contain format characters “G” or “g”, “D” or “d”, “X” or “x”, and “F” or “f”. If format is null or an empty string, the general format specifier (“G”) is used. For more information about these format characters, see the Remarks section of the System.Enum.Format(System.Type,System.Object,System.String) method. For more information about formatting in general, see. A format string.
ToString
Converts the value of this instance to its equivalent String representation using the specified format and format information.
Return Value: The String representation of the value of this instance as specified by format and provider.
format can contain format characters “G” or “g”, “D” or “d”, “X” or “x”, and “F” or “f”. If format is null or an empty string, the general format specifier (“G”) is used. For more information about these format characters, see the Remarks section of the System.Enum.Format(System.Type,System.Object,System.String) method. For more information about formatting in general, see. A format specification. (Reserved) An System.IFormatProvider object that supplies format information about this instance.
Environment class (System)
ToString
Description
Provides information about, and means to manipulate, the current environment and platform.
CommandLine
ToString
Gets the command line for this process.
CurrentDirectory
ToString
Gets and sets the fully qualified path of the current directory; that is, the directory from which this process starts.
By definition, if this process starts in the root directory of a local or network drive, the value of this property is the drive name followed by a trailing slash (for example, “C:\”). If this process starts in a subdirectory, the value of this property is the drive and subdirectory path, without a trailing slash (for example, “C:\mySubDirectory”).
ExitCode
ToString
Gets or sets the exit code of the process.
This property can be used to return a success code from an application. For example, it can be used to control the execution of a set of applications invoked in a script.
HasShutdownStarted
ToString
MachineName
ToString
Gets the NetBIOS name of this local computer.
The name of this computer is established at system startup when the name is read from the registry. If this computer is a node in a cluster, the name of the node is returned.
NewLine
ToString
Gets the newline string defined for this environment.
The property value is a constant customized specifically for the current platform.
OSVersion
ToString
StackTrace
ToString
Gets current stack trace information.
SystemDirectory
ToString
Gets the fully qualified path of the system directory.
An example of the value returned is the string “C:\WinNT\System32”.
TickCount
ToString
Gets the number of milliseconds elapsed since the system started.
The value of this property is derived from the system timer and is stored as a 32-bit signed integer. Therefore, the elapsed time will wrap around to zero if the system is run continuously for 49.7 days.
UserDomainName
ToString
Gets the name of the application domain of the current user.
The value of this property is typically the host machine name, but can depend upon the application solution being deployed.
UserInteractive
ToString
Gets a value indicating whether the current process is running in user interactive mode.
This will be false only when running as a Service Process or from inside a Web application. When this property is false, you should not display any modal dialogs or message boxes, because there is no graphical user interface for the user to interact with.
UserName
ToString
Gets the user name of the person who started the current thread.
This property can be used to identify the current user to the system and application for security or access purposes. It can also be used to customize a particular application for each user.
Version
ToString
Gets a Version object that describes the major, minor, build, and revision numbers of the common language runtime.
WorkingSet
ToString
Gets the amount of physical memory mapped to the process context.
Exit
Terminates this process and gives the underlying operating system the specified exit code. Exit code to be given to the operating system.
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.
Return Value: A System.String with each environment variable replaced by its value.
Replacement only occurs for environment variables that are set. For example, suppose name is “MyENV=% MyENV %”. If the environment variable, MyENV, is set to 42, this method returns “MyENV=42”. If MyENV is not set, no change occurs; this method returns “MyENV=% MyENV %”. A string containing the names of zero or more environment variables. Each environment variable is quoted with the percent sign character (‘%’).
GetCommandLineArgs
Returns a String array containing the command line arguments for the current process.
Return Value: An array of System.String 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.
GetEnvironmentVariable
Returns the value of the specified environment variable.
Return Value: A string containing the value of variable, or null if variable is not found. A string containing the name of an environment variable.
GetEnvironmentVariables
Returns all environment variables and their values.
Return Value: An object derived from System.Collections.IDictionary, which can return all environment variables and their values.
GetFolderPath
Gets the path to the system special folder identified by the specified enumeration.
This method retrieves the path to a system special folder, such as Program Files, Programs, System, or Startup, which can be used to access common information. The folder enumeration specifies the folder to retrieve. Special folders are set by default by the system, or explicitly by the user, when installing a version of Windows. An enumerated constant that identifies a system special folder.
GetLogicalDrives
Returns an array of String containing the names of the logical drives on the current computer.
Return Value: An array of System.String 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:”.
EventArgs class (System)
ToString
Description
System.EventArgs is the base class for event data.
For more information about events, see the.
ToString
Represents an event with no event data.
The value of System.EventArgs.Empty is a read-only instance of System.EventArgs.
EventArgs
Example Syntax:
ToString
Initializes a new instance of the System.EventArgs class.
This constructor is only called by the common language runtime.
EventHandler delegate (System)
ToString
Description
Represents the method that will handle the event that has no event data. The source of the event. An EventArgs that contains the event data.
The event model in the .NET Framework is based on having an event delegate that connects an event with its handler. To raise an event, two elements are needed: A class that holds the event data. This class must derive from the base class System.EventArgs.
Exception class (System)
ToString
Description
Defines the base class for all exceptions.
Exceptions are responses to abnormal or exceptional conditions that arise while a program is executing. The common language runtime provides an exception handling model that is based on the representation of exceptions as objects, and the separation of program code and exception handling code into try block and catch block, respectively. There can be one or more catch blocks, each designed to handle a particular type of exception, or one block designed to catch a more specific exception than another block.
Exception
Example Syntax:
ToString
Initializes a new instance of the System.Exception class with default properties.
All the derived classes should provide this default constructor. The following table shows the initial property values for an instance of System.Exception.
Exception
Example Syntax:
ToString
Initializes a new instance of the System.Exception class with a specified error message.
The following table shows the initial property values for an instance of System.Exception. The error message that explains the reason for the exception.
Exception
Example Syntax:
ToString
Initializes a new instance of the System.Exception class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
Exception
Example Syntax:
ToString
Initializes a new instance of the System.Exception class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
ToString
Gets or sets a link to the help file associated with this exception.
The return value, which represents a help file, is a URN or URL. For example: “file:///C:/Applications/Bazzal/help.html#ErrorNum42”
HResult
ToString
Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.
HRESULT is a 32-bit value, divided into three different fields: a severity code, a facility code, and an error code. The severity code indicates whether the return value represents information, warning, or error. The facility code identifies the area of the system responsible for the error. The error code is a unique number that is assigned to represent the exception. Each exception is mapped to a distinct HRESULT. When managed code throws an exception, the runtime passes the HRESULT to the COM client. When unmanaged code returns an error, the HRESULT is converted to an exception, which is then thrown by the runtime.
InnerException
ToString
Gets a reference to the inner exception.
You can create a new exception that catches an earlier exception. The code that handles the second exception can make use of the additional information from the earlier exception to handle the error more appropriately.
Message
ToString
Gets the error message text.
Every exception should carry an error message that provides information about the exception, such as why it is thrown. The System.Exception.Message property is set when the exception object is constructed. If an exception is constructed without a supplied error message, this property provides a default message indicating the type of the exception that is thrown.
Source
ToString
Gets or sets a string containing the name of the application or the object that causes the error.
If System.Exception.Source is not set, the name of the assembly where the exception originated is returned.
StackTrace
ToString
Gets the stack trace, which identifies the location in the code where the error occurs.
The execution stack keeps track of all the methods that are in execution at a given instant. A trace of the method calls is called a stack trace with the most recent method call appearing first. The stack trace listing provides a means to follow the call sequence to the line number in the method where the exception occurs.
TargetSite
ToString
Gets the method that throws this exception.
If the method that throws this exception is not available and the stack trace is not null, System.Exception.TargetSite obtains the method from the stack trace. If the stack trace is null, System.Exception.TargetSite returns null
GetBaseException
Gets the original exception that is thrown.
Return Value: A reference to the original exception object.
System.Exception.GetBaseException returns the original, innermost exception that causes this exception and other related exceptions linked via the System.Exception.InnerException property. If the current exception is the only one thrown, then its reference will be returned.
GetObjectData
Sets the System.Runtime.Serialization.SerializationInfo object with information about the exception.
System.TypeLoadException.GetObjectData(System.Runtime.Serializat System.Runtime.Serialization.SerializationInfo with all the exception object data targeted for serialization. During deserialization, the exception object is reconstituted from the System.Runtime.Serialization.SerializationInfo transmitted over the stream. The object that holds the serialized object data. The contextual information about the source or destination.
ToString
Returns the fully qualified name of this exception and possibly the error message, the name of the inner exception, and the stack trace.
Return Value: The fully qualified class name, plus possibly the error message, the name of the inner exception, and the stack trace.
If there is no error message or if it is an empty string (“ ”), then no error message is returned. The name of the inner exception and the stack trace are returned only if they are not null.
ExecutionEngineException class (System)
ToString
Description
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 uses the HRESULT COR_E_EXECUTIONENGINE, which has the value 0x80131506.
ExecutionEngineException
Example Syntax:
ToString
Initializes a new instance of the System.ExecutionEngineException class with default properties.
The following table shows the initial property values for an instance of System.ExecutionEngineException.
ExecutionEngineException
Example Syntax:
ToString
Initializes a new instance of the System.ExecutionEngineException class with a specified error message.
The following table shows the initial property values for an instance of System.ExecutionEngineException. The error message that explains the reason for the exception.
ExecutionEngineException
Example Syntax:
ToString
Initializes a new instance of the System.ExecutionEngineException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
FieldAccessException class (System)
ToString
Description
The exception that is thrown when there is an illegal attempt to access a private or protected field inside a class.
System.FieldAccessException uses the HRESULT COR_E_FIELDACCESS, which has the value 0x80131507.
FieldAccessException
Example Syntax:
ToString
Initializes a new instance of the System.FieldAccessException class with default properties.
The following table shows the initial property values for an instance of System.FieldAccessException.
FieldAccessException
Example Syntax:
ToString
Initializes a new instance of the System.FieldAccessException class with a specified error message.
The following table shows the initial property values for an instance of System.FieldAccessException. The error message that explains the reason for the exception.
FieldAccessException
Example Syntax:
ToString
Initializes a new instance of the System.FieldAccessException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
FieldAccessException
Example Syntax:
ToString
Initializes a new instance of the System.FieldAccessException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If inner is non-null, then the current Exception is raised in a catch block handling inner.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
FlagsAttribute class (System)
ToString
Description
Custom attribute indicating an enumeration should be treated as a bitfield; that is, a set of flags.
Bitfields can be combined using a bitwise OR operation, whereas enumerated constants cannot.
FlagsAttribute
Example Syntax:
ToString
Initializes a new instance of the FlagsAttribute class.
TypeId
FormatException class (System)
ToString
Description
The exception that is thrown when the format of an argument does not meet the parameter specifications of the invoked method.
System.FormatException is thrown when the format of an argument in a method invocation does not match the format of the corresponding formal parameter type. For example, if a method specifies a System.String parameter consisting of two digits with an embedded period, passing a corresponding string argument containing only two digits to that method would cause System.FormatException to be thrown.
FormatException
Example Syntax:
ToString
Initializes a new instance of the System.FormatException class with default properties.
The following table shows the initial property values for an instance of System.FormatException.
FormatException
Example Syntax:
ToString
Initializes a new instance of the System.FormatException class with a specified error message.
The following table shows the initial property values for an instance of System.FormatException. The error message that explains the reason for the exception.
FormatException
Example Syntax:
ToString
Initializes a new instance of the System.FormatException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
FormatException
Example Syntax:
ToString
Initializes a new instance of the System.FormatException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
GC class (System)
ToString
Description
Controls the system garbage collector, a service that automatically reclaims unused memory.
Methods in this class influence when an object is garbage collected and when resources allocated by an object are released (“finalized”). Properties in this class provide information about the total amount of memory available in the system and the age category, or “generation”, of memory allocated to an object.
MaxGeneration
ToString
Gets the maximum number of generations the system currently supports.
A “generation” number indicates the relative age of each segment of allocated memory. The newest memory is in generation zero and the oldest memory is in generation MaxGeneration. The garbage collector service improves its performance by adjusting generation numbers each time it reclaims memory, then taking into consideration newer memory is more likely to be eligible for garbage collection than older memory.
Collect
Forces garbage collection of all generations.
Collect
Forces garbage collection from generation zero through a specified generation. The maximum generation to garbage collect.
GetGeneration
Returns the current generation of a specified object.
Return Value: The current generation of obj. The object for which generation information is retrieved.
GetGeneration
Returns the current generation of the target of a specified weak reference.
Return Value: The current generation of the target of wo. The weak reference of a target.
GetTotalMemory
Retrieves the number of bytes currently thought to be allocated. A parameter indicates whether this method should wait a short interval before returning while the system garbage collects and finalizes objects.
If forceFullCollection is true, this method waits a short interval before returning while the system garbage collects and finalizes objects. The duration of the interval is an internally specified limit determined by the number of garbage collection cycles completed and the change in the amount of memory recovered between cycles. A Boolean value, which if true indicates this method should wait before returning.
KeepAlive
References the specified object, making it ineligible for garbage collection from the start of the current routine to the point where this method is called.
When calling methods in unmanaged code (such as Win32 APIs, unmanaged DLLs, or methods using COM), it is sometimes necessary to indicate a particular object should not be garbage collected, even though there are no references to it from managed code or data. The object to reference.
ReRegisterForFinalize
Requests the system call the finalizer method for the specified object, for which SuppressFinalize has previously been called.
A finalizer can use this method to resurrect itself or an object it references. The object for which a finalizer should be called.
SuppressFinalize
Requests the system not call the finalizer method for the specified object. The object for which a finalizer should not be called.
WaitForPendingFinalizers
Suspends the current thread until the thread processing the queue of finalizers has emptied that queue.
Finalizers are run on a separate thread of execution, so there is no guarantee this method will terminate. However, this thread can be interrupted by another thread while this method is in progress. This means you can start another thread that waits for a period of time, then interrupts this thread if it is still suspended.
Guid structure (System)
WaitForPendingFinalizers
Description
Represents a globally unique identifier (GUID).
A GUID is a 128-bit integer (16 bytes) that can be used across all computers and networks wherever a unique identifier is required. Such an identifier has a very low probability of being duplicated.
WaitForPendingFinalizers
Initializes a new instance of the Guid class.
Guid
Example Syntax:
WaitForPendingFinalizers
Initializes a new instance of the Guid class using the specified array of bytes. A 16 element byte array containing values with which to initialize the GUID.
Guid
Example Syntax:
WaitForPendingFinalizers
Initializes a new instance of the Guid class using the value represented by the specified string.
The string may begin and end with braces: ‘{’, and ‘}’. A String that contains a GUID in the following format: hexadecimal digits are arranged in groups of 8, 4, 4, 4, and 12 digits with hyphens between the groups. The GUID can optionally be enclosed in matching braces. For example: dddddddd-dddd-dddd-dddd-dddddddddddd or {dddddddd-dddd-dddd-dddd-dddddddddddd}.
Guid
Example Syntax:
WaitForPendingFinalizers
Initializes a new instance of the Guid class using the specified integers and byte array. The first 4 bytes of the GUID. The next 2 bytes of the GUID. The next 2 bytes of the GUID. The remaining 8 bytes of the GUID.
Guid
Example Syntax:
WaitForPendingFinalizers
Initializes a new instance of the Guid class using the specified integers and bytes.
Specifying individual bytes in this manner can be used to circumvent byte order restrictions (“big endian” or “little endian” byte order) on particular types of computers. The first 4 bytes of the GUID. The next 2 bytes of the GUID. The next bytes of the GUID. The next byte of the GUID. The next byte of the GUID. The next byte of the GUID. The next byte of the GUID. The next byte of the GUID. The next byte of the GUID. The next byte of the GUID. The next byte of the GUID.
Guid
Example Syntax:
WaitForPendingFinalizers
Initializes a new instance of the Guid class using the specified unsigned integers and bytes.
Specifying the bytes in this manner avoids endianness issues. The first 4 bytes of the GUID. The next 2 bytes of the GUID. The next 2 bytes of the GUID. The next byte of the GUID. The next byte of the GUID. The next byte of the GUID. The next byte of the GUID. The next byte of the GUID. The next byte of the GUID. The next byte of the GUID. The next byte of the GUID.
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: A signed number indicating the relative values of this instance and value.
Any instance of Guid, regardless of its value, is considered greater than null. An object to compare, or null.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if o is a Guid that has the same value as this instance; otherwise, false. The object to compare with this instance.
GetHashCode
Returns the hash code for this instance.
Return Value: The hash code for this instance.
NewGuid
Initializes a new instance of the Guid class.
Return Value: A new Guid object.
This is a convenient static method that you can call to get a new Guid.
op_Equality
Returns an indication whether the values of two specified Guid objects are equal.
Return Value: true if a and b are equal; otherwise, false. A Guid object. A Guid object.
op_Inequality
Returns an indication whether the values of two specified Guid objects are not equal.
Return Value: true if a and b are not equal; otherwise, false. A Guid object. A Guid object.
ToByteArray
Returns a 16-element byte array that contains the value of the GUID.
Return Value: A 16-element byte array.
ToString
Returns a String representation of the value of this instance in Registry format.
Return Value: A String formatted in this pattern: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx where the value of the GUID is represented as a series of lower-case 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”.
This method provides a default GUID format that is sufficient for typical use; however, other versions of this method that take a format parameter provide a few common format variations.
ToString
Returns a String representation of the value of this Guid instance, according to the provided format specifier.
Return Value: A System.String representation of the value of this Guid instance.
format can contain the following format specifiers. In the table that follows, all digits in the return value are hexadecimal. Each character ‘x’ represents a hexadecimal digit; each hyphen (‘-’), bracket (‘{’, ‘}’), and parenthesis (‘(‘, ’)’) appears as shown. A String containing a single format specifier character indicating how the GUID value should be formatted.
ToString
Returns a String representation of the value of this instance of the Guid class, according to the provided format specifier and culture-specific format information.
Return Value: A System.String representation of the value of this Guid instance.
format can contain the following format specifiers. In the table that follows, all digits in the return value are hexadecimal. Each character ‘x’ represents a hexadecimal digit; each hyphen (‘-’), bracket (‘{’, ‘}’), and parenthesis (‘(‘, ’)’) appears as shown. A String containing a single format specifier character indicating how the GUID value should be formatted. (Reserved) An IFormatProvider reference that supplies culture-specific formatting services.
IAppDomainSetup interface (System)
ToString
Description
ApplicationBase
ToString
ApplicationName
ToString
CachePath
ToString
ConfigurationFile
ToString
DynamicBase
ToString
LicenseFile
ToString
PrivateBinPath
ToString
PrivateBinPathProbe
ToString
ShadowCopyDirectories
ToString
ShadowCopyFiles
ToString
IAsyncResult interface (System)
ToString
Description
Represents the the status on an asynchronous operation.
The System.IAsyncResult interface is implemented by classes containing methods that can operate asynchronously. It is the return type of the “BeginXXX” method that initiates an asynchronous operation, and is the type of the third parameter of the “EndXXX” method that concludes an asynchronous operation.
AsyncState
ToString
Gets a user-defined object that qualifies or contains information about an asynchronous operation.
This property returns the object that is the last parameter of the “BeginXXX” method that initiates an asynchronous operation.
AsyncWaitHandle
ToString
Gets a System.Threading.WaitHandle instance that is used to wait for an asynchronous operation to complete.
The return value enables the client to wait for an asynchronous operation to complete instead of polling System.IAsyncResult.IsCompleted until the operation concludes. The return value can be used to perform a System.Threading.WaitHandle.WaitOne(System.Int32,System.Boolean), System.Threading.WaitHandle.WaitAny(System.Threading.WaitHandle[ ],System. Int32,System.Boolean), or System.Threading.WaitHandle.WaitAll(System.Threading.WaitHandle[ ],System.Int32,System.Boolean) operation.
CompletedSynchronously
ToString
Gets an indication whether the “BeginXXX” call completed synchronously.
If the synchronous completion of the call is detected in the System.AsyncCallback delegate, it is probable that the thread that called “BeginXXX” is the current thread. Most implementers of the System.IAsyncResult interface will not use this ability and will return false.
IsCompleted
ToString
Gets an indication whether the asynchronous operation is finished. Implementers will typically return the value of a private field or internal test as the value of this property.
ICloneable interface (System)
ToString
Description
Supports cloning, which creates a new instance of a class with the same value as an existing instance.
The System.ICloneable interface contains one member, System.ICloneable.Clone, which is intended to support cloning beyond that supplied by System.Object.MemberwiseClone.
Clone
Creates a new object that is a copy of the current instance.
Return Value: A new object that is a copy of this instance.
System.ICloneable.Clone can be implemented either as a deep copy or a shallow copy. In a deep copy, all objects are duplicated; whereas, in a shallow copy, only the top-level objects are duplicated and the lower levels contain references.
IComparable interface (System)
Clone
Description
Defines a generalized comparison method, which a value type or class implements to create a type-specific comparison method.
This interface is implemented by types whose values can be ordered; for example, the numeric and string classes.
CompareTo
Compares the current instance with another object of the same type.
Return Value: A 32-bit signed integer that indicates the relative order of the comparands. The return value has these meanings: Value Meaning Less than zero This instance is less than obj.
This method is only a definition and must be implemented by a specific class or value type to have effect. The meaning of the comparisons, “less than,” “equal to,” and “greater than,” depends on the particular implementation. An object to compare with this instance.
IConvertible interface (System)
CompareTo
Description
Defines methods that convert the value of the implementing reference or value type to a common language runtime type that has an equivalent value.
This interface provides methods to convert the value of an instance of an implementing type to a common language runtime type that has an equivalent value. The common language runtime types are System.Boolean, System.SByte, System.Byte, System.Int16, System.UInt16, System.Int32, System.UInt32, System.Int64, System.UInt64, System.Single, System.Double, System.Decimal, System.DateTime, System.Char, and System.String.
GetTypeCode
Returns the System.TypeCode for this instance.
Return Value: The enumerated constant that is the System.TypeCode of the class or value type that implements this interface. ToBoolean
Converts the value of this instance to an equivalent Boolean value using the specified culture-specific formatting information.
Return Value: A Boolean value equivalent to the value of this instance. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToByte
Converts the value of this instance to an equivalent 8-bit unsigned integer using the specified culture-specific formatting information.
Return Value: An 8-bit unsigned integer equivalent to the value of this instance. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToChar
Converts the value of this instance to an equivalent Unicode character using the specified culture-specific formatting information.
Return Value: A Unicode character equivalent to the value of this instance. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToDateTime
Converts the value of this instance to an equivalent System.DateTime using the specified culture-specific formatting information.
Return Value: A System.DateTime instance equivalent to the value of this instance. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToDecimal
Converts the value of this instance to an equivalent System.Decimal number using the specified culture-specific formatting information.
Return Value: A System.Decimal number equivalent to the value of this instance. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToDouble
Converts the value of this instance to an equivalent double-precision floating-point number using the specified culture-specific formatting information.
Return Value: A double-precision floating-point number equivalent to the value of this instance. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToInt16
Converts the value of this instance to an equivalent 16-bit signed integer using the specified culture-specific formatting information.
Return Value: An 16-bit signed integer equivalent to the value of this instance. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToInt32
Converts the value of this instance to an equivalent 32-bit signed integer using the specified culture-specific formatting information.
Return Value: An 32-bit signed integer equivalent to the value of this instance. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToInt64
Converts the value of this instance to an equivalent 64-bit signed integer using the specified culture-specific formatting information.
Return Value: An 64-bit signed integer equivalent to the value of this instance. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToSByte
Converts the value of this instance to an equivalent 8-bit signed integer using the specified culture-specific formatting information.
Return Value: An 8-bit signed integer equivalent to the value of this instance. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToSingle
Converts the value of this instance to an equivalent single-precision floating-point number using the specified culture-specific formatting information.
Return Value: A single-precision floating-point number equivalent to the value of this instance. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToString
Converts the value of this instance to an equivalent System.String using the specified culture-specific formatting information.
Return Value: A System.String instance equivalent to the value of this instance. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
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.
Return Value: An System.Object instance of type conversionType whose value is equivalent to the value of this instance. The System.Type to which the value of this instance is converted. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToUInt16
Converts the value of this instance to an equivalent 16-bit unsigned integer using the specified culture-specific formatting information.
Return Value: An 16-bit unsigned integer equivalent to the value of this instance. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToUInt32
Converts the value of this instance to an equivalent 32-bit unsigned integer using the specified culture-specific formatting information.
Return Value: An 32-bit unsigned integer equivalent to the value of this instance. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ToUInt64
Converts the value of this instance to an equivalent 64-bit unsigned integer using the specified culture-specific formatting information.
Return Value: An 64-bit unsigned integer equivalent to the value of this instance. An System.IFormatProvider interface implementation that supplies culture-specific formatting information.
ICustomFormatter interface (System)
ToUInt64
Description
Defines a method that supports custom, user-defined formatting of the value of an object.
When this interface is implemented by a reference or value type, the System.ICustomFormatter.Format(System.String,System.Object,System.IFormatProvider) method returns a custom-formatted string representation of an object's value.
Format
Converts the value of a specified object to an equivalent string representation using specified format and culture-specific formatting information.
Return Value: The string representation of the value of arg, formatted as specified by format and formatProvider.
The format parameter contains a user-defined formatting specification. For more information about standard .NET Framework formatting specifications, see. A format string containing formatting specifications. An object to format. An System.IFormatProvider object that supplies format information about the current instance.
IDisposable interface (System)
Format
Description
Defines a method to release allocated unmanaged resources.
The common language runtime garbage collector automatically releases memory allocated to a managed object when that object is no longer used. Furthermore, it is unpredictable when garbage collection will occur. However, the garbage collector has no knowledge of unmanaged resources, such as window handles and open files and streams.
Dispose
Releases unmanaged resources.
Use this method to close or release unmanaged resources such as files, streams, and handles, held by an instance of the class that implements this interface.
IFormatProvider interface (System)
Dispose
Description
Provides a mechanism for retrieving an object to control formatting.
A class or value type implements the System.IFormatProvider.GetFormat(System.Type) method of this interface to obtain an object that provides format information or processing for the implementing type.
GetFormat
Gets the format object of the specified type.
Return Value: A format object of type formatType—or—null if there is no format object of type formatType. An object that specifies the type of format object to get.
IFormattable interface (System)
GetFormat
Description
Provides functionality to format the value of an object into a string representation.
System.IFormattable is implemented by the base data types.
ToString
Formats the value of the current instance using the specified format.
Return Value: A System.String containing the value of the current instance in the specified format.
System.Globalization.NumberFormatInfo, System.Globalization.DateTimeFormatInfo and System.Globalization.CultureInfo implement the System.IFormatProvider interface. The System.String specifying the format to use. The System.IFormatProvider to use to format the value.
IndexOutOfRangeException class (System)
ToString
Description
The exception that is thrown when an attempt is made to access an element of an array with an index that is outside the bounds of the array. This class cannot be inherited.
System.IndexOutOfRangeException uses the HRESULT COR_E_INDEXOUTOFRANGE, which has the value 0x80131508.
IndexOutOfRangeException
Example Syntax:
ToString
Initializes a new instance of the System.IndexOutOfRangeException class with default properties.
The following table shows the initial property values for an instance of System.IndexOutOfRangeException.
IndexOutOfRangeException
Example Syntax:
ToString
Initializes a new instance of the System.IndexOutOfRangeException class with a specified error message. The following table shows the initial property values for an instance of System.IndexOutOfRangeException. The error message that explains the reason for the exception.
IndexOutOfRangeException
Example Syntax:
ToString
Initializes a new instance of the System.IndexOutOfRangeException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
Int16 structure (System)
ToString
Description
Represents a 16-bit signed integer.
The Int16 value type represents signed integers with values ranging from negative 32768 through positive 32767.
ToString
A constant representing the largest possible value of Int16.
The value of this constant is 32767; that is, hexadecimal 0x7FFF.
ToString
A constant representing the smallest possible value of Int16.
The value of this constant is −32768; that is, hexadecimal 0x8000.
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: A signed number indicating the relative values of this instance and value.
An Int16, regardless of its value, is considered greater than a null reference. An object to compare, or null.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if obj is an instance of Int16 and equals the value of this instance; otherwise, false. An object to compare with this instance.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
GetTypeCode
Returns the TypeCode for value type Int16.
Return Value: The enumerated constant, System.TypeCode.Int16.
Parse
Converts the String representation of a number to its 16-bit signed integer equivalent.
Return Value: A 16-bit signed integer equivalent to the number contained in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert.
Parse
Converts the String representation of a number in a specified culture-specific format to its 16-bit signed integer equivalent.
Return Value: A 16-bit signed integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
Parse
Converts the String representation of a number in a specified style to its 16-bit signed integer equivalent.
Return Value: A 16-bit signed integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStylesconstants that indicate the permitted format of s.
Parse
Converts the String representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent.
Return Value: A 16-bit signed integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStylesconstants that indicate the permitted format of s. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
IConvertible.ToBoolean
IConvertible.ToChar
IConvertible.ToDecimal
IConvertible.ToInt16
IConvertible.ToInt32
IConvertible.ToInt64
IConvertible.ToSByte
IConvertible.ToSingle
IConvertible.ToType
IConvertible.ToUInt16
IConvertible.ToUInt64
ToString
Converts the numeric value of this instance to its equivalent String representation.
Return Value: The System.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.
The return value is formatted with the general format specifier (“G”) and the System.Globalization.NumberFormatInfo for the current culture.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by provider.
This instance is formatted with the general format specifier (“G”). An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
ToString
Converts the numeric value of this instance to its equivalent String representation, using the specified format.
Return Value: The System.String representation of the value of this instance as specified by format.
If format is null or an empty string, the return value of this instance is formatted with the general format specifier (“G”). A format string.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified format and culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by format and provider.
If format is null or an empty string, the return value for this instance is formatted with the general format specifier (“G”). A format specification. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about this instance.
Int32 structure (System)
ToString
Description
Represents a 32-bit signed integer.
The Int32 value type represents signed integers with values ranging from negative 2,147,483,648 through positive 2,147,483,647.
ToString
A constant representing the largest possible value of Int32.
The value of this constant is 2,147,483,647; that is, hexadecimal 0x7FFFFFFF.
ToString
A constant representing the smallest possible value of Int32.
The value of this constant is −2,147,483,648; that is, hexadecimal 0x80000000.
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: A signed number indicating the relative values of this instance and value.
Any instance of Int32, regardless of its value, is considered greater than null. An object to compare, or null.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if obj is an instance of Int32 and equals the value of this instance; otherwise, false. An object to compare with this instance.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
GetTypeCode
Returns the TypeCode for value type Int32.
Return Value: The enumerated constant, System.TypeCode.Int32.
Parse
Converts the String representation of a number to its 32-bit signed integer equivalent.
Return Value: An 32-bit signed integer equivalent to the number contained in s.
s contains a number of the form: [ws][sign]digits [ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert.
Parse
Converts the String representation of a number in a specified culture-specific format to its 32-bit signed integer equivalent.
Return Value: A 32-bit signed integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
Parse
Converts the String representation of a number in a specified style to its 32-bit signed integer equivalent.
Return Value: An 32-bit signed integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStylesconstants that indicate the permitted format of s.
Parse
Converts the String representation of a number in a specified style and culture-specific format to its 32-bit signed integer equivalent.
Return Value: An 32-bit signed integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStylesconstants that indicate the permitted format of s. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
IConvertible.ToBoolean
IConvertible.ToByte
IConvertible.ToChar
IConvertible.ToDateTime
IConvertible.ToDecimal
IConvertible.ToDouble
IConvertible.ToInt16
IConvertible.ToInt32
IConvertible.ToInt64
IConvertible.ToSByte
IConvertible.ToSingle
IConvertible.ToType
IConvertible.ToUInt16
IConvertible.ToUInt64
ToString
Converts the numeric value of this instance to its equivalent String to representation.
Return Value: The System.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.
The return value is formatted with the general format specifier (“G”) and the System.Globalization.NumberFormatInfo for the current culture.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by provider.
This instance is formatted with the general format specifier (“G”). An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
ToString
Converts the numeric value of this instance to its equivalent String representation, using the specified format.
Return Value: The System.String representation of the value of this instance as specified by format.
If format is null or an empty string (“ ”), the return value of this instance is formatted with the general format specifier (“G”). A format string.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified format and culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by format and provider.
If format is null or an empty string ( ),the return value for this instance is formatted with the general format specifier (“G”). A format specification. An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
Int64 structure (System)
ToString
Description
Represents a 64-bit signed integer.
The Int64 value type represents integers with values ranging from negative 9,223,372,036,854,775,808 through positive 9,223,372,036,854,775,807.
ToString
A constant representing the largest possible value of Int64.
The value of this constant is 9,223,372,036,854,775,807; that is, hexadecimal 0x7FFFFFFFFFFFFFFF.
ToString
A constant representing the smallest possible value of Int64.
The value of this constant is negative 9,223,372,036,854,775,808; that is, hexadecimal 0x8000000000000000.
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: A signed number indicating the relative values of this instance and value.
An Int64, regardless of its value, is considered greater than a null reference. An object to compare, or null.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if obj is an instance of Int64 and equals the value of this instance; otherwise, false. An object to compare with this instance.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
GetTypeCode
Returns the TypeCode for value type Int64.
Return Value: The enumerated constant, System.TypeCode.Int64.
Parse
Converts the String representation of a number to its 64-bit signed integer equivalent.
Return Value: A 64-bit signed integer equivalent to the number contained in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert.
Parse
Converts the String representation of a number in a specified culture-specific format to its 64-bit signed integer equivalent.
Return Value: A 64-bit signed integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
Parse
Converts the String representation of a number in a specified style to its 64-bit signed integer equivalent.
Return Value: A 64-bit signed integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStylesconstants that indicate the permitted format of s.
Parse
Converts the String representation of a number in a specified style and culture-specific format to its 64-bit signed integer equivalent.
Return Value: A 64-bit signed integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStylesconstants that indicate the permitted format of s. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
IConvertible.ToBoolean
IConvertible.ToByte
IConvertible.ToChar
IConvertible.ToDateTime
IConvertible.ToDecimal
IConvertible.ToDouble
IConvertible.ToInt16
IConvertible.ToInt32
IConvertible.ToInt64
IConvertible.ToSByte
IConvertible.ToSingle
IConvertible.ToType
IConvertible.ToUInt16
IConvertible.ToUInt32
IConvertible.ToUInt64
ToString
Converts the numeric value of this instance to its equivalent String representation.
Return Value: The System.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.
The return value is formatted with the general format specifier (“G”) and the System.Globalization.NumberFormatInfo for the current culture.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by provider.
This instance is formatted with the general format specifier (“G”). An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
ToString
Converts the numeric value of this instance to its equivalent String representation, using the specified format.
Return Value: The System.String representation of the value of this instance as specified by format.
If format is null or an empty string (“ ”), the return value of this instance is formatted with the general format specifier (“G”). A format string.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified format and culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by format and provider.
If format is null or an empty string (“ ”), the return value for this instance is formatted with the general format specifier (“G”). A format specification. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about this instance.
IntPtr structure (System)
ToString
Description
A platform-specific type that is used to represent a pointer or a handle.
The System.IntPtr type is designed to be a platform-specific, machine-sized integer. That is, an instance of this type is expected to be 32-bits on 32-bit hardware and operating systems, and 64-bits on 64-bit hardware and operating systems.
ToString
A read-only field that represents an uninitialized pointer or handle.
The value of this field is not equivalent to null, but is instead a pointer which has not been assigned any value whatsoever. Use this field to efficiently determine whether an instance of IntPtr has been set.
IntPtr
Example Syntax:
ToString
Initializes a new instance of the System.IntPtr structure to the specified 32-bit pointer or handle. A pointer or handle contained in a 32-bit signed integer.
IntPtr
Example Syntax:
ToString
Initializes a new instance of the System.IntPtr structure to the specified 64-bit pointer.
An exception is only thrown if the value of value requires more bits than the current platform supports. A pointer or handle contained in a 64-bit signed integer.
IntPtr
Example Syntax:
ToString
Size
ToString
Gets the size of this instance.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if obj is an instance of IntPtr and equals the value of this instance; otherwise, false. An object to compare with this instance or null.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
op_Equality
Determines whether two specified instances of System.IntPtr are equal.
Return Value: true if value1 equals value2; otherwise, false. An IntPtr. An IntPtr.
op_Explicit
Converts the value of a 32-bit signed integer to an System.IntPtr.
Return Value: A new instance of System.IntPtr initialized to value. A 32-bit signed integer.
op_Explicit
Converts the value of a 64-bit signed integer to an System.IntPtr
Return Value: A new instance of System.IntPtr initialized to value. A 64-bit signed integer.
op_Explicit
Converts the value of the specified System.IntPtr instance to a 32-bit signed integer.
An exception is only thrown if the value of value requires more bits than the current platform supports. An IntPtr.
op_Explicit
op_Explicit
Converts the value of the specified System.IntPtr instance to a 64-bit signed integer. An IntPtr.
op_Explicit
op_Inequality
Determines whether two specified instances of System.IntPtr are not equal.
Return Value: true if value1 does not equal value2; otherwise, false. An IntPtr. An IntPtr. Serializable.GetObjectData
ToInt32
Converts the value of this instance to a 32-bit signed integer.
Return Value: A 32-bit signed integer.
An exception is only thrown if the value of value requires more bits than the current platform supports.
ToInt64
Converts the value of this instance to a 64-bit signed integer.
Return Value: A a 64-bit signed integer.
ToPointer
Converts the value of this instance to a pointer to an unspecified type.
Return Value: A pointer to System.Void; that is, a pointer to memory containing data of an unspecified type.
ToString
Converts the numeric value of this instance to its equivalent String representation.
Return Value: The System.String representation of the value of this instance.
InvalidCastException class (System)
ToString
Description
The exception that is thrown for invalid casting or explicit conversion.
System.InvalidCastException is thrown if: For a conversion from a System.Single or a System.Double to a System.Decimal, the source value is infinity, Not-a-Number (NaN), or too large to be represented as the destination type.
InvalidCastException
Example Syntax:
ToString
Initializes a new instance of the System.InvalidCastException class with default properties.
The following table shows the initial property values for an instance of System.InvalidCastException.
InvalidCastException
Example Syntax:
ToString
Initializes a new instance of the System.InvalidCastException class with a specified error message.
The following table shows the initial property values for an instance of System.InvalidCastException. The error message that explains the reason for the exception.
InvalidCastException
Example Syntax:
ToString
Initializes a new instance of the System.InvalidCastException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
InvalidCastException
Example Syntax:
ToString
Initializes a new instance of the System.InvalidCastException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the to constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
InvalidOperationException class (System)
ToString
Description
The exception that is thrown when a method call is invalid for the object's current state.
System.InvalidOperationException is used in cases when the failure to invoke a method is caused by reasons other than invalid arguments. For example, System.InvalidOperationException is thrown by: System.Collections.IEnumerator.MoveNext if objects of a collection are modified after the enumerator is created.
InvalidOperationException
Example Syntax:
ToString
Initializes a new instance of the System.InvalidOperationException class with default properties.
The following table shows the initial property values for an instance of System.InvalidOperationException.
InvalidOperationException
Example Syntax:
ToString
Initializes a new instance of the System.InvalidOperationException class with a specified error message.
The following table shows the initial property values for an instance of System.InvalidOperationException. The error message that explains the reason for the exception.
InvalidOperationException
Example Syntax:
ToString
Initializes a new instance of the System.InvalidOperationException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
InvalidOperationException
Example Syntax:
ToString
Initializes a new instance of the System.InvalidOperationException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
InvalidProgramException class (System)
ToString
Description
The exception that is thrown when a program contains an invalid IL or metadata. Generally this indicates a bug in a compiler.
System.InvalidProgramException uses the HRESULT COR_E_INVALIDPROGRAM, which has the value 0x8013153A.
InvalidProgramException
Example Syntax:
ToString
Initializes a new instance of the System.InvalidProgramException class with default properties.
The following table shows the initial property values for an instance of System.InvalidProgramException.
InvalidProgramException
Example Syntax: ToString
Initializes a new instance of the System.InvalidProgramException class with a specified error message.
The following table shows the initial property values for an instance of System.InvalidProgramException. The error message that explains the reason for the exception.
InvalidProgramException
Example Syntax:
ToString
Initializes a new instance of the System.InvalidProgramException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If inner is non-null, then the current Exception is raised in a catch block handling inner.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
IServiceProvider interface (System)
ToString
Description
Defines a mechanism for retrieving a “service” object; that is, an object which provides custom support to other objects.
This interface is implemented by a class or value type which provides a service to other objects.
GetService
Gets the service object of the specified type.
Return Value: A service object of type serviceType—or—null if there is no service object of type serviceType. An object that specifies the type of service object to get.
LoaderOptimization enumeration (System)
GetService
Description
An enumeration used with the System.LoaderOptimizationAttribute class to specify loader optimizations for an executable.
GetService
Indicates that the application will probably have many domains which use the same code, and the loader should share maximal internal resources across application domains.
GetService
Indicates that the application will probably host unique code in multiple domains, and the loader should share resources across application domains for globally available (strong named) assemblies only.
GetService
Indicates 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.
GetService
Indicates that the application will probably have a single domain, and loader should not share internal resources across application domains.
LoaderOptimizationAttribute class (System)
ToString
Description
Used to set the default loader optimization policy for the process. Should only be set on the main method for an application. It is ignored on all other methods.
The loader can make optimizations to share internal resource across application domains, at a slight expense in static access speed. This attribute tells the loader what type of application to optimize for—SingleDomain, MultiDomain (each domain running the same classes), or MultiDomainHost (multiple domains that can run different classes).
LoaderOptimizationAttribute
Example Syntax:
ToString
Initializes a new instance of the System.LoaderOptimizationAttribute class to the specified value. A value equivalent to a System.LoaderOptirnization constant.
LoaderOptimizationAttribute
Example Syntax:
ToString
Initializes a new instance of the System.LoaderOptimizationAttribute class to the specified value. A System.LoaderOptimization constant.
TypeId
Value
ToString
Description
Gets the current System.LoaderOptimization value for this instance.
LocalDataStoreSlot class (System)
ToString
Description
Encapsulates a memory slot to store local data. This class cannot be inherited.
Threads and contexts use a local store memory mechanism to store thread-specific and context-specific data, respectively. The common language runtime allocates a multi-slot data store array to each process when it is created. The thread or context calls various functions to allocate a data slot in the data store, to store and retrieve a data value in the slot, and to free a data slot for reuse after the thread or context object expires.
Finalize
Releases the memory slot reserved by an object when the object no longer exists.
System.LocalDataStoreSlot.Finalize locks the data store manager before marking the data slot as unoccupied.
MarshalByRefObject class (System)
ToString
Description
Base class for Remoting objects that need to be marshal by reference. This includes WellKnown SingleCall and WellKnown Singleton WebService objects and Client Activated Objects.
Some key points to classes that derived from MarshalByRefObject:* Derive from System.MarshalByRefObject or any of its children (except from context bound objects which derive from System.ContextBoundObject).
MarshalByRefObject
Example Syntax:
ToString
CreateObjRef
GetLifetimeService
Retrieves a lifetime service object that controls the lifetime policy for this instance. For the default Lifetime service this will be an object of type ILease.
Return Value: Returns Object to control lifetime Service.
InitializeLifetimeService
Objects can provide their own lease and so control their own lifetime. They do this by overriding the InitializeLifetimeService method provided on MarshalByRefObject.
Math class (System)
ToString
Description
Provides constants and static methods for trigonometric, logarithmic, and other common mathematical functions.
ToString
A constant, e, that specifies the natural logarithmic base.
The value of this field is 2.7182818284590452354.
ToString
A constant, (pi), that specifies the ratio of the circumference of a circle to its diameter.
The value of this field is 3.14159265358979323846.
Abs
Returns the absolute value of a Decimal number.
Return Value: A Decimal, x, such that 0 (<=)x(<=) System.Decimal.MaxValue. A number in the range System.Decimal.MinValue (<=) value (<=) System.Decimal.MaxValue.
Abs
Returns the absolute value of a double-precision floating point number.
Return Value: A double-precision floating point number, x, such that 0 (<=)x(=System.Double.MaxValue. A number in the range System.Double.MinValue<value (<=) System.Double.MaxValue. Abs
Returns the absolute value of a 16-bit signed integer.
Return Value: A 16-bit signed integer, x, such that 0 (<=)x(=System.Int16.MaxValue. A number in the range System.Int16.MinValue<value (<=) System.Int16.MaxValue. Abs
Returns the absolute value of a 32-bit signed integer.
Return Value: A 32-bit signed integer, x, such that 0 (<=)x(<=) System.Int32.MaxValue. A number in the range System.Int32.MinValue<value (<=) System.Int32.MaxValue. Abs
Returns the absolute value of a 64-bit signed integer.
Return Value: A 64-bit signed integer, x, such that 0 (<=)x(<=) System.Int64.MaxValue. A number in the range System.Int64.MinValue<value (<=) System.Int64.MaxValue. Abs
Returns the absolute value of an 8-bit signed integer.
Return Value: An 8-bit signed integer, x, such that 0 (<=)x(<=) System.SByte.MaxValue. A number in the range System.SByte.MinValue<value (<=) System.SByte.MaxValue. Abs
Returns the absolute value of a single-precision floating point number.
Return Value: A single-precision floating point number, x, such that 0 (<=)x(<=) System.Single.MaxValue. A number in the range System.Single.MinValue<value (<=) System.Single.MaxValue.
Acos
Returns the angle whose cosine is the specified number.
Return Value: An angle, q, measured in radians, such that 0 (<=)q(<=) (pi)—or—System.Double.NaN if d<−1 or d>1. Multiply the return value by 180/(pi) to convert from radians to degrees. A number representing a cosine, where −1 (<=)d(<=) 1.
Asin
Returns the angle whose sine is the specified number.
Return Value: An angle, q, measured in radians, such that −(pi)/2 (<=) q (<=) (pi)/2—or—System.Double.NaN if d<−1 or d>1.
A positive return value represents a counterclockwise angle from the x-axis; a negative return value represents a clockwise angle. A number representing a sine, where −1 (<=)d(<=) 1.
Atan
Returns the angle whose tangent is the specified number.
Return Value: An angle, q, measured in radians, such that −(pi)/2 (<=) q (<=) (pi)/2.
A positive return value represents a counterclockwise angle from the x-axis; a negative return value represents a clockwise angle. A number representing a tangent.
Atan2
Returns the angle whose tangent is the quotient of two specified numbers.
Return Value: An angle, q, measured in radians, such that −(pi)<q (<=) (pi), and tan(q)=y/x, where (x, y) is a point in the Cartesian plane. Observe the following: For (x, y) in quadrant 1, 0<q<(pi)/2.
The return value is the angle in the Cartesian plane formed by the x-axis, and a vector starting from the origin, (0,0), and terminating at the point, (x,y). The y coordinate of a point. The x coordinate of a point.
Ceiling
Returns the smallest whole number greater than or equal to the specified number.
Return Value: The smallest whole number greater than or equal to a.
The behavior of this method follows IEEE Standard 754, section 4. This kind of rounding is sometimes called rounding towards positive infinity. A number.
Cos
Returns the cosine of the specified angle.
Return Value: The cosine of d.
The angle, d, must be in radians. Multiply by (pi)/180 to convert degrees to radians. An angle, measured in radians.
Cosh
Returns the hyperbolic cosine of the specified angle.
Return Value: The hyperbolic cosine of value. An angle, measured in radians.
Exp
Returns e raised to the specified power.
Return Value: The number e raised to the power d.
Use the System.Math.Pow(System.Double,System.Double) method to calculate powers of other bases. A number specifying a power.
Floor
Returns the largest whole number less than or equal to the specified number.
Return Value: The largest whole number less than or equal to d.
The behavior of this method follows IEEE Standard 754, section 4. This kind of rounding is sometimes called rounding towards negative infinity. A number.
IEEERemainder
Returns the remainder resulting from the division of a specified number by another specified number.
Return Value: 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).
This operation complies with the remainder operation defined in Section 5.1 of ANSI/IEEE Std 754-1985; IEEE Standard for Binary Floating-Point Arithmetic; Institute of Electrical and Electronics Engineers, Inc; 1985. A dividend. A divisor.
Log
Returns the natural (base e) logarithm of a specified number.
Return Value: Sign of d Returns Positive The natural logarithm of d; that is, In d, or log e d Zero System.Double.PositiveInfinity Negative System.Double.NaN d is specified as a base 10 number. A number whose logarithm is to be found.
Log
Returns the logarithm of a specified number in a specified base.
Return Value: Sign of d Returns Positive The logarithm of a, in base, newBase; that is, log a.
a and newBase are specified as base 10 numbers. A number whose logarithm is to be found. The base of the logarithm.
Log10
Returns the base 10 logarithm of a specified number.
Return Value: Sign of d Returns Positive The base 10 log of d; that is, log d.
d is specified as a base 10 number. A number whose logarithm is to be found.
Max
Returns the larger of two 8-bit unsigned integers.
Return Value: val1 or val2, whichever is larger. The first of two 8-bit unsigned integers to compare. The second of two 8-bit unsigned integers to compare.
Max
Returns the larger of two Decimal numbers.
Return Value: val1 or val2, whichever is larger. The first of two System.Decimal numbers to compare. The second of two System.Decimal numbers to compare.
Max
Returns the larger of two double-precision floating point numbers.
Return Value: val1 or val2, whichever is larger. The first of two double-precision floating point numbers to compare. The second of two double-precision floating point numbers to compare.
Max
Returns the larger of two 16-bit signed integers.
Return Value: val1 or val2, whichever is larger. The first of two 16-bit signed integers to compare. The second of two 16-bit signed integers to compare.
Max
Returns the larger of two 32-bit signed integers.
Return Value: val1 or val2, whichever is larger. The first of two 32-bit signed integers to compare. The second of two 32-bit signed integers to compare.
Max
Returns the larger of two 64-bit signed integers.
Return Value: val1 or val2, whichever is larger. The first of two 64-bit signed integers to compare. The second of two 64-bit signed integers to compare.
Max
Returns the larger of two 8-bit signed integers.
Return Value: val1 or val2, whichever is larger. The first of two 8-bit unsigned integers to compare. The second of two 8-bit unsigned integers to compare.
Max
Returns the larger of two single-precision floating point numbers.
Return Value: val1 or val2, whichever is larger. The first of two single-precision floating point numbers to compare. The second of two single-precision floating point numbers to compare.
Max
Returns the larger of two 16-bit unsigned integers.
Return Value: val1 or val2, whichever is larger. The first of two 16-bit unsigned integers to compare. The second of two 16-bit unsigned integers to compare.
Max
Returns the larger of two 32-bit unsigned integers.
Return Value: val1 or val2, whichever is larger. The first of two 32-bit unsigned integers to compare. The second of two 32-bit unsigned integers to compare.
Max
Returns the larger of two 64-bit unsigned integers.
Return Value: val1 or val2, whichever is larger. The first of two 64-bit unsigned integers to compare. The second of two 64-bit unsigned integers to compare.
Min
Returns the smaller of two 8-bit unsigned integers.
Return Value: val1 or val2, whichever is smaller. The first of two 8-bit unsigned integers to compare. The second of two 8-bit unsigned integers to compare.
Min
Returns the smaller of two Decimal numbers.
Return Value: a or val2, whichever is smaller. The first of two System.Decimal numbers to compare. The second of two System.Decimal numbers to compare.
Min
Returns the smaller of two double-precision floating point numbers.
Return Value: a or val2, whichever is smaller. The first of two double-precision floating point numbers to compare. The second of two double-precision floating point numbers to compare.
Min
Returns the smaller of two 16-bit signed integers.
Return Value: val1 or val2, whichever is smaller. The first of two 16-bit signed integers to compare. The second of two 16-bit signed integers to compare.
Min
Returns the smaller of two 32-bit signed integers.
Return Value: val1 or val2, whichever is smaller. The first of two 32-bit signed integers to compare. The second of two 32-bit signed integers to compare.
Min
Returns the smaller of two 64-bit signed integers.
Return Value: val1 or val2, whichever is smaller. The first of two 64-bit signed integers to compare. The second of two 64-bit signed integers to compare.
Min
Returns the smaller of two 8-bit signed integers.
Return Value: val1 or val2, whichever is smaller. The first of two 8-bit signed integers to compare. The second of two 8-bit signed integers to compare.
Min
Returns the smaller of two single-precision floating point numbers.
Return Value: val1 or val2, whichever is smaller. The first of two single-precision floating point numbers to compare. The second of two single-precision floating point numbers to compare.
Min
Returns the smaller of two 16-bit unsigned integers.
Return Value: val1 or val2, whichever is smaller. The first of two 16-bit unsigned integers to compare. The second of two 16-bit unsigned integers to compare.
Min
Returns the smaller of two 32-bit unsigned integers.
Return Value: val1 or val2, whichever is smaller. The first of two 32-bit unsigned integers to compare. The second of two 32-bit unsigned integers to compare.
Min
Returns the smaller of two 64-bit unsigned integers.
Return Value: val1 or val2, whichever is smaller. The first of two 64-bit unsigned integers to compare. The second of two 64-bit unsigned integers to compare.
Pow
Returns a specified number raised to the specified power.
Return Value: The number x raised to the power y. A number to be raised to a power. A number that specifies a power.
Round
Returns the whole number nearest the specified value.
Return Value: The whole number nearest parameter d. If d is halfway between two whole numbers, one of which by definition is even and the other odd, then the even number is returned.
The behavior of this method follows IEEE Standard 754, section 4. This kind of rounding is sometimes called rounding to nearest, or banker's rounding. A System.Decimal number to be rounded.
Round
Returns the whole number nearest the specified value.
Return Value: The whole number nearest a. If a is halfway between two whole numbers, one of which by definition is even and the other odd, then the even number is returned.
The behavior of this method follows IEEE Standard 754, section 4. This kind of rounding is sometimes called rounding to nearest, or banker's rounding. A double-precision floating point number to be rounded.
Round
Returns the number with the specified precision nearest the specified value.
Return Value: The number nearest d with precision equal to decimals. If d is halfway between two numbers, one of which is even and the other odd, then the even number is returned. If the precision of d is less than decimals, then d is returned unchanged. The decimals parameter specifies the number of significant fractional digits in the return value and ranges from 0 to 28. If decimals is zero, then a whole number is returned. A System.Decimal number to be rounded. The number of significant fractional digits (precision) in the return value.
Round
Returns the number with the specified precision nearest the specified value.
Return Value: The number nearest value with precision equal to digits. If value is halfway between two numbers, one of which is even and the other odd, then the even number is returned. If the precision of value is less than digits, then value is returned unchanged.
The digits parameter specifies the number of significant fractional digits in the return value and ranges from 0 to 15. If digits is zero, then a whole number is returned. A double-precision floating point number to be rounded. The number of significant fractional digits (precision) in the return value.
Sign
Returns a value indicating the sign of a Decimal number.
Return Value: A number indicating the sign of value. A signed System.Decimal number.
Sign
Returns a value indicating the sign of a double-precision floating point number.
Return Value: A number indicating the sign of value. A signed number.
Sign
Returns a value indicating the sign of a 16-bit signed integer.
Return Value: A number indicating the sign of value. A signed number.
Sign
Returns a value indicating the sign of a 32-bit signed integer.
Return Value: A number indicating the sign of value. A signed number.
Sign
Returns a value indicating the sign of a 64-bit signed integer.
Return Value: A number indicating the sign of value. A signed number.
Sign
Returns a value indicating the sign of an 8-bit signed integer.
Return Value: A number indicating the sign of value. Number Description−1 value is less than zero. A signed number. Sign
Returns a value indicating the sign of a single-precision floating point number.
Return Value: A number indicating the sign of value. A signed number.
Sin
Returns the sine of the specified angle.
Return Value: The sine of a. The angle, a, must be in radians. Multiply by (pi)/180 to convert degrees to radians. An angle, measured in radians.
Sinh
Returns the hyperbolic sine of the specified angle.
Return Value: The hyperbolic sine of value. An angle, measured in radians.
Sqrt
Returns the square root of a specified number.
Return Value: Value of d Returns Zero, or positive The positive square root of d. A number.
Tan
Returns the tangent of the specified angle.
Return Value: The tangent of a.
The angle, a, must be in radians. Multiply by (pi)/180 to convert degrees to radians. An angle, measured in radians.
Tanh
Returns the hyperbolic tangent of the specified angle.
Return Value: The hyperbolic tangent of value. An angle, measured in radians.
MemberAccessException class (System)
ToString
Description
The exception that is thrown when an attempt to access a class member fails.
System.MemberAccessException is the base class for System.FieldAccessException, System.MethodAccessException, System.MissingMemberException, System.MissingMethodException, and System.MissingFieldException. These exceptions are thrown when a class member is not found or access to the member is not permitted.
MemberAccessException
Example Syntax:
ToString
Initializes a new instance of the System.MemberAccessException class with default properties.
The following table shows the initial property values for an instance of System.MemberAccessException.
MemberAccessException
Example Syntax:
ToString
Initializes a new instance of the System.MemberAccessException class with a specified error message.
The following table shows the initial property values for an instance of System.MemberAccessException. The error message that explains the reason for the exception.
MemberAccessException
Example Syntax:
ToString
Initializes a new instance of the System.MemberAccessException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
MemberAccessException
Example Syntax:
ToString
Initializes a new instance of the System.MemberAccessException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If inner is non-null, then the current Exception is raised in a catch block handling inner.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
MethodAccessException class (System)
ToString
Description
The exception that is thrown when there is an illegal attempt to access a private or protected method inside a class.
System.MethodAccessException uses the HRESULT COR_E_METHODACCESS, which has the value 0x80131510.
MethodAccessException
Example Syntax:
ToString
Initializes a new instance of the System.MethodAccessException class with default properties.
The following table shows the initial property values for an instance of System.MethodAccessException.
MethodAccessException
Example Syntax: ToString
Initializes a new instance of the System.MethodAccessException class with a specified error message.
The following table shows the initial property values for an instance of System.MethodAccessException. The error message that explains the reason for the exception.
MethodAccessException
Example Syntax:
ToString
Initializes a new instance of the System.MethodAccessException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
MethodAccessException
Example Syntax:
ToString
Initializes a new instance of the System.MethodAccessException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If inner is non-null, then the current Exception is raised in a catch block handling inner.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
MissingFieldException class (System)
ToString
Description
The exception that is thrown when there is an attempt to dynamically access a field that does not exist.
System.MissingFieldException uses the HRESULT COR_E_MISSINGFIELD, which has the value 0x80131511.
MissingFieldException
Example Syntax:
ToString
System.MissingFieldException
Description
Initializes a new instance of the System.MissingFieldException class with default properties.
The following table shows the initial property values for an instance of System.MissingFieldException.
MissingFieldException
Example Syntax:
ToString
Initializes a new instance of the System.MissingFieldException class with a specified error message.
The following table shows the initial property values for an instance of System.MissingFieldException. The error message that explains the reason for the exception.
MissingFieldException
Example Syntax:
ToString
Initializes a new instance of the System.MissingFieldException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
MissingFieldException
Example Syntax:
ToString
Initializes a new instance of the System.MissingFieldException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If inner is non-null, then the current Exception is raised in a catch block handling inner.
MissingFieldException
Example Syntax:
ToString
Initializes a new instance of the System.MissingFieldException class with the specified class name and field name. The name of the class in which access to a nonexistent field was attempted. The name of the field that cannot be accessed.
HelpLink
HResult
InnerException
Message
ToString
Description
Gets the text string showing the signature of the missing field, the class name, and the field name.
If the class name is not specified when the object is constructed, the default text string inherited from the base class is returned. This property overrides System.MissingMemberException.Message. The error message should be localized.
Source
StackTrace
TargetSite
MissingMemberException class (System)
ToString
Description
The exception that is thrown when there is an attempt to dynamically access a class member that does not exist.
Normally a compilation error is generated if the code attempts to access a nonexistent member of a class.
ToString
Holds the class name of the missing member.
ToString
Holds the name of the missing member.
ToString
Holds the signature of the missing member.
System.MissingMemberException.Signature contains a System.Byte value that represents the signature of the missing member.
MissingMemberException
Example Syntax:
ToString
Initializes a new instance of the System.MissingMemberException class with default properties.
The following table shows the initial property values for an instance of System.MissingMemberException.
MissingMemberException
Example Syntax:
ToString
Initializes a new instance of the System.MissingMemberException class with a specified error message.
The following table shows the initial property values for an instance of System.MissingMemberException. The error message that explains the reason for the exception.
MissingMemberException
Example Syntax:
ToString
Initializes a new instance of the System.MissingMemberException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
MissingMemberException
Example Syntax:
ToString
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.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If inner is non-null, then the current Exception is raised in a catch block handling inner.
MissingMemberException
Example Syntax:
ToString
Initializes a new instance of the System.MissingMemberException class with the specified class name and member name. The name of the class in which access to a nonexistent member was attempted. The name of the member that cannot be accessed.
HelpLink
HResult
InnerException
Message
ToString
Description
Gets the text string showing the class name, the member name, and the signature of the missing member. If the class name is not specified when the object is constructed, the default text string inherited from the base class is returned.
This property overrides System.Exception.Message. The error message should be localized.
Source
StackTrace
TargetSite
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.
System.TypeLoadException.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext) sets a System.Runtime.Serialization.SerializationInfo with all the exception object data targeted for serialization. During deserialization, the exception object is reconstituted from the System.Runtime.Serialization.SerializationInfo transmitted over the stream. The object that holds the serialized object data. The contextual information about the source or destination.
MissingMethodException class (System)
ToString
Description
The exception that is thrown when there is an attempt to dynamically access a method that does not exist.
System.MissingMethodException uses the HRESULT COR_E_MISSINGMETHOD, which has the value 0x80131513.
MissingMethodException
Example Syntax:
ToString
System.MissingMethodException
Description
Initializes a new instance of the System.MissingMethodException class with default properties.
The following table shows the initial property values for an instance of System.MissingMethodException.
MissingMethodException
Example Syntax:
ToString
Initializes a new instance of the System.MissingMethodException class with a specified error message.
The following table shows the initial property values for an instance of System.MissingMethodException. The error message that explains the reason for the exception.
MissingMethodException
Example Syntax:
ToString
Initializes a new instance of the System.MissingMethodException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
MissingMethodException
Example Syntax:
ToString
Initializes a new instance of the System.MissingMethodException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If inner is non-null, then the current Exception is raised in a catch block handling inner.
MissingMethodException
Example Syntax:
ToString
Initializes a new instance of the System.MissingMethodException class with the specified class name and method name. The name of the class in which access to a nonexistent method was attempted. The name of the method that cannot be accessed.
HelpLink
HResult
InnerException
Message
ToString
Description
Gets the text string showing the class name, the method name, and the signature of the missing method.
If the class name is not specified when the object is constructed, the default text string inherited from the base class is returned.
Source
StackTrace
TargetSite
MTAThreadAttribute class (System)
ToString
Description
Indicates the default threading model for an application is multi-threaded apartment.
Only apply this attribute to the main method of an application.
MTAThreadAttribute
Example Syntax:
ToString
Initializes a new instance of the System.MTAThreadAttribute class.
TypeId
MulticastDelegate class (System)
ToString
Description
Represents a multicast delegate; that is, a delegate that can have more than one element in its invocation list.
All multicast delegates are derived from class MulticastDelegate.
MulticastDelegate
Example Syntax:
ToString
Initializes a new instance of the MulticastDelegate class. This constructor is called from the class generated by the compiler-generated code.
This must match the constructor in Delegate. The object on which the specified method is defined. The name of the method for which to create a delegate.
MulticastDelegate
Example Syntax:
ToString
Initializes a new instance of the MulticastDelegate class. This constructor is called from a class to generate a delegate based upon a static method name and the Type object for the class defining the method. The Type object that represents the class that the specified method is defined on. The name of the static method for which to create a delegate.
Method
Target
CombineImpl
Combines this System.Delegate with the passed Delegate to form a new delegate.
Return Value: A Delegate object as the new root. The Delegate with which to combine this Delegate.
DynamicInvokeImpl
Processes the full invocation list.
Return Value: An array of type Object that contains the return value of the encapsulated method. The arguments to be passed to the encapsulated method.
Equals
Determines whether this multicast delegate and the specified object are equal.
Return Value: true if obj and this instance have the same invocation lists; otherwise, false.
Two delegates, whether single- or multi-cast, are equal if they have the same invocation lists. Two invocation lists are considered identical if they have the same order, and the corresponding elements from the two lists represent the same method and target. The object to compare with this instance.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
GetInvocationList
Returns the invocation list of this multicast delegate, in invocation order.
Return Value: An array of delegates in the invocation list.
op_Equality
Determines whether two MulticastDelegate objects are equal.
Return Value: True if d1 and d2 have the same invocation lists; otherwise false.
Two delegates, whether single- or multi-cast, are equal if they have the same invocation lists. Two invocation lists are considered identical if they have the same order, and the corresponding elements from the two lists represent the same method and target. The left operand. The right operand.
op_Inequality
Determines whether two MulticastDelegate objects are not equal.
Return Value: True if d1 and d2 do not have the same invocation lists; otherwise false.
Two delegates, whether single- or multi-cast, are equal if they have the same invocation lists. Two invocation lists are considered identical if they have the same order, and the corresponding elements from the two lists represent the same method and target. The left operand. The right operand.
RemoveImpl
Searches the invocation list for an element that has System.Delegate-based equality with value
Return Value: A new Delegate if an element on the invocation list is found that has Delegate-based equality with value (and thus is removed from the invocation list). If such an element is not found, the current invocation list is returned. The Delegate to search for in the invocation list.
MulticastNotSupportedException class (System)
ToString
Description
The exception that is thrown when there is an attempt to combine two instances of a non-combinable delegate type unless one of the operands is null. This class cannot be inherited.
A valid delegate combination is made when one or both operands is a combinable delegate type. If both operands are non-combinable delegate type, then one operand must be null. A combinable delegate type must satisfy the following conditions: The declared return type of the delegate must be void.
MulticastNotSupportedException
Example Syntax:
ToString
Initializes a new instance of the System.MulticastNotSupportedException class with default properties.
The following table shows the initial property values for an instance of System.MulticastNotSupportedException.
MulticastNotSupportedException
Example Syntax:
ToString
Initializes a new instance of the System.MulticastNotSupportedException class with a specified error message.
The following table shows the initial property values for an instance of System.MulticastNotSupportedException. The error message that explains the reason for the exception.
MulticastNotSupportedException
Example Syntax:
ToString
Initializes a new instance of the System.MulticastNotSupportedException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If inner is non-null, then the current Exception is raised in a catch block handling inner.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
NonSerializedAttribute class (System)
ToString
Description
Indicates that a field of a serializable class should not be serialized. This class cannot be inherited.
The target objects for the System.NonSerializedAttribute are public and private fields of a serializable class. By default, classes are not serializable unless they are marked with the System.SerializableAttribute. During the serialization process all the public and private fields of a class are serialized by default. Fields that must not be serialized can be marked with the System.NonSerializedAttribute, which instructs the serialization process to ignore the target field during serialization.
NonSerializedAttribute
Example Syntax:
ToString
Initializes a new instance of the System.NonSerializedAttribute class.
TypeId
NotFiniteNumberException class (System)
ToString
Description
The exception that is thrown when a floating-point value is positive infinity, negative infinity, or Not-a-Number (NaN).
Applications written in C# will not throw this exception.
NotFiniteNumberException
Example Syntax:
ToString
Initializes a new instance of the System.NotFiniteNumberException class with default properties.
The following table shows the initial property values for an instance of System.NotFiniteNumberException.
NotFiniteNumberException
Example Syntax:
ToString
Initializes a new instance of the System.NotFiniteNumberException class with the invalid number.
The offendingNumber parameter must be both a System.Double and an invalid number. The invalid number.
NotFiniteNumberException
Example Syntax:
ToString
Initializes a new instance of the System.NotFiniteNumberException class with a specified error message.
The following table shows the initial property values for an instance of System.NotFiniteNumberException. The error message that explains the reason for the exception.
NotFiniteNumberException
Example Syntax:
ToString
Initializes a new instance of the System.NotFiniteNumberException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
NotFiniteNumberException
Example Syntax:
ToString
Initializes a new instance of the System.NotFiniteNumberException class with a specified error message and the invalid number.
The following table shows the initial property values for an instance of System.NotFiniteNumberException. The error message that explains the reason for the exception. The invalid number.
NotFiniteNumberException
Example Syntax:
ToString
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 the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. The invalid number. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
OffendingNumber
ToString
Description
Gets the invalid number that is a positive infinity, a negative infinity, or Not-a-Number (NaN).
Source
StackTrace
TargetSite
GetObjectData
Sets the System.Runtime.Serialization.SerializationInfo object with the invalid number and additional exception information.
System.TypeLoadException.GetObjectData(System.Runtime.Serialization. SerializationInfo,System.Runtime.Serialization.StreamingContext) sets a System.Runtime.Serialization.SerializationInfo with all the exception object data targeted for serialization. During deserialization, the exception object is reconstituted from the System.Runtime.Serialization.SerializationInfo transmitted over the stream. The object that holds the serialized object data. The contextual information about the source or destination.
NotImplementedException class (System)
ToString
Description
The exception that is thrown when a requested method or operation is not implemented.
System.NotImplementedException uses the default System.Object.Equals(System.Object) implementation, which supports reference equality. For a list of initial values for an instance of System.NotImplementedException, see the System.NotImplementedException.#ctor constructors.
NotImplementedException
Example Syntax:
ToString
Initializes a new instance of the System.NotImplementedException class with default properties.
The following table shows the initial property values for an instance of System.NotImplementedException.
NotImplementedException
Example Syntax:
ToString
Initializes a new instance of the System.NotImplementedException class with a specified error message.
The following table shows the initial property values for an instance of System.NotImplementedException. The error message that explains the reason for the exception.
NotImplementedException
Example Syntax:
ToString
Initializes a new instance of the System.NotImplementedException class with serialized data. The object that holds the serialized object data. The contextual information about the source or destination.
NotImplementedException
Example Syntax:
ToString
Initializes a new instance of the System.NotImplementedException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If inner is non-null, then the current Exception is raised in a catch block handling inner.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
NotSupportedException class (System)
ToString
Description
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.
There are methods that are not supported in the base class, with the expectation that these methods will be implemented in the derived classes instead. The derived class might implement only a subset of the methods from the base class, and throw System.NotSupportedException for the unsupported methods.
NotSupportedException
Example Syntax:
ToString
Initializes a new instance of the System.NotSupportedException class with default properties.
The following table shows the initial property values for an instance of System.NotSupportedException.
NotSupportedException
Example Syntax:
ToString
Initializes a new instance of the System.NotSupportedException class with a specified error message.
The following table shows the initial property values for an instance of System.NotSupportedException. The error message that explains the reason for the exception.
NotSupportedException
Example Syntax:
ToString
Initializes a new instance of the System.NotSupportedException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
NotSupportedException
Example Syntax:
ToString
Initializes a new instance of the System.NotSupportedException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
NullReferenceException class (System)
ToString
Description
The exception that is thrown when there is an attempt to dereference a null object reference.
System.NullReferenceException uses the HRESULT COR_E_NULLREFERENCE, which has the value 0x80004003.
NullReferenceException
Example Syntax:
ToString
Initializes a new instance of the System.NullReferenceException class with default properties.
The following table shows the initial property values for an instance of System.NullReferenceException
NullReferenceException
Example Syntax:
ToString
Initializes a new instance of the System.NullReferenceException class with a specified error message.
The following table shows the initial property values for an instance of System.NullReferenceException. The error message that explains the reason for the exception.
NullReferenceException
Example Syntax:
ToString
Initializes a new instance of the System.NullReferenceException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
NullReferenceException
Example Syntax:
ToString
Initializes a new instance of the System.NullReferenceException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
Object class (System)
ToString
Description
Supports all classes in the .NET Framework class hierarchy and provides low-level services to derived classes. This is the ultimate superclass of all classes in the .NET Framework; it is the root of the type hierarchy.
Languages typically do not require a class to declare inheritance from System.Object because the inheritance is implicit.
Object
Example Syntax:
ToString
Initializes a new instance of the System.Object class.
This constructor is called by constructors in derived classes, but it can also be used to directly create an instance of the System.Object class.
Equals
Determines whether the specified System.Object is equal to the current System.Object.
Return Value: true if the specified System.Object is equal to the current System.Object; otherwise, false.
The default implementation of System.Object.Equals(System.Object) supports reference equality only, but derived classes can override this method to support value equality. The System.Object to compare with the current System.Object.
Equals
Determines whether the specified System.Object instances are considered equal.
Return Value: true if objA is the same instance as objB or if both are null references or if objA.Equals(objB) returns true; otherwise, false.
The default implementation of System.Object.Equals(System.Object) supports reference equality only, but derived classes can override this method to support value equality. The first System.Object to compare. The second System.Object to compare.
Finalize
Allows an System.Object to attempt to free resources and perform other cleanup operations before the System.Object is reclaimed by garbage collection.
System.Object.Finalize is protected and, therefore, is accessible only through this class or a derived class.
GetHashCode
Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
Return Value: A hash code for the current System.Object.
This method can be overridden by a derived class. Value classes must override this method to provide a hash function that is appropriate for the class and that ensures a better distribution in the hash table. Classes that might be used as a key in a hash table must also override this method, because objects that are used as keys in a hash table are required to generate their own hash code through this method.
GetType
Gets the System.Type of the current instance.
Return Value: The System.Type instance that represents the exact runtime type of the current instance.
For two objects x and y that have identical runtime types, Object.ReferenceEquals(x.GetType( ),y.GetType( )) returns true.
MemberwiseClone
Creates a shallow copy of the current System.Object
Return Value: A shallow copy of the current System.Object.
This method cannot be overridden; a derived class should implement the System.ICloneable interface if a shallow copy is not appropriate.
ReferenceEquals
Determines whether the specified System.Object instances are the same instance.
Return Value: true if objA is the same instance as objB or if both are null references; otherwise, false. The first System.Object to compare. The second System.Object to compare.
ToString
Returns a System.String that represents the current System.Object.
Return Value: A System.String that represents the current System.Object.
This method returns a human-readable string that is culture-sensitive. For example, for an instance of the System.Double class whose value is zero, the implementation of System.Double.ToString might return “0.00” or “0,00” depending on the current UI culture.
ObjectDisposedException class (System)
ToString
ObjectDisposedException
Example Syntax:
ToString
System.ObjectDisposedException
ObjectDisposedException
Example Syntax:
ToString
ObjectDisposedException
Example Syntax:
ToString
System.ObjectDisposedException
HelpLink
HResult
InnerException
Message
ToString
ObjectName
ToString
Source
StackTrace
TargetSite
ObsoleteAttribute class (System)
ToString
Description
Marks the program elements that are no longer in use. This class cannot be inherited.
System.ObsoleteAttribute is applicable to all program elements except assemblies, modules, parameters or return values. Marking an element as obsolete informs the users that the element will be removed in future versions of the product or that the functionality provided by the element is made internal to your application.
ObsoleteAttribute
Example Syntax:
ToString
Initializes a new instance of the System.ObsoleteAttribute class with default properties.
The following table shows the initial property values for an instance of System.ObsoleteAttribute.
ObsoleteAttribute
Example Syntax:
ToString
Initializes a new instance of the System.ObsoleteAttribute class with a specified workaround message.
The following table shows the initial property values for an instance of System.ObsoleteAttribute. The text string that describes alternative workarounds.
ObsoleteAttribute
Example Syntax:
ToString
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.
The following table shows the initial property values for an instance of System.ObsoleteAttribute. The text string that describes alternative workarounds. The Boolean value that indicates whether the obsolete element usage is considered an error.
IsError
ToString
Gets a Boolean value indicating whether the compiler will treat usage of the obsolete program element as an error.
Message
ToString
Gets the workaround message, including a description of the alternative program elements.
TypeId
OperatingSystem class (System)
ToString
Description
Represents information about an operating system, such as the version and platform identifier.
This class provides a method to copy an instance of OperatingSystem, and a method to return a string representation of operating system information.
OperatingSystem
Example Syntax:
ToString
Initializes a new instance of the OperatingSystem class, using the specified platform identifier value and version object. A System.PlatformID enumerated constant that indicates the operating system platform. A System.Version object that indicates the version of the operating system.
Platform
ToString
Gets a PlatformID value that identifies this operating system platform.
Version
ToString
Gets a Version object that identifies this operating system.
Clone
Returns an OperatingSystem object that is identical to this instance.
Return Value: An OperatingSystem object that is a copy of this instance.
ToString
Converts the value of this instance to its equivalent String representation.
Return Value: The format of the return value is: platform majorVersion.minorVersion.build.revision For example, if the operating sysem is Windows 2000, the return value is: “Microsoft Windows NT 5.0.0.2195”.
OutOfMemoryException class (System)
ToString
Description
The exception that is thrown when there is not enough memory to continue the execution of a program.
System.OutOfMemoryException uses the HRESULT COR_E_OUTOFMEMORY, which has the value 0x8007000E.
OutOfMemoryException
Example Syntax:
ToString
Initializes a new instance of the System.OutOfMemoryException class with default properties.
The following table shows the initial property values for an instance of System.OutOfMemoryException.
OutOfMemoryException
Example Syntax:
ToString
Initializes a new instance of the System.OutOfMemoryException class with a specified error message.
The following table shows the initial property values for an instance of System.OutOfMemoryException. The error message that explains the reason for the exception.
OutOfMemoryException
Example Syntax:
ToString
Initializes a new instance of the System.OutOfMemoryException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
OutOfMemoryException
Example Syntax:
ToString
Initializes a new instance of the System.OutOfMemoryException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
OverflowException class (System)
ToString
Description
The exception that is thrown when an arithmetic, casting, or conversion operation in a checked context results in an overflow.
For a result from an integral or decimal-type arithmetic operation or conversion that is outside the range of the destination type: In a checked context, a compile-time error occurs if the operation is a constant expression. Otherwise, an System.OverflowException is thrown if the operation is performed at run-time.
OverflowException
Example Syntax:
ToString
Initializes a new instance of the System.OverflowException class with default properties.
The following table shows the initial property values for an instance of System.OverflowException.
OverflowException
Example Syntax:
ToString
Initializes a new instance of the System.OverflowException class with a specified error message.
The following table shows the initial property values for an instance of System.OverflowException. The error message that explains the reason for the exception.
OverflowException
Example Syntax:
ToString
Initializes a new instance of the System.OverflowException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
OverflowException
Example Syntax:
ToString
Initializes a new instance of the System.OverflowException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
ParamArrayAttribute class (System)
ToString
Description
Indicates that the method will allow a variable number of arguments in its invocation. This class cannot be inherited.
A parameter array allows the specification of an unknown number of arguments. A parameter array must be the last parameter in a formal parameter list, and it must be a single-dimension array. A parameter array permits arguments to a method to be specified in two ways: A single expression of a type that is implicitly convertible to the parameter array type. The parameter array functions as a value parameter.
ParamArrayAttribute
Example Syntax:
ToString
Initializes a new instance of the System.ParamArrayAttribute class with default properties.
TypeId
PlatformID enumeration (System)
ToString
Description
Describes the platforms supported by an assembly.
These flags are used to bind to an assembly.
ToString
The operating system is Windows NT or later.
ToString
The operating system is Win32s. Win32s is a layer that runs on 16-bit versions of Windows to provide access to 32-bit applications.
ToString
The operating system is Windows 95 or later.
PlatformNotSupportedException class (System)
ToString
Description
The exception that is thrown when a feature does not run on a particular platform.
PlatformNotSupportedException uses the HRESULT COR_E_PLATFORMNOTSUPPORTED, which has the value 0x80131539.
PlatformNotSupportedException
Example Syntax:
ToString
Initializes a new instance of the System.PlatformNotSupportedException class with default properties.
When an instance of the System.PlatformNotSupportedException class is created by a call to this constructor, the following properties are initialized to the specified values: Property Value System.Exception.InnerExceptionnull.
PlatformNotSupportedException
Example Syntax:
ToString
Initializes a new instance of the System.PlatformNotSupportedException class with a specified error message.
When an instance of the System.PlatformNotSupportedException class is created by a call to this constructor, the following properties are initialized to the specified values: Property Value System.Exception.InnerExceptionnull. The text message that explains the reason for the exception.
PlatformNotSupportedException
Example Syntax:
ToString
Initializes a new instance of the System.PlatformNotSupportedException class with serialized data. The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown. The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.
PlatformNotSupportedException
Example Syntax:
ToString
Initializes a new instance of the System.PlatformNotSupportedException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The text message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If the inner parameter is non-null, then the current Exception is raised in a catch block handling inner.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
Random class (System)
ToString
Description
Represents a pseudo-random number generator, a device that produces a sequence of numbers that meet certain statistical requirements for randomness.
Pseudo-random numbers are chosen with equal probability from a finite set of numbers. The chosen numbers are not completely random because a definite mathematical algorithm is used to select them, but they are sufficiently random for practical purposes.
Random
Example Syntax:
ToString
Initializes a new instance of the Random class, using a time-dependent default seed value.
The distribution of the generated numbers is uniform; each number is equally likely to be returned.
Random
Example Syntax:
ToString
Initializes a new instance of the Random class, using the specified seed value.
If your application requires different random number sequences, invoke this constructor repeatedly with different seed values. One way to produce a unique seed value is to make it time-dependent. For example, derive the seed value from the system clock. A number used to calculate a starting value for the pseudo-random number sequence.
Next
Returns a positive random number.
Return Value: A number greater than or equal to zero and less than System.Int32.MaxValue.
Next
Returns a positive random number less than the specified maximum.
Return Value: A number greater than or equal to zero, and less than maxValue. The upper bound of the random number to be generated.
Next
Returns a random number within a specified range.
Return Value: A number greater than or equal to minValue and less than maxValue. If min Value equals max Value, min Value is returned. The lower bound of the random number returned. The upper bound of the random number returned.
NextBytes
Fills the elements of a specified array of bytes with random numbers.
Each element of the array of bytes is set to a random number greater than or equal to zero, and less than or equal to System.Byte.MaxValue. An array of bytes to contain random numbers.
NextDouble
Returns a random number between 0.0 and 1.0.
Return Value: A double-precision floating point number greater than or equal to 0.0, and less than 1.0.
This method is the public version of the protected method, System.Random.Sample.
Sample
Returns a random number between 0.0 and 1.0.
Return Value: A double-precision floating point number greater than or equal to 0.0, and less than 1.0.
Create a derived class of Random to override this method and produce a different distribution.
RankException class (System)
ToString
Description
The exception that is thrown when an array with the wrong number of dimensions is passed to a method.
System.RankException uses the HRESULT COR_E_RANK, which has the value 0x80131517.
RankException
Example Syntax:
ToString
Initializes a new instance of the System.RankException class with default properties.
The following table shows the initial property values for an instance of System.RankException.
RankException
Example Syntax:
ToString
Initializes a new instance of the System.RankException class with a specified error message.
The following table shows the initial property values for an instance of System.RankException. The error message that explains the reason for the exception.
RankException
Example Syntax:
ToString
Initializes a new instance of the System.RankException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
RankException
Example Syntax:
ToString
Initializes a new instance of the System.RankException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
ResolveEventArgs class (System)
ToString
Description
Provides data for the System.AppDomain.TypeResolve, System.AppDomain.ResourceResolve, and System.AppDomain.AssemblyResolve events.
ResolveEventArgs
Example Syntax:
ToString
Initializes a new instance of the ResolveEventArgs class.
This constructor is typically only called by the common language runtime. The name of an item to resolve.
Name
ToString
The name of the item to be resolved.
ResolveEventHandler delegate (System)
ToString
Description
Represents the method that will handle the System.AppDomain.TypeResolve, System.AppDomain.ResourceResolve, and System.AppDomain.AssemblyResolve events of an System.AppDomain. The source of the event. A System.ResolveEventArgs that contains the event data.
If the runtime class loader cannot resolve a reference to an assembly, type or a resource through normal means, the corresponding events are raised to give the callback a chance to tell the runtime which assembly the referenced assembly, type or resource is in.
RuntimeArgumentHandle structure (System)
ToString
Description
References a variable-length argument list.
This class has no members, and exists solely to support C/C++ programming language functions that take a variable number of parameters.
RuntimeFieldHandle structure (System)
ToString
Description
The RuntimeFieldHandle is a handle to the internal metadata representation of a field.
Value
ToString
The value of the handle.
GetObjectData
Returns a SerializationInfo completely populated with all the data needed to reinstantiate the object at the other end of serialization. The object to be populated with serialization information. The destination context of the serialization.
RuntimeMethodHandle structure (System)
ToString
Description
The RuntimeMethodHandle is a handle to the internal metadata representation of a method.
Value
ToString
The value of the handle.
GetFunctionPointer
GetObjectData
Returns a SerializationInfo completely populated with all the data needed to reinstantiate the object at the other end of serialization. The object to be populated with serialization information. The destination context of the serialization.
RuntimeTypeHandle structure (System)
ToString
Description
The RuntimeTypeHandle is a handle to the internal metadata representation of a type.
Value
ToString
The value of the handle.
GetObjectData
Returns a SerializationInfo completely populated with all the data needed to reinstantiate the object at the other end of serialization. The object to be populated with serialization information. The destination context of the serialization.
SByte structure (System)
ToString
Description
Represents an 8-bit signed integer.
The SByte value type represents integers with values ranging from negative 128 to positive 127.
ToString
A constant representing the largest possible value of SByte.
The value of this constant is 127; that is, hexadecimal 0x7F.
ToString
A constant representing the smallest possible value of SByte.
The value of this constant is −128; that is, hexadecimal 0x80.
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: A signed number indicating the relative values of this instance and obj.
Any instance of SByte, regardless of its value, is considered greater than null. An object to compare, or null.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if obj is an instance of SByte and equals the value of this instance; otherwise, false. An object to compare with this instance.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
GetTypeCode
Parse
Converts the String representation of a number to its 8-bit signed integer equivalent.
Return Value: An 8-bit signed integer equivalent to the number contained in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert.
Parse
Converts the String representation of a number in a specified culture-specific format to its 8-bit signed integer equivalent.
Return Value: An 8-bit signed integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
Parse
Converts the String representation of a number in a specified style to its 8-bit signed integer equivalent.
Return Value: An 8-bit signed integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStylesconstants that indicate the permitted format of s.
Parse
Converts the String representation of a number in a specified style and culture-specific format to its 8-bit signed integer equivalent.
Return Value: An 8-bit signed integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStylesconstants that indicate the permitted format of s. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
IConvertible.ToBoolean
IConvertible.ToByte
IConvertible.ToChar
IConvertible.ToDecimal
IConvertible.ToDouble
IConvertible.ToInt16
IConvertible.ToInt32
IConvertible.ToInt64
IConvertible.ToSByte
IConvertible.ToSingle
IConvertible.ToType
IConvertible.ToUInt16
IConvertible.ToUInt64
ToString
Converts the numeric value of this instance to its equivalent String representation.
Return Value: The System.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.
The return value is formatted with the general format specifier (“G”) and the System.Globalization.NumberFormatInfo for the current culture.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by provider.
This instance is formatted with the general format specifier (“G”). An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
ToString
Converts the numeric value of this instance to its equivalent String representation, using the specified format.
Return Value: The System.String representation of the value of this instance as specified by format.
If format is null or an empty string, the return value of this instance is formatted with the general format specifier (“G”). A format string.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified format and culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by format and provider.
If format is null or an empty string, the return value for this instance is formatted with the general format specifier (“G”). A format specification. An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
SerializableAttribute class (System)
ToString
Description
Indicates that a class can be serialized. This class cannot be inherited.
Apply the System.SerializableAttribute attribute to a class to indicate it can be serialized. The common language runtime throws System.Runtime.Serialization.SerializationException if any class in the graph of objects being serialized does not have the System.SerializableAttribute attribute applied.
SerializableAttribute
Example Syntax:
ToString
Initializes a new instance of the System.SerializableAttribute class.
TypeId
Single structure (System)
ToString
Description
Represents a single-precision floating point number.
The Single value type represents a single-precision 32-bit number with values ranging from negative 3.402823e38 to positive 3.402823e38, as well as positive or negative zero, System.Single.PositiveInfinity, System.Single.NegativeInfinity, and Not-a-Number (System.Single.NaN).
ToString
A constant representing the smallest positive Single greater than zero.
The value of this constant is 1.4e-45.
ToString
A constant representing the largest possible value of Single.
The value of this constant is positive 3.402823e38.
ToString
A constant representing the smallest possible value of Single.
The value of this constant is negative 3.402823e38.
ToString
A constant representing Not-a-Number (NaN).
The value of this constant is the result of dividing zero by zero.
ToString
A constant representing negative infinity.
The value of this constant is the result of dividing a negative number by zero.
ToString
A constant representing positive infinity.
The value of this constant is the result of dividing a positive number by zero.
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: A signed number indicating the relative values of this instance and value.
Any instance of Single, regardless of its value, is considered greater than null. An object to compare, or null.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if obj is an instance of Single and equals the value of this instance; otherwise, false. An object to compare with this instance.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
GetTypeCode
Returns the TypeCode for value type Single.
Return Value: The enumerated constant, System.TypeCode.Single.
IsInfinity
Returns a value indicating whether the specified number evaluates to either negative or positive infinity.
Return Value: true if f evaluates to negative or positive infinity; otherwise, false. A single-precision floating point number.
IsNaN
Returns a value indicating whether the specified number evaluates to Not-a-Number (NaN).
Return Value: true if f evaluates to NaN; otherwise, false. A single-precision floating point number.
IsNegativeInfinity
Returns a value indicating whether the specified number evaluates to negative infinity.
Return Value: true if f evaluates to negative infinity; otherwise, false. A single-precision floating point number.
IsPositiveInfinity
Returns a value indicating whether the specified number evaluates to
Return Value: true if f evaluates to positive infinity; otherwise, false. A single-precision floating point number.
Parse
Converts the String representation of a number to its single-precision floating point number equivalent.
Return Value: A single-precision floating point number equivalent to the numeric value or symbol specified in s.
s can contain System.Globalization.NumberFormatInfo.PositiveInfInitySymbol, System.Globalization.NumberFormatInfo.NegativeInfinitySymbol, System.Globalization.NumberFormatInfo.NaNSymbol, or a string of the form: [ws][sign]integral-digits[.[fractional-digits]][e[sign]exponential-digits][ws] Optional items are framed in square brackets (‘[’ and ‘]’). Items containing the term “digits” consist of a series of numeric characters ranging from 0 to 9. A System.String containing a number to convert.
Parse
Converts the String representation of a number in a specified culture-specific format to its single-precision floating point number equivalent.
Return Value: A single-precision floating point number equivalent to the numeric value or symbol specified in s.
s can contain System.Globalization.NumberFormatInfo.PositiveInfinitySymbol, System.Globalization.NumberFormatInfo.NegativeInfinitySymbol, System.Globalization.NumberFormatInfo.NaNSymbol, or a string of the form: [ws][sign]integral-digits[.[fractional-digits]][e[sign]exponential-digits][ws] Optional items are framed in square brackets (‘[’ and ‘]’). Items containing the term “digits” consist of a series of numeric characters ranging from 0 to 9. A System.String containing a number to convert. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
Parse
Converts the String representation of a number in a specified style to its single-precision floating point number equivalent.
Return Value: A single-precision floating point number equivalent to the numeric value or symbol specified in s.
s can contain System.Globalization.NumberFormatInfo.PositiveInfinitySymbol, System.Globalization.NumberFormatInfo.NegativeInfinitySymbol, System.Globalization.NumberFormatInfo.NaNSymbol, or a string of the form:
Parse
Converts the String representation of a number in a specified style and culture-specific format to its single-precision floating point number equivalent.
Return Value: A single-precision floating point number equivalent to the numeric value or symbol specified in s.
s can contain System.Globalization.NumberFormatInfo.PositiveInfinitySymbol, System.Globalization.NumberFormatInfo.NegativeInfinitySymbol, System.Globalization.NumberFormatInfo.NaNSymbol, or a string of the form: [ws][sign]integral-digits [.[fractional-digits]][e[sign]exponential-digits][ws] Optional items are framed in square brackets (‘[’ and ‘]’). Items containing the term “digits” consist of a series of numeric characters ranging from 0 to 9. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStylesconstants that indicate the permitted format of s. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
IConvertible.ToBoolean
IConvertible.ToByte
IConvertible.ToDateTime
IConvertible.ToDecimal
IConvertible.ToDouble
IConvertible.ToInt16
IConvertible.ToInt32
IConvertible.ToInt64
IConvertible.ToSByte
IConvertible.ToSingle
IConvertible.ToType
IConvertible.ToUInt16
IConvertible.ToUInt32
IConvertible.ToUInt64
ToString
Converts the numeric value of this instance to its equivalent String representation.
Return Value: The System.String representation of the value of this instance.
The return value can be
System.Globalization.NumberFormatInfo.PositiveInfinitySymbol, System.Globalization.NumberFormatInfo.NegativeInfinitySymbol, System.Globalization.NumberFormatInfo.NaNSymbol, or a string of the form: [sign]integral-digits[.[fractional-digits]] [e[sign]exponential-digits] Optional items are framed in square brackets (‘[’ and ‘]’). Items containing the term “digits” consist of a series of numeric characters ranging from 0 to 9.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by provider.
The return value can be System.Globalization.NumberFormatInfo.PositiveInfinitySymbol, System.Globalization.NumberFormatInfo.NegativeInfinitySymbol, System.Globalization.NumberFormatInfo.NaNSymbol, or a string of the form: [sign]integral-digits[.[fractional-digits]] [e[sign]exponential-digits] Optional items are framed in square brackets (‘[’ and ‘]’). Items containing the term “digits” consist of a series of numeric characters ranging from 0 to 9. An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
ToString
Converts the numeric value of this instance to its equivalent String representation, using the specified format.
Return Value: The System.String representation of the value of this instance as specified by format.
The return value can be System.Globalization.NumberFormatInfo.PositiveInfinitySymbol, System.Globalization.NumberFormatInfo.NegativeInfinitySymbol, System.Globalization.NumberFormatInfo.NaNSymbol, or a string of the form: [sign]integral-digits[. [fractional-digits]] [e[sign]exponential-digits] Optional items are framed in square brackets (‘[’ and ‘]’). Items containing the term “digits” consist of a series of numeric characters ranging from 0 to 9. A format string.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified format and culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by format and provider.
The return value can be System.Globalization.NumberFormatInfo.PositiveInfinitySymbol, System.Globalization.NumberFormatInfo.NegativeInfinitySymbol, System.Globalization.NumberFormatInfo.NaNSymbol, or a string of the form: [sign] integral-digits [[fractional-digits]] [e [sign] exponential-digits] Optional items are framed in square brackets (‘[’ and ‘]’). Items containing the term “digits” consist of a series of numeric characters ranging from 0 to 9. A format specification. An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
Environment.SpecialFolder enumeration (System)
ToString
Description
Specifies enumerated constants used to retrieve directory paths to system special folders.
The System.Environment.SpecialFolder.System method uses these enumerated constants to indicate the special folder path to retrieve.
ToString
The directory that serves as a common repository for application-specific data for the current, roaming user.
ToString
The directory that serves as a common repository for application-specific data that is used by all users.
ToString
The directory for components that are shared across applications.
ToString
The directory that serves as a common repository for Internet cookies.
ToString
The directory used to physically store file objects on the desktop.
ToString
The directory that serves as a common repository for the user's favorite items.
ToString
The directory that serves as a common repository for Internet history items.
ToString
The directory that serves as a common repository for temporary Internet files.
ToString
The directory that serves as a common repository for application-specific data that is used by the current, non-roaming user.
ToString
The directory that serves as a common repository for documents.
ToString
The program files directory.
ToString
The directory that contains the user's program groups.
ToString
The directory that contains the user's most recently used documents.
ToString
The directory that contains Send To menu items.
ToString
The directory that contains the Start menu items.
ToString
The directory that corresponds to the user's Startup program group.
ToString
The System directory.
ToString
The directory that serves as a common repository for document templates. StackOverflowException class (System)
ToString
Description
The exception that is thrown when the execution stack overflows by having too many pending method calls. This class cannot be inherited.
System.StackOverflowException is thrown for execution stack overflow errors, typically in case of a very deep or unbounded recursion.
StackOverflowException
Example Syntax:
ToString
Initializes a new instance of the System.StackOverflowException class with default properties.
The following table shows the initial property values for an instance of System.StackOverflowException.
StackOverflowException
Example Syntax:
ToString
Initializes a new instance of the System.StackOverflowException class with a specified error message.
The following table shows the initial property values for an instance of System.StackOverflowException. The error message that explains the reason for the exception.
StackOverflowException
Example Syntax:
ToString
Initializes a new instance of the System.StackOverflowException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
STAThreadAttribute class (System)
ToString
Description
Indicates the default threading model for an application is single-threaded apartment.
Only apply this attribute to the main method of an application.
STAThreadAttribute
Example Syntax:
ToString
Initializes a new instance of the System.STAThreadAttribute class.
TypeId
String class (System)
ToString
Description
Represents an immutable string of characters.
An instance of String is said to be “immutable” because its value cannot be modified once it has been created. Methods that appear to modify a String instance actually return a new instance containing the modification. Use the System.Text.StringBuilder class if it is necessary to actually modify the contents of a string-like object.
ToString
A read-only field that represents the empty string.
The value of this field is the string, “”.
String
Example Syntax:
ToString
Initializes a new instance of the String class to the value indicated by a specified pointer to an array of Unicode characters.
If value is a null pointer, an System.String.Empty instance is initialized. A pointer to an array of Unicode characters.
String
Example Syntax:
ToString
Initializes a new instance of the String class to the value indicated by an array of Unicode characters. An array of Unicode characters.
String
Example Syntax:
ToString
Initializes a new instance of the String class to the value indicated by a pointer to an array of 8-bit signed integers.
If value is a null pointer, an System.String.Empty instance is initialized. A pointer to an array of 8-bit signed integers.
String
Example Syntax:
ToString
Initializes a new instance of the String class to the value indicated by a specified Unicode character repeated a specified number of times. A Unicode character. The number of times c occurs.
String
Example Syntax:
ToString
Initializes a new instance of the String class to the value indicated by a specified pointer to an array of Unicode characters, a starting character position within that array, and a length.
If value is a null pointer, an System.String.Empty instance is initialized. A pointer to an array of Unicode characters. The starting position within value. The number of characters within value to use.
String
Example Syntax:
ToString
Initializes a new instance of the String class to the value indicated by an array of Unicode characters, a starting character position within that array, and a length.
If value is null, an System.String.Empty instance is initialized. An array of Unicode characters. The starting position within value. The number of characters within value to use.
String
Example Syntax:
ToString
Initializes a new instance of the String class to the value indicated by a specified pointer to an array of 8-bit signed integers, a starting character position within that array, and a length.
If value is a null pointer, an System.String.Empty instance is initialized. A pointer to an array of 8-bit signed integers. The starting position within value. The number of characters within value to use.
String
Example Syntax:
ToString
Initializes a new instance of the String class to the value indicated by a specified pointer to an array of 8-bit signed integers, a starting character position within that array, a length, and an Encoding object.
If value is a null pointer, an System.String.Empty instance is initialized. A pointer to an array of 8-bit signed integers. The starting position within value. The number of characters within value to use. An System.Text.Encoding object that specifies how the array referenced by value is encoded.
Chars
ToString
Gets the character at a specified character position in this instance.
index is zero-based. A character position in this instance.
Length
ToString
Gets the number of characters in this instance.
Clone
Returns a reference to this instance of String.
Return Value: This instance of String.
The return value is not an independent copy of this instance; it is simply another view of the same data. Use the System.String.Copy(System.String) or System.String.CopyTo(System.Int32,System.Char[ ],System.Int32,System.Int32) method to create a separate String object with the same value as this instance.
Compare
Compares two specified String objects.
Return Value: A 32-bit signed integer indicating the lexical relationship between the two comparands.
By definition, any String, including the empty string, compares greater than a null reference; and two null references compare equal to each other. The first String. The second String.
Compare
Compares two specified String objects, ignoring or honoring their case.
Return Value: A 32-bit signed integer indicating the lexical relationship between the two comparands.
By definition, any String, including the empty string, compares greater than a null reference; and two null references compare equal to each other. The first String. The second String. A System.Boolean indicating a case-sensitive or insensitive comparison. (true indicates a case-insensitive comparison.)
Compare
Compares two specified String objects, ignoring or honoring their case, and honoring culture-specific information about their formatting.
Return Value: A 32-bit signed integer indicating the lexical relationship between the two comparands.
culture specifies a System.Globalization.CultureInfo object, which provides culture-specific information that can affect the comparison. The first String. The second String. A System.Boolean indicating a case-sensitive or insensitive comparison. (true indicates a case-insensitive comparison.) A System.Globalization.CultureInfo object that supplies culture-specific formatting information.
Compare
Compares substrings of two specified String objects.
Return Value: A 32-bit signed integer indicating the lexical relationship between the two comparands.
length cannot be negative. If length is zero, then zero is returned. The first String. The position of the substring within strA. The second String. The position of the substring within strB. The maximum number of characters in the substrings to compare.
Compare
Compares substrings of two specified String objects, ignoring or honoring their case.
Return Value: A 32-bit signed integer indicating the lexical relationship between the two comparands.
indexA and indexB are zero-based. The first String. The position of the substring within strA. The second String. The position of the substring within strB. The maximum number of characters in the substrings to compare. A System.Boolean indicating a case-sensitive or insensitive comparison. (true indicates a case-insensitive comparison.)
Compare
Compares substrings of two specified String objects, ignoring or honoring their case, and honoring culture-specific information about their formatting.
Return Value: An integer indicating the lexical relationship between the two comparands.
culture specifies a System.Globalization.CultureInfo object, which provides culture-specific information that can affect the comparison. The first String. The position of the substring within strA. The second String. The position of the substring within the strB. The maximum number of characters in the substrings to compare. A System.Boolean indicating a case-sensitive or insensitive comparison. (true indicates a case-insensitive comparison.) A System.Globalization.CultureInfo object that supplies culture-specific formatting information.
CompareOrdinal
Compares two specified String objects, without considering the local national language or culture.
Return Value: An integer indicating the lexical relationship between the two comparands.
By definition, any String, including the empty string, compares greater than a null reference; and two null references compare equal to each other. The first String. The second String.
CompareOrdinal
Compares substrings of two specified String objects, without considering the local national language or culture. Parameters specify the length and starting positions of the substrings.
Return Value: A 32-bit signed integer indicating the lexical relationship between the two comparands.
By definition, any String, including the empty string, compares greater than a null reference; and two null references compare equal to each other. The first String. The starting index of the substring in strA. The second String. The starting index of the substring in strB. The maximum number of characters in the substrings to compare.
CompareTo
Compares this instance with a specified Object.
Return Value: A 32-bit signed integer indicating the lexical relationship between the two comparands.
value must be a String object. An System.Object that evaluates to a Sting.
CompareTo
Compares this instance with a specified String object.
Return Value: A 32-bit signed integer indicating the lexical relationship between the two comparands.
By definition, any String, including the empty string, compares greater than a null reference; and two null references compare equal to each other. A String.
Concat
Creates the String representation of a specified object.
Return Value: The String representation of the value of arg0.
An System.String.Empty string is used in place of any null argument. An System.Object or null.
Concat
Concatenates the String representations of the elements in a specified Object array.
Return Value: The concatenated String representations of the values of the elements in args.
An System.String.Empty string is used in place of any null object in the array. An System.Object array.
Concat
Concatenates the elements of a specified String array.
Return Value: The concatenated elements of values.
An System.String.Empty string is used in place of any null object in the array. An array of String instances.
Concat
Concatenates the String representations of two specified objects.
Return Value: The concatenated String representations of the values of arg0 and arg1.
An System.String.Empty string is used in place of any null argument. The first System.Object. The second Object.
Concat
Concatenates two specified instances of String.
Return Value: The concatenation of str0 and str1.
An System.String.Empty string is used in place of any null argument. The first String. The second String.
Concat
Concatenates the String representations of three specified objects.
Return Value: The concatenated String representations of the values of arg0, arg1, and arg2.
An System.String.Empty string is used in place of any null argument. The first System.Object. The second Object. The third Object.
Concat
Concatenates three specified instances of String.
Return Value: The concatenation of str0, str1, and str2.
An System.String.Empty string is used in place of any null argument. The first String. The second String. The third String.
Concat
Concat
Concatenates four specified instances of String.
Return Value: The concatenation of str0, str1, str2, and str3.
An System.String.Empty string is used in place of any null object in the array. The first String. The second String. The third String. The fourth String.
Copy
Creates a new instance of String with the same value as a specified instance of String.
Return Value: A new String with the same value as str. The String to be copied
CopyTo
Copies a specified number of characters from a specified position in this instance to a specified position in an array of Unicode characters.
count characters are copied from the sourceIndex position of this instance to the destinationIndex position of destination. A character position in this instance. An array of Unicode characters. An array element in destination. The number of characters in this instance to copy to destination.
EndsWith
Determines whether the end of this instance matches the specified String.
Return Value: true if the end of this instance matches value; false if value does not match or is longer than this instance.
The comparison is case-sensitive. A String.
Equals
Determines whether this instance of String and a specified object, which must be a String, have the same value.
Return Value: true if obj is a String and its value is the same as this instance; otherwise, false. This instance is null.
This comparison is case-sensitive. An System.Object.
Equals
Determines whether this instance and a specified String have the same value.
Return Value: true if the value of value is the same as this instance; otherwise, false. This instance is null.
This comparison is case-sensitive. A String.
Equals
Determines whether two specified String objects have the same value.
Return Value: true if the value of a is the same as the value of b; otherwise, false.
The comparison is case-sensitive. A String or null. A String or null.
Format
Replaces the format specification in a specified String with the textual equivalent of the value of a specified Object instance.
Return Value: A copy of format in which the first format specification has be replaced by the String equivalent of the arg0.
The format parameter is embedded with zero or more format specifications of the form, {N [, M][: formatString]}, where: N is a zero-based integer indicating the argument to be formatted. A String containing zero or more format specifications. An System.Object to be formatted.
Format
Replaces the format specification in a specified String with the textual equivalent of the value of a corresponding Object instance in a specified array.
Return Value: A copy of format in which the format specifications have been replaced by the String equivalent of the corresponding instances of Object in args.
The format parameter is embedded with zero or more format specifications of the form, {N [, M] [: formatString]}, where: N is a zero-based integer indicating the argument to be formatted. A String containing zero or more format specifications. An System.Object array containing zero or more objects to be formatted.
Format
Replaces the format specification in a specified String with the textual equivalent of the value of a corresponding Object instance in a specified array. A specified parameter supplies culture-specific formatting information.
Return Value: A copy of format in which the format specifications have been replaced by the String equivalent of the corresponding instances of Object in args
The format parameter is embedded with zero or more format specifications of the form, {N [, M] [: formatString]}, where: N is a zero-based integer indicating the argument to be formatted. An System.IFormatProvider interface implementation that supplies culture-specific formatting information. A String containing zero or more format specifications. An System.Object array containing zero or more objects to be formatted.
Format
Replaces the format specification in a specified String with the textual equivalent of the value of two specified Object instances.
Return Value: A copy of format in which the first and second format specifications have been replaced by the String equivalent of the arg0 and arg1.
A String containing zero or more format specifications. The first System.Object to be formatted. The second Object to be formatted.
Format
Replaces the format specification in a specified String with the textual equivalent of the value of three specified Object instances.
Return Value: A copy of format in which the first, second, and third format specifications have been replaced by the String equivalent of the arg0,arg1, and arg2.
The format parameter is embedded with zero or more format specifications of the form, {N [, M] [: formatString]}, where: N is a zero-based integer indicating the argument to be formatted. A String containing zero or more format specifications. The first System.Object to be formatted. The second Object to be formatted. The third Object to be formatted.
GetEnumerator
Retrieves an object that can iterate through the individual characters in this instance.
Return Value: A System.CharEnumerator object.
This method is required by programming languages that support the System.Collections.IEnumerator interface to iterate through members of a collection. For example, the Microsoft Visual Basic and C# programming languages' for each statement invokes this method to return a CharEnumerator object that can provide read-only access to the characters in this instance of String
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
GetTypeCode
Returns the TypeCode for class String.
Return Value: The enumerated constant, System.TypeCode.String.
IndexOf
Reports the index of the first occurrence of the specified Unicode character in this instance.
Return Value: A positive 32-bit signed integer, the index, that is the character position in this instance where value was found; otherwise, −1 if value was not found.
Index numbering starts from zero. A Unicode character to seek.
IndexOf
Reports the index of the first occurrence of the specified String in this instance.
Return Value: Value Meaning A positive index position.
The search begins at the first character position of this instance and continues until the last character position. The search is case-sensitive and uses the current culture. The String to seek.
IndexOf
Reports the index of the first occurrence of the specified Unicode character in this instance. The search starts at a specified character position.
Return Value: A positive 32-bit signed integer, the index, indicating the character position in this instance where value was found; otherwise, −1 if value was not found.
Index numbering starts from zero. A Unicode character to seek. The search starting position.
IndexOf
Reports the index of the first occurrence of the specified String in this instance. The search starts at a specified character position.
Return Value: Value Meaning A positive index position.
The search begins at the startIndex character position of this instance and continues until the last character position. The search is case-sensitive and uses the current culture. The String to seek. The search starting position.
IndexOf
Reports the index of the first occurrence of the specified character in this instance. The search starts at a specified character position and examines a specified number of character positions.
Return Value: A positive 32-bit signed integer, the index, that is the character position in this instance where value was found; otherwise, −1 if value was not found.
The search begins at startIndex and continues until count−1. The character at count is not included in the search. A Unicode character to seek. The search starting position. The number of character positions to examine.
IndexOf
Reports the index of the first occurrence of the specified String in this instance. The search starts at a specified character position and examines a specified number of character positions.
Return Value: Value Meaning A positive index position.
The search begins at the startIndex character position and continues for count character positions. The search is case-sensitive and uses the current culture. The String to seek. The search starting position. The number of character positions to examine.
IndexOfAny
Reports the index of the first occurrence in this instance of any character in a specified array of Unicode characters.
Return Value: The positive integer index of the first occurrence in this instance where any character in anyOf was found; otherwise, −1 if no character in anyOf was found.
Index numbering starts from zero. A Unicode character array containing one or more characters to seek.
IndexOfAny
Reports the index of the first occurrence in this instance of any character in a specified array of Unicode characters. The search starts at a specified character position.
Return Value: The positive integer index of the first occurrence in this instance where any character in anyOf was found; otherwise, −1 if no character in anyOf was found.
Index numbering starts from zero. A Unicode character array containing one or more characters to seek. The search starting position.
IndexOfAny
Reports the index of the first occurrence in this instance of any character in a specified array of Unicode characters. The search starts at a specified character position and examines a specified number of character positions.
Return Value: The positive integer index of the first occurrence in this instance where any character in anyOf was found; otherwise, −1 if no character in anyOf was found.
The search begins at startIndex and continues until count−1. The character at count is not included in the search. A Unicode character array containing one or more characters to seek. The search starting position. The number of character positions to examine.
Insert
Inserts a specified instance of String at a specified index position in this instance.
Return Value: A new String equivalent to this instance but with value inserted at position startIndex. If startIndex is equal to the length of this instance, value is appended to the end of this instance. The index position of the insertion. The String to insert. Intern
Retrieves the system's reference to the specified String
Return Value: The String reference to str.
The common language runtime automatically maintains a table, called the “intern pool”, which contains a single instance of each unique literal string constant declared in a program, as well as any unique instance of String you add programmatically. A String, or null.
IsInterned
Retrieves a reference to a specified String.
Return Value: A String reference to str if it is in the common language runtime “intern pool”; otherwise null.
The common language runtime automatically maintains a table, called the “intern pool”, which contains a single instance of each unique literal string constant declared in a program, as well as any unique instance of String you add programmatically. A String.
Join
Concatenates a specified separator String between each element of a specified String array, yielding a single concatenated string.
Return Value: A String consisting of the elements of value interspersed with the separator string.
For example if separator is “, ” and the elements of value are “apple”, “orange”, “grape”, and “pear”, Join(separator, value) returns “apple, orange, grape, pear”. A System.String. An array of Strings.
Join
Concatenates a specified separator String between each element of a specified String array, yielding a single concatenated string. Parameters specify the first array element and number of elements to use.
Return Value: A String consisting of the strings in value joined by separator.
For example if separator is “, “and the elements of value are “apple”, ”orange”, “grape”, and “pear”, Join(separator, value, 1, 2) returns “orange, grape”. A System.String. An array of String. The first array element in value to use. The number of elements of value to use.
LastIndexOf
Reports the index position of the last occurrence of a specified Unicode character within this instance.
Return Value: The index position of value if that character is found, or −1 if it is not.
This method begins searching at the last character position of this instance and precedes backwards towards the beginning until either value is found or the first character position has been examined. The search is case-sensitive. A Unicode character to seek.
LastIndexOf
Reports the index position of the last occurrence of a specified String within this instance.
Return Value: Value Meaning A positive index position.
This method begins searching at the last character position of this instance and precedes backwards towards the beginning until either value is found or the first character position has been examined. The search is case-sensitive. A String to seek.
LastIndexOf
Reports the index position of the last occurrence of a specified Unicode character within this instance. The search starts at a specified character position.
Return Value: The index position of value if that character is found, or −1 if it is not.
This method begins searching at the startIndex character position of this instance and precedes backwards towards the beginning until either value is found or the first character position has been examined. The search is case-sensitive. A Unicode character to seek. The starting position of a substring within this instance.
LastIndexOf
Reports the index position of the last occurrence of a specified String within this instance. The search starts at a specified character position.
Return Value: Value Meaning A positive index position.
This method begins searching at the startIndex character position of this instance and precedes backwards towards the beginning until either value is found or the first character position has been examined. The search is case-sensitive. The String to seek. The search starting position.
LastIndexOf
Reports the index position of the last occurrence of the specified Unicode character in a substring within this instance. The search starts at a specified character position and examines a specified number of character positions.
Return Value: The index position of value if that character is found, or −1 if it is not.
This method begins searching at the startIndex character position of this instance and precedes backwards towards the beginning until either value is found or count character positions have been examined. The search is case-sensitive. A Unicode character to seek. The starting position of a substring within this instance.
The number of character positions to examine.
LastIndexOf
Reports the index position of the last occurrence of a specified String within this instance. The search starts at a specified character position and examines a specified number of character positions.
Return Value: Value Meaning A positive index position.
This method begins searching at the startIndex character position of this instance and precedes backwards towards the beginning until either value is found or count character positions have been examined. The search is case-sensitive. The String to seek. The search starting position. The number of character positions to examine.
LastIndexOfAny
Reports the index position of the last occurrence in this instance of one or more characters specified in a Unicode array.
Return Value: The positive integer index of the last occurrence in this instance where any character in anyOf was found; otherwise, −1 if no character in anyOf was found.
This method begins searching at the last character position of this instance and precedes backwards towards the beginning until either a character in anyOf is found or the first character position has been examined. The search is case-sensitive. A Unicode character array containing one or more characters to seek.
LastIndexOfAny
Reports the index position of the last occurrence in this instance of one or more characters specified in a Unicode array. The search starts at a specified character position.
Return Value: The positive integer index of the last occurrence in this instance where any character in anyOf was found; otherwise, −1 if no character in anyOf was found.
This method begins searching at the startIndex character position of this instance and precedes backwards towards the beginning until either a character in anyOf is found or the first character position has been examined. The search is case-sensitive. A Unicode character array containing one or more characters to seek. The search starting position.
LastIndexOfAny
Reports the index position of the last occurrence in this instance of one or more characters specified in a Unicode array. The search starts at a specified character position and examines a specified number of character positions.
Return Value: The positive integer index of the last occurrence in this instance where any character in anyOf was found; otherwise, −1 if no character in anyOf was found.
This method begins searching at the startIndex character position of this instance and precedes backwards towards the beginning until either a character in anyOf is found or count character positions have been examined. The search is case-sensitive. A Unicode character array containing one or more characters to seek. The search starting position. The number of character positions to examine.
op_Equality
Determines whether two specified String objects have the same value.
Return Value: true if the value of a is the same as the value of b; otherwise, false.
This operator is implemented using the System.String.Equals(System.Object) method, which means the comparands are tested for a combination of reference and value equality. The comparison is case-sensitive. A String or null. A String or null.
op_Inequality
Determines whether two specified String objects have different values.
Return Value: true if the value of a is different than the value of b; otherwise, false.
This operator is implemented using the
System.String.Equals(System.Object) method, which means the comparands are tested for a combination of reference and value equality. The comparison is case-sensitive. A String or null. A String or null.
PadLeft
Right-aligns the characters in this instance, padding with spaces on the left for a specified total length.
Return Value: A new String that is equivalent to this instance, but right-aligned and padded on the left with as many spaces as needed to create a length of totalWidth. The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.
PadLeft
Right-aligns the characters in this instance, padding on the left with a specified Unicode character for a specified total length.
Return Value: A new String that is equivalent to this instance, but right-aligned and padded on the left with as many paddingChar characters as needed to create a length of totalWidth. The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters. A Unicode padding character.
PadRight
Left-aligns the characters in this string, padding with spaces on the right, for a specified total length.
Return Value: A new String that is equivalent to this instance, but left-aligned and padded on the right with as many spaces as needed to create a length of totalWidth. The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.
PadRight
Left-aligns the characters in this string, padding on the right with a specified Unicode character, for a specified total length.
Return Value: A new String that is equivalent to this instance, but left-aligned and padded on the right with as many paddingChar characters as needed to create a length of totalWidth. The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters. A Unicode padding character.
Remove
Deletes a specified number of characters from this instance beginning at a specified position.
Return Value: A new String that is equivalent to this instance less count number of characters.
For example, the following C# code prints “123456”. The position in this instance to begin deleting characters. The number of characters to delete.
Replace
Replaces all occurrences of a specified Unicode character in this instance with another specified Unicode character.
Return Value: A String equivalent to this instance but with all instances of oldChar replaced with newChar. A Unicode character to be replaced. A Unicode character to replace all occurrences of oldChar.
Replace
Replaces all occurrences of a specified String in this instance, with another specified String.
Return Value: A String equivalent to this instance but with all instances of oldValue replaced with newValue. A String to be replaced. A String to replace all occurrences of oldValue.
Split
Identifies the substrings in this instance that are delimited by one or more characters specified in an array, then places the substrings into a String array.
Return Value: An array consisting of a single element containing this instance, if this instance contains none of the characters in separator.
For example: Input separator Output “42,\n12, 19” new Char[ ] {‘,’, ‘ ’} {“42”, “ ”, “12”, “ ”, “19”} “42 . . . 12 . . . 19” new Char[ ] {‘.’} {“42”, “ ”, “12”, “ ”, “19”} “Banana” new Char[ ] {‘.’} {“Banana”} “Darb\nSmarba” new Char[ ] { } {“Darb”, “Smarba”} “Darb\nSmarba” null {“Darb”, “Smarba” } An array of Unicode characters that delimit the substrings in this instance, an empty array containing no delimiters, or null.
Split
Identifies the substrings in this instance that are delimited by one or more characters specified in an array, then places the substrings into a String array. A parameter specifies the maximum number of array elements to return.
Return Value: An array consisting of a single element containing this instance, if this instance contains none of the characters in separator.
If there are more than count substrings in this instance, the first count minus substrings are returned in the first count minus 1 elements of the return value, and the remaining characters in this instance are returned in the last element of the return value. An array of Unicode characters that delimit the substrings in this instance, an empty array containing no delimiters, or null. The maximum number of array elements to return.
StartsWith
Determines whether the beginning of this instance matches the specified String.
Return Value: true if value matches the beginning of this string or is System.String.Empty; otherwise false.
The StartsWith method makes a comparison at the beginning of the string, determines whether it matches this current instance, and returns a System.Boolean represetation of their relationship. The specified string must match the prefix or be an empty string (i.e., equals System.String.Empty). The comparison is case-sensitive. The String to seek.
Substring
Retrieves a substring from this instance. The substring starts at a specified character position.
Return Value: A String equivalent to the substring that begins at startIndex in this instance.
The index is zero-based. The starting character position of a substring in this instance.
Substring
Retrieves a substring from this instance. The substring starts at a specified character position and has a specified length.
Return Value: A String equivalent to the substring of length length that begins at startIndex in this instance.
startIndex is zero-based. The index of the start of the substring. The number of characters in the substring.
IEnumerable.GetEnumerator
IConvertible.ToByte
IConvertible.ToChar
IConvertible.ToDateTime
IConvertible.ToDecimal
IConvertible.ToDouble
IConvertible.ToInt16
IConvertible.ToInt32
IConvertible.ToInt64
IConvertible.ToSByte
IConvertible.ToSingle
IConvertible.ToType
IConvertible.ToUInt16
IConvertible.ToUInt32
IConvertible.ToUInt64
ToCharArray
Copies the characters in this instance to a Unicode character array.
Return Value: A Unicode character array whose elements are the individual characters of this instance.
ToCharArray
Copies the characters in a specified substring in this instance to a Unicode character array.
Return Value: A Unicode character array whose elements are the length number of characters in this instance starting from character position startIndex. The starting position of a substring in this instance. The length of the substring in this instance.
ToLower
Returns a copy of this String in lowercase.
Return Value: A String in lowercase.
This method takes into account the current System.Globalization.CultureInfo information.
ToLower
Returns a copy of this String in lowercase, taking into account specified culture-specific information.
Return Value: A String in lowercase. A System.Globalization.CultureInfo object that supplies culture-specific formatting information.
ToString
Returns this instance of String; no actual conversion is performed.
Return Value: This String.
ToString
Returns this instance of String; no actual conversion is performed.
Return Value: This String.
provider is reserved, and does not currently participate in this operation. (Reserved) An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
ToUpper
Returns a copy of this String in uppercase, using default properties.
Return Value: A new string in uppercase.
This method takes into account the current System.Globalization.CultureInfo information.
ToUpper
Returns a copy of this String in uppercase, taking into account culture-specific information.
Return Value: A String in uppercase. A System.Globalization.CultureInfo object that supplies culture-specific formatting information.
Trim
Removes all occurrences of white space characters from the beginning and end of this instance.
Return Value: A new String equivalent to this instance after white space characters are removed.
This method defines white space characters as hexadecimal 0x9, 0xA, 0xB, 0xC, 0xD, 0x20, 0xA0, 0x2000, 0x2001, 0x2002, 0x2003, 0x2004, 0x2005, 0x2006, 0x2007, 0x2008, 0x2009, 0x200A, 0x200B, 0x3000, and 0xFEFF.
Trim
Removes all occurrences of a set of characters specified in a Unicode character array from the beginning and end of this instance.
Return Value: The String that remains after all occurrences of the characters in trimChars are removed. If trimChars is null, white space characters are removed instead.
This method defines white space characters as hexadecimal 0x9, 0xA, 0xB, 0xC, 0xD, 0x20, 0xA0, 0x2000, 0x2001, 0x2002, 0x2003, 0x2004, 0x2005, 0x2006, 0x2007, 0x2008, 0x2009, 0x200A, 0x200B, 0x3000, and 0xFEFF. An array of Unicode characters to be removed or null.
TrimEnd
Removes all occurrences of a set of characters specified in a Unicode character array from the end of this instance.
Return Value: The String that remains after all occurrences of the characters in trimChars are removed. If trimChars is null, white space characters are removed instead.
This method defines white space characters as hexadecimal 0x9, 0xA, 0xB, 0xC, 0xD, 0x20, 0xA0, 0x2000, 0x2001, 0x2002, 0x2003, 0x2004, 0x2005, 0x2006, 0x2007, 0x2008, 0x2009, 0x200A, 0x200B, 0x3000, and 0xFEFF. An array of Unicode characters to be removed or null.
TrimStart
Removes all occurrences of a set of characters specified in a Unicode character array from the beginning of this instance.
Return Value: The String that remains after all occurrences of characters in trimChars are removed. If trimChars is null, white space characters are removed instead.
This method defines white space characters as hexadecimal 0x9, 0xA, 0xB, 0xC, 0xD, 0x20, 0xA0, 0x2000, 0x2001, 0x2002, 0x2003, 0x2004, 0x2005, 0x2006, 0x2007, 0x2008, 0x2009, 0x200A, 0x200B, 0x3000, and 0xFEFF. An array of Unicode characters to be removed or null.
SystemException class (System)
TrimStart
Description
Defines the base class for predefined exceptions in the System namespace.
System.SystemException is thrown by the common language runtime when errors occur that are nonfatal and recoverable by user programs. These errors result from failed runtime check (such as an array out-of-bound error), and can occur during the execution of any method.
SystemException
Example Syntax:
TrimStart
Initializes a new instance of the System.SystemException class with default properties.
The following table shows the initial property values for an instance of System.SystemException.
SystemException
Example Syntax:
TrimStart
Initializes a new instance of the System.SystemException class with a specified error message.
The following table shows the initial property values for an instance of System.SystemException. The error message that explains the reason for the exception.
SystemException
Example Syntax:
TrimStart
Initializes a new instance of the System.SystemException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
SystemException
Example Syntax:
TrimStart
Initializes a new instance of the System.SystemException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
ThreadStaticAttribute class (System)
ToString
Description
Indicates that the value of a static field is unique for each thread.
A static field marked with System.ThreadStaticAttribute is not shared between threads. Each executing thread has a separate instance of the static field, and independently set and get values for that field. If the static field is accessed on a different thread, it will contain a different value.
ThreadStaticAttribute
Example Syntax:
ToString
Initializes a new instance of the System.ThreadStaticAttribute class.
TypeId
TimeSpan structure (System)
ToString
Description
Represents a time interval.
The value of an instance of TimeSpan represents a period of time. That value is the number of “ticks” contained in the instance. A tick is the smallest unit of time that can be specified, and is equal to 100 nanoseconds. Both the specification of a number of ticks and the value of a TimeSpan can be positive or negative.
ToString
A constant whose value is the maximum TimeSpan value.
The value of this constant is equivalent to System.Int64.MaxValue ticks. The string representation of this value is positive 10675199.02:48:05.4775807.
ToString
A constant whose value is the minimum TimeSpan value.
The value of this constant is equivalent to System.Int64.MinValue ticks. The string representation of this value is negative 10675199.02:48:05.4775808.
ToString
A constant whose value is the number of ticks equivalent to 1 day.
The value of this constant is 864 billion; that is, 864000000000.
ToString
A constant whose value is the number of ticks equivalent to 1 hour. The value of this constant is 36 billion; that is, 36000000000.
ToString
A constant whose value is the number of ticks equivalent to 1 millisecond.
The value of this constant is 10 thousand; that is, 10000.
ToString
A constant whose value is the number of ticks equivalent to 1 minute.
The value of this constant is 600 million; that is, 600000000.
ToString
A constant whose value is the number of ticks equivalent to 1 second.
The value of this constant is 10 million; that is, 10000000.
ToString
A constant whose value is the zero TimeSpan value.
This constant provides a convenient source for zero in time calculations.
TimeSpan
Example Syntax:
ToString
Initializes a new instance of the TimeSpan class to the specified number of ticks. A time period in the form of ticks.
TimeSpan
Example Syntax:
ToString
Initializes a new instance of the TimeSpan class to a specified number of hours, minutes, and seconds.
The specified hours, minutes, and seconds are converted to ticks, and that value initializes this instance. Number of hours. Number of minutes. Number of seconds.
TimeSpan
Example Syntax:
ToString
Initializes a new instance of the TimeSpan class to a specified number of days, hours, minutes, and seconds.
The specified days, hours, minutes, and seconds are converted to ticks, and that value initializes this instance. Number of days. Number of hours. Number of minutes. Number of seconds.
TimeSpan
Example Syntax:
ToString
Initializes a new instance of the TimeSpan class to a specified number of days, hours, minutes, seconds, and milliseconds.
The specified days, hours, minutes, seconds, and milliseconds are converted to ticks, and that value initializes this instance. Number of days. Number of hours. Number of minutes. Number of seconds. Number of milliseconds.
Days
ToString
Gets the number of whole days represented by this instance.
DateTime values can be represented as expressions of the form “d.hh:mm:ss.ff” where the “d” component is days, “hh” is hours, “mm” is minutes, “ss” is seconds, and “ff” is fractions of a second. The value of this property is the days component.
Hours
ToString
Gets the number of whole hours represented by this instance.
DateTime values can be represented as expressions of the form “d.hh:mm:ss.ff” where the “d” component is days, “hh” is hours, “mm” is minutes, “ss” is seconds, and “ff” is fractions of a second. The value of this property is the hours component.
Milliseconds
ToString
Gets the number of whole milliseconds represented by this instance.
DateTime values can be represented as expressions of the form “d.hh:mm:ss.ff” where the “d” component is days, “hh” is hours, “mm” is minutes, “ss” is seconds, and “ff” is fractions of a second. The value of this property is the fractions of a second component expressed in milliseconds.
Minutes
ToString
Gets the number of whole minutes represented by this instance.
DateTime values can be represented as expressions of the form “d.hh:mm:ss.ff” where the “d” component is days, “hh” is hours, “mm” is minutes, “ss” is seconds, and “ff” is fractions of a second. The value of this property is the minutes component.
Seconds
ToString
Gets the number of whole seconds represented by this instance.
DateTime values can be represented as expressions of the form “d.hh:mm:ss.ff” where the “d” component is days, “hh” is hours, “mm” is minutes, “ss” is seconds, and “ff” is fractions of a second. The value of this property is the seconds component.
Ticks
ToString
Gets the value of this instance in ticks.
The smallest unit of time is the “tick,” which is equal to 100-nanoseconds. A tick can be negative or positive.
TotalDays
ToString
Gets the value of this instance expressed in whole and fractional days.
TotalHours
ToString
Gets the value of this instance expressed in whole and fractional hours.
TotalMilliseconds
ToString
Gets the value of this instance expressed in whole and fractional milliseconds.
TotalMinutes
ToString
Gets the value of this instance expressed in whole and fractional minutes.
TotalSeconds
ToString
Gets the value of this instance expressed in whole and fractional seconds.
Add
Adds the specified TimeSpan to this instance.
Return Value: A TimeSpan that represents the value of this instance plus the value of ts.
The result must be between System.TimeSpan.MinValue and System.TimeSpan.MaxValue, otherwise an exception is thrown. A TimeSpan instance.
Compare
Compares two TimeSpan values and returns an integer that indicates their relationship.
Return Value: Value Condition−1 t1 is less than t2 0 t1 is equal to t2 1 t1 is greater than t2 The first TimeSpan instance. The second TimeSpan instance.
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: Value Condition−1 The value of this instance is less than the value of value.
Any instance of TimeSpan, regardless of its value, is considered greater than null. An object to compare, or null.
Duration
Returns a TimeSpan whose value is the absolute value of this instance.
Return Value: A TimeSpan whose value is the value of this instance and converted if necessary to a positive number.
The value of a TimeSpan, which is the number of ticks it contains, can be positive or negative.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if value is a TimeSpan that represents the same time as this instance; otherwise, false. An object to compare with this instance.
Equals
Returns a value indicating whether two specified instances of TimeSpan are equal.
Return Value: true if the values of t1 and t2 are equal; otherwise, false. An instance of TimeSpan. An instance of TimeSpan.
FromDays
Returns a TimeSpan that represents a specified number of days, where the specification is accurate to the nearest millisecond.
Return Value: A TimeSpan that represents value.
If value is System.Double.PositiveInfinity, System.TimeSpan.MaxValue is returned. If value is System.Double.NegativeInfinity or System.Double.NaN, System.TimeSpan.MinValue is returned. A number of days, accurate to the nearest millisecond.
FromHours
Returns a TimeSpan that represents a specified number of hours, where the specification is accurate to the nearest millisecond.
Return Value: A TimeSpan that represents value.
If value is System.Double.PositiveInfinity, System.TimeSpan.MaxValue is returned. If value is System.Double.NegativeInfinity or System.Double.NaN, System.TimeSpan.MinValue is returned. A number of hours accurate to the nearest millisecond.
FromMilliseconds
Returns a TimeSpan that represents a specified number of milliseconds.
Return Value: A TimeSpan that represents value.
If value is System.Double.PositiveInfinity, System.TimeSpan.MaxValue is returned. If value is System.Double.NegativeInfinity or System.Double.NaN, System.TimeSpan.MinValue is returned. A number of milliseconds.
FromMinutes
Returns a TimeSpan that represents a specified number of minutes, where the specification is accurate to the nearest millisecond.
Return Value: A TimeSpan that represents value.
If value is System.Double.PositiveInfinity, System.TimeSpan.MaxValue is returned. If value is System.Double.NegativeInfinity or System.Double.NaN, System.TimeSpan.MinValue is returned. A number of minutes, accurate to the to nearest millisecond.
FromSeconds
Returns a TimeSpan that represents a specified number of seconds, where the specification is accurate to the nearest millisecond.
Return Value: A TimeSpan that represents value.
If value is System.Double.PositiveInfinity, System.TimeSpan.MaxValue is returned. If value is System.Double.NegativeInfinity or System.Double.NaN, System.TimeSpan.MinValue is returned. A number of seconds, accurate to the nearest millisecond.
FromTicks
Returns a TimeSpan that represents a specified time, where the specification is in units of ticks.
Return Value: A TimeSpan with a value of value.
This is a convenience method with the same behavior as the System.TimeSpan.#ctor constructor. A number of ticks that represent a time.
GetHashCode
Returns a hash code for this instance.
Return Value: A 32-bit signed integer hash code.
Two TimeSpan objects might have the same hash code even though they represent different time values.
Negate
Returns a TimeSpan whose value is the negated value of this instance.
Return Value: The same numeric value as this instance, but with the opposite sign.
op_Addition
Adds two specified TimeSpan instances.
Return Value: A TimeSpan whose value is the sum of the values of t1 and t2. A TimeSpan A TimeSpan
op_Equality
Indicates whether two TimeSpan instances are equal.
Return Value: true if the values of t1 and t2 are equal; otherwise, false. A TimeSpan A TimeSpan
op_GreaterThan
Indicates whether a specified TimeSpan is greater than another specified TimeSpan.
Return Value: true if the value of t1 is greater than the value of t2; otherwise, false. A TimeSpan A TimeSpan
op_GreaterThanOrEqual
Indicates whether a specified TimeSpan is greater than or equal to another specified TimeSpan.
Return Value: true if the value of t1 is greater than or equal to the value of t2; otherwise, false. A TimeSpan A TimeSpan
op_Inequality
Indicates whether two TimeSpan instances are not equal.
Return Value: true if the values of t1 and t2 are not equal; otherwise, false. A TimeSpan A TimeSpan
op_LessThan
Indicates whether a specified TimeSpan is less than another specified TimeSpan.
Return Value: true if the value of t1 is less than the value of t2; otherwise, false. A TimeSpan A TimeSpan
op_LessThanOrEqual
Indicates whether a specified TimeSpan is less than or equal to another specified TimeSpan.
Return Value: true if the value of t1 is less than or equal to the value of t2; otherwise, false. A TimeSpan A TimeSpan op_Subtraction
Subtracts a specified TimeSpan from another specified TimeSpan.
Return Value: A TimeSpan whose value is the result of the value of t1 minus the value of t2. A TimeSpan A TimeSpan
op_UnaryNegation
Returns a TimeSpan whose value is the negated value of the specified instance.
Return Value: A TimeSpan with the same numeric value as this instance, but the opposite sign. A TimeSpan
op_UnaryPlus
Returns the specified instance of TimeSpan.
Return Value: Returns t. A TimeSpan
Parse
Constructs a TimeSpan from a time indicated by a specified String.
Return Value: A TimeSpan that corresponds to s.
s contains a specification of the form: [ws][−][d.]hh:mm:ss[.ff][ws] Items in square brackets (‘[’ and ‘]’) are optional, colons and periods (‘:’ and ‘.’) are literal characters, and other items are as follows. A String.
Subtract
Subtracts the specified TimeSpan object from this instance.
Return Value: A TimeSpan whose value is the result of the value of this instance minus the value of ts.
The result must be between System.TimeSpan.MinValue and System.TimeSpan.MaxValue, otherwise an exception is thrown. A TimeSpan instance.
ToString
Returns the String representation of the value of this instance.
Return Value: A System.String that represents the value of this instance. The format of the return value is of the form: [−][d.]hh:mm:ss[.ff] Items in square brackets (‘[’ and ‘]’) are optional, colons and periods (‘:’ and ‘.’) are literal characters, and other items are as follows.
The return value of this method can be consumed by System.TimeSpan.Parse(System.String).
TimeZone class (System)
ToString
Description
Represents a time zone.
A time zone is a geographical region in which the same standard time is used.
TimeZone
Example Syntax:
ToString
Initializes a new instance of the System.TimeZone class.
CurrentTimeZone
ToString
Gets the time zone of the current computer system.
DaylightName
ToString
Gets the daylight saving time zone name.
If daylight saving time is not used in the time zone, an empty string (“ ”) is returned.
StandardName
ToString
Gets the standard time zone name.
GetDaylightChanges
Returns the daylight saving time period for a particular year.
Return Value: A System.Globalization.DaylightTime instance containing the start and end date for daylight saving time in year.
Only one daylight saving time period per year is supported. If daylight saving time is not used in the current time zone, null is returned. The year to which the daylight saving time period applies.
GetUtcOffset
Returns the coordinated universal time (UTC) offset for the specified local time.
Return Value: The UTC offset from time, measured in ticks.
Coordinated universal time (UTC) was previously known as Greenwich Mean Time (GMT). “Local time” is the date and time on the computer you are using. “Offset” is the difference between local time and UTC. That is: local time=UTC+offset time must be in the Gregorian calendar and the time zone represented by this instance. If time is in daylight saving time, this method returns the UTC offset to the daylight saving time zone. This method obtains the daylight saving time rule from the system. The local date and time.
IsDaylightSavingTime
Returns a value indicating whether a specified date and time is within a daylight saving time period.
Description
Returns a value indicating whether the specified date and time is within a daylight saving time period.
Return Value: true if time is in a daylight saving time period; false otherwise, or if time is null.
The year to which the daylight saving time period applies is derived from time. A date and time.
IsDaylightSavingTime
Returns a value indicating whether the specified date and time is within the specified daylight saving time period.
Return Value: true if time is in daylightTimes; otherwise, false. A date and time. A daylight saving time period.
ToLocalTime
Returns the local time that corresponds to a specified coordinated universal time (UTC).
Return Value: A System.DateTime instance whose value is the local time that corresponds to time.
Coordinated universal time (UTC) was previously known as Greenwich Mean Time (GMT). “Local time” is the date and time on the computer you are using. “Offset” is the difference between local time and GMT. That is: local time=UTC+offset A UTC time.
ToUniversalTime
Returns the coordinated universal time (UTC) that corresponds to a specified local time.
Return Value: A System.DateTime instance whose value is the UTC time that corresponds to time.
Coordinated universal time (UTC) was previously known as Greenwich Mean Time (GMT). “Local time” is the date and time on the computer you are using. “Offset” is the difference between local time and UTC. That is: UTC=local time-offset The local date and time.
Type class (System)
ToUniversalTime
Description
Represents type declarations: class types, interface types, array types, value types, and enumeration types.
Type is the root of all reflection operations and the object that represents a type inside the system.
ToUniversalTime
Separates names in the namespace of the System.Type. This field is read-only.
ToUniversalTime
Represents an empty array of type System.Type. This field is read-only.
ToUniversalTime
Represents the member filter used on attributes. This field is read-only. This field holds a reference to the delegate used by the System.Type.FindMembers(System.Reflection.MemberTypes,System.Reflection. BindingFlags,System.Reflection.MemberFilter,System.Object) method. The method encapsulated by this delegate takes two parameters: the first is a System.Reflection.MemberInfo object and the second is an Object. The method determines whether the MemberInfo object matches the criteria specified by the Object. The Object may be assigned the value of any one of the fields on the classes System.Reflection.FieldAttributes, System.Reflection.MethodAttributes, or System.Reflection.MethodImplAttributes.
ToUniversalTime
Represents the case-sensitive member filter used on names. This field is read-only.
This field holds a reference to the delegate used by the System.Type.FindMembers(System.Reflection.MemberTypes,System.Reflection.BindingFlags,System.Reflection.MemberFilter,System.Object) method. The method encapsulated by this delegate takes two parameters: the first is a System.Reflection.MemberInfo object and the second is an Object. The method determines whether the MemberInfo object matches the criteria specified by the Object. The Object is assigned a string value, which may include a trailing “*” wildcard character. Only wildcard end string matching is supported.
ToUniversalTime
Represents the case-insensitive member filter used on names. This field is read-only.
This field holds a reference to the delegate used by the System.Type.FindMembers(System.Reflection.MemberTypes,System.Reflection.BindingFlags,System.Reflection.MemberFilter,System.Object) method. The method encapsulated by this delegate takes two parameters: the first is a System.Reflection.MemberInfo object and the second is an Object. The method determines whether the MemberInfo object matches the criteria specified by the Object. The Object is assigned a string value, which may include a trailing “*” wildcard character. Only wildcard end string matching is supported.
ToUniversalTime
Represents a missing value in the System.Type information. This field is read-only.
Use the Missing field to obtain the default value of a parameter. If the Missing field is passed in for a parameter value and there is no default value for that parameter, an System.ArgumentException is thrown.
Type
Example Syntax:
ToUniversalTime
Initializes a new instance of the System.Type class.
This constructor is invoked by derived classes during the construction of type objects.
Assembly
ToUniversalTime
Gets the System.Reflection.Assembly associated with a class.
AssemblyQualifiedName
ToUniversalTime
Gets the fully qualified name of the System.Type, including the name of the assembly from which the System.Type was loaded.
All compilers that support the common language runtime will emit the simple name of a nested class, and reflection constructs a mangled name when queried, in accordance with the following conventions.
Attributes
ToUniversalTime
Gets the attributes associated with the System.Type.
BaseType
ToUniversalTime
Gets the type from which the current System.Type directly inherits.
The base type is the type from which the current type directly inherits.
DeclaringType
ToUniversalTime
Gets the class that declares this member.
This property implements the abstract property inherited from System.Reflection.MemberInfo.
DefaultBinder
ToUniversalTime
Gets the default binder used by the system.
Reflection models the accessibility rules of the common type system. For example, if the caller is in the same assembly, the caller does not need special permissions for internal members. Otherwise, the caller needs System.Security.Permissions.ReflectionPermission. This is consistent with lookup of members that are protected, private, and so on.
FullName
ToUniversalTime
Gets the fully qualified name of the System.Type, including the namespace of the System.Type.
All compilers that support the common language runtime will emit the simple name of a nested class, and reflection constructs a mangled name when queried, in accordance with the following conventions.
GUID
ToUniversalTime
Gets the GUID associated with the System.Type.
HasElementType
ToUniversalTime
Gets a value indicating whether the current System.Type encompasses or refers to another type; that is, whether the current System.Type is an array, a pointer, or is passed by reference.
For example, Type.GetType(“Int32[ ]”).HasElementType returns true, but Type.GetType(“Int32”).HasElementType returns false. HasElementType also returns true for “Int32*” and “Int32&”.
IsAbstract
ToUniversalTime
Gets a value indicating whether the System.Type is abstract and must be overridden.
IsAnsiClass
ToUniversalTime
Gets a value indicating whether the string format attribute AnsiClass is selected for the System.Type.
The System.Reflection.TypeAttributes.StringFormatMask selects the string format attributes. The string format attributes enhance interoperability by defining how strings should be interpreted.
IsArray
ToUniversalTime
Gets a value indicating whether the System.Type is an array.
An instance of the System.Array class will return false because it is an object, not an array.
IsAutoClass
ToUniversalTime
Gets a value indicating whether the string format attribute AutoClass is selected for the System.Type.
The System.Reflection.TypeAttributes.StringFormatMask selects the string format attributes. The string format attributes enhance interoperability by defining how strings should be interpreted.
IsAutoLayout
ToUniversalTime
Gets a value indicating whether the class layout attribute AutoLayout is selected for the System.Type.
The System.Reflection.TypeAttributes.LayoutMask is used to select the class layout attributes. The class layout attributes(AutoLayout, SequentialLayout and ExplicitLayout) define how the fields of the class instance are laid out in memory.
IsByRef
ToUniversalTime
Gets a value indicating whether the System.Type is passed by reference.
IsClass
ToUniversalTime
Gets a value indicating whether the System.Type is a class; that is, not a value type or interface.
The System.Reflection.TypeAttributes.ClassSemanticsMask distinguishes a type declaration as class, interface, or value type.
IsCOMObject
ToUniversalTime
Gets a value indicating whether the System.Type is a COM object.
This method returns false for COM interfaces because they are not objects. COM interfaces can be implemented by Microsoft.NET Framework objects.
IsContextful
ToUniversalTime
Gets a value indicating whether the System.Type can be hosted in a context.
A context intercepts calls to the class members and enforces policies that are applied to the class, such as synchronization. For more detailed information on remoting contexts, see System.Runtime.Remoting.Contexts.Context.
IsEnum
ToUniversalTime
Gets a value indicating whether the System.Type is an enumeration.
For example, GetType(Enum).IsEnum( ) returns false because System.Enum is an object, not an enumeration.
IsExplicitLayout
ToUniversalTime
Gets a value indicating whether the class layout attribute ExplicitLayout is selected for the System.Type.
The System.Reflection.TypeAttributes.LayoutMask is used to select the class layout attributes. The class layout attributes (AutoLayout, SequentialLayout and ExplicitLayout) define how the fields of the class instance are laid out in memory.
IsImport
ToUniversalTime
Gets a value indicating whether the System.Type was imported from another class.
IsInterface
ToUniversalTime
Gets a value indicating whether the System.Type is an interface; that is, not a class or a value type.
The System.Reflection.TypeAttributes.ClassSemanticsMask distinguishes a type declaration as class, interface or value type.
IsLayoutSequential
ToUniversalTime
Gets a value indicating whether the class layout attribute SequentialLayout is selected for the System.Type.
The System.Reflection.TypeAttributes.LayoutMask is used to select the class layout attributes. The class layout attributes (AutoLayout, SequentialLayout and ExplicitLayout) define how the fields of the class instance are laid out in memory.
IsMarshalByRef
ToUniversalTime
Gets a value indicating whether the Type is marshaled by reference.
IsNestedAssembly
ToUniversalTime
Gets a value indicating whether the System.Type is nested and visible only within its own assembly. The System.Reflection.TypeAttributes.VisibilityMask selects the visibility attributes.
IsNestedFamANDAssem
ToUniversalTime
Gets a value indicating whether the System.Type is nested and visible only to classes that belong to both its own family and its own assembly.
The System.Reflection.TypeAttributes.VisibilityMask selects the visibility attributes.
IsNestedFamily
ToUniversalTime
Gets a value indicating whether the System.Type is nested and visible only within its own family.
The System.Reflection.TypeAttributes.VisibilityMask selects the visibility attributes.
IsNestedFamORAssem
ToUniversalTime
Gets a value indicating whether the System.Type is nested and visible only to classes that belong to either its own family or to its own assembly.
The System.Reflection.TypeAttributes.VisibilityMask selects the visibility attributes.
IsNestedPrivate
ToUniversalTime
Gets a value indicating whether the System.Type is nested and declared private.
The System.Reflection.TypeAttributes.VisibilityMask selects the visibility attributes.
IsNestedPublic
ToUniversalTime
Gets a value indicating whether the System.Type is nested and declared public.
The System.Reflection.TypeAttributes.VisibilityMask selects the visibility attributes.
IsNotPublic
ToUniversalTime
Gets a value indicating whether the top-level System.Type is not declared public.
IsPublic and IsNotPublic get the visibility of the top-level type only.
IsPointer
ToUniversalTime
Gets a value indicating whether the System.Type is a pointer.
IsPrimitive
ToUniversalTime
Gets a value indicating whether the System.Type is one of the primitive types.
The primitive types are System.Boolean, System.Byte, System.SByte, System.Int16, System.UInt16, System.Int32, System.UInt32, System.Int64, System.UInt64, System.Char, System.Double, and System.Single.
IsPublic
ToUniversalTime
Gets a value indicating whether the top-level System.Type is declared public.
IsPublic and IsNotPublic get the visibility of the top-level type only.
IsSealed
ToUniversalTime
Gets a value indicating whether the System.Type is declared sealed.
IsSerializable
ToUniversalTime
Gets a value indicating whether the System.Type is serializable.
IsSpecialName
ToUniversalTime
Gets a value indicating whether the System.Type has a name that requires special handling.
Names that begin with or contain an underscore character (), property accessors, and operator overloading methods are examples of types that might require special treatment by some compilers.
IsUnicodeClass
ToUniversalTime
Gets a value indicating whether the string format attribute UnicodeClass is selected for the System.Type.
The System.Reflection.TypeAttributes.StringFormatMask is used to select the string format attributes. The string format attributes enhance interoperability by defining how strings should be interpreted.
IsValueType
ToUniversalTime
Gets a value indicating whether the System.Type is a value type. Value types are those that are represented as sequences of bits; value types are not classes or interfaces. These are referred to as “structs” in some programming languages. Enums are a special case of value types.
MemberType
ToUniversalTime
Gets a bitmask indicating the member type.
Module
ToUniversalTime
Gets the module (the DLL) in which the current System.Type is defined.
Name
Namespace
ToUniversalTime
Description
Gets the namespace of the System.Type.
ReflectedType
ToUniversalTime
Gets the class object that was used to obtain this member.
This property implements the abstract property inherited from System.Reflection.MemberInfo.
TypeHandle
ToUniversalTime
Gets the handle for the current System.Type.
TypeHandle encapsulates a pointer to an internal data structure that represents the type. This handle is unique during the process lifetime. The handle is valid only in the application domain in which it was obtained.
TypeInitializer
ToUniversalTime
Gets the name of the class constructor for the System.Type.
Class initializers are available through System.Type.GetMember(System.String), System.Type.GetMembers, System.Type.FindMembers(System.Reflection.MemberTypes,System.Reflection. BindingFlags,System.Reflection.MemberFilter,System.Object), and System.Type.GetConstructors.
UnderlyingSystemType
ToUniversalTime
Indicates the type provided by the common language runtime that represents this type.
Equals
Determines if the underlying system type of the current System.Type is the same as the underlying system type of the specified System.Object.
Return Value: true if the underlying system type of o is the same as the underlying system type of the current System.Type; otherwise, false. The System.Object whose underlying system type is to be compared with the underlying system type of the current System.Type.
Equals
Determines if the underlying system type of the current System.Type is the same as the underlying system type of the specified System.Type.
Return Value: true if the underlying system type of o is the same as the underlying system type of the current System.Type; otherwise, false. The System.Type whose underlying system type is to be compared with the underlying system type of the current System.Type.
FindInterfaces
Returns an array of System.Type objects representing a filtered list of interfaces implemented or inherited by the current System.Type.
Return Value: An array of System.Type objects representing a filtered list of the interfaces implemented or inherited by the current System.Type.
This method can be overridden by a derived class. The System.Reflection.TypeFilter delegate that compares the interfaces against filterCriteria. The search criteria that determines whether an interface should be included in the returned array.
FindMembers
Returns a filtered array of System.Reflection.MemberInfo objects of the specified member type.
Return Value: A filtered array of System.Reflection.MemberInfo objects of the specified member type.
This method can be overridden by a derived class. A MemberTypes object indicating the type of member to search for. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted. The delegate that does the comparisons, returning true if the member currently being inspected matches the filterCriteria and false otherwise. You can use the FilterAttribute, FilterName, and FilterNameIgnoreCase delegates supplied by this class. The first uses the fields of FieldAttributes, MethodAttributes, and MethodImplAttributes as search criteria, and the other two delegates use String objects as the search criteria. The search criteria that determines whether a member is returned in the array of MemberInfo objects.
GetArrayRank
Gets the number of dimensions in an System.Array.
Return Value: The number of dimensions in an System.Array.
GetAttributeFlagsImpl
When overridden in a derived class, implements the System.Type.Attributes property and gets a bitmask indicating the attributes associated with the System.Type.
Return Value: A System.Reflection.TypeAttributes object representing the attribute set of the System.Type
GetConstructor
Searches for a public instance constructor whose parameters match the types in the specified array.
Return Value: A System.Reflection.ConstructorInfo object representing the public instance constructor whose parameters match the types in the parameter type array, if found; otherwise, null.
System.Type.GetConstructor(System.Reflection.BindingFlags,System. Reflection.Binder,System.Reflection.CallingConventions,System.Type[ ],System. Reflection.ParameterModifier[ ]) looks for public instance constructors and cannot be used to obtain a class initializer. Class initializers are available through System.Type.GetMember(System.String), System.Type.GetMembers, System.Type.FindMembers(System.Reflection.MemberTypes,System.Reflection.BindingFlags,System.Reflection.MemberFilter,System.Object), System.Type.GetConstructors, and System.Type.TypeInitializer. An array of System.Type objects representing the number, order, and type of the parameters for the constructor to get.
GetConstructor
Searches for a constructor whose parameters match the specified argument types and modifiers, using the specified binding constraints.
Return Value: A System.Reflection.ConstructorInfo object representing the constructor that matches the specified requirements, if found; otherwise, null
The types array and the modifiers array have the same length. A parameter specified in the types array can have the following attributes, which are specified in the modifiers array: pdIn, pdOut, pdLcid, pdRetval, pdOptional, and pdHasDefault, which represent [In], [Out], [lcid], [retval], [optional], and a value specifying whether the parameter has a default value. A parameter's associated attributes are stored in the metadata and enhance interoperability. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted. A System.Reflection.Binder object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection. An array of System.Type objects representing the number, order, and type of the parameters for the constructor to get. An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the parameter type array.
GetConstructor
Searches for a constructor whose parameters match the specified argument types and modifiers, using the specified binding constraints and the specified calling convention.
Return Value: A System.Reflection.ConstructorInfo object representing the constructor that matches the specified requirements, if found; otherwise, null.
The types array and the modifiers array have the same length. A parameter specified in the types array can have the following attributes, which are specified in the modifiers array: pdIn, pdOut, pdLcid, pdRetval, pdOptional, and pdHasDefault, which represent [In], [Out], [lcid], [retval], [optional], and a value specifying whether the parameter has a default value. A parameter's associated attributes are stored in the metadata and enhance interoperability. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted. A System.Reflection.Binder object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection. The System.Reflection.CallingConventions object that specifies the set of rules to use regarding the order and layout of arguments, how the return value is passed, what registers are used for arguments, and the stack is cleaned up. An array of System.Type objects representing the number, order, and type of the parameters for the constructor to get. An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array.
GetConstructorImpl
When overridden in a derived class, searches for a constructor whose parameters match the specified argument types and modifiers, using the specified binding constraints and the specified calling convention.
Return Value: A System.Reflection.ConstructorInfo object representing the constructor that matches the specified requirements, if found; otherwise, null.
The types array and the modifiers array have the same length. A parameter specified in the types array can have the following attributes, which are specified in the modifiers array: pdIn, pdOut, pdLcid, pdRetval, pdOptional, and pdHasDefault, which represent [In], [Out], [lcid], [retval], [optional], and a value specifying whether the parameter has a default value. A parameter's associated attributes are stored in the metadata and are used for interoperability. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted. A System.Reflection.Binder object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection. The System.Reflection.CallingConventions object that specifies the set of rules to use regarding the order and layout of arguments, how the return value is passed, what registers are used for arguments, and the stack is cleaned up. An array of System.Type objects representing the number, order, and type of the parameters for the constructor to get. An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array.
GetConstructors
Returns all the public constructors defined for the current System.Type.
Return Value: An array of System.Reflection.ConstructorInfo objects representing all the public constructors defined for the current System.Type, including the type initializer if it is defined.
The following table shows what members of a base class are returned by the Get methods when reflecting on a type.
GetConstructors
When overridden in a derived class, searches for the constructors defined for the current System.Type, using the specified BindingFlags.
Return Value: An array of System.Reflection.ConstructorInfo objects representing all constructors defined for the current System.Type that match the specified binding constraints, including the type initializer if it is defined.
bindingAttr can be used to specify whether to return only public constructors or both public and non-public constructors. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.
GetDefaultMembers
Searches for the members defined for the current System.Type whose System.Reflection.DefaultMemberAttribute is set.
Return Value: An array of System.Reflection.MemberInfo objects representing all default members of the current System.Type.
This method can be overridden by a derived class.
GetElementType
When overridden in a derived class, returns the System.Type of the object encompassed or referred to by the current array, pointer or reference type.
Return Value: The System.Type of the object encompassed or referred to by the current array, pointer or reference type.
For example, Type.GetType(“Int32[ ]”).GetElementType returns Int32.
GetEvent
Returns the System.Reflection.EventInfo object representing the specified event.
Return Value: The System.Reflection.EventInfo object representing the specified event which is declared or inherited by the current System.Type, if found; otherwise, null.
The search for name is case-sensitive. The System.String containing the name of an event which is declared or inherited by the current System.Type.
GetEvent
When overridden in a derived class, returns the System.Reflection.EventInfo object representing the specified event, using the specified binding constraints.
Return Value: The System.Reflection.EventInfo object representing the specified event which is declared or inherited by the current System.Type, if found; otherwise, null.
The following System.Reflection.BindingFlags filter flags can be used to define which events to include in the search: Public to include public events in the search. The System.String containing the name of an event which is declared or inherited by the current System.Type. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.
GetEvents
Returns all the public events that are declared or inherited by the current System.Type.
Return Value: An array of System.Reflection.EventInfo objects representing all the public events which are declared or inherited by the current System.Type.
This method can be overridden by a derived class.
GetEvents
When overridden in a derived class, searches for events that are declared or inherited by the current System.Type, using the specified binding constraints.
Return Value: An array of System.Reflection.EventInfo objects representing all events which are declared or inherited by the current System.Type that match the specified binding constraints.
The following System.Reflection.BindingFlags filter flags can be used to define which events to include in the search: Public to include public events in the search. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.
GetField
Searches for the field with the specified name.
Return Value: A System.Reflection.FieldInfo object representing the field with the specified name, if found; otherwise, null.
The search for name is case-sensitive. The System.String containing the name of the data field to get.
GetField
Searches for the specified field, using the specified binding constraints.
Return Value: A System.Reflection.FieldInfo object representing the field that matches the specified requirements, if found; otherwise, null.
The following table shows what members of a base class are returned by the Get methods when reflecting on a type. The System.String containing the name of the data field to get. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.
GetFields
Returns all the public fields of the current System.Type.
Return Value: An array of System.Reflection.FieldInfo objects representing all the public fields defined for the current System.Type.
The following table shows what members of a base class are returned by the Get methods when reflecting on a type.
GetFields
When overridden in a derived class, searches for the fields defined for the current System.Type, using the specified binding constraints.
Return Value: An array of System.Reflection.FieldInfo objects representing all fields defined for the current System.Type that match the specified binding constraints.
The following System.Reflection.BindingFlags filter flags can be used to define which fields to include in the search: Instance to include instance fields in the search. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.
GetHashCode
Returns the hash code of the System.Type
Return Value: The hash code of the System.Type.
GetInterface
Searches for the interface with the specified name.
Return Value: A System.Type object representing the interface with the specified name, implemented or inherited by the current System.Type, if found; otherwise, null.
The search for name is case-sensitive. The System.String containing the name of the interface to get.
GetInterface
When overridden in a derived class, searches for the specified interface, specifying whether to do a case-sensitive search.
Return Value: A System.Type object representing the interface with the specified name, implemented or inherited by the current System.Type, if found; otherwise, null.
If name has 128 or more standard ASCII characters, a case-sensitive search is performed, regardless of the value of ignoreCase. Arrays or COM types are not searched for unless they have been previously loaded into the table of available classes. The System.String containing the name of the interface to get. true to perform a case-insensitive search for name.
GetInterfaceMap
Returns an interface mapping for the specified interface type.
Return Value: An System.Reflection.InterfaceMapping object representing the interface mapping for interfaceType.
The interface map denotes how an interface is mapped into the actual methods on a class that implements that interface. The System.Type of the interface of which to retrieve a mapping.
GetInterfaces
When overridden in a derived class, gets all the interfaces implemented or inherited by the current System.Type.
Return Value: An array of System.Type objects representing all the interfaces implemented or inherited by the current System.Type.
GetMember
Searches for the members with the specified name.
Return Value: An array of System.Reflection.MemberInfo objects representing the public members with the specified name, if found; otherwise, null.
The search for name is case-sensitive. The System.String containing the name of the public members to get.
GetMember
Searches for the specified members, using the specified binding constraints.
Return Value: An array of System.Reflection.MemberInfo objects representing the public members with the specified name, if found; otherwise, null.
This method can be overridden by a derived class. The System.String containing the name of the members to get. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.
GetMember
Searches for the specified members of the specified member type, using the specified binding constraints.
Return Value: An array of System.Reflection.MemberInfo objects representing the public members with the specified name, if found; otherwise, null.
Members include properties, methods, fields, events, and so on. The System.String containing the name of the members to get. The System.Type of member to search for. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.
GetMembers
Returns all the public members of the current System.Type.
Return Value: An array of System.Reflection.MemberInfo objects representing all the public members of the current System.Type. Members include properties, methods, fields, events, and so on.
GetMembers
When overridden in a derived class, searches for the members defined for the current System.Type, using the specified binding constraints.
Return Value: An array of System.Reflection.MemberInfo objects representing all members defined for the current System.Type that match the specified binding constraints.
Members include properties, methods, fields, events, and so on. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.
GetMethod
Searches for the public method with the specified name.
Return Value: A System.Reflection.MethodInfo object representing the public method with the specified name, if found; otherwise, null.
The search for name is case-sensitive. The System.String containing the name of the public method to get.
GetMethod
Searches for the specified method, using the specified binding constraints.
Return Value: A System.Reflection.MethodInfo object representing the method that matches the specified requirements, if found; otherwise, null.
The following System.Reflection.BindingFlags filter flags can be used to define which methods to include in the search: Instance to include instance methods in the search. The System.String containing the name of the method to get. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.
GetMethod
Searches for the specified public method whose parameters match the specified argument types.
Return Value: A System.Reflection.MethodInfo object representing the public method whose parameters match the specified argument types, if found; otherwise, null.
The search for name is case-sensitive. The System.String containing the name of the public method to get. An array of System.Type objects representing the number, order, and type of the parameters for the method to get.
GetMethod
Searches for the specified public method whose parameters match the specified argument types and modifiers.
Return Value: A System.Reflection.MethodInfo object representing the public method that matches the specified requirements, if found; otherwise, null.
The types array and the modifiers array have the same length. A parameter specified in the types array can have the following attributes, which are specified in the modifiers array: pdIn, pdOut, pdLcid, pdRetval, pdOptional, and pdHasDefault, which represent [In], [Out], [lcid], [retval], [optional], and a value specifying whether the parameter has a default value. A parameter's associated attributes are stored in the metadata and are used for interoperability. The System.String containing the name of the public method to get. An array of System.Type objects representing the number, order, and type of the parameters for the method to get. An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array.
GetMethod
Searches for the specified method whose parameters match the specified argument types and modifiers, using the specified binding constraints.
Return Value: A System.Reflection.MethodInfo object representing the method that matches the specified requirements, if found; otherwise, null.
The types array and the modifiers array have the same length. A parameter specified in the types array can have the following attributes, which are specified in the modifiers array: pdIn, pdOut, pdLcid, pdRetval, pdOptional, and pdHasDefault, which represent [In], [Out], [lcid], [retval], [optional], and a value specifying whether the parameter has a default value. A parameter's associated attributes are stored in the metadata and enhance interoperability. The System.String containing the name of the method to get. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted. A System.Reflection.Binder object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection. An array of System.Type objects representing the number, order, and type of the parameters for the method to get. An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array.
GetMethod
Searches for the specified method whose parameters match the specified argument types and modifiers, using the specified binding constraints and the specified calling convention.
Return Value: A System.Reflection.MethodInfo object representing the method that matches the specified requirements, if found; otherwise, null.
The following table shows what members of a base class are returned by the GetXXX methods when reflecting on a type. The System.String containing the name of the method to get. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted. A System.Reflection.Binder object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection. The System.Reflection.CallingConventions object that specifies the set of rules to use regarding the order and layout of arguments, how the return value is passed, what registers are used for arguments, and how the stack is cleaned up. An array of System.Type objects representing the number, order, and type of the parameters for the method to get. An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array.
GetMethodImpl
When overridden in a derived class, searches for the specified method whose parameters match the specified argument types and modifiers, using the specified binding constraints and the specified calling convention.
Return Value: A System.Reflection.MethodInfo object representing the method that matches the specified requirements, if found; otherwise, null.
If types is null, arguments are not matched. The System.String containing the name of the method to get. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted. A System.Reflection.Binder object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection. The System.Reflection.CallingConventions object that specifies the set of rules to use regarding the order and layout of arguments, how the return value is passed, what registers are used for arguments, and what process cleans up the stack. An array of System.Type objects representing the number, order, and type of the parameters for the method to get. An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array.
GetMethods
Returns all the public methods of the current System.Type
Return Value: An array of System.Reflection.MethodInfo objects representing all the public methods defined for the current System.Type.
The following table shows what members of a base class are returned by the Get methods when reflecting on a type.
GetMethods
When overridden in a derived class, searches for the methods defined for current System.Type, using the specified binding constraints.
Return Value: An array of System.Reflection.MethodInfo objects representing all methods defined for the current System.Type that match the specified binding constraints.
The following System.Reflection.BindingFlags filter flags can be used to define which methods to include in the search: Instance to include instance methods in the search. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.
GetNestedType
Searches for the nested type with the specified name.
Return Value: A System.Type object representing the nested type with the specified name, if found; otherwise, null.
The search for name is case-sensitive. The System.String containing the name of the nested type to get.
GetNestedType
When overridden in a derived class, searches for the specified nested type, using the specified binding constraints.
Return Value: A System.Type object representing the nested type that matches the specified requirements, if found; otherwise, null.
The following System.Reflection.BindingFlags filter flags can be used to define which nested types to include in the search: Public to include public nested types in the search. The System.String containing the name of the nested type to get. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.
GetNestedTypes
Returns all the types nested within the current System.Type.
Return Value: An array of System.Type objects representing all the types nested within the current System.Type.
The following table shows what members of a base class are returned by the Get methods when reflecting on a type.
GetNestedTypes
When overridden in a derived class, searches for the types nested within the current System.Type, using the specified binding constraints.
Return Value: An array of System.Type objects representing all the types nested within the current System.Type that match the specified binding constraints.
The following System.Reflection.BindingFlags filter flags can be used to define which nested types to include in the search: Public to include public nested types in the search. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.
GetProperties
Returns all the public properties of the current System.Type.
Return Value: An array of System.Reflection.PropertyInfo objects representing all public properties of the current System.Type.
The following table shows what members of a base class are returned by the Get methods when reflecting on a type.
GetProperties
When overridden in a derived class, searches for the properties of the current System.Type, using the specified binding constraints.
Return Value: An array of System.Reflection.PropertyInfo objects representing all properties of the current System.Type that match the specified binding constraints.
A property is considered public to reflection if it has at least one accessor that is public. That is, you can call type.GetProperty(“propertyname”, BindingFlags.Public|BindingFlags.Instance|BindingFlags.Static) to get it. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.
GetProperty
Searches for the public property with the specified name.
Return Value: A System.Reflection.PropertyInfo object representing the public property with the specified name, if found; otherwise, null.
The search for name is case-sensitive. The System.String containing the name of the public property to get.
GetProperty
Searches for the specified property, using the specified binding constraints.
Return Value: A System.Reflection.PropertyInfo object representing the property that matches the specified requirements, if found; otherwise, null.
The types array and the modifiers array have the same length. A parameter specified in the types array can have the following attributes, which are specified in the modifiers array: pdIn, pdOut, pdLcid, pdRetval, pdOptional, and pdHasDefault, which represent [In], [Out], [lcid], [retval], [optional], and a value specifying whether the parameter has a default value. A parameter's associated attributes are stored in the metadata and enhance interoperability. The System.String containing the name of the property to get. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.
GetProperty
Searches for the public property with the specified name and return type.
Return Value: A System.Reflection.PropertyInfo object representing the public property with the specified name, if found; otherwise, null.
The search for name is case-sensitive. The System.String containing the name of the public property to get. The return type of the property.
GetProperty
Searches for the specified public property whose parameters match the specified argument types.
Return Value: A System.Reflection.PropertyInfo object representing the public property whose parameters match the specified argument types, if found; otherwise, null.
The search for name is case-sensitive. The System.String containing the name of the public property to get. An array of System.Type objects representing the number, order, and type of the parameters for the indexed property to get.
GetProperty
Searches for the specified public property whose parameters match the specified argument types.
Return Value: A System.Reflection.PropertyInfo object representing the public property whose parameters match the specified argument types, if found; otherwise, null.
The search for name is case-sensitive. The System.String containing the name of the public property to get. The return type of the property. An array of System.Type objects representing the number, order, and type of the parameters for the indexed property to get.
GetProperty
Searches for the specified public property whose parameters match the specified argument types and modifiers.
Return Value: A System.Reflection.PropertyInfo object representing the public property that matches the specified requirements, if found; otherwise, null.
The types array and the modifiers array have the same length. A parameter specified in the types array can have the following attributes, which are specified in the modifiers array: pdIn, pdOut, pdLcid, pdRetval, pdOptional, and pdHasDefault, which represent [In], [Out], [lcid], [retval], [optional], and a value specifying whether the parameter has a default value. A parameter's associated attributes are stored in the metadata and enhance interoperability. The System.String containing the name of the public property to get. The return type of the property. An array of System.Type objects representing the number, order, and type of the parameters for the indexed property to get. An array of System.Reflection.ParameterModifier objects representing the attributes Is associated with the corresponding element in the types array.
GetProperty
Searches for the specified property whose parameters match the specified argument types and modifiers, using the specified binding constraints.
Return Value: A System.Reflection.PropertyInfo object representing the property that matches the specified requirements, if found; otherwise, null
The following table shows what members of a base class are returned by the Get methods when reflecting on a type. The System.String containing the name of the property to get. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted. A System.Reflection.Binder object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection. The return type of the property. An array of System.Type objects representing the number, order, and type of the parameters for the indexed property to get. An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array.
GetPropertyImpl
When overridden in a derived class, searches for the specified property whose parameters match the specified argument types and modifiers, using the specified binding constraints.
Return Value: A System.Reflection.PropertyInfo object representing the property that matches the specified requirements, if found; otherwise, null.
The types array and the modifiers array have the same length. A parameter specified in the types array can have the following attributes, which are specified in the modifiers array: pdIn, pdOut, pdLcid, pdRetval, pdOptional, and pdHasDefault, which represent [In], [Out], [lcid], [retval], [optional], and a value specifying whether the parameter has a default value. A parameter's associated attributes are stored in the metadata and are used for interoperability. The System.String containing the name of the property to get. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted. A System.Reflection.Binder object that defines a set of properties and enables binding, which can involve selection of an overloaded member, coercion of argument types, and invocation of a member through reflection. The return type of the property. An array of System.Type objects representing the number, order, and type of the parameters for the indexed property to get. An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array.
GetType
Gets the System.Type with the specified name, performing a case-sensitive search.
Return Value: The System.Type with the specified name, if found; otherwise, null
GetType only works on assemblies loaded from disk. If you call GetType to look up a type defined in a dynamic assembly defined using the System.Reflection.Emit services, you might get inconsistent behavior. The behavior depends on whether the dynamic assembly is persistent, that is, created using the RunAndSave or Save access modes of the System.Reflection.Emit.AssemblyBuilderAccess enumeration. If the dynamic assembly is persistent and has been written to disk before GetType is called, the loader finds the saved assembly on disk, loads that assembly, and retrieves the type from that assembly. If the assembly has not been saved to disk when GetType is called, the method returns null. The name of the System.Type to get.
GetType
Gets the System.Type with the specified name, performing a case-sensitive search and specifying whether to throw an exception if an error occurs while loading the System.Type.
Return Value: The System.Type with the specified name, if found; otherwise, null
GetType only-works on assemblies loaded from disk. If you call GetType to look up a type defined in a dynamic assembly defined using the System.Reflection.Emit services, you might get inconsistent behavior. The behavior depends on whether the dynamic assembly is persistent, that is, created using the RunAndSave or Save access modes of the System.Reflection.Emit.AssemblyBuilderAccess enumeration. If the dynamic assembly is persistent and has been written to disk before GetType is called, the loader finds the saved assembly on disk, loads that assembly, and retrieves the type from that assembly. If the assembly has not been saved to disk when GetType is called, the method returns null. The name of the System.Type to get. true to throw a System.TypeLoadException if an error occurs while loading the System.Type.
GetType
Gets the System.Type with the specified name, specifying whether to perform a case-sensitive search and whether to throw an exception if an error occurs while loading the System.Type.
Return Value: The System.Type with the specified name, if found; otherwise, null
GetType only works on assemblies loaded from disk. If you call GetType to look up a type defined in a dynamic assembly defined using the System.Reflection.Emit services, you might get inconsistent behavior. The behavior depends on whether the dynamic assembly is persistent, that is, created using the RunAndSave or Save access modes of the System.Reflection.Emit.AssemblyBuilderAccess enumeration. If the dynamic assembly is persistent and has been written to disk before GetType is called, the loader finds the saved assembly on disk, loads that assembly, and retrieves the type from that assembly. If the assembly has not been saved to disk when GetType is called, the method returns null. The name of the System.Type to get. true to throw a System.TypeLoadException if an error occurs while loading the System.Type. true to perform a case-insensitive search for typeName, if typeName has less than 128 characters.
GetTypeArray
Gets the types of the objects in the specified array.
Return Value: An array of System.Type objects representing the types of the corresponding elements in args. An array of objects whose types to determine.
GetTypeCode
Gets the underlying type code of the specified System.Type.
Return Value: The System.TypeCode value of the underlying type. The System.Type whose underlying type code to get.
GetTypeFromCLSID
Gets the System.Type associated with the specified class identifier (CLSID).
Return Value: System._ComObject regardless of whether the CLSID is valid. The CLSID of the System.Type to get.
GetTypeFromCLSID
Gets the System.Type associated with the specified class identifier (CLSID), specifying whether to throw an exception if an error occurs while loading the System.Type.
Return Value: System._ComObject regardless of whether the CLSID is valid.
Exceptions such as System.OutOfMemoryException will be thrown when specifying true for throwOnError, but it will not fail for unregistered CLSID's. The CLSID of the System.Type to get. true to throw a System.TypeLoadException if an error occurs while loading the System.Type.
GetTypeFromCLSID
Gets the System.Type associated with the specified class identifier (CLSID) from the specified server.
Return Value: System._ComObject regardless of whether the CLSID is valid. The CLSID of the System.Type to get. The server from which to load the type.
GetTypeFromCLSID
Gets the System.Type associated with the specified class identifier (CLSID) from the specified server, specifying whether to throw an exception if an error occurs while loading the System.Type.
Return Value: System._ComObject regardless of whether the CLSID is valid.
Exceptions such as System.OutOfMemoryException will be thrown when specifying true for throwOnError, but it will not fail for unregistered CLSID's. The CLSID of the System.Type to get. The server from which to load the type. true to throw a System.TypeLoadException if an error occurs while loading the System.Type.
GetTypeFromHandle
Gets the System.Type referenced by the specified type handle.
Return Value: The System.Type referenced by the specified System.RuntimeTypeHandle.
The handles are valid only in the application domain in which they were obtained. The System.RuntimeTypeHandle object that refers to the System.Type.
GetTypeFromProgID
Gets the System.Type associated with the specified program identifier (PROGID), returning null if an error is encountered while loading the System.Type.
Return Value: The System.Type associated with the specified PROGID, if progID is a valid entry in the registry and a type is associated with it; otherwise, null.
This method is provided for COM support. PROGIDs are not used in the Microsoft.NET Framework because they have been superceded by the concept of namespace. The PROGID of the System.Type to get.
GetTypeFromProgID
Gets the System.Type associated with the specified program identifier (PROGID), specifying whether to throw an exception if an error occurs while loading the System.Type.
Return Value: The System.Type associated with the specified program identifier (PROGID), if progID is a valid entry in the registry and a type is associated with it; otherwise, null.
This method is provided for COM support. Program IDs are not used in Microsoft .NET Framework because they have been superceded by the concept of namespace. The PROGID of the System.Type to get. true to throw a System.TypeLoadException if an error occurs while loading the System.Type.
GetTypeFromProgID
Gets the System.Type associated with the specified program identifier (progID) from the specified server, returning null if an error is encountered while loading the System.Type.
Return Value: The System.Type associated with the specified program identifier (progID), if progID is a valid entry in the registry and a type is associated with it; otherwise, null.
This method is provided for COM support. Program IDs are not used in Microsoft .NET Framework because they have been superceded by the concept of namespace. The progID of the System.Type to get. The server from which to load the type.
GetTypeFromProgID
Gets the System.Type associated with the specified program identifier (progID) from the specified server, specifying whether to throw an exception if an error occurs while loading the System.Type.
Return Value: The System.Type associated with the specified program identifier (progID), if progID is a valid entry in the registry and a type is associated with it; otherwise, null
This method is provided for COM support. Program IDs are not used in Microsoft .NET Framework because they have been superceded by the concept of namespace. The progID of the System.Type to get. The server from which to load the type. true to throw a System.TypeLoadException if an error occurs while loading the System.Type.
GetTypeHandle
Gets the handle for the System.Type of a specified object.
Return Value: The handle for the System.Type of the specified System.Object.
The handles are valid only in the application domain in which they were obtained. The System.Object for which to get the Type handle.
HasElementTypeImpl
When overridden in a derived class, implements the System.Type.HasElementType property and determines whether the current System.Type encompasses or refers to another type; that is, whether the current System.Type is an array, a pointer, or is passed by reference.
Return Value: true if the System.Type is an array, a pointer, or is passed by reference; otherwise, false.
For example, Type.GetType(“Int32[ ]”).HasElementTypeImpl returns true, but Type.GetType(“Int32”).HasElementTypeImpl returns false. HasElementTypeImpl also returns true for “Int32*” and “Int32&”.
InvokeMember
Invokes the specified member, using the specified binding constraints and matching the specified argument list.
Return Value: An System.Object representing the return value of the invoked member.
The following System.Reflection.BindingFlags filter flags can be used to define which members to include in the search: Instance to include instance members in the search. The System.String containing the name of the constructor, method, property, or field member to invoke. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted. The access can be one of the BindingFlags such as Public, NonPublic, Private, InvokeMethod, GetField, and so on. The type of lookup need not be specified. If the type of lookup is omitted, BindingFlags.DefaultLookup will apply. A System.Reflection.Binder object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection. The System.Object on which to invoke the specified member. An array containing the arguments to pass to the member to invoke.
InvokeMember
Invokes the specified member, using the specified binding constraints and matching the specified argument list and culture.
Return Value: An System.Object representing the return value of the invoked member.
The following System.Reflection.BindingFlags filter flags can be used to define which members to include in the search: Instance to include instance members in the search. The System.String containing the name of the constructor, method, property, or field member to invoke. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted. The access can be one of the BindingFlags such as Public, NonPublic, Private, InvokeMethod, GetField, and so on. The type of lookup need not be specified. If the type of lookup is omitted, BindingFlags.DefaultLookup will apply. A System.Reflection.Binder object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection. The System.Object on which to invoke the specified member. An array containing the arguments to pass to the member to invoke. The System.Globalization.CultureInfo object representing the globalization locale to use, which may be necessary for locale-specific conversions, such as converting a numeric String to a Double.
InvokeMember
When overridden in a derived class, invokes the specified member, using the specified binding constraints and matching the specified argument list, modifiers and culture.
Return Value: An System.Object representing the return value of the invoked member.
InvokeMember calls a constructor member or a method member, gets or sets a property member, gets or sets a data field member, or gets or sets an element of an array member. The System.String containing the name of the constructor, method, property, or field member to invoke. A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted. The access can be one of the BindingFlags such as Public, NonPublic, Private, InvokeMethod, GetField, and so on. The type of lookup need not be specified. If the type of lookup is omitted, BindingFlags.DefaultLookup will apply. A System.Reflection.Binder object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection. The System.Object on which to invoke the specified member. An array containing the arguments to pass to the member to invoke. An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the args array. A parameter's associated attributes are stored in the member's signature. The default binder does exact matching on the System.Reflection.ParameterAttributesOut and None attributes. The System.Globalization.CultureInfo object representing the globalization locale to use, which may be necessary for locale-specific conversions, such as converting a numeric String to a Double. An array containing the names of the parameters to which the values in the args array are passed.
IsArrayImpl
When overridden in a derived class, implements the System.Type.IsArray property and determines whether the System.Type is an array.
Return Value: true if the System.Type is an array; otherwise, false.
An instance of the System.Array class must return false because it is an object, not an array.
IsAssignableFrom
Determines whether an instance of the specified type can be assigned to the current System.Type instance.
Return Value: true if an instance of c can be assigned to the current System.Type instance; otherwise, false.
This method can be overridden by a derived class. The System.Type to examine whether its objects can be assigned to the current System.Type instance.
IsByRefImpl
When overridden in a derived class, implements the System.Type.IsByRef property and determines whether the System.Type is passed by reference.
Return Value: true if the System.Type is passed by reference; otherwise, false.
IsCOMObjectImpl
When overridden in a derived class, implements the System.Type.IsCOMObject property and determines whether the System.Type is a COM object.
Return Value: true if the System.Type is a COM object; otherwise, false.
This method returns false for COM interfaces because they are not objects. COM interfaces can be implemented by Microsoft .NET Framework objects.
IsContextfulImpl
Implements the System.Type.IsContextful property and determines whether the System.Type can be hosted in a context.
Return Value: true if the System.Type can be hosted in a context; otherwise, false
This method can be overridden by a derived class.
IsInstanceOfType
Determines whether the specified object is an instance of the System.Type
Return Value: true if o is an instance of the System.Type; otherwise, false.
This method can be overridden by a derived class. The System.Object whose type to compare with System.Type.
IsMarshalByRefImpl
Implements the System.Type.IsMarshalByRef property and determines whether the System.Type is marshalled by reference.
Return Value: true if the System.Type is marshalled by reference; otherwise, false.
This method can be overridden by a derived class.
IsPointerImpl
When overridden in a derived class, implements the System.Type.IsPointer property and determines whether the System.Type is a pointer.
Return Value: true if the System.Type is a pointer; otherwise, false.
IsPrimitiveImpl
When overridden in a derived class, implements the System.Type.IsPrimitive property and determines whether the System.Type is one of the primitive types.
Return Value: true if the System.Type is one of the primitive types; otherwise, false.
The primitive types are System.Boolean, System.Byte, System.SByte, System.Int16, System.UInt16, System.Int32, System.UInt32, System.Int64, System.UInt64, System.Char, System.Double, and System.Single.
IsSubclassOf
Determines whether the current System.Type is a derived class of the specified class.
Return Value: true if the current System.Type is a direct or indirect derived class of c; otherwise, false.
This method can be overridden by a derived class. The System.Type that might be a base class of the current System.Type.
IsValueTypeImpl
Implements the System.Type.IsValueType property and determines whether the System.Type is a value type; that is, not a class or an interface.
Return Value: true if the System.Type is a value type; otherwise, false.
Value types describe values that are represented as sequences of bits; value types are not classes or interfaces. These are referred to as “structs” in some programming languages. Enums are value types.
ToString
Returns a String representing the name of the current Type.
Return Value: A System.String representing the name of the current System.Type.
This method returns the fully qualified common language runtime namespace and name for all primitive types. For example, the C# instruction, (long)0.Type( ).ToString( ) returns “System.Int64” instead of merely “Int64”.
TypeCode enumeration (System)
ToString
Description
Specifies the type of an object.
Call the System.IConvertible.GetTypeCode method on classes that implement the System.IConvertible interface to obtain the type code for an instance of that class.
ToString
A simple type representing Boolean values of true or false.
ToString
An integral type representing unsigned 8-bit integers with values between 0 and 255.
ToString
An integral type representing unsigned 16-bit integers with values between 0 and 65535. The set of possible values for the System.TypeCode.Char type corresponds to the Unicode character set.
ToString
A type representing a date and time value.
ToString
A database null (column) value.
ToString
A simple type representing values ranging from 1.0×10 to approximately 7.9×10 with 28-29 significant digits.
ToString
A floating point type representing values ranging from approximately 5.0×10 to 1.7×10 with a precision of 15-16 digits.
ToString
A null reference.
ToString
An integral type representing signed 16-bit integers with values between −32768 and 32767.
ToString
An integral type representing signed 32-bit integers with values between −2147483648 and 2147483647.
ToString
An integral type representing signed 64-bit integers with values between −9223372036854775808 and 9223372036854775807.
ToString
A general type representing any reference or value type not explicitly represented by another TypeCode.
ToString
An integral type representing signed 8-bit integers with values between −128 and 127.
ToString
A floating point type representing values ranging from approximately 1.5×10 to 3.4×10 with a precision of 7 digits.
ToString
A sealed class type representing Unicode character strings.
ToString
An integral type representing unsigned 16-bit integers with values between 0 and 65535.
ToString
An integral type representing unsigned 32-bit integers with values between 0 and 4294967295.
ToString
An integral type representing unsigned 64-bit integers with values between 0 and 18446744073709551615.
TypedReference structure (System)
ToString
Description
Describes objects that contain both a managed pointer to a location and a runtime representation of the type that may be stored at that location.
A typed reference is a type/value combination used for varargs and other support.
Equals
Checks if this object is equal to the specified object.
Return Value: true if this object is equal to the specified object; otherwise, false.
The object with which to compare the current object.
GetHashCode
Returns the hash code of this object.
Return Value: The hash code of this object.
GetTargetType
Returns the type of the target of the specified TypedReference.
Return Value: The type of the target of the specified TypedReference. The value whose target's type is to be returned.
MakeTypedReference
Makes a TypedReference for the specified target object using the specifying fields.
Return Value: A TypedReference for the specified target. The target object that defines the type of the TypedReference. The fields to be encapsulated.
SetTypedReference
Converts the specified value to a TypedReference.
Return Value: This method assigns value to target. A change type of value converts it to the type of the TypedReference. The System.Convert.ChangeType(System.Object,System.TypeCode) method does the conversion. The target of the conversion. The value to be converted.
TargetTypeToken
Returns the internal metadata type handle for the specified TypedReference.
Return Value: The internal metadata type handle for the specified TypedReference. The TypedReference for which the type handle is requested.
ToObject
Converts the specified TypedReference to an Object.
Return Value: An Object converted from a TypedReference.
This might be a boxing operation. The TypedReference to be converted.
TypeInitializationException class (System)
ToString
Description
The exception that is thrown as a wrapper around the exception thrown by the class initializer. This class cannot be inherited.
When a class initializer fails to initialize a type, a System.TypeInitializationException is created and passed a reference to the exception thrown by the type's class initializer. The System.Exception.InnerException property of System.TypeInitializationException holds the underlying exception.
TypeInitializationException
Example Syntax:
ToString
Initializes a new instance of the System.TypeInitializationException class with the default error message, the specified type name, and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The fully qualified name of the type that fails to initialize. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
TypeName
ToString
Description
Gets the fully qualified name of the type that fails to initialize.
TypeLoadException class (System)
ToString
Description
The exception that is thrown when type-loading failures occur.
System.TypeLoadException is thrown when the Common Language Runtime cannot find the assembly, the type within the assembly, or cannot load the type.
TypeLoadException
Example Syntax:
ToString
Initializes a new instance of the System.TypeLoadException class with default properties.
The following table shows the initial property values for an instance of System.TypeLoadException.
TypeLoadException
Example Syntax:
ToString
Initializes a new instance of the System.TypeLoadException class with a specified error message.
The following table shows the initial property values for an instance of System.TypeLoadException. The error message that explains the reason for the exception.
TypeLoadException
Example Syntax:
ToString
Initializes a new instance of the System.TypeLoadException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
TypeLoadException
Example Syntax:
ToString
Initializes a new instance of the System.TypeLoadException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If inner is non-null, then the current Exception is raised in a catch block handling inner.
HelpLink
HResult
InnerException
Message
ToString
Description
Gets the error message for this exception.
This property overrides System.Exception.Message. The error message should be localized.
Source
StackTrace
TargetSite
TypeName
ToString
Description
Gets the fully qualified name of the type that causes the exception.
When overriding System.TypeLoadException.TypeName in a derived class, be sure to call the base class's System.TypeLoadException.TypeName property.
GetObjectData
Sets the System.Runtime.Serialization.SerializationInfo object with the class name, method name, resource ID, and additional exception information. System.TypeLoadException.GetObjectData(System.Runtime.Serialization. SerializationInfo,System.Runtime.Serialization.StreamingContext) sets a System.Runtime.Serialization.SerializationInfo with all the exception object data targeted for serialization. During deserialization, the exception object is reconstituted from the System.Runtime.Serialization.SerializationInfo transmitted over the stream. The object that holds the serialized object data. The contextual information about the source or destination.
TypeUnloadedException class (System)
ToString
Description
The exception that is thrown when there is an attempt to access an unloaded class.
System.TypeUnloadedException uses the HRESULT COR_E_TYPEUNLOADED, which has the value 0x80131013.
TypeUnloadedException
Example Syntax:
ToString
Initializes a new instance of the System.TypeUnloadedException class with default properties.
The following table shows the initial property values for an instance of System.TypeUnloadedException.
TypeUnloadedException
Example Syntax:
ToString
Initializes a new instance of the System.TypeUnloadedException class with a specified error message.
The following table shows the initial property values for an instance of System.TypeUnloadedException. The error message that explains the reason for the exception.
TypeUnloadedException
Example Syntax: ToString
Initializes a new instance of the System.TypeUnloadedException class with serialized data.
This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see. The object that holds the serialized object data. The contextual information about the source or destination.
TypeUnloadedException
Example Syntax:
ToString
Initializes a new instance of the System.TypeUnloadedException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If innerException is non-null, then the current Exception is raised in a catch block handling innerException.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
UInt16 structure (System)
ToString
Description
Represents a 16-bit unsigned integer.
The UInt16 value type represents unsigned integers with values ranging from 0 to 65535.
ToString
A constant representing the largest possible value of UInt16.
The value of this constant is 65535; that is, hexadecimal 0xFFFF.
ToString
A constant representing the smallest possible value of UInt16.
The value of this constant is 0.
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: A signed number indicating the relative values of this instance and value.
Any instance of UInt16, regardless of its value, is considered greater than null. An object to compare, or null.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if obj is an instance of UInt16 and equals the value of this instance; otherwise, false. An object to compare with this instance.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
GetTypeCode
Returns the TypeCode for value type UInt16.
Return Value: The enumerated constant, System.TypeCode.UInt16.
Parse
Converts the String representation of a number to its 16-bit unsigned integer equivalent.
Return Value: An 16-bit unsigned integer equivalent to the number contained in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert.
Parse
Converts the String representation of a number in a specified culture-specific format to its 16-bit unsigned integer equivalent.
Return Value: An 16-bit unsigned integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits [ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
Parse
Converts the String representation of a number in a specified style to its 16-bit unsigned integer equivalent.
Return Value: An 16-bit unsigned integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStyles constants that indicate the permitted format of s.
Parse
Converts the String representation of a number in a specified style and culture-specific format to its 16-bit unsigned integer equivalent.
Return Value: An 16-bit unsigned integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStylesconstants that indicate the permitted format of s. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
IConvertible.ToBoolean
IConvertible.ToByte
IConvertible.ToChar
IConvertible.ToDateTime
IConvertible.ToDecimal
IConvertible.ToDouble
IConvertible.ToInt32
IConvertible.ToInt64
IConvertible.ToSByte
IConvertible.ToSingle
IConvertible.ToType
IConvertible.ToUInt16
IConvertible.ToUInt32
IConvertible.ToUInt64
ToString
Converts the numeric value of this instance to its equivalent String representation.
Return Value: The System.String representation of the value of this instance, consisting of a sequence of digits ranging from 0 to 9, without a sign or leading zeroes.
The return value is formatted with the general format specifier (“G”) and the System.Globalization.NumberFormatInfo for the current culture.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by provider.
This instance is formatted with the general format specifier (“G”). An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified format.
Return Value: The System.String representation of the value of this instance as specified by format.
If format is null or an empty string (“ ”), the return value of this instance is formatted with the general format specifier (“G”). A format string.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified format and culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by format and provider.
If format is null or an empty string (“ ”), the return value for this instance is formatted with the general format specifier (“G”). A format specification. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about this instance.
UInt32 structure (System)
ToString
Description
Represents a 32-bit unsigned integer.
The UInt32 value type represents unsigned integers with values ranging from 0 to 4,294,967,295.
ToString
A constant representing the largest possible value of UInt32 The value of this constant is 4294967295; that is, hexadecimal 0xFFFFFFFF.
ToString
A constant representing the smallest possible value of UInt32.
The value of this constant is 0.
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: A signed number indicating the relative values of this instance and value.
Any instance of UInt32, regardless of its value, is considered greater than null. An object to compare, or null.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if obj is an instance of UInt32 and equals the value of this instance; otherwise, false. An object to compare with this instance.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
GetTypeCode
Returns the TypeCode for value type UInt32.
Return Value: The enumerated constant, System.TypeCode.UInt32.
Parse
Converts the String representation of a number to its 32-bit unsigned integer equivalent.
Return Value: An 32-bit unsigned integer equivalent to the number contained in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert.
Parse
Converts the String representation of a number in a specified culture-specific format to its 32-bit unsigned integer equivalent.
Return Value: An 32-bit unsigned integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
Parse
Converts the String representation of a number in a specified style to its 32-bit unsigned integer equivalent.
Return Value: An 32-bit unsigned integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStyles constants that indicate the permitted format of s.
Parse
Converts the String representation of a number in a specified style and culture-specific format to its 32-bit unsigned integer equivalent.
Return Value: An 32-bit unsigned integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStylesconstants that indicate the permitted format of s. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
IConvertible.ToBoolean
IConvertible.ToByte
IConvertible.ToChar
IConvertible.ToDateTime
IConvertible.ToDecimal
IConvertible.ToDouble
IConvertible.ToInt16
IConvertible.ToInt32
IConvertible.ToInt64
IConvertible.ToSByte
IConvertible.ToSingle
IConvertible.ToType
IConvertible.ToUInt16
IConvertible.ToUInt32
IConvertible.ToUInt64
ToString
Converts the numeric value of this instance to its equivalent String representation.
Return Value: The System.String representation of the value of this instance, consisting of a sequence of digits ranging from 0 to 9, without a sign or leading zeroes.
The return value is formatted with the general format specifier (“G”) and the System.Globalization.NumberFormatInfo for the current culture.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by provider.
This instance is formatted with the general format specifier (“G”). An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified format.
Return Value: The System.String representation of the value of this instance as specified by format.
If format is null or an empty string (“ ”)the return value of this instance is formatted with the general format specifier (“G”). A format string.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified format and culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by format and provider.
If format is null or an empty string (“ ”) the return value for this instance is formatted with the general format specifier (“G”). A format specification. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about this instance.
UInt64 structure (System)
ToString
Description
Represents a 64-bit unsigned integer.
The UInt64 value type represents unsigned integers with values ranging from 0 to 184,467,440,737,095,551,615.
ToString
A constant representing the largest possible value of UInt64.
The value of this constant is 18,446,744,073,709,551,615; that is, hexadecimal 0xFFFFFFFFFFFFFFFF.
ToString
A constant representing the smallest possible value of UInt64.
The value of this constant is 0.
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: A signed number indicating the relative values of this instance and value.
Any instance of UInt64, regardless of its value, is considered greater than null. An object to compare, or null.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if obj is an instance of UInt64 and equals the value of this instance; otherwise, false. An object to compare with this instance.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
GetTypeCode
Returns the TypeCode for value type UInt64.
Return Value: The enumerated constant, System.TypeCode.UInt64.
Parse
Converts the String representation of a number to its 64-bit unsigned integer equivalent.
Return Value: An 64-bit unsigned integer equivalent to the number contained in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert.
Parse
Converts the String representation of a number in a specified culture-specific format to its 64-bit unsigned integer equivalent.
Return Value: An 64-bit unsigned integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
Parse
Converts the String representation of a number in a specified style to its 64-bit unsigned integer equivalent.
Return Value: An 64-bit unsigned integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStyles constants that indicate the permitted format of s.
Parse
Converts the String representation of a number in a specified style and culture-specific format to its 64-bit unsigned integer equivalent.
Return Value: An 64-bit unsigned integer equivalent to the number specified in s.
s contains a number of the form: [ws][sign]digits[ws] Items in square brackets (‘[’ and ‘]’) are optional, and other items are as follows. A System.String containing a number to convert. The combination of one or more System.Globalization.NumberStylesconstants that indicate the permitted format of s. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about s.
IConvertible.ToBoolean
IConvertible.ToByte
IConvertible.ToChar
IConvertible.ToDouble
IConvertible.ToInt16
IConvertible.ToInt32
IConvertible.ToInt64
IConvertible.ToSByte
IConvertible.ToSingle
IConvertible.ToType
IConvertible.ToUInt16
IConvertible.ToUInt32
IConvertible.ToUInt64
ToString
Converts the numeric value of this instance to its equivalent String representation.
Return Value: The System.String representation of the value of this instance, consisting of a sequence of digits ranging from 0 to 9, without a sign or leading zeroes.
The return value is formatted with the general format specifier (“G”) and the System.Globalization.NumberFormatInfo for the current culture.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by provider.
This instance is formatted with the general format specifier (“G”). An System.IFormatProvider interface implementation which supplies culture-specific formatting information.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified format.
Return Value: The System.String representation of the value of this instance as specified by format.
If format is null or an empty string (“ ”), the return value of this instance is formatted with the general format specifier (“G”). A format string.
ToString
Converts the numeric value of this instance to its equivalent String representation using the specified format and culture-specific format information.
Return Value: The System.String representation of the value of this instance as specified by format and provider.
If format is null or an empty string (“ ”), the return value for this instance is formatted with the general format specifier (“G”). A format specification. An System.IFormatProvider interface implementation which supplies culture-specific formatting information about this instance.
UIntPtr structure (System)
ToString
Description
A platform-specific type that is used to represent a pointer or a handle.
The System.UIntPtr type is designed to be a platform-specific, machine-sized integer. That is, an instance of this type is expected to be 32-bits on 32-bit hardware and operating systems, and 64-bits on 64-bit hardware and operating systems.
ToString
A read-only field that represents an uninitialized pointer or handle.
The value of this field is not equivalent to null, but is instead a pointer which has not been assigned any value whatsoever. Use this field to efficiently determine whether an instance of UIntPtr has been set.
UIntPtr
Example Syntax:
ToString
Initializes a new instance of the System.UIntPtr structure to the specified 32-bit pointer or handle. A pointer or handle contained in a 32-bit unsigned integer.
UIntPtr
Example Syntax:
ToString
Initializes a new instance of the System.UIntPtr structure to the specified 64-bit pointer or handle.
An exception is only thrown if the value of value requires more bits than the current platform supports. A pointer or handle contained in a 64-bit unsigned integer.
UIntPtr
Example Syntax:
ToString
Size
ToString
Gets the size of this instance.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if obj is an instance of UIntPtr and equals the value of this instance; otherwise, false. An object to compare with this instance or null.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer hash code.
op_Equality
Determines whether two specified instances of System.UIntPtr are equal.
Return Value: true if value1 equals value2; otherwise, false. A UIntPtr. A
UIntPtr.
op_Explicit
Converts the value of a 32-bit unsigned integer to an System.UIntPtr
Return Value: A new instance of System.UIntPtr initialized to value. A 32-bit unsigned integer.
op_Explicit
Converts the value of a 64-bit unsigned integer to an System.UIntPtr.
Return Value: A new instance of System.UIntPtr initialized to value. A 64-bit unsigned integer.
op_Explicit
op_Explicit
Converts the value of the specified System.UIntPtr instance to a 64-bit unsigned integer. A UIntPtr.
op_Explicit
Converts the value of the specified System.UIntPtr instance to a 32-bit unsigned integer.
An exception is only thrown if the value of value requires more bits than the current platform supports. A UIntPtr.
op_Explicit
Determines whether two specified instances of System.UIntPtr are not equal.
Return Value: true if value1 does not equal value2; otherwise, false. A UIntPtr. A UIntPtr.
ISerializable.GetObjectData
Converts the value of this instance to a pointer to an unspecified type.
Return Value: A pointer to System.Void; that is, a pointer to memory containing data of an unspecified type.
ToString
Converts the numeric value of this instance to its equivalent String representation.
Return Value: The System.String representation of the value of this instance.
ToUInt32
Converts the value of this instance to a 32-bit unsigned integer.
Return Value: A 32-bit unsigned integer.
An exception is only thrown if the value of value requires more bits than the current platform supports.
ToUInt64
Converts the value of this instance to a 64-bit unsigned integer.
Return Value: A a 64-bit unsigned integer.
UnauthorizedAccessException class (System)
ToUInt64
Description
The exception that is thrown when the operating system denies access because of an I/O error or a specific type of security error.
UnauthorizedAccessException uses the HRESULT ICOR_E_UNAUTHORIZEDACCESS, which has the value 0x80070005.
UnauthorizedAccessException
Example Syntax:
ToUInt64
Initializes a new instance of the System.UnauthorizedAccessException class.
UnauthorizedAccessException
Example Syntax:
ToUInt64
Initializes a new instance of the System.UnauthorizedAccessException class with a specified error message. The error message that explains the reason for the exception.
UnauthorizedAccessException
Example Syntax:
ToUInt64
Initializes a new instance of the System.UnauthorizedAccessException class with serialized data. The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown. The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination.
UnauthorizedAccessException
Example Syntax:
ToUInt64
Initializes a new instance of the System.UnauthorizedAccessException class with a specified error message and a reference to the inner exception that is the root cause of this exception.
When an ExceptionX is thrown as a direct result of a previous exception Y, the System.Exception.InnerException property of X should contain a reference to Y. The InnerException property returns the same value as was passed into the constructor, or null if the inner exception value was not supplied to the constructor. The error message that explains the reason for the exception. An instance of System.Exception that is the cause of the current Exception. If the inner parameter is non-null, then the current Exception is raised in a catch block handling inner.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
UnhandledExceptionEventArgs class (System)
ToString
Description
Provides data for the event that is raised when there is an exception that is not handled by the application domain.
System.UnhandledExceptionEventArgs provides access to the exception object and a flag indicating whether the common language runtime is terminating. The System.UnhandledExceptionEventArgs is one of the parameters passed into System.UnhandledExceptionEventHandler.
UnhandledExceptionEventArgs
Example Syntax:
ToString
Initializes a new instance of the System.UnhandledExceptionEventArgs class with the exception object and a common language runtime termination flag. The exception that is not handled. true if the runtime is terminating; otherwise, false.
ExceptionObject
ToString
Gets the unhandled exception object.
IsTerminating
ToString
Indicates whether the common language runtime is terminating.
UnhandledExceptionEventHandler delegate (System)
ToString
Description
Represents the method that will handle the event triggered by an exception that is not handled by the application domain. The source of the unhandled exception event. An UnhandledExceptionEventArgs that contains the event data.
When you create an System.UnhandledExceptionEventHandler delegate, you identify the method that will handle the event. To associate the event handler with your event, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see.
ValueType class (System)
ToString
Description
Provides the base class for value types.
ValueType overrides the virtual methods from System.Object with more appropriate implementations for value types. See also System.Enum, which inherits from ValueType.
ValueType
Example Syntax:
ToString
Equals
Indicates whether this instance and a specified object are equal.
Return Value: true if obj and this instance are the same type and represent the same value; otherwise, false. Another object to compare to.
GetHashCode
Returns the hash code for this instance.
Return Value: A 32-bit signed integer that is the hash code for this instance.
Any value types that are inserted into a Hashtable must override GetHashCode( ) for performance reasons. The default implementation on ValueType will return the same value for all instances of a particular type, which makes hashing as slow as a linked list. See the documentation for Object's
GetHashCode for more details.
ToString
Returns the fully qualified type name of this instance.
Return Value: A System.String containing a fully qualified type name.
Version class (System)
ToString
Description
Represents the version number for a common language runtime assembly. This class cannot be inherited.
Version numbers consist of four components: major, minor, build, and revision. Components major and minor are required. Component revision is only optional if build is not defined.
Version
Example Syntax:
ToString
Initializes a new instance of the System.Version class.
Version
Example Syntax:
ToString
Initializes a new instance of the Version class using the value represented by the specified String.
version can only contain components major, minor, build, and revision, in that order and all separated by periods. There must be at least two components, and at most four. The first two components are assumed to be major and minor. A string containing the major, minor, build, and revision numbers, where each number is delimited with a period character (‘.’)
Version
Example Syntax:
ToString
Initializes a new instance of the Version class using the specified major and minor values.
Metadata restricts major and minor to a maximum value of System.UInt16.MaxValue−1. The major version number. The minor version number.
Version
Example Syntax:
ToString
Initializes a new instance of the Version class using the specified major, minor, and build values.
Metadata restricts major, minor, and build to a maximum value of System.UInt16.MaxValue−1. The major version number. The minor version number. The build number.
Version
Example Syntax:
ToString
Initializes a new instance of the Version class with the specified major, minor, build, and revision numbers.
Metadata restricts major, minor, build, and revision to a maximum of System.UInt16.MaxValue−1. The major version number. The minor version number. The build number. The revision number.
Build
ToString
Gets the value of the build component of the version number for this instance.
For example, if the version number is 6.2.1.3, the build number is 1. If the version number is 6.2, the build number is undefined.
Major
ToString
Gets the value of the major component of the version number for this instance.
For example, if the version number is 6.2, the major version is 6.
Minor
ToString
Gets the value of the minor component of the version number for this instance.
For example, if the version number is 6.2, the minor version is 2.
Revision
ToString
Gets the value of the revision component of the version number for this instance.
For example, if the version number is 6.2.1.3, the revision number is 3. If the version number is 6.2, the revision number is undefined.
Clone
Returns a new Version object whose value is the same as this instance.
Return Value: A copy of this Version object.
CompareTo
Compares this instance to a specified object and returns an indication of their relative values.
Return Value: Return Value Description Less than zero This instance is prior to version.
The components of Version in decreasing order of importance are: major, minor, build, and revision. An unknown component is assumed to be older than any known component. An object to compare, or null.
Equals
Returns a value indicating whether this instance is equal to a specified object.
Return Value: true if this instance and version are both Version objects, and every component of this instance matches the corresponding component of version; otherwise, false. An object to compare with this instance.
GetHashCode
Returns a hash code for this instance.
Return Value: A 32-bit signed integer hash code.
op_Equality
Determines whether two specified instances of Version are equal.
Return Value: true if v1 equals v2; otherwise false. The first instance of Version.
The second instance of Version.
op_GreaterThan
Determines whether the first specified instance of Version is greater than the second specified instance of Version.
Return Value: true if v1 is greater than v2; otherwise false. The first instance of Version. The second instance of Version.
op_GreaterThanOrEqual
Determines whether the first specified instance of Version is greater than or equal to the second instance of Version.
Return Value: true if v1 is greater than or equal to v2; otherwise false. The first instance of Version. The second instance of Version.
op_Inequality
Determines whether two specified instances of Version are not equal.
Return Value: true if v1 does not equal v2; otherwise false. The first instance of Version. The second instance of Version.
op_LessThan
Determines whether the first specified instance of Version is less than the second specified instance of Version.
Return Value: true if v1 is less than v2; otherwise false. The first instance of Version. The second instance of Version.
op_LessThanOrEqual
Determines whether the first specified instance of Version is less than or equal to the second instance of Version.
Return Value: true if v1 is less than or equal to v2; otherwise false. The first instance of Version. The second instance of Version.
ToString
Converts the value of this instance to its equivalent String representation.
Return Value: The System.String representation of the values of the major, minor, build, and revision components of this instance, as depicted in the following format. Each component is separated by a period character (‘.’). Square brackets (‘[’ and ‘]’) indicate a component that will not appear in the return value if the component is not defined: major.minor[.build[.revision]] For example, if you create an instance of Version using the constructor Version(1,1), the returned string is “1.1”. If you create an instance of Version using the constructor Version(1,3,4,2), the returned string is “1.3.4.2”.
ToString
Converts the value of this instance to its equivalent String representation. A specified count indicates the number of components to return.
Return Value: The System.String representation of the values of the major, minor, build, and revision components of this instance, each separated by a period character (‘.’). The number of components to return.
Void structure (System)
ToString
Description
Indicates a method that does not return a value; that is, the method has the void return type.
This class is used in the System.Reflection namespace. This class has no members, and you cannot create an instance of this class.
WeakReference class (System)
ToString
Description
Represents a “weak reference”, which references an object while still allowing it to be garbage collected.
The common language runtime “garbage collection” mechanism reclaims inaccessible (that is, “unreachable”) memory allocated to an object. An object becomes unreachable if all references to it become invalid, for example, by setting those references to null.
WeakReference
Example Syntax:
ToString
Initializes a new instance of the WeakReference class, referencing the specified object.
This constructor creates a short weak reference to target. The object to track.
WeakReference
Example Syntax:
ToString
Initializes a new instance of the WeakReference class, referencing the specified object and using the specified resurrection tracking.
If trackResurrection is false, a short weak reference is created. If trackResurrection is true, a long weak reference is created. Typically, only short weak references are needed. An object to track. Indicates when to stop tracking the object. If true, the object is tracked after finalization; if false, the object is only tracked until finalization.
WeakReference
Example Syntax:
ToString
Initializes a new instance of the System.WeakReference class, using the specified serialization and stream information.
The context parameter is reserved, and does not currently participate in this operation. An object that holds all the data needed to serialize or deserialize this instance. (Reserved) Describes the source and destination of the serialized stream specified by info.
IsAlive
ToString
Gets an indication whether the object referenced by this instance has been garbage collected.
WeakReferenceException is thrown if the object referenced by this instance is invalid. This can occur if there is an attempt to resurrect the referenced object after it has been finalized.
Target
ToString
Gets or sets the object (the “target”) referenced by this instance.
WeakReferenceException will be thrown if the reference to the object referenced by this instance is invalid. This can occur if there is an attempt to resurrect the referenced object after it has been finalized.
TrackResurrection
ToString
Gets an indication whether the object referenced by this instance is tracked after it is garbage collected and finalized.
Finalize
Frees any resources allocated by this instance.
GetObjectData
Populates a SerializationInfo object with all the data needed to serialize this instance.
This method stores all the information in info necessary to serialize this instance. A SerializationInfo object. (Reserved) The location where serialized data will be stored and retrieved.
Uri class (System)
ToString
Description
Provides an object representation of a uniform resource indentifier (URI) and easy access to the parts of the URI.
A URI is a compact representation of a resource available to your application on the Internet. The System.Uri class defines the properties and methods for handling URIs, including parsing, comparing, and combining. The System.Uri class properties are read-only, to modify a System.Uri instance use the System.UriBuilder class.
ToString
Specifies the characters that separate the communication protocol scheme from the address portion of the URI. This field is read-only.
ToString
Specifies that the URI is a pointer to a file. This field is read-only. ToString
Specifies that the URI is accessed through the File Transfer Protocol (FTP).
This field is read-only.
ToString
Specifies that the URI is accessed through the Gopher protocol. This field is read-only.
ToString
Specifies that the URI is accessed through the Hypertext Transfer Protocol (HTTP). This field is read-only.
ToString
Specifies that the URI is accessed through the Secure Hypertext Transfer Protocol (HTTPS). This field is read-only.
ToString
Specifies that the URI is an email address and is accessed through the Simple Network Mail Protocol (SNMP). This field is read-only.
ToString
Specifes that the URI is an Internet news group and is accessed through the Network News Transport Protocol (NNTP). This field is read-only.
ToString
Specifes that the URI is an Internet news group and is accessed through the Network News Transport Protocol (NNTP). This field is read-only.
Uri
Example Syntax:
ToString
Initializes a new instance of the System.Uri class with the specified URI.
This constructor creates a System.Uri instance from a URI string. It parses the URI, puts it in canonical format, and makes any required escape encodings. A URI.
Uri
Example Syntax:
ToString
Initializes a new instance of the System.Uri class from the specified instances of the System.Runtime.Serialization.SerializationInfo and System.Runtime.Serialization.StreamingContext classes.
This constructor implements the System.Runtime.Serialization.ISerializable interface for the System.Uri class. An instance of the System.Runtime.Serialization.SerializationInfo class containing the information required to serialize the new System.Uri instance. An instance of the System.Runtime.Serialization.StreamingContext class containing the source of the serialized stream associated with the new System.Uri instance.
Uri
Example Syntax:
ToString
Initializes a new instance of the System.Uri class with the specified URI, with control of character escaping.
This constructor creates a System.Uri instance from a URI string. It parses the URI, and puts it in canonical format. The caller must set dontEscape to true if the URI is already escaped, or false if the constructor should transform the URI to its escaped encoding. The URI. true if the URI contains escape characters; otherwise, false.
Uri
Example Syntax:
ToString
Initializes a new instance of the System.Uri class based on the specified base and relative URIs.
This constructor creates a System.Uri instance by combining the baseUri and the relativeUri. If relativeUri is an absolute URI (containing a scheme, hostname, and optionally a port number) the System.Uri instance is created using only relativeUri. The base URI. The relative URI to add to the base URI.
Uri
Example Syntax:
ToString
Initializes a new instance of the System.Uri class based on the specified base and releative URIs, with control of character escaping.
This constructor creates a System.Uri instance by combining baseUri and relativeUri. If the URI passed in relativeUri is an absolute URI (containing a scheme, hostname, and optionally a port number) the System.Uri instance is created using only relative Uri. The caller must set dontEscape to true if the URI is already escaped. The base URI. The relative URI to add to the base URI. true if the URI contains escape characters; otherwise, false.
AbsolutePath
ToString
Gets the absolute path of the URI.
The System.Uri.AbsolutePath property contains the path information that the server uses to resolve requests for information. Typically this is the path to the desired information on the server's file system, although it also can indicate the application or script the server must run to provide the information.
AbsoluteUri
ToString
Gets the absolute URI.
The System.Uri.AbsoluteUri property includes the entire URI stored in the System.Uri instance, including all fragments and query strings.
Authority
ToString
Gets the Domain Name System (DNS) host name or IP address and the port number for a server.
The Authority property returns the fully qualified DNS host name or IP address of the server specified in the URI, along with the port number for non-default ports.
Fragment
ToString
Gets the escaped fragment.
The System.Uri.Fragment property gets any text following a fragment marker (#) in the URI, including the fragment marker itself. Given the URI http://www.contoso.com/index.htm#main, the fragment property would get #main.
Host
ToString
Gets the Domain Name System (DNS) host name, or IP address of the server specified in the URI.
The System.Uri.Host property gets the fully qualified DNS host name or IP address of the server specified in the URI.
HostNameType
ToString
Returns the type of the host name specified in the URI.
IsDefaultPort
ToString
Gets a value indicating whether the port value of the URI is the default for this scheme.
IsFile
ToString
Gets a value indicating whether the specified System.Uri is a file URI.
The System.Uri.IsFile property is true when the System.Uri.Scheme property equals System.Uri.UriSchemeFile.
IsLoopback
ToString
Gets a value indicating whether the specified System.Uri references the local host.
IsUnc
ToString
Gets a value indicating whether the specified System.Uri is a universal naming convention (UNC) path.
The System.Uri.IsUnc property is true if the specified System.Uri instance is a UNC path (suc as \\server\folder).
LocalPath
ToString
Gets a local operating-system representation of a file name.
PathAndQuery
ToString
Gets the System.Uri.AbsolutePath and System.Uri.Query properties separated by a question mark (?).
The System.Uri.PathAndQuery property contains the absolute path on the server and the query information sent with the request. It is identical to concatenating the System.Uri.AbsolutePath and System.Uri.Query properties.
Port
ToString
Gets the port number of the specified URI.
The port number defines the protocol port used for contacting the server referenced in the URI. If a port is not is not specified as part of the URI, the System.Uri.Port property returns the default value for the protocol.
Query
ToString
Gets any query information included in the specified URI.
The System.Uri.Query property contains any query information included in the URI. Query information is separated from the path information by a question mark (?) and continues to the end of the URI. The query information returned includes the leading question mark.
Scheme
ToString
Gets the scheme name of the specified URI.
The following table lists the valid scheme names for the System.Uri.Scheme property.
Segments
ToString
Gets an array of the segments that make up the specified URI.
UserEscaped
ToString
Indicates that the URI string was escaped before the System.Uri instance was created.
The System.Uri.UserEscaped property is set to true to indicate that the string used to create the System.Uri instance was escaped before it was passed to the constructor; that is, the dontEscape parameter of the constructor call was set to true.
UserInfo
ToString
Gets the user name, password, and other user-specific information associated with the specified URI.
Canonicalize
CheckHostName
Determines whether the specified host name is valid.
Return Value: true if the host name is valid; otherwise, false.
The System.Uri.CheckHostName(System.String) method checks that the host name provided meets the requirements for a valid Internet host name. It does not, however, perform a host-name lookup to verify the existence of the host. The host name to validate.
CheckSchemeName
Determines whether the specified scheme name is valid.
Return Value: true if the scheme name is valid; otherwise, false.
The CheckSchemeName method checks the scheme name for validity according to RFC 2396. The scheme name must begin with a letter, and must contain only letters, digits, and the characters “.”, “+”, or “−”. The scheme name to validate.
CheckSecurity
Equals
Compares two System.Uri instances for equality.
Return Value: true if the two System.Uri instances contain the same URI; otherwise, false.
The System.Uri.Equals(System.Object) method compares two URI instances without regard to any fragments that they might contain. For instance, given the URIs http://www.contoso.com/index.htm#search and http://www.contoso.com/index.htm the System.Uri.Equals(System.Object) method would return true. The System.Uri instance to compare with the current instance.
Escape
EscapeString
Converts a string to its escaped representation.
Return Value: The escaped representation of the string.
The System.Uri.EscapeString(System.String) method converts all characters with an ASCII value greater than 127 to hexidecimal representation.
The string to transform to its escaped representation.
FromHex
Returns the decimal value of a hexadecimal digit.
Return Value: A number from 1-15 that corresponds to the specified hexadecimal digit.
The System.Uri.FromHex(System.Char) method converts a character representing a hexadecimal digit (0-9, a-f, A-F) to its decimal value (0-15). If digit is not a valid hexadecimal digit, System.ArgumentException is thrown. The hexadecimal digit (0-9, a-f, A-F) to convert.
GetHashCode
Returns the hash code for the specified URI.
Return Value: The hash value generated for the URI.
The System.Uri.GetHashCode method generates the URI's hash value without including any fragment identifiers. For example, the URIs http://www.contoso.com/index.htm#search and http://www.contoso.com/index.htm yield the same hash code.
GetLeftPart
Returns the specified portion of a URI.
Return Value: A string containing the specified portion of the URI.
The System.Uri.GetLeftPart(System.UriPartial) method returns a string containing the left-most portion of the URI, ending with the portion specified by part. The string returned includes delimiters but does not include any fragments or queries or their delimiters, except in certain cases. One of the System.UriPartial values that specifies the the end of the portion of the URI to return.
HexEscape
Converts a specified character into its hexadecimal equivalent.
Return Value: The hexadecimal representation of the specified character. The character to convert to hexadecimal representation.
HexUnescape
Converts a specified hexadecimal representation of a character to the character.
Return Value: The character represented by the hexadecimal encoding at position index. If the character at index is not hexadecimal encoded, the character at index is returned. The value of index is incremented to point to the character following the one returned. The hexadecimal representation of a character. The location in pattern where the hexadecimal representation of a character begins.
IsBadFileSystemCharacter
IsExcludedCharacter
IsHexDigit
Determines whether a specified character is a valid hexadecimal digit.
Return Value: true if the character is a valid hexadecimal digit; otherwise false.
Hexadecimal digits are the digits 0-9 and the letters A-F or a-f. The character to validate.
IsHexEncoding
Determines whether a string is hex encoded.
Return Value: true if pattern is hex encoded at the specified location; otherwise, false.
The System.Uri.IsHexEncoding(System.String,System.Int32) method checks for hex encoding that follows the pattern “% hexhex” in a string, where “hex” is a digit from 0-9 or or a letter from A-F (case-insensitive). The string to check. The location in pattern to check for hex encoding.
IsReservedCharacter
MakeRelative
Determines the difference between two System.Uri instances.
Return Value: If the two URIs are the same except for the path information, then that difference; if the two have additional differences, the absolute URI of toUri. The URI to compare to the current URI.
Parse
ISerializable.GetObjectData
Returns the display string for the specified System.Uri instance.
Return Value: The string containing the unescaped display name of the System.Uri.
Unescape
UriBuilder class (System)
Unescape
Description
Provides a custom constructor for uniform resource indentifiers (URIs) and modifies URIs for the System.Uri class.
The System.UriBuilder class provides a convenient way to modify the contents of a System.Uri instance without creating a new System.Uri instance for each modification.
UriBuilder
Example Syntax:
Unescape
Initializes a new instance of the System.UriBuilder class.
The default constructor creates a new instance of the System.UriBuilder class with all properties empty.
UriBuilder
Example Syntax: Unescape
Initializes a new instance of the System.UriBuilder class with the specified URI.
This constructor initializes a new instance of the System.UriBuilder class with the System.UriBuilder.Fragment, System.UriBuilder.Host, System.UriBuilder.Path, System.UriBuilder.Port, System.UriBuilder.Query System.UriBuilder.Scheme, and System.UriBuilder.Uri properties set as specified in uri. A URI string.
UriBuilder
Example Syntax:
Unescape
Initializes a new instance of the System.UriBuilder class with the specified System.Uri instance.
This constructor initializes a new instance of the System.UriBuilder class with the System.UriBuilder.Fragment, System.UriBuilder.Host, System.UriBuilder.Path, System.UriBuilder.Port, System.UriBuilder.Query, System.UriBuilder.Scheme, and System.UriBuilder.Uri properties set as specified in uri. An instance of the System.Uri class.
UriBuilder
Example Syntax:
Unescape
Initializes a new instance of the System.UriBuilder class with the specified scheme and host.
The System.UriBuilder instance is initialized with the System.UriBuilder.Scheme property set to schemeName and the System.UriBuilder.Host property set to hostName. An Internet access protocol. A DNS-style domain name or IP address.
UriBuilder
Example Syntax:
Unescape
Initializes a new instance of the System.UriBuilder class with the specified scheme, host, and port.
The System.UriBuilder instance is initialized with the System.UriBuilder.Scheme property set to schemeName, the System.UriBuilder.Host property set to hostName, and the System.UriBuilder.Port property set to portNumber. The System.UriBuilder.Path property is set to the slash character (/). An Internet access protocol. A DNS-style domain name or IP address. An IP port number for the service.
UriBuilder
Example Syntax:
Unescape
Initializes a new instance of the System.UriBuilder class with the specified scheme, host, port number, and path.
The System.UriBuilder instance is initialized with the System.UriBuilder.Scheme property set to schemeName, the System.UriBuilder.Host property set to hostName, the System.UriBuilder.Port property set to portNumber and the System.UriBuilder.Path property set to pathValue. An Internet access protocol. A DNS-style domain name or IP address. An IP port number for the service. The path to the Internet resource.
UriBuilder
Example Syntax:
Unescape
Initializes a new instance of the System.UriBuilder class with the specified scheme, host, port number, path and query string or fragment identifier.
The System.UriBuilder instance is initialized with the System.UriBuilder.Scheme property set to schemeName, the System.UriBuilder.Host property set to hostName, the System.UriBuilder.Port property set to portNumber, and the System.UriBuilder.Path property is set to pathValue. If extraValue contains a number sign (#), then System.UriBuilder.Fragment is set to extraValue. If extraValue contains a question mark (?), then System.UriBuilder.Query is set to extra Value. An Internet access protocol. A DNS-style domain name or IP address. An IP port number for the service. The path to the Internet resource. A query string or fragment identifier.
Fragment
Unescape
Gets or sets the fragment portion of the URI.
The System.UriBuilder.Fragment property contains any text following a fragment marker (#) in the URI, including the marker itself. When setting the System.UriBuilder.Fragment property, the fragment marker is added to its value.
Host
Unescape
Gets or sets the Domain Name System (DNS) host name or IP address of a server.
The System.UriBuilder.Host property contains the fully qualified DNS host name or IP address (in dotted-quad notation) of the server.
Password
Unescape
Gets or sets the password associated with the user accessing the URI.
Path
Unescape
Gets or sets the path to the resource referenced by the URI.
The System.UriBuilder.Path property contains the path information that the server uses to resolve requests for information. Typically this is the path to the desired information on the server's file system, although it also can indicate the application or script that the server must run to provide the information.
Port
Unescape
Gets or sets the port number of the URI.
The port number defines the protocol port for contacting the server referenced in the URI. If a port is not specified as part of the URI, the System.Uri.Port property returns the value−1 to indicate that the server uses the default value for the protocol.
Query
Unescape
Gets or sets any query information included in the URI.
The System.Uri.Query property contains any query information included in the URI. Query information is separated from the path information by a question mark (?) and continues to the end of the URI. The query information returned includes the leading question mark.
Scheme
Unescape
Gets or sets the scheme name of the URI.
The following table lists the valid scheme names for the System.Uri.Scheme property.
Uri
Unescape
Gets the System.Uri instance constructed by the specified System.UriBuilder instance.
The System.UriBuilder.Uri property contains the System.Uri created by the System.UriBuilder. Any changes made to the System.UriBuilder properties are reflected in the System.UriBuilder.Uri property.
UserName
Unescape
The user name associated with the user accessing the URI.
Equals
Compares an existing System.Uri instance with the contents of the System.UriBuilder for equality.
Return Value: true if the specified System.Uri is equal to the System.Uri constructed by this System.UriBuilder instance; otherwise, false.
The System.UriBuilder.Equals(System.Object) method compares a specified System.Uri instance with the System.Uri instance built by the System.UriBuilder instance. If the two are the same, the System.UriBuilder.Equals(System.Object) method returns true. The System.Uri instance to compare with the current instance.
GetHashCode
Returns the hash code for the URI.
Return Value: The hash code generated for the URI.
The hash code is generated without including any fragment included. The URIs http://www.contoso.com/index.htm#search and http://www.contoso.com/index.htm generate the same hash code.
ToString
Returns the display string for the specified System.UriBuilder instance.
Return Value: The string containing the unescaped display name of the System.UriBuilder.
UriFormatException class (System)
ToString
Description
The exception that is thrown when an invalid Uniform Resource Identifier (URI) is detected.
The System.UriFormatException is thrown by the Uri class constructor if the supplied URI could not correctly parsed. The format for a valid URI is defined in RFC 2396.
UriFormatException
Example Syntax:
ToString
Initializes a new instance of the System.UriFormatException class.
The default constructor initializes a new instance of the System.UriFormatException class with all fields set to null
UriFormatException
Example Syntax:
ToString
Initializes a new instance of the System.UriFormatException class with the specified message.
The UriFormatException constructor initializes the System.UriFormatException instance with the System.Exception.Message property set to the value of textString. The error message string.
UriFormatException
Example Syntax:
ToString
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
ISerializable.GetObjectData
UriHostNameType enumeration (System)
ToString
Description
Defines host name types for the System.Uri.CheckHostName(System.String) method.
The System.UriHostNameType enumeration defines the values that the System.Uri.CheckHostName(System.String) method can return.
ToString
The host is set, but the type cannot be determined.
ToString
The host name is a domain name system (DNS) style host name.
ToString
The host name is an Internet Protocol (IP) version 4 host address.
ToString
The host name is an Internet Protocol (IP) version 6 host address.
ToString
The type of the host name is not supplied. UriPartial enumeration (System)
ToString
Description
Defines the parts of a URI for the System.Uri.GetLeftPart(System.UriPartial) method.
The System.UriPartial enumeration defines the values that can be passed to the System.Uri.GetLeftPart(System.UriPartial) method.
ToString
The scheme and authority segment of the URI.
ToString
The s
System.Collections Namespace
The System.Collections namespace contains classes and interfaces for in-memory data storage and manipulation. There are three main things this namespace is providing. The first is concrete implementations of commonly used collection classes such as a growable array (ArrayList), Hashtable, Stack, Queue, etc. Application developers use these classes as a convenient way to store and retrieve in-memory data. The second set of types in the System.Collections namespace is a set of interfaces to define a formal contract between developers creating new collections and developers consuming collections. For example the IEnumerable interface defines the contract for collections that can offer sequential access via an enumerator. The ASP.NET application model supports data binding controls to data sources that honor the IEnumerable contract. That means that any new collection implementation will automatically be databindable in the ASP.NET model. The third set of types in the System.Collections namespace supports creating strongly typed collections. The CollectionBase class offers data storage that is convenient for developers creating their own, strongly typed collections. This is common for library developers that frequently want to do something such as expose a ControlsCollection that has its Add and Remove method typed to take a Control. By implementing the ControlsCollection to derive from CollectionBase the developer is saved much of the tedious work of rewriting the collection from scratch.
The following example shows adding data to a data collection and outputting the data from collection.
System.Collections
The namespace contains interfaces and classes that define various collections of objects, such as lists, queues, bit arrays, hashtables and dictionaries.
Description
The System.Collections namespace contains interfaces and classes that define various collections of objects, such as lists, queues, bit arrays, hashtables and dictionaries.
ArrayList class (System.Collections)
Description
Implements the System.Collections.IList interface using an array whose size is dynamically increased as required.
The capacity of an System.Collections.ArrayList is the number of elements the list can hold. As elements are added to an System.Collections.ArrayList, the capacity is automatically increased as required through reallocation. The capacity can be decreased by calling System.Collections.ArrayList.TrimToSize or by setting the System.Collections.ArrayList.Capacity property explicitly.
Constructors:
ArrayList
Example Syntax:
Initializes a new instance of the System.Collections.ArrayList class that is empty and has the default initial capacity.
The initial capacity is the starting capacity of the new System.Collections.ArrayList. The default initial capacity for an System.Collections.ArrayList is 16.
ArrayList
Example Syntax:
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.
The initial capacity is the starting capacity of the new System.Collections.ArrayList. If the number of elements added to the list reaches the current capacity, the capacity is automatically doubled. The System.Collections.ICollection whose elements are copied to the new list.
ArrayList
Example Syntax:
Initializes a new instance of the System.Collections.ArrayList class that is empty and has the specified initial capacity.
The initial capacity is the starting capacity of the new System.Collections.ArrayList. The default initial capacity for an System.Collections.ArrayList is 16. If the specified initial capacity is zero, the default initial capacity is used. The number of elements that the new list is initially capable of storing.
Properties:
Capacity
Gets or sets the number of elements that the System.Collections.ArrayList can contain.
System.Collections.ArrayList.Capacity is the number of elements that the System.Collections.ArrayList is capable of storing.
Count
Gets the number of elements actually contained in the System.Collections.ArrayList.
System.Collections.ArrayList.Count is the number of elements that are actually in the System.Collections.ArrayList.
IsFixedSize
Gets a value indicating whether the System.Collections.ArrayList has a fixed size.
A collection with a fixed size does not allow the addition or removal of elements, but it allows the modification of existing elements.
IsReadOnly
Gets a value indicating whether the System.Collections.ArrayList is read-only.
IsSynchronized
Gets a value indicating whether access to the System.Collections.ArrayList is synchronized (thread-safe).
To guarantee the thread safety of the System.Collections.ArrayList, all operations must be done through the wrapper returned by the System.Collections.ArrayList.Synchronized(System.Collections.IList) method. Item
Gets or sets the element at the specified index.
This property provides the ability to access a specific element in the collection by using the following syntax: myCollection[index]. The zero-based index of the element to get or set.
SyncRoot
Gets an object that can be used to synchronize access to the System.Collections.ArrayList
To create a synchronized version of the System.Collections.ArrayList, use the System.Collections.ArrayList.Synchronized(System.Collections.IList) method. However, derived classes can provide their own synchronized version of the System.Collections.ArrayList using the System.Collections.ArrayList.SyncRoot property. The synchronizing code must perform operations on the System.Collections.ArrayList.SyncRoot of the System.Collections.ArrayList, not directly on the System.Collections.ArrayList. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the System.Collections.ArrayList object.
Methods:
Adapter
Creates an System.Collections.ArrayList wrapper for a specific System.Collections.IList.
Return Value: The System.Collections.ArrayList wrapper around the System.Collections.IList.
System.Collections.ArrayList.Adapter(System.Collections.IList) does not copy the contents of System.Collections.IList. Instead, it only creates an System.Collections.ArrayList wrapper around System.Collections.IList; therefore, changes to the System.Collections.IList also affect the System.Collections.ArrayList. The System.Collections.IList to wrap.
Add
Adds an object to the end of the System.Collections.ArrayList.
Return Value: The System.Collections.ArrayList index at which the value has been added.
If System.Collections.ArrayList.Count already equals System.Collections.ArrayList.Capacity, the capacity of the list is doubled by automatically reallocating the internal array and copying the existing elements to the new array before the new element is added. The System.Object to be added to the end of the System.Collections.ArrayList.
AddRange
Adds the elements of an System.Collections.ICollection to the end of the System.Collections.ArrayList.
If the new System.Collections.ArrayList.Count (the current System.Collections.ArrayList.Count plus the size of the collection) will be greater than System.Collections.ArrayList.Capacity, the capacity of the list is either doubled or increased to the new System.Collections.ArrayList.Count, whichever is greater. The internal array is automatically reallocated to accommodate the new elements and the existing elements are copied to the new array before the new elements are added. The System.Collections.ICollection whose elements should be added to the end of the 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.
Return Value: The zero-based index of the 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.
The value parameter and each element of the ISystem.Collections.ArrayList must implement the System.IComparable interface, which is used for comparisons. If the System.Collections.ArrayList is not already sorted according to the System.IComparable implementation, the result might be incorrect. The System.Object to locate.
BinarySearch
Searches the entire sorted System.Collections.ArrayList for an element using the specified comparer and returns the zero-based index of the element.
Return Value: The zero-based index of the 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.
The comparer customizes how the elements are compared. For example, you can use a System.Collections.CaseInsensitiveComparer instance as the comparer to perform case-insensitive string searches. The System.Object to locate. The System.Collections.IComparer implementation to use when comparing elements.
BinarySearch
Searches a section of the sorted System.Collections.ArrayList for an element using the specified comparer and returns the zero-based index of the element.
Return Value: The zero-based index of the 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.
The comparer customizes how the elements are compared. For example, you can use a System.Collections.CaseInsensitiveComparer instance as the comparer to perform case-insensitive string searches. The zero-based starting index of the range to search. The length of the range to search. The System.Object to locate. The System.Collections.IComparer implementation to use when comparing elements.
Clear
Removes all elements from the System.Collections.ArrayList.
System.Collections.ArrayList.Count is set to zero.
Clone
Creates a shallow copy of the System.Collections.ArrayList.
Return Value: A shallow copy of the System.Collections.ArrayList.
A shallow copy of a collection is a new collection containing references to the same elements as the original collection. The elements themselves or anything referenced by the elements are not copied. In contrast, a deep copy of a collection copies the elements and everything directly or indirectly referenced by the elements.
Contains
Determines whether an element is in the System.Collections.ArrayList.
Return Value: true if item is found in the System.Collections.ArrayList; otherwise, false.
This method performs a linear search; therefore, the average execution time is proportional to System.Collections.ArrayList.Count. That is, this method is an O(n) operation, where n is System.Collections.ArrayList.Count. The System.Object to locate in the System.Collections.ArrayList.The element to locate can be null.
CopyTo
Copies the entire System.Collections.ArrayList to a compatible one-dimensional System.Array, starting at the beginning of the target array.
The specified array must be of a compatible type. 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.
CopyTo
Copies the entire System.Collections.ArrayList to a compatible one-dimensional System.Array, starting at the specified index of the target array.
The specified array must be of a compatible type. 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. The zero-based index in array at which copying begins.
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.
The specified array must be of a compatible type. The zero-based index in the source System.Collections.ArrayList at which copying begins. 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. The zero-based index in array at which copying begins. The number of elements to copy.
FixedSize
Returns an System.Collections.ArrayList wrapper with a fixed size.
Return Value: An System.Collections.ArrayList wrapper with a fixed size.
This wrapper can be used to prevent additions to and deletions from the original System.Collections.ArrayList. The elements can still be modified or replaced. The System.Collections.ArrayList to wrap.
FixedSize
Returns an System.Collections.IList wrapper with a fixed size.
Return Value: An System.Collections.IList wrapper with a fixed size.
This wrapper can be used to prevent additions to and deletions from the original System.Collections.IList. The elements can still be modified or replaced. The System.Collections.IList to wrap.
GetEnumerator
Returns an enumerator for the entire System.Collections.ArrayList.
Return Value: An System.Collections.IEnumerator for the entire System.Collections.ArrayList.
Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.
GetEnumerator
Returns an enumerator for a section of the System.Collections.ArrayList.
Return Value: An System.Collections.IEnumerator for the specified section of the System.Collections.ArrayList.
Enumerators are intended to be used only to read data in the collection.
Enumerators cannot be used to modify the underlying collection. The zero-based starting index of the System.Collections.ArrayList section that the enumerator should refer to. The number of elements in the System.Collections.ArrayList section that the enumerator should refer to.
GetRange
Returns an System.Collections.ArrayList which represents a subset of the elements in the source System.Collections.ArrayList.
Return Value: An System.Collections.ArrayList which represents a subset of the elements in the source System.Collections.ArrayList.
This method does not create copies of the elements. The new System.Collections.ArrayList is only a view window into the source System.Collections.ArrayList. However, all subsequent changes to the source System.Collections.ArrayList must be done through this view window System.Collections.ArrayList. If changes are made directly to the source System.Collections.ArrayList, the view window System.Collections.ArrayList is invalidated and any operations on it will return an System.InvalidOperationException. The zero-based System.Collections.ArrayList index at which the range starts. The number of elements in the range.
IndexOf
Searches for the specified System.Object and returns the zero-based index of the first occurrence within the entire System.Collections.ArrayList.
Return Value: The zero-based index of the first occurrence of value within the entire the System.Collections.ArrayList, if found; otherwise, −1.
The System.Collections.ArrayList is searched forward starting at the first element and ending at the last element. The System.Object to locate in the System.Collections.ArrayList.
IndexOf
Searches for the specified System.Object and returns the zero-based index of the first occurrence within the section of the System.Collections.ArrayList that extends from the specified index to the last element.
Return Value: The zero-based index of the first occurrence of value within the section of the System.Collections.ArrayList that extends from startIndex to the last element, if found; otherwise, −1.
The System.Collections.ArrayList is searched forward starting at startIndex and ending at the last element. The System.Object to locate in the System.Collections.ArrayList. The zero-based starting index of the search.
IndexOf
Searches for the specified System.Object and returns the zero-based index of the first occurrence within the section of the System.Collections.ArrayList that starts at the specified index and contains the specified number of elements.
Return Value: The zero-based index of the first occurrence of value within the section of the System.Collections.ArrayList that starts at startIndex and contains count number of elements, if found; otherwise, −1.
The System.Collections.ArrayList is searched forward starting at startIndex and ending at startIndex+count−1. The System.Object to locate in the System.Collections.ArrayList. The zero-based starting index of the search. The number of elements in the section to search.
Insert
Inserts an element into the System.Collections.ArrayList at the specified index.
If System.Collections.ArrayList.Count already equals System.Collections.ArrayList.Capacity, the capacity of the list is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which value should be inserted. The System.Object to insert.
InsertRange
Inserts the elements of a collection into the System.Collections.ArrayList at the specified index.
If the new System.Collections.ArrayList.Count (the current System.Collections.ArrayList.Count plus the size of the collection) is greater than System.Collections.ArrayList.Capacity, the capacity of the list is either doubled or increased to the new count, whichever is greater. The internal array is automatically reallocated to accommodate the new elements. The zero-based index at which the new elements should be inserted. The System.Collections.ICollection whose elements should be inserted into the 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.
Return Value: The zero-based index of the last occurrence of value within the entire the System.Collections.ArrayList, if found; otherwise, −1.
The System.Collections.ArrayList is searched backward starting at the last element and ending at the first element. The. System.Object to locate in the System.Collections.ArrayList.
LastIndexOf
Searches for the specified System.Object and returns the zero-based index of the last occurrence within the section of the System.Collections.ArrayList that extends from the first element to the specified index.
Return Value: The zero-based index of the last occurrence of value within the section of the System.Collections.ArrayList that extends from the first element to startIndex, if found; otherwise, −1.
The System.Collections.ArrayList is searched backward starting at startIndex and ending at the first element. The System.Object to locate in the System.Collections.ArrayList. The zero-based starting index of the backward search.
LastIndexOf
Searches for the specified System.Object and returns the zero-based index of the last occurrence within the section of the System.Collections.ArrayList that contains the specified number of elements and ends at the specified index.
Return Value: The zero-based index of the last occurrence of value within the section of the System.Collections.ArrayList that contains count number of elements and ends at startIndex, if found; otherwise, −1.
The System.Collections.ArrayList is searched backward starting at startIndex and ending at startIndex−count+1. The System.Object to locate in the System.Collections.ArrayList. The zero-based starting index of the backward search. The number of elements in the section to search.
ReadOnly
Returns a read-only System.Collections.ArrayList wrapper.
Return Value: A read-only System.Collections.ArrayList wrapper around list.
To prevent any modifications to list, expose list only through this wrapper. The System.Collections.ArrayList to wrap.
ReadOnly
Returns a read-only System.Collections.IList wrapper.
Return Value: A read-only System.Collections.IList wrapper around list.
To prevent any modifications to list, expose list only through this wrapper. The System.Collections.IList to wrap.
Remove
Removes the first occurrence of a specific object from the System.Collections.ArrayList.
This method performs a linear search; therefore, the average execution time is proportional to System.Collections.ArrayList.Count. That is, this method is an O(n) operation, where n is System.Collections.ArrayList.Count. The System.Object to remove from the System.Collections.ArrayList.
RemoveAt
Removes the element at the specified index of the System.Collections.ArrayList.
In collections such as lists, queues and stacks, the elements that follow the removed element move up to occupy the vacated spot. The zero-based index of the element to remove.
RemoveRange
Removes a range of elements from the System.Collections.ArrayList.
In collections such as lists, queues and stacks, the elements that follow the removed elements move up to occupy the vacated spots. The zero-based starting index of the range of elements to remove. The number of elements to remove.
Repeat
Returns an System.Collections.ArrayList whose elements are copies of the specified value.
Return Value: An System.Collections.ArrayList with count number of elements, all of which are copies of value. The System.Object to copy multiple times in the new System.Collections.ArrayList. The value to copy can be null. The number of times value should be copied.
Reverse
Reverses the order of the elements in the entire System.Collections.ArrayList.
Reverse
Reverses the order of the elements in the specified range.
This method uses System.Array.Reverse(System.Array) to reverse the order of the elements, such that the element at System.Collections.ArrayList [i], where i is any index within the range, moves to System.Collections.ArrayList U], where j equals index+index+count−i−1. The zero-based starting index of the range to reverse. The number of elements in the range to reverse.
SetRange
Copies the elements of a collection over a range of elements in the System.Collections.ArrayList. The zero-based System.Collections.ArrayList index at which to start copying the elements of c. The System.Collections.ICollection whose elements to copy to the System.Collections.ArrayList.
Sort
Sorts the elements in the entire System.Collections.ArrayList using the System.IComparable implementation of each element.
This method uses System.Array.Sort(System.Array), which uses the QuickSort algorithm. This is an O(n log n) operation, where n is the number of elements to sort.
Sort
Sorts the elements in the entire System.Collections.ArrayList using the specified comparer.
This method uses System.Array.Sort(System.Array), which uses the QuickSort algorithm. This is an O(n log n) operation, where n is the number of elements to sort. The System.Collections.IComparer implementation to use when comparing elements.
Sort
Sorts the elements in a section of System.Collections.ArrayList using the specified comparer.
This method uses System.Array.Sort(System.Array), which uses the QuickSort algorithm. This is an O(n log n) operation, where n is the number of elements to sort. The zero-based starting index of the range to sort. The length of the range to sort. The System.Collections.IComparer implementation to use when comparing elements.
Synchronized
Returns an System.Collections.ArrayList wrapper that is synchronized (thread-safe).
Return Value: An System.Collections.ArrayList wrapper that is synchronized (thread-safe).
To guarantee the thread safety of the System.Collections.ArrayList, all operations must be done through this wrapper. The System.Collections.ArrayList to synchronize.
Synchronized
Returns an System.Collections.IList wrapper that is synchronized (thread-safe).
Return Value: An System.Collections.IList wrapper that is synchronized (thread-safe).
To guarantee the thread safety of the System.Collections.ArrayList, all operations must be done through this wrapper. The System.Collections.IList to synchronize.
ToArray
Copies the elements of the System.Collections.ArrayList to a new System.Object array.
Return Value: An System.Object array containing copies of the elements of the System.Collections.ArrayList.
The elements are copied using
System.Array.Copy(System.Array,System.Array,System.Int32), which is an O(n) operation, where n is System.Collections.ArrayList.Count.
ToArray
Copies the elements of the System.Collections.ArrayList to a new array of the specified type.
Return Value: An array of the specified type containing copies of the elements of the System.Collections.ArrayList.
The elements are copied using
System.Array.Copy(System.Array,System.Array,System.Int32), which is an O(n) operation, where n is System.Collections.ArrayList.Count. The System.Type of array to create and copy elements to.
TrimToSize
Sets the capacity to the actual number of elements in the System.Collections.ArrayList.
This method can be used to minimize a list's memory overhead if no new elements will be added to the list.
BitArray class (System.Collections)
TrimToSize
Description
Manages a compact array of bit values, which are represented as Booleans, where true indicates that the bit is on (1) and false indicates the bit is off (0).
The size of a System.Collections.BitArray is controlled by the client; indexing past the end of the System.Collections.BitArray throws an System.ArgumentException.
BitArray
Example Syntax:
TrimToSize
Initializes a new instance of the System.Collections.BitArray class that contains bit values copied from the specified System.Collections.BitArray. The System.Collections.BitArray to copy.
BitArray
Example Syntax:
TrimToSize
Initializes a new instance of the System.Collections.BitArray class that
s contains bit values copied from the specified array of Booleans. An array of Booleans to copy.
BitArray
Example Syntax:
TrimToSize
Initializes a new instance of the System.Collections.BitArray class that contains bit values copied from the specified array of bytes.
The first byte in the array represents bits 0 through 7, the second byte represents bits 8 through 15, and so on. The Least Significant Bit of each byte represents the lowest index value: “bytes [0] & 1” represents bit 0, “bytes [0] & 2” represents bit 1, “bytes [0] & 4” represents bit 2, and so on. An array of bytes containing the values to copy, where each byte represents eight consecutive bits.
BitArray
Example Syntax:
TrimToSize
Initializes a new instance of the System.Collections.BitArray class that can hold the specified number of bit values, which are initially set to false. The number of bit values in the new System.Collections.BitArray.
BitArray
Example Syntax:
TrimToSize
Initializes a new instance of the System.Collections.BitArray class that contains bit values copied from the specified array of 32-bit integers.
The number in the first values array element represents bits 0 through 31, the second number in the array represents bits 32 through 63, and so on. The Least Significant Bit of each integer represents the lowest index value: “values [0] & 1” 1 represents bit 0, “values [0] & 2” represents bit 1, “values [0] & 4” represents bit 2, and so on. An array of integers containing the values to copy, where each integer represents 32 consecutive bits.
BitArray
Example Syntax:
TrimToSize
Initializes a new instance of the System.Collections.BitArray class that can hold the specified number of bit values, which are initially set to the specified value. The number of bit values in the new System.Collections.BitArray. The Boolean value to assign to each bit.
Count
TrimToSize
Gets the number of elements contained in the System.Collections.BitArray.
System.Collections.BitArray.Length and System.Collections.BitArray.Count return the same value.
IsReadOnly
TrimToSize
Gets a value indicating whether the System.Collections.BitArray is read-only.
System.Collections.BitArray implements the System.Collections.BitArray.IsReadOnly property because it is required by the System.Collections.IList interface.
IsSynchronized
TrimToSize
Gets a value indicating whether access to the System.Collections.BitArray is synchronized (thread-safe).
System.Collections.BitArray implements the System.Collections.BitArray.IsSynchronized property because it is required by the System.Collections.ICollection interface.
Item
TrimToSize
Gets or sets the value of the bit at a specific position in the System.Collections.BitArray.
This property provides the ability to access a specific element in the collection by using the following syntax: myCollection[index]. The zero-based index of the value to get or set.
Length
TrimToSize
Gets or sets the number of elements in the System.Collections.BitArray.
System.Collections.BitArray.Length and System.Collections.BitArray.Count return the same value.
SyncRoot
TrimToSize
Gets an object that can be used to synchronize access to the System.Collections.BitArray.
Derived classes can provide their own synchronized version of the System.Collections.BitArray using the System.Collections.BitArray.SyncRoot property. The synchronizing code must perform operations on the System.Collections.BitArray.SyncRoot of the System.Collections.BitArray, not directly on the System.Collections.BitArray. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the System.Collections.BitArray object.
And
Performs the bitwise AND operation on the elements in the current System.Collections.BitArray against the corresponding elements in the specified System.Collections.BitArray.
Return Value: A System.Collections.BitArray containing the result of the bitwise AND operation on the elements in the current System.Collections.BitArray against the corresponding elements in the specified System.Collections.BitArray
The bitwise AND operation returns true if both operands are true, and returns false if one or both operands are false. The System.Collections.BitArray with which to perform the bitwise AND operation.
Clone
Creates a shallow copy of the System.Collections.BitArray.
Return Value: A shallow copy of the System.Collections.BitArray.
A shallow copy of a collection is a new collection containing references to the same elements as the original collection. The elements themselves or anything referenced by the elements are not copied. In contrast, a deep copy of a collection copies the elements and everything directly or indirectly referenced by the elements.
CopyTo
Copies the entire System.Collections.BitArray to a compatible one-dimensional System.Array, starting at the specified index of the target array.
The specified array must be of a compatible type. Only bool int and byte types of arrays are supported. The one-dimensional System.Array that is the destination of the elements copied from System.Collections.BitArray. The System.Array must have zero-based indexing. The zero-based index in array at which copying begins.
Get
Gets the value of the bit at a specific position in the System.Collections.BitArray.
Return Value: The value of the bit at position index. The zero-based index of the value to get.
GetEnumerator
Returns an enumerator that can iterate through the System.Collections.BitArray.
Return Value: An System.Collections.IEnumerator for the entire System.Collections.BitArray.
Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.
Not
Inverts all the bit values in the current System.Collections.BitArray, so that elements set to true are changed to false, and elements set to false are changed to true.
Return Value: The current instance with inverted bit values.
Or
Performs the bitwise OR operation on the elements in the current System.Collections.BitArray against the corresponding elements in the specified System.Collections.BitArray.
Return Value: A System.Collections.BitArray containing the result of the bitwise OR operation on the elements in the current System.Collections.BitArray against the corresponding elements in the specified System.Collections.BitArray.
The bitwise OR operation returns true if one or both operands are true, and returns false if both operands are false. The System.Collections.BitArray with which to perform the bitwise OR operation.
Set
Sets the bit at a specific position in the System.Collections.BitArray to the specified value. The zero-based index of the bit to set. The Boolean value to assign to the bit.
SetAll
Sets all bits in the System.Collections.BitArray to the specified value. The Boolean value to assign to all bits.
Xor
Performs the bitwise exclusive OR operation on the elements in the current System.Collections.BitArray against the corresponding elements in the specified System.Collections.BitArray.
Return Value: A System.Collections.BitArray containing the result of the bitwise exclusive OR operation on the elements in the current System.Collections.BitArray against the corresponding elements in the specified System.Collections.BitArray.
The bitwise exclusive OR operation returns true if exactly one operand is true, and returns false if both operands have the same Boolean value. The System.Collections.BitArray with which to perform the bitwise exclusive OR operation.
CaseInsensitiveComparer class (System.Collections)
Xor
Description
Compares two objects for equivalence, ignoring the case of strings.
System.Collections.CaseInsensitiveComparer implements the System.Collections.IComparer interface supporting case-insensitive comparisons on strings, just as System.Collections.CaseInsensitiveHashCodeProvider implements the System.Collections.IHashCodeProvider interface supporting case-insensitive comparisons on strings.
CaseInsensitiveComparer
Example Syntax:
Xor
Initializes a new instance of the System.Collections.CaseInsensitiveComparer class using the System.Threading.Thread.CurrentCulture of the current thread. Comparison procedures use the System.Threading.Thread.CurrentCulture of the current thread to determine the sort order. String comparisons might have different results depending on the culture. For more information on culture-specific comparisons, see the System.Globalization namespace and.
CaseInsensitiveComparer
Example Syntax:
Xor
Initializes a new instance of the System.Collections.CaseInsensitiveComparer class using the specified System.Globalization.CultureInfo.
Comparison procedures use the specified
System.Globalization.CultureInfo to determine the sort order. String comparisons might have different results depending on the culture. For more information on culture-specific comparisons, see the System.Globalization namespace and. The System.Globalization.CultureInfo to use for the new System.Collections.CaseInsensitiveComparer.
Default
Xor
Gets an instance of System.Collections.CaseInsensitiveComparer that is always available.
Compare
Performs a case-insensitive 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.
Return Value: Value Condition Less than zero a is less than b, with casing ignored.
If a implements System.IComparable, then a. The first object to compare. The second object to compare. CaseInsensitiveHashCodeProvider class (System. Collections)
ToString
Description
Supplies a hash code for an object, using a hashing algorithm that ignores the case of strings. System.Collections.CaselnsensitiveHashCodeProvider implements the System.Collections.IHashCodeProvider interface supporting case-insensitive comparisons on strings, just as System.Collections.CaseInsensitiveComparer implements the System.Collections.IComparer interface supporting case-insensitive comparisons on strings.
CaseInsensitiveHashCodeProvider
Example Syntax:
ToString
Initializes a new instance of the System.Collections.CaselnsensitiveHashCodeProvider class using the current System.Globalization.CultureInfo.
The System.Globalization.CultureInfo provides information about casing.
CaseInsensitiveHashCodeProvider
Example Syntax:
ToString
Initializes a new instance of the System.Collections.CaselnsensitiveHashCodeProvider class using the current System.Globalization.CultureInfo.
The System.Globalization.CultureInfo provides information about casing.
The System.Globalization.CultureInfo to use for the new System.Collections.CaselnsensitiveHashCodeProvider.
Default
ToString
Gets an instance of System.Collections.CaselnsensitiveHashCodeProvider that is always available.
GetHashCode
Returns a hash code for the given object, using a hashing algorithm that ignores the case of strings.
Return Value: A hash code for the given object, using a hashing algorithm that ignores the case of strings.
The return value from this method must not be persisted for two reasons. First, the hash function of a class might be altered to generate a better distribution, rendering any values from the old hash function useless. Second, the default implementation of this class does not guarantee that the same value will be returned by different instances. The System.Object for which a hash code is to be returned.
CollectionBase class (System.Collections)
ToString
Description
Provides the abstract base class for a strongly typed collection.
A System.Collections.CollectionBase instance is always modifiable. See System.Collections.ReadOnlyCollectionBase for a read-only version of this class.
CollectionBase
Example Syntax:
ToString
Count
ToString
Gets the number of elements contained in the System.Collections.CollectionBase instance.
InnerList
ToString
Gets an System.Collections.ArrayList containing the list of elements in the System.Collections.CollectionBase instance.
List
ToString
Gets an System.Collections.IList containing the list of elements in the System.Collections.CollectionBase instance.
Clear
Removes all objects from the System.Collections.CollectionBase instance. System.Collections.CollectionBase.Count is set to zero.
GetEnumerator
Returns an enumerator that can iterate through the System.Collections.CollectionBase instance.
Return Value: An System.Collections.IEnumerator for the System.Collections.CollectionBase instance.
Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.
OnClear
Performs additional custom processes when clearing the contents of the System.Collections.CollectionBase instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action before the collection is cleared.
OnClearComplete
Performs additional custom processes after clearing the contents of the System.Collections.CollectionBase instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action after the collection is cleared.
OnInsert
Performs additional custom processes before inserting a new element into the System.Collections.CollectionBase instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action before the specified element is inserted.
The zero-based index at which to insert value. The new value of the element at index.
OnInsertComplete
Performs additional custom processes after inserting a new element into the System.Collections.CollectionBase instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action after the specified element is inserted. The zero-based index at which to insert value. The new value of the element at index.
OnRemove
Performs additional custom processes when removing an element from the System.Collections.CollectionBase instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action before the specified element is removed. The zero-based index at which value can be found. The value of the element to remove from index.
OnRemoveComplete
Performs additional custom processes after removing an element from the System.Collections.CollectionBase instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action after the specified element is removed. The zero-based index at which value can be found. The value of the element to remove from index.
OnSet
Performs additional custom processes before setting a value in the System.Collections.CollectionBase instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action before the specified element is set. The zero-based index at which oldValue can be found. The value to replace with newValue. The new value of the element at index.
OnSetComplete
Performs additional custom processes after setting a value in the System.Collections.CollectionBase instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action after the specified element is set. The zero-based index at which oldValue can be found. The value to replace with newValue. The new value of the element at index.
OnValidate
Performs additional custom processes when validating a value.
The default implementation of this method determines whether value is null, and, if so, throws System.ArgumentNullException. It is intended to be overridden by a derived class to perform additional action when the specified element is validated. The object to validate.
RemoveAt
Removes the element at the specified index of the System.Collections.CollectionBase instance.
In collections such as lists, queues and stacks, the elements that follow the removed element move up to occupy the vacated spot. The zero-based index of the element to remove.
ICollection.CopyTo
IList.Add
IList.Contains
IList.IndexOf
IList.Insert
IList.Remove
Comparer class (System.Collections)
ToString
Description
Compares two objects for equivalence, where string comparisons are case-sensitive.
This class is the default implementation of the System.Collections.IComparer interface. The System.Collections.CaseInsensitiveComparer class is the implementation of the System.Collections.IComparer interface that performs case-insensitive string comparisons.
ToString
Gets an instance of System.Collections.Comparer that is always available.
An instance of System.Collections.Comparer that is always available.
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.
Return Value: Value Condition Less than zero a is less than b.
If a implements System.IComparable, then a. The first object to compare. The second object to compare.
DictionaryBase class (System.Collections)
ToString
Description
Provides the abstract base class for a strongly typed collection of key-and-value pairs.
Each element is a key-and-value pair stored in a System.Collections.DictionaryEntry object.
DictionaryBase
Example Syntax:
ToString
Count
ToString
Gets the number of elements contained in the System.Collections.DictionaryBase instance.
Dictionary
ToString
Description
Gets the list of elements contained in the System.Collections.DictionaryBase instance.
InnerHashtable
ToString
Gets the list of elements contained in the System.Collections.DictionaryBase instance.
Clear
Clears the contents of the System.Collections.DictionaryBase instance.
System.Collections.DictionaryBase.Count is set to zero.
CopyTo
Copies the System.Collections.DictionaryBase elements to a one-dimensional System.Array at the specified index.
The elements are copied to the System.Array in the same order in which the enumerator iterates through the System.Collections.DictionaryBase. The one-dimensional System.Array that is the destination of the System.Collections.DictionaryEntry objects copied from the System.Collections.DictionaryBase instance. The System.Array must have zero-based indexing. The zero-based index in array at which copying begins.
GetEnumerator
Returns an enumerator that can iterate through the System.Collections.DictionaryBase instance.
Return Value: An System.Collections.IEnumerator for the System.Collections.DictionaryBase instance.
Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.
OnClear
Performs additional custom processes before clearing the contents of the System.Collections.DictionaryBase instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action before the collection is cleared.
OnClearComplete
Performs additional custom processes after clearing the contents of the System.Collections.DictionaryBase instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action after the collection is cleared.
OnGet
Gets the element with the specified key and value in the System.Collections.DictionaryBase instance.
Return Value: An System.Object containing the element with the specified key and value.
The default implementation of this method returns currentValue. It is intended to be overridden by a derived class to perform additional action when the specified element is retrieved. The key of the element to get. The current value of the element associated with key.
OnInsert
Performs additional custom processes before inserting a new element into the System.Collections.DictionaryBase instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action before the specified element is inserted. The key of the element to insert. The value of the element to insert.
OnInsertComplete
Performs additional custom processes after inserting a new element into the System.Collections.DictionaryBase instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action after the specified element is inserted. The key of the element to insert. The value of the element to insert.
OnRemove
Performs additional custom processes before removing an element from the System.Collections.DictionaryBase instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action before the specified element is removed. The key of the element to remove. The value of the element to remove.
OnRemoveComplete
Performs additional custom processes after removing an element from the System.Collections.DictionaryBase instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action after the specified element is removed. The key of the element to remove. The value of the element to remove.
OnSet
Performs additional custom processes before setting a value in the System.Collections.DictionaryBase instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action before the specified element is set. The key of the element to locate. The old value of the element associated with key. The new value of the element associated with key.
OnSetComplete
Performs additional custom processes after setting a value in the System.Collections.DictionaryBase instance.
The default implementation of this method is intended to be overridden by a derived class to perform some action after the specified element is set. The key of the element to locate. The old value of the element associated with key. The new value of the element associated with key.
OnValidate
Performs additional custom processes when validating the element with the specified key and value.
The default implementation of this method is intended to be overridden by a derived class to perform some action when the specified element is validated. The key of the element to validate. The value of the element to validate.
IDictionary.Add
IDictionary.Contains
IDictionary.Remove
ToString
Description
Defines a dictionary key-and-value pair that can be set or retrieved. The System.Collections.IDictionaryEnumerator.Entry method returns an instance of this class.
DictionaryEntry
Example Syntax:
ToString
Initializes an instance of the System.Collections.DictionaryEntry class with the specified key and value. The object defined in each key-and-value pair. The definition associated with key.
Key
ToString
Gets or sets the key in the key-and-value pair.
Value
ToString
Gets or sets the value in the key-and-value pair.
Hashtable class (System.Collections)
ToString
Description
Represents a collection of key-and-value pairs that are organized based on the hash code of the key.
Each element is a key-and-value pair stored in a System.Collections.DictionaryEntry object.
Hashtable
Example Syntax:
ToString
Creates an empty System.Collections.Hashtable with the default initial capacity and using the default load factor, the default hash code provider and the default comparer.
A hashtable's capacity is used to calculate the optimal number of hashtable buckets based on the load factor. The default initial capacity is zero. Capacity is automatically increased as required.
Hashtable
Example Syntax:
ToString
Copies the elements from the specified dictionary to a new System.Collections.Hashtable with the same initial capacity as the number of elements copied and using the default load factor, the default hash code provider and the default comparer.
The initial capacity is set to the number of elements in the source dictionary. Capacity is automatically increased as required based on the load factor. The System.Collections.IDictionary to copy to a new System.Collections.Hashtable.
Hashtable
Example Syntax:
ToString
Creates an empty System.Collections.Hashtable with the specified initial capacity and using the default load factor, the default hash code provider and the default comparer.
Specifying the initial capacity eliminates the need to perform a number of resizing operations while adding elements to the System.Collections.Hashtable. Capacity is automatically increased as required based on the load factor. The approximate number of elements that the System.Collections.Hashtable can initially contain.
Hashtable
Example Syntax:
ToString
Copies the elements from the specified dictionary to a new System.Collections.Hashtable with the same initial capacity as the number of elements copied and using the specified load factor, the default hash code provider and the default comparer.
The initial capacity is set to the number of elements in the source dictionary. Capacity is automatically increased as required based on the load factor. The System.Collections.IDictionary to copy to a new System.Collections.Hashtable. A number in the range from 0.1 through 1.0 indicating the maximum ratio of elements to buckets.
Hashtable
Example Syntax:
ToString
Creates an empty System.Collections.Hashtable with the default initial capacity and using the default load factor, the specified hash code provider and the specified comparer.
A hashtable's capacity is used to calculate the optimal number of hashtable buckets based on the load factor. The default initial capacity is zero. Capacity is automatically increased as required. The System.Collections.IHashCodeProvider that supplies the hash codes for all keys in the System.Collections.Hashtable. The System.Collections.IComparer to use to determine whether two keys are equal.
Hashtable
Example Syntax:
ToString
Creates an empty System.Collections.Hashtable with the specified initial capacity and using the specified load factor, the default hash code provider and the default comparer.
Specifying the initial capacity eliminates the need to perform a number of resizing operations while adding elements to the System.Collections.Hashtable. Capacity is automatically increased as required based on the load factor. The approximate number of elements that the System.Collections.Hashtable can initially contain. A number in the range from 0.1 through 1.0 indicating the maximum ratio of elements to buckets.
Hashtable
Example Syntax:
ToString
Hashtable
Example Syntax:
ToString
Copies the elements from the specified dictionary to a new System.Collections.Hashtable with the same initial capacity as the number of elements copied and using the default load factor, the specified hash code provider and the specified comparer.
The initial capacity is set to the number of elements in the source dictionary. Capacity is automatically increased as required based on the load factor. The System.Collections.IDictionary to copy to a new System.Collections.Hashtable. The System.Collections.IHashCodeProvider that supplies the hash codes for all keys in the System.Collections.Hashtable. The System.Collections.IComparer to use to determine whether two keys are equal.
Hashtable
Example Syntax:
ToString
Creates an empty System.Collections.Hashtable with the specified initial capacity and using the default load factor, the specified hash code provider and the specified comparer.
Specifying the initial capacity eliminates the need to perform a number of resizing operations while adding elements to the System.Collections.Hashtable. Capacity is automatically increased as required based on the load factor. The approximate number of elements that the System.Collections.Hashtable can initially contain. The System.Collections.IHashCodeProvider that supplies the hash codes for all keys in the System.Collections.Hashtable. The System.Collections.IComparer to use to determine whether two keys are equal.
Hashtable
Example Syntax:
ToString
Copies the elements from the specified dictionary to a new System.Collections.Hashtable with the same initial capacity as the number of elements copied and using the specified load factor, the specified hash code provider and the specified comparer.
The initial capacity is set to the number of elements in the source dictionary. Capacity is automatically increased as required based on the load factor. The System.Collections.IDictionary to copy to a new System.Collections.Hashtable. A number in the range from 0.1 through 1.0 indicating the maximum ratio of elements to buckets. The System.Collections.IHashCodeProvider that supplies the hash codes for all keys in the System.Collections.Hashtable. The System.Collections.IComparer to use to determine whether two keys are equal.
Hashtable
Example Syntax:
ToString
Creates an empty System.Collections.Hashtable with the specified initial capacity and using the specified load factor, the specified hash code provider and the specified comparer.
Specifying the initial capacity eliminates the need to perform a number of resizing operations while adding elements to the System.Collections.Hashtable. Capacity is automatically increased as required based on the load factor. The approximate number of elements that the System.Collections.Hashtable can initially contain. A number in the range from 0.1 through 1.0 indicating the maximum ratio of elements to buckets. The System.Collections.IHashCodeProvider that supplies the hash codes for all keys in the System.Collections.Hashtable. The System.Collections.IComparer to use to determine whether two keys are equal.
comparer
ToString
Gets or sets the comparer to use for the System.Collections.Hashtable
Count
ToString
Gets the number of key-and-value pairs contained in the System.Collections.Hashtable.
hcp
ToString
Gets or sets the object that can dispense hash codes.
IsFixedSize
ToString
Gets a value indicating whether the System.Collections.Hashtable has a fixed size.
A collection with a fixed size does not allow the addition or removal of elements, but it allows the modification of existing elements.
IsReadOnly
ToString
Gets a value indicating whether the System.Collections.Hashtable is read-only.
IsSynchronized
ToString
Gets a value indicating whether access to the System.Collections.Hashtable is synchronized (thread-safe).
A System.Collections.Hashtable can safely support one writer and multiple readers concurrently. To support multiple writers, all operations must be done through the wrapper returned by the System.Collections.Hashtable.Synchronized(System.Collections.Hashtable) method.
Item
ToString
Gets or sets the value associated with the specified key.
This property provides the ability to access a specific element in the collection by using the following syntax: myCollection[key]. The key whose value to get or set.
Keys
ToString
Gets an System.Collections.ICollection containing the keys in the System.Collections.Hashtable.
The order of the keys in the System.Collections.ICollection is unspecified, but it is the same order as the associated values in the System.Collections.ICollection returned by the System.Collections.Hashtable.Values method.
SyncRoot
ToString
Gets an object that can be used to synchronize access to the System.Collections.Hashtable.
To create a synchronized version of the System.Collections.Hashtable, use the System.Collections.Hashtable.Synchronized(System.Collections.Hashtable) method. However, derived classes can provide their own synchronized version of the System.Collections.Hashtable using the System.Collections.Hashtable.SyncRoot property. The synchronizing code must perform operations on the System.Collections.Hashtable.SyncRoot of the System.Collections.Hashtable, not directly on the System.Collections.Hashtable. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the System.Collections.Hashtable object.
Values
ToString
Gets an System.Collections.ICollection containing the values in the System.Collections.Hashtable.
The order of the values in the System.Collections.ICollection is unspecified, but it is the same order as the associated keys in the System.Collections.ICollection returned by the System.Collections.Hashtable.Keys method.
Add
Adds an element with the specified key and value into the System.Collections.Hashtable.
An object that has no correlation between its state and its hash code value should typically not be used as the key. For example, String objects are better than StringBuilder objects for use as keys. The key of the element to add. The value of the element to add.
Clear
Removes all elements from the System.Collections.Hashtable. System.Collections.Hashtable.Count is set to zero.
Clone
Creates a shallow copy of the System.Collections.Hashtable.
Return Value: A shallow copy of the System.Collections.Hashtable.
A shallow copy of a collection is a new collection containing references to the same elements as the original collection. The elements themselves or anything referenced by the elements are not copied. In contrast, a deep copy of a collection copies the elements and everything directly or indirectly referenced by the elements.
Contains
Determines whether the System.Collections.Hashtable contains a specific key.
Return Value: true if the System.Collections.Hashtable contains an element with the specified key; otherwise, false.
This implementation is close to O(1) in most cases. The key to locate in the System.Collections.Hashtable.
ContainsKey
Determines whether the System.Collections.Hashtable contains a specific key.
Return Value: true if the System.Collections.Hashtable contains an element with the specified key; otherwise, false.
This implementation is close to O(1) in most cases. The key to locate in the System.Collections.Hashtable.
ContainsValue
Determines whether the System.Collections.Hashtable contains a specific value.
Return Value: true if the System.Collections.Hashtable contains an element with the specified value; otherwise, false.
This method performs a linear search; therefore, the average execution time is proportional to System.Collections.Hashtable.Count. That is, this method is an O(n) operation, where n is System.Collections.Hashtable.Count. The value to locate in the System.Collections.Hashtable.
CopyTo
Copies the System.Collections.Hashtable elements to a one-dimensional System.Array instance at the specified index.
The elements are copied to the System.Array in the same order in which the enumerator iterates through the System.Collections.Hashtable. 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. The zero-based index in array at which copying begins.
GetEnumerator
Returns an enumerator that can iterate through the System.Collections.Hashtable.
Return Value: An System.Collections.IDictionaryEnumerator for the System.Collections.Hashtable.
Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.
GetHash
Returns the hash code for the specified key.
Return Value: The hash code for key.
If the hashtable was created with a specific System.Collections.IHashCodeProvider implementation, this method uses that hash code provider; otherwise, it uses the System.Object.GetHashCode implementation of key. The System.Object for which a hash code is to be returned.
GetObjectData
Implements the System.Runtime.Serialization.ISerializable interface and returns the data needed to serialize the System.Collections.Hashtable. A System.Runtime.Serialization.SerializationInfo object containing the information required to serialize the System.Collections.Hashtable. A System.Runtime.Serialization.StreamingContext object containing the source and destination of the serialized stream associated with the System.Collections.Hashtable.
KeyEquals
Compares a specific System.Object with a specific key in the System.Collections.Hashtable.
Return Value: true if item and key are equal; otherwise, false.
If the hashtable was created with a specific System.Collections.IComparer implementation, this method uses that comparer; that is, System.Collections.IComparer.Compare(System.Object,System.Object) (item, key). Otherwise, it uses item.Equals(key). The System.Object to compare with key. The key in the System.Collections.Hashtable to compare with item.
OnDeserialization
Implements the System.Runtime.Serialization.ISerializable interface and raises the deserialization event when the deserialization is complete. The source of the deserialization event.
Remove
Removes the element with the specified key from the System.Collections.Hashtable.
If the System.Collections.Hashtable does not contain an element with the specified key, the System.Collections.Hashtable remains unchanged. No exception is thrown. The key of the element to remove.
Synchronized
Returns a synchronized (thread-safe) wrapper for the System.Collections.Hashtable.
Return Value: A synchronized (thread-safe) wrapper for the System.Collections.Hashtable.
A System.Collections.Hashtable can safely support one writer and multiple readers concurrently. To support multiple writers, all operations must be done through this wrapper only. The System.Collections.Hashtable to synchronize.
IEnumerable.GetEnumerator
ICollection interface (System.Collections)
ToString
Description
Defines size, enumerators and synchronization methods for all collections.
The System.Collections.ICollection interface is the base interface for classes in the System.Collections namespace.
Count
ToString
When implemented by a class, gets the number of elements contained in the System.Collections.ICollection.
IsSynchronized
ToString
When implemented by a class, gets a value indicating whether access to the System.Collections.ICollection is synchronized (thread-safe).
System.Collections.ICollection.SyncRoot returns an object, which can be used to synchronize access to the System.Collections.ICollection.
SyncRoot
ToString
When implemented by a class, gets an object that can be used to synchronize access to the System.Collections.ICollection.
For collections whose underlying store is not publicly available, the expected implementation is to return the current instance. Note that the pointer to the current instance might not be sufficient for collections that wrap other collections; those should return the underlying collection's SyncRoot property.
CopyTo
When implemented by a class, copies the elements of the System.Collections.ICollection to an System.Array, starting at a particular System.Array index. 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. The zero-based index in array at which copying begins.
IComparer interface (System.Collections)
CopyTo
Description
Exposes a method that compares two objects.
This interface is used in conjunction with the System.Array.Sort(System.Array) and System.Array.BinarySearch(System.Array,System.Object) methods. It provides a way to customize the sort order of a collection.
Compare
Compares two objects and returns a value indicating whether one is less than, equal to or greater than the other.
Return Value: Value Condition Less than zero x is less than y.
The preferred implementation is to use the System.IComparable.CompareTo(System.Object) method of one of the parameters. First object to compare. Second object to compare.
IDictionary interface (System.Collections)
Compare
Description
Represents a collection of key-and-value pairs.
The System.Collections.IDictionary class is the base interface for collections of key-and-value pairs.
IsFixedSize
Compare
When implemented by a class, gets a value indicating whether the System.Collections.IDictionary has a fixed size.
A collection with a fixed size does not allow the addition or removal of elements, but it allows the modification of existing elements.
IsReadOnly
Compare
When implemented by a class, gets a value indicating whether the System.Collections.IDictionary is read-only.
Item
Compare
When implemented by a class, gets or sets the element with the specified key.
This property provides the ability to access a specific element in the collection by using the following syntax: myCollection[key]. The key of the element to get or set.
Keys
Compare
When implemented by a class, gets an System.Collections.ICollection containing the keys of the System.Collections.IDictionary.
The order of the keys in the returned System.Collections.ICollection is unspecified, but it is guaranteed to be the same order as the corresponding values in the System.Collections.ICollection returned by the System.Collections.IDictionary.Values method.
Values
Compare
When implemented by a class, gets an System.Collections.ICollection containing the values in the System.Collections.IDictionary.
The order of the values in the returned System.Collections.ICollection is unspecified, but it is guaranteed to be the same order as the corresponding keys in the System.Collections.ICollection returned by the System.Collections.IDictionary.Keys method.
Add
When implemented by a class, adds an element with the provided key and value to the System.Collections.IDictionary.
The System.Collections.IDictionary.Item(System.Object) property can also be used to add new elements by setting the value of a key that does not exist in the dictionary. For example: myCollection[“myNonexistentKey”]=myValue. However, if the specified key already exists in the dictionary, setting the System.Collections.IDictionary.Item(System.Object) property overwrites the old value. In contrast, the System.Collections.IDictionary.Add(System.Object,System.Object) method does not modify existing elements. The System.Object to use as the key of the element to add. The System.Object to use as the value of the element to add.
Clear
When implemented by a class, removes all elements from the System.Collections.IDictionary.
Contains
When implemented by a class, determines whether the System.Collections.IDictionary contains an element with the specified key.
Return Value: true if the System.Collections.IDictionary contains an element with the key; otherwise, false. The key to locate in the System.Collections.IDictionary.
GetEnumerator
When implemented by a class, returns an System.Collections.IDictionaryEnumerator for the System.Collections.IDictionary.
Return Value: An System.Collections.IDictionaryEnumerator for the System.Collections.IDictionary
Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.
Remove
When implemented by a class, removes the element with the specified key from the System.Collections.IDictionary.
In collections such as lists, queues and stacks, the elements that follow the removed element move up to occupy the vacated spot. The key of the element to remove.
IDictionaryEnumerator interface (System.Collections)
Remove
Description
Enumerates the elements of a dictionary.
Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.
Entry
Remove
When implemented by a class, gets both the key and the value of the current dictionary entry.
After an enumerator is created or after a System.Collections.IEnumerator.Reset, System.Collections.IEnumerator.MoveNext must be called to advance the enumerator to the first element of the collection before reading the value of System.Collections.IDictionaryEnumerator.Entry; otherwise, System.Collections.IDictionaryEnumerator.Entry is undefined.
Key
Remove
When implemented by a class, gets the key of the current dictionary entry.
After an enumerator is created or after a System.Collections.IEnumerator.Reset, System.Collections.IEnumerator.MoveNext must be called to advance the enumerator to the first element of the collection before reading the value of System.Collections.IDictionaryEnumerator.Key; otherwise, System.Collections.IDictionaryEnumerator.Key is undefined.
Value
Remove
When implemented by a class, gets the value of the current dictionary entry.
After an enumerator is created or after a System.Collections.IEnumerator.Reset, System.Collections.IEnumerator.MoveNext must be called to advance the enumerator to the first element of the collection before reading the value of System.Collections.IDictionaryEnumerator.Value; otherwise, System.Collections.IDictionaryEnumerator.Value is undefined.
IEnumerable interface (System.Collections)
Remove
Description
Exposes the enumerator, which supports a simple iteration over a collection.
System.Collections.IEnumerable must be implemented to support the For Each semantics of Microsoft Visual Basic. COM classes that allow enumerators also implement this interface.
GetEnumerator
Returns an enumerator that can iterate through a collection.
Return Value: An System.Collections.IEnumerator that can be used to iterate through the collection.
Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.
IEnumerator interface (System.Collections)
GetEnumerator
Description
Supports a simple iteration over a collection.
System.Collections.IEnumerator is the base interface for all enumerators.
Current
GetEnumerator
Gets the current element in the collection.
After an enumerator is created or after a System.Collections.IEnumerator.Reset, System.Collections.IEnumerator.MoveNext must be called to advance the enumerator to the first element of the collection before reading the value of System.Collections.IEnumerator.Current; otherwise, System.Collections.IEnumerator.Current is undefined.
MoveNext
Advances the enumerator to the next element of the collection.
Return Value: true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.
After an enumerator is created or after a call to System.Collections.IEnumerator.Reset, an enumerator is positioned before the first element of the collection, and the first call to System.Collections.IEnumerator.MoveNext moves the enumerator over the first element of the collection.
9 Reset
Sets the enumerator to its initial position, which is before the first element in the collection.
All calls to System.Collections.IEnumerator.Reset must result in the same state for the enumerator. This may involve taking a new snapshot of the collection or moving to the beginning of the collection.
IHashCodeProvider interface (System.Collections)
Reset
Description
Supplies a hash code for an object, using a custom hash function.
The System.Collections.IHashCodeProvider interface is used in conjunction with System.Collections.Hashtable. The objects used as keys by a System.Collections.Hashtable must implement or inherit the System.Object.GetHashCode and System.Object.Equals(System.Object) methods. However, if the System.Collections.Hashtable constructor is passed a reference to an object that implements both the System.Collections.IHashCodeProvider interface and the System.Collections.IComparer interface, then System.Collections.IHashCodeProvider.GetHashCode(System.Object) and System.Collections.IComparer.Compare(System.Object,System.Object) can be used instead.
GetHashCode
Returns a hash code for the specified object.
Return Value: A hash code for the specified object.
The return value from this method must not be persisted for two reasons. First, the hash function of a class might be altered to generate a better distribution, rendering any values from the old hash function useless. Second, the default implementation of this class does not guarantee that the same value will be returned by different instances. The System.Object for which a hash code is to be returned.
IList interface (System.Collections)
GetHashCode
Description
Represents a collection of objects that can be individually accessed by index.
System.Collections.IList is a descendant of the Is System.Collections.ICollection interface and is the base interface of all lists.
IsFixedSize
GetHashCode
When implemented by a class, gets a value indicating whether the System.Collections.IList has a fixed size.
A collection with a fixed size does not allow the addition or removal of elements, but it allows the modification of existing elements.
IsReadOnly
GetHashCode
When implemented by a class, gets a value indicating whether the System.Collections.IList is read-only.
Item
GetHashCode
When implemented by a class, gets or sets the element at the specified index.
This property provides the ability to access a specific element in the collection by using the following syntax: myCollection[index]. The zero-based index of the element to get or set.
Add
When implemented by a class, adds an item to the System.Collections.IList.
Return Value: The position into which the new element was inserted. The System.Object to add to the System.Collections.IList.
Clear
When implemented by a class, removes all items from the System.Collections.IList.
Contains
When implemented by a class, determines whether the System.Collections.IList contains a specific value.
Return Value: true if the System.Object is found in the System.Collections.IList; otherwise, false. The System.Object to locate in the System.Collections.IList. IndexOf
When implemented by a class, determines the index of a specific item in the System.Collections.IList.
Return Value: The index of value if found in the list; otherwise, −1. The System.Object to locate in the System.Collections.IList.
Insert
When implemented by a class, inserts an item to the System.Collections.IList at the specified position.
If index equals the number of items in the System.Collections.IList, then value is appended to the end. The zero-based index at which value should be inserted. The System.Object to insert into the System.Collections.IList.
Remove
When implemented by a class, removes the first occurrence of a specific object from the System.Collections.IList.
In collections such as lists, queues and stacks, the elements that follow the removed element move up to occupy the vacated spot. The System.Object to remove from the System.Collections.IList.
RemoveAt
When implemented by a class, removes the System.Collections.IList item at the specified index.
In collections such as lists, queues and stacks, the elements that follow the removed element move up to occupy the vacated spot. The zero-based index of the item to remove.
Queue class (System.Collections)
RemoveAt
Description
Represents a first-in, first-out collection of objects.
Queues are useful for storing messages in the order they were received for sequential processing. This class implements a queue as a circular array. Objects stored in a System.Collections.Queue are inserted at one end and removed from the other. If the number of elements added to the System.Collections.Queue reaches the current capacity, the capacity is automatically increased to accommodate more elements. The capacity can be decreased by calling System.Collections.Queue.TrimToSize.
Queue
Example Syntax:
RemoveAt
Initializes a new instance of the System.Collections.Queue class that is empty, has the default initial capacity and uses the default growth factor.
The initial capacity is the starting capacity of the new System.Collections.Queue. The growth factor is the number by which the current capacity is multiplied when a greater capacity is required. The default initial capacity is 32 and the default growth factor is 2.0.
Queue
Example Syntax:
RemoveAt
Initializes a new instance of the System.Collections.Queue class that contains elements copied from the specified collection, has the same initial capacity as the number of elements copied and uses the default growth factor.
The initial capacity is the starting capacity of the new System.Collections.Queue. The growth factor is the number by which the current capacity is multiplied when a greater capacity is required. The default initial capacity is 32 and the default growth factor is 2.0. The System.Collections.ICollection to copy elements from.
Queue
Example Syntax:
RemoveAt
Initializes a new instance of the System.Collections.Queue class that is empty, has the specified initial capacity and uses the default growth factor.
The initial capacity is the starting capacity of the new System.Collections.Queue. The growth factor is the number by which the current capacity is multiplied when a greater capacity is required. The default initial capacity is 32 and the default growth factor is 2.0. The initial number of elements that the System.Collections.Queue can contain.
Queue
Example Syntax:
RemoveAt
Initializes a new instance of the System.Collections.Queue class that is empty, has the specified initial capacity and uses the specified growth factor.
The initial capacity is the starting capacity of the new System.Collections.Queue. The growth factor is the number by which the current capacity is multiplied when a greater capacity is required. The default initial capacity is 32 and the default growth factor is 2.0. The initial number of elements that the System.Collections.Queue can contain. The factor by which the capacity of the System.Collections.Queue is expanded.
Count
RemoveAt
Gets the number of elements contained in the System.Collections.Queue System.Collections.Queue.Count is the number of elements that are actually in the System.Collections.Queue. The capacity of a System.Collections.Queue is the number of elements that the System.Collections.Queue is capable of storing.
IsSynchronized
RemoveAt
Gets a value indicating whether access to the System.Collections.Queue is synchronized (thread-safe).
To guarantee the thread safety of the System.Collections.Queue, all operations must be done through the wrapper returned by the System.Collections.Queue.Synchronized(System.Collections.Queue) method.
SyncRoot
RemoveAt
Gets an object that can be used to synchronize access to the System.Collections.Queue.
To create a synchronized version of the System.Collections.Queue, use the System.Collections.Queue.Synchronized(System.Collections.Queue) method. However, derived classes can provide their own synchronized version of the System.Collections.Queue using the System.Collections.Queue.SyncRoot property. The synchronizing code must perform operations on the System.Collections.Queue.SyncRoot of the System.Collections.Queue, not directly on the System.Collections.Queue. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the System.Collections.Queue object.
Removes all objects from the System.Collections.Queue.
System.Collections.Queue.Count is set to zero. To reset the capacity of the System.Collections.Queue, call System.Collections.Queue.TrimToSize Trimming an empty System.Collections.Queue sets the capacity of the System.Collections.Queue to the default capacity, not zero.
Clone
Creates a shallow copy of the System.Collections.Queue.
Return Value: A shallow copy of the System.Collections.Queue.
A shallow copy of a collection is a new collection containing references to the same elements as the original collection. The elements themselves or anything referenced by the elements are not copied. In contrast, a deep copy of a collection copies the elements and everything directly or indirectly referenced by the elements.
Contains
Determines whether an element is in the System.Collections.Queue
Return Value: true if obj is found in the System.Collections.Queue; otherwise, false.
This method performs a linear search; therefore, the average execution time proportional to System.Collections.Queue.Count. That is, this method is an O(n) operation, where n is System.Collections.Queue.Count. The System.Object to locate in the System.Collections.Queue. The element to locate can be null.
CopyTo
Copies the System.Collections.Queue elements to an existing one-dimensional System.Array, starting at the specified array index.
The elements are copied to the System.Array in the same order in which the enumerator iterates through the System.Collections.Queue. The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Queue. The System.Array must have zero-based indexing. The zero-based index in array at which copying begins.
Dequeue
Removes and returns the object at the beginning of the System.Collections.Queue.
Return Value: The object that is removed from the beginning of the System.Collections.Queue.
This method is similar to the System.Collections.Queue.Peek method, but System.Collections.Queue.Peek does not modify the System.Collections.Queue Enqueue
Adds an object to the end of the System.Collections.Queue.
If System.Collections.Queue.Count already equals the capacity of the System.Collections.Queue, the capacity is increased by automatically reallocating the internal array before copying the old elements and adding the new element. The new capacity is determined by multiplying the current capacity by the growth factor, which is determined when the System.Collections.Queue is constructed. The object to add to the System.Collections.Queue.
GetEnumerator
Returns an enumerator that can iterate through the System.Collections.Queue.
Return Value: An System.Collections.IEnumerator for the System.Collections.Queue.
Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.
Peek
Returns the object at the beginning of the System.Collections.Queue without removing it.
Return Value: The object at the beginning of the System.Collections.Queue.
This method is similar to the System.Collections.Queue.Dequeue method, but System.Collections.Queue.Peek does not modify the System.Collections.Queue.
Synchronized
Returns a System.Collections.Queue wrapper that is synchronized (thread-safe).
Return Value: A System.Collections.Queue wrapper that is synchronized (thread-safe).
To guarantee the thread safety of the System.Collections.Queue, all operations must be done through this wrapper only. The System.Collections.Queue to synchronize.
ToArray
Copies the System.Collections.Queue elements to a new array.
Return Value: A new array containing elements copied from the System.Collections.Queue.
The System.Collections.Queue is not modified. The order of the elements in the new array is the same as the order of the elements from the beginning of the System.Collections.Queue to its end.
TrimToSize
Sets the capacity to the actual number of elements in the System.Collections.Queue.
This method can be used to minimize a list's memory overhead if no new elements will be added to the list.
ReadOnlyCollectionBase class (System.Collections)
TrimToSize
Description
Provides the abstract base class for a strongly typed read-only collection.
A System.Collections.ReadOnlyCollectionBase instance is always read-only. See System.Collections.CollectionBase for a modifiable version of this class.
ReadOnlyCollectionBase
Example Syntax:
TrimToSize
Count
TrimToSize
Gets the number of elements contained in the System.Collections.ReadOnlyCollectionBase instance.
InnerList
TrimToSize
Gets the list of elements contained in the System.Collections.ReadOnlyCollectionBase instance.
GetEnumerator
Returns an enumerator that can iterate through the System.Collections.ReadOnlyCollectionBase instance.
Return Value: An System.Collections.IEnumerator for the System.Collections.ReadOnlyCollectionBase instance.
Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.
ICollection.CopyTo
SortedList class (System.Collections)
ToString
Description
Represents a collection of key-and-value pairs that are sorted by the keys and are accessible by key and by index.
A System.Collections.SortedList is a hybrid between a System.Collections.Hashtable and an System.Array. When an element is accessed by its key using the System.Collections.SortedList.Item(System.Object) indexer property, it behaves like a System.Collections.Hashtable. When an element is accessed by its index using System.Collections.SortedList.GetByIndex(System.Int32) or System.Collections.SortedList.SetByIndex(System.Int32,System.Object), it behaves like an System.Array.
SortedList
Example Syntax:
ToString
Initializes a new instance of the System.Collections.SortedList class that is empty, has the default initial capacity and is sorted according to the System.IComparable interface implemented by each key added to the System.Collections.SortedList.
The initial capacity is the starting capacity of the new System.Collections.SortedList. The default initial capacity for a System.Collections.SortedList is 16.
SortedList
Example Syntax:
ToString
Initializes a new instance of the System.Collections.SortedList class that is empty, has the default initial capacity and is sorted according to the specified System.Collections.IComparer interface.
The initial capacity is the starting capacity of the new System.Collections.SortedList. The default initial capacity for a System.Collections.SortedList is 16. The System.Collections.IComparer implementation to use when comparing keys.
SortedList
Example Syntax:
ToString
Initializes a new instance of the System.Collections.SortedList class that contains elements copied from the specified dictionary, has the same initial capacity as the number of elements copied and is sorted according to the System.IComparable interface implemented by each key.
The initial capacity is the starting capacity of the new System.Collections.SortedList. When adding elements to the list, if the number of elements exceeds the current capacity, the capacity is automatically doubled. The System.Collections.IDictionary to copy to a new System.Collections.SortedList.
SortedList
Example Syntax:
ToString
Initializes a new instance of the System.Collections.SortedList class that is empty, has the specified initial capacity and is sorted according to the System.IComparable interface implemented by each key added to the System.Collections.SortedList.
The initial capacity is the starting capacity of the new System.Collections.SortedList. The default initial capacity for a System.Collections.SortedList is 16. The initial number of elements that the System.Collections.SortedList can contain.
SortedList
Example Syntax:
ToString
Initializes a new instance of the System.Collections.SortedList class that is empty, has the specified initial capacity and is sorted according to the specified System.Collections.IComparer interface.
The initial capacity is the starting capacity of the new System.Collections.SortedList. The default initial capacity for a System.Collections.SortedList is 16. The System.Collections.IComparer implementation to use when comparing keys. The initial number of elements that the System.Collections.SortedList can contain.
SortedList
Example Syntax:
ToString
Initializes a new instance of the System.Collections.SortedList class that contains elements copied from the specified dictionary, has the same initial capacity as the number of elements copied and is sorted according to the specified System.Collections.IComparer interface.
The initial capacity is the starting capacity of the new System.Collections.SortedList. When adding elements to the list, if the number of elements exceeds the current capacity, the capacity is automatically doubled. The System.Collections.IDictionary to copy to a new System.Collections.SortedList. The System.Collections.IComparer implementation to use when comparing keys.
Capacity
ToString
Gets or sets the capacity of the System.Collections.SortedList
If the number of elements added to the list reaches the current capacity, the capacity is automatically doubled.
Count
ToString
Gets the number of elements contained in the System.Collections.SortedList.
Each element is a key-and-value pair that can be accessed as a System.Collections.DictionaryEntry object.
IsFixedSize
ToString
Gets a value indicating whether the System.Collections.SortedList has a fixed size.
A collection with a fixed size does not allow the addition or removal of elements, but it allows the modification of existing elements.
IsReadOnly
ToString
Gets a value indicating whether the System.Collections.SortedList is read-only.
IsSynchronized
ToString
Gets a value indicating whether access to the System.Collections.SortedList is synchronized (thread-safe).
To guarantee the thread safety of the System.Collections.SortedList, all operations must be done through the wrapper returned by the System.Collections.SortedList.Synchronized(System.Collections.SortedList) method.
Item
ToString
Gets and sets the value associated with a specific key in the System.Collections.SortedList.
If setting the value of key and key does not exist in the System.Collections.SortedList, a new element is created with the specified key and the specified value. The key associated with the value to get or set.
Keys
ToString
Gets the keys in the System.Collections.SortedList.
The System.Collections.ICollection is a read-only view of the keys of the System.Collections.SortedList. Modifications made to the underlying System.Collections.SortedList are immediately reflected in the System.Collections.ICollection
SyncRoot
ToString
Gets an object that can be used to synchronize access to the System.Collections.SortedList.
To create a synchronized version of the System.Collections.SortedList, use the System.Collections.SortedList.Synchronized(System.Collections.SortedList) method. However, derived classes can provide their own synchronized version of the System.Collections.SortedList using the System.Collections.SortedList.SyncRoot property. The synchronizing code must perform operations on the System.Collections.SortedList.SyncRoot of the System.Collections.SortedList, not directly on the System.Collections.SortedList. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the System.Collections.SortedList object.
Values
ToString
Gets the values in the System.Collections.SortedList
The System.Collections.ICollection is a read-only view of the values of the System.Collections.SortedList. Modifications made to the underlying System.Collections.SortedList are immediately reflected in the System.Collections.ICollection.
Add
Adds an element with the specified key and value to the System.Collections.SortedList.
If the number of elements added to the list reaches the current capacity, the capacity is automatically doubled. The insertion point is determined based on the comparer selected, either explicitly or by default when the System.Collections.SortedList was created. The key of the element to add. The value of the element to add.
Clear
Removes all elements from the System.Collections.SortedList.
System.Collections.SortedList.Count is set to zero.
Clone
Creates a shallow copy of the System.Collections.SortedList.
Return Value: A shallow copy of the System.Collections.SortedList.
A shallow copy of a collection is a new collection containing references to the same elements as the original collection. The elements themselves or anything referenced by the elements are not copied. In contrast, a deep copy of a collection copies the elements and everything directly or indirectly referenced by the
Contains
Determines whether the System.Collections.SortedList contains a specific key.
Return Value: true if the System.Collections.SortedList contains an element with the specified key; otherwise, false.
The elements of a System.Collections.SortedList are sorted by the keys either according to a specific System.Collections.IComparer implementation specified when the System.Collections.SortedList is created or according to the System.IComparable implementation provided by the keys themselves. The key to locate in the System.Collections.SortedList.
ContainsKey
Determines whether the System.Collections.SortedList contains a specific key.
Return Value: true if the System.Collections.SortedList contains an element with the specified key; otherwise, false.
The elements of a System.Collections.SortedList are sorted by the keys either according to a specific System.Collections.IComparer implementation specified when the System.Collections.SortedList is created or according to the System.IComparable implementation provided by the keys themselves. The key Ito locate in the System.Collections.SortedList.
ContainsValue
Determines whether the System.Collections.SortedList contains a specific value.
Return Value: true if the System.Collections.SortedList contains an element with the specified value; otherwise, false.
This method performs a linear search; therefore, the average execution time is proportional to System.Collections.SortedList.Count. That is, this method is an Of n) operation, where n is System.Collections.SortedList.Count. The value to locate in the System.Collections.SortedList.
CopyTo
Copies the System.Collections.SortedList elements to a one-dimensional System.Array instance at the specified index.
The key-and-value pairs are copied to the System.Array in the same order in which the enumerator iterates through the System.Collections.SortedList. The one-dimensional System.Array that is the destination of the System.Collections.DictionaryEntry objects copied from System.Collections.SortedList. The System.Array must have zero-based indexing. The zero-based index in array at which copying begins.
GetByIndex
Gets the value at the specified index of the System.Collections.SortedList
Return Value: The value at the specified index of the System.Collections.SortedList.
The index sequence is based on the sort sequence. When an element is added, it is inserted into System.Collections.SortedList in the correct sort order, and the indexing adjusts accordingly. When an element removed, the indexing also adjusts accordingly. Therefore, the index of a specific key-and-value pair might change as elements are added or removed from the System.Collections.SortedList. The zero-based index of the value to get.
GetEnumerator
Returns an enumerator that can iterate through the System.Collections.SortedList.
Return Value: An System.Collections.IDictionaryEnumerator for the System.Collections.SortedList.
Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.
GetKey
Gets the key at the specified index of the System.Collections.SortedList.
Return Value: The key at the specified index of the System.Collections.SortedList.
The index sequence is based on the sort sequence. When an element is added, it is inserted into System.Collections.SortedList in the correct sort order, and the indexing adjusts accordingly. When an element removed, the indexing also adjusts accordingly. Therefore, the index of a specific key-and-value pair might change as elements are added or removed from the System.Collections.SortedList. The zero-based index of the key to get.
GetKeyList
Gets the keys in the System.Collections.SortedList.
Return Value: An System.Collections.IList containing the keys in the System.Collections.SortedList.
The returned System.Collections.IList is a read-only view of the keys of the System.Collections.SortedList. Modifications made to the underlying System.Collections.SortedList are immediately reflected in the System.Collections.IList.
GetValueList
Gets the values in the System.Collections.SortedList.
Return Value: An System.Collections.IList containing the values in the System.Collections.SortedList.
The returned System.Collections.IList is a read-only view of the values of the System.Collections.SortedList. Modifications made to the underlying System.Collections.SortedList are immediately reflected in the System.Collections.IList
IndexOfKey
Returns the zero-based index of the specified key in the System.Collections.SortedList.
Return Value: The zero-based index of key, if key is found in the System.Collections.SortedList; otherwise, −1.
The elements of a System.Collections.SortedList are sorted by the keys either according to a specific System.Collections.IComparer implementation specified when the System.Collections.SortedList is created or according to the System.IComparable implementation provided by the keys themselves. The key to locate in the System.Collections.SortedList.
IndexOfValue
Returns the zero-based index of the first occurrence of the specified value in the System.Collections.SortedList.
Return Value: The zero-based index of the first occurrence of value, if value is found in the System.Collections.SortedList; otherwise, −1.
The index sequence is based on the sort sequence. When an element is added, it is inserted into System.Collections.SortedList in the correct sort order, and the indexing adjusts accordingly. When an element removed, the indexing also adjusts accordingly. Therefore, the index of a specific key-and-value pair might change as elements are added or removed from the System.Collections.SortedList. The value to locate in the System.Collections.SortedList.
Remove
Removes the element with the specified key from System.Collections.SortedList.
If the System.Collections.SortedList does not contain an element with the specified key, the System.Collections.SortedList remains unchanged. No exception is thrown. The key of the element to remove.
RemoveAt
Removes the element at the specified index of System.Collections.SortedList.
The index sequence is based on the sort sequence. When an element is added, it is inserted into System.Collections.SortedList in the correct sort order, and the indexing adjusts accordingly. When an element removed, the indexing also adjusts accordingly. Therefore, the index of a specific key-and-value pair might change as elements are added or removed from the System.Collections.SortedList. The zero-based index of the element to remove.
SetByIndex
Replaces the value at a specific index in the System.Collections.SortedList.
The index sequence is based on the sort sequence. When an element is added, it is inserted into System.Collections.SortedList in the correct sort order, and the indexing adjusts accordingly. When an element removed, the indexing also adjusts accordingly. Therefore, the index of a specific key-and-value pair might change as elements are added or removed from the System.Collections.SortedList. The zero-based index at which to save value. The System.Object to save into the System.Collections.SortedList.
Synchronized
Returns a synchronized (thread-safe) wrapper for the System.Collections.SortedList.
Return Value: A synchronized (thread-safe) wrapper for the System.Collections.SortedList.
To guarantee the thread safety of the System.Collections.SortedList, all operations must be done through this wrapper only. The System.Collections.SortedList to synchronize.
IEnumerable.GetEnumerator
TrimToSize
Sets the capacity to the actual number of elements in the System.Collections.SortedList.
This method can be used to minimize a list's memory overhead if no new elements will be added to the list.
Stack class (System.Collections)
TrimToSize
Description
Represents a simple last-in-first-out collection of objects. System.Collections.Stack is implemented as a circular buffer.
Stack
Example Syntax:
TrimToSize
Initializes a new instance of the System.Collections.Stack class that is empty and has the default initial capacity.
The initial capacity is the starting capacity of the new System.Collections.Stack. The default initial capacity for a System.Collections.Stack is 10.
Stack
Example Syntax:
TrimToSize
Initializes a new instance of the System.Collections.Stack class that contains elements copied from the specified collection and has the same initial capacity as the number of elements copied.
The initial capacity is the starting capacity of the new System.Collections.Stack. If the number of elements added to the stack reaches the current capacity, the capacity is automatically doubled. The System.Collections.ICollection to copy elements from.
Stack
Example Syntax:
TrimToSize
Initializes a new instance of the System.Collections.Stack class that is empty and has the specified initial capacity or the default initial capacity, whichever is greater.
The initial capacity is the starting capacity of the new System.Collections.Stack. The default initial capacity for a System.Collections.Stack is 10. The initial number of elements that the System.Collections.Stack can contain.
Count
TrimToSize
Gets the number of elements contained in the System.Collections.Stack.
IsSynchronized
TrimToSize
Gets a value indicating whether access to the System.Collections.Stack is synchronized (thread-safe).
To guarantee the thread safety of the System.Collections.Stack, all operations must be done through the wrapper returned by the System.Collections.Stack.Synchronized(System.Collections.Stack) method.
SyncRoot
TrimToSize
Gets an object that can be used to synchronize access to the System.Collections.Stack.
To create a synchronized version of the System.Collections.Stack, use the System.Collections.Stack.Synchronized(System.Collections.Stack) method. However, derived classes can provide their own synchronized version of the System.Collections.Stack using the System.Collections.Stack.SyncRoot property. The synchronizing code must perform operations on the System.Collections.Stack.SyncRoot of the System.Collections.Stack, not directly on the System.Collections.Stack. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the System.Collections.Stack object.
Clear
Removes all objects from the System.Collections.Stack.
System.Collections.Stack.Count is set to zero.
Clone
Creates a shallow copy of the System.Collections.Stack.
Return Value: A shallow copy of the System.Collections.Stack.
A shallow copy of a collection is a new collection containing references to the same elements as the original collection. The elements themselves or anything referenced by the elements are not copied. In contrast, a deep copy of a collection copies the elements and everything directly or indirectly referenced by the elements.
Contains
Determines whether an element is in the System.Collections.Stack
Return Value: true if obj is found in the System.Collections.Stack; otherwise, false.
This method performs a linear search; therefore, the average execution time is proportional to System.Collections.Stack.Count. That is, this method is an O(n) operation, where n is System.Collections.Stack.Count. The System.Object to locate in the System.Collections.Stack. The element to locate can be null.
CopyTo
Copies the System.Collections.Stack to an existing one-dimensional System.Array, starting at the specified array index.
The elements are copied onto the array in a last-in-first-out order, similar to the order of the elements returned by a succession of calls to System.Collections.Stack.Pop. The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Stack. The System.Array must have zero-based indexing. The zero-based index in array at which copying begins.
GetEnumerator
Returns an System.Collections.IEnumerator for the System.Collections.Stack.
Return Value: An System.Collections.IEnumerator for the System.Collections.Stack.
Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.
Peek
Returns the object at the top of the System.Collections.Stack without removing it.
Return Value: The System.Object at the top of the System.Collections.Stack.
null can be pushed onto the System.Collections.Stack as a placeholder, if needed. To distinguish between a null value and the end of the stack, check the System.Collections.Stack.Count property or catch the System.InvalidOperationException, which is thrown when the Is System.Collections.Stack is empty.
Pop
Removes and returns the object at the top of the System.Collections.Stack
Return Value: The System.Object removed from the top of the System.Collections.Stack.
System.Collections.Stack is implemented as a circular buffer.
Push
Inserts an object at the top of the System.Collections.Stack. System.Collections.Stack is implemented as a circular buffer. The System.Object to push onto the System.Collections.Stack.
Returns a synchronized (thread-safe) wrapper for the System.Collections.Stack.
Return Value: A synchronized wrapper around the System.Collections.Stack.
To guarantee the thread safety of the System.Collections.Stack, all operations must be done through this wrapper. The System.Collections.Stack to synchronize.
ToArray
Copies the System.Collections.Stack to a new array.
Return Value: A new array containing copies of the elements of the System.Collections.Stack.
The elements are copied onto the array in a last-in-first-out order, similar to the order
System.Collections.Specialized
The namespace contains specialized and strongly-typed collections; for example, a linked list dictionary, a bit vector and collections that contain only strings.
Description
The System.Collections.Specialized namespace contains specialized and strongly-typed collections; for example, a linked list dictionary, a bit vector and collections that contain only strings. BitVector32 structure (System.Collections.Specialized)
Description
Provides a simple structure that stores Boolean values and small integers in 32 bits of memory.
System.Collections.Specialized.BitVector32 is more efficient than System.Collections.BitArray for Boolean values and small integers that are used internally.
Constructors:
BitVector32
Example Syntax:
Initializes a new instance of the System.Collections.Specialized.BitVector32 structure containing the data represented in an existing System.Collections.Specialized.BitVector32 structure. A System.Collections.Specialized.BitVector32 structure that contains the data to copy.
BitVector32
Example Syntax:
Initializes a new instance of the System.Collections.Specialized.BitVector32 structure containing the data represented in an integer. An integer representing the data of the new System.Collections.Specialized.BitVector32.
Properties:
Data
Gets the value of the System.Collections.Specialized.BitVector32 as an integer.
To access the value of the individual sections or bit flags, use the System.Collections.Specialized.BitVector32.Item(System.Int32) property. Item
Gets or sets the value stored in the specified System.Collections.Specialized.BitVector32.Section.
System.Collections.Specialized.BitVector32.Item(System.Int32)
Item
Gets or sets the state of the bit flag indicated by the specified mask.
System.Collections.Specialized.BitVector32.Item(System.Int32) [Section] property is the indexer for a System.Collections.Specialized.BitVector32 that is set up as sections, and System.Collections.Specialized.BitVector32.Item(System.Int32) [int] property is the indexer for a System.Collections.Specialized.BitVector32 that is set up as bit flags. A mask that indicates the bit to get or set.
Methods:
CreateMask
Creates the first mask in a series of masks that can be used to access individual bits in a System.Collections.Specialized.BitVector32 that is set up as bit flags.
Return Value: A mask that isolates the first bit flag in the System.Collections.Specialized.BitVector32.
Use CreateMask( ) to create the first mask in a series and CreateMask(int) for all subsequent masks.
CreateMask
Creates the mask following the specified mask in a series of masks that can be used to access individual bits in a System.Collections.Specialized.BitVector32 that is set up as bit flags.
Return Value: A mask that isolates the bit flag following the one that previous points to in System.Collections.Specialized.BitVector32.
Use CreateMask( ) to create the first mask in a series and CreateMask(int) for all subsequent masks. The mask that indicates the previous bit flag.
CreateSection
Creates the first System.Collections.Specialized.BitVector32.Section in a series of sections that contain small integers.
Return Value: A System.Collections.Specialized.BitVector32.Section that can hold a number from zero to maxValue.
A System.Collections.Specialized.BitVector32.Section is a window into the System.Collections.Specialized.BitVector32 and is composed of the smallest number of consecutive bits that can contain the maximum value specified in Sytem.Collections.Specialized.BitVector32.CreateSection(System.Int16). For example, a section with a maximum value of 1 is composed of only one bit, whereas a section with a maximum value of 5 is composed of three bits. You can create a System.Collections.Specialized.BitVector32.Section with a maximum value of 1 to serve as a Boolean, thereby allowing you to store integers and Booleans in the same System.Collections.Specialized.BitVector32. A 16-bit signed integer that specifies the maximum value for the new System.Collections.Specialized.BitVector32.Section.
CreateSection
Creates a new System.Collections.Specialized.BitVector32.Section following the specified System.Collections.Specialized.BitVector32.Section in a series of sections that contain small integers.
Return Value: A System.Collections.Specialized.BitVector32.Section that can hold a number from zero to maxValue.
A System.Collections.Specialized.BitVector32.Section is a window into the System.Collections.Specialized.BitVector32 and is composed of the smallest number of consecutive bits that can contain the maximum value specified in System.Collections.Specialized.BitVector32.CreateSection(System.Int16). For example, a section with a maximum value of 1 is composed of only one bit, whereas a section with a maximum value of 5 is composed of three bits. You can create a System.Collections.Specialized.BitVector32.Section with a maximum value of 1 to serve as a Boolean, thereby allowing you to store integers and Booleans in the same System.Collections.Specialized.BitVector32. A 16-bit signed integer that specifies the maximum value for the new System.Collections.Specialized.BitVector32.Section. The previous System.Collections.Specialized.BitVector32.Section in the System.Collections.Specialized.BitVector32.
Equals
Determines whether the specified object is equal to the System.Collections.Specialized.BitVector32.
Return Value: true if the specified System.Object is equal to the System.Collections.Specialized.BitVector32; otherwise, false.
The object o is considered equal to the System.Collections.Specialized.BitVector32 if the type of o is compatible with the System.Collections.Specialized.BitVector32 type and if the value of o is equal to the value of System.Collections.Specialized.BitVector32.Data. The System.Object to compare with the current System.Collections.Specialized.BitVector32.
GetHashCode
Serves as a hash function for the System.Collections.Specialized.BitVector32.
Return Value: A hash code for the System.Collections.Specialized.BitVector32.
The hash code of a System.Collections.Specialized.BitVector32 is based on the value of System.Collections.Specialized.BitVector32.Data. Two instances of System.Collections.Specialized.BitVector32 with the same value for System.Collections.Specialized.BitVector32.Data will also generate the same hash code.
ToString
ToString
CollectionsUtil class (System.Collections.Specialized)
ToString
Description
Creates collections that ignore the case in strings.
These methods generate a case-insensitive instance of the collection using case-insensitive implementations of the hash code provider and the comparer. The resulting instance can be used like any other instances of that class, although it may behave differently.
CollectionsUtil
Example Syntax:
ToString
CreateCaseInsensitiveHashtable
Creates a new case-insensitive instance of the System.Collections.Hashtable class with the default initial capacity.
Return Value: A new case-insensitive instance of the System.Collections.Hashtable class with the default initial capacity.
The new System.Collections.Hashtable instance uses the default load factor, the System.Collections.CaselnsensitiveHashCodeProvider, and the System.Collections.CaseInsensitiveComparer
CreateCaseInsensitiveHashtable
Copies the entries from the specified dictionary to a new case-insensitive instance of the System.Collections.Hashtable class with the same initial capacity as the number of entries copied.
Return Value: A new case-insensitive instance of the System.Collections.Hashtable class containing the entries from the specified System.Collections.IDictionary.
The new System.Collections.Hashtable instance uses the default load factor, the System.Collections.CaselnsensitiveHashCodeProvider, and the System.Collections.CaseInsensitiveComparer. The System.Collections.IDictionary to copy to a new case-insensitive System.Collections.Hashtable.
CreateCaseInsensitiveHashtable
Creates a new case-insensitive instance of the System.Collections.Hashtable class with the specified initial capacity.
Return Value: A new case-insensitive instance of the System.Collections.Hashtable class with the specified initial capacity.
The new System.Collections.Hashtable instance uses the default load factor, the System.Collections.CaselnsensitiveHashCodeProvider, and the System.Collections.CaseInsensitiveComparer. The approximate number of entries that the System.Collections.Hashtable can initially contain.
CreateCaseInsensitiveSortedList
Creates a new instance of the System.Collections.SortedList class that ignores the case of strings.
Return Value: A new instance of the System.Collections.SortedList class that ignores the case of strings.
The new System.Collections.SortedList instance is sorted according to the System.Collections.CaseInsensitiveComparer.
HybridDictionary class (System.Collections.Specialized)
ToString
Description
Implements IDictionary by using a System.Collections.Specialized.ListDictionary while the collection is small, and then switching to a System.Collections.Hashtable when the collection gets large.
This class is recommended for cases where the number of elements in a dictionary is unknown. It takes advantage of the improved performance of a System.Collections.Specialized.ListDictionary with small collections, and offers the flexibility of switching to a System.Collections.Hashtable which handles larger collections better than System.Collections.Specialized.ListDictionary
HybridDictionary
Example Syntax:
ToString
Creates an empty case-sensitive System.Collections.Specialized.HybridDictionary.
By default, the collection is case-sensitive and uses the key's implementation of System.Object.GetHashCode as the hash code provider and the key's implementation of System.Object.Equals(System.Object) as the comparer.
HybridDictionary
Example Syntax:
ToString
Creates an empty System.Collections.Specialized.HybridDictionary with the specified case-sensitivity.
If caseInsensitive is false, the collection uses the key's implementations of System.Object.GetHashCode and System.Object.Equals(System.Object). If caseInsensitive is true, the collection uses the System.Collections.CaselnsensitiveHashCodeProvider and a private case-insensitive and culture-insensitive implementation of the System.Collections.IComparer interface that only converts the strings to the same case and compares the Unicode values of the characters. A Boolean that denotes whether the System.Collections.Specialized.HybridDictionary is case-insensitive.
HybridDictionary
Example Syntax:
ToString
Creates a case-sensitive System.Collections.Specialized.HybridDictionary with the specified initial size.
If the initial size of the collection is greater than the optimal size for a System.Collections.Specialized.ListDictionary, the collection is stored in a System.Collections.Hashtable right away to avoid the overhead of copying elements from the System.Collections.Specialized.ListDictionary to the System.Collections.Hashtable. The approximate number of entries that the System.Collections.Specialized.HybridDictionary can initially contain.
HybridDictionary
Example Syntax:
ToString
Creates a System.Collections.Specialized.HybridDictionary with the specified initial size and case-sensitivity.
If the initial size of the collection is greater than the optimal size for a System.Collections.Specialized.ListDictionary, the collection is stored in a System.Collections.Hashtable right away to avoid the overhead of copying elements from the System.Collections.Specialized.ListDictionary to the System.Collections.Hashtable. The approximate number of entries that the System.Collections.Specialized.HybridDictionary can initially contain. A Boolean that denotes whether the System.Collections.Specialized.HybridDictionary is case-insensitive.
Count
ToString
Gets the number of key-and-value pairs contained in the System.Collections.Specialized.HybridDictionary
IsFixedSize
ToString
Gets a value indicating whether the System.Collections.Specialized.HybridDictionary has a fixed size. System.Collections.Specialized.HybridDictionary implements the System.Collections.Specialized.HybridDictionary.IsFixedSize property because it is required by the interface.
IsReadOnly
ToString
Gets a value indicating whether the System.Collections.Specialized.HybridDictionary is read-only.
System.Collections.Specialized.HybridDictionary implements the System.Collections.Specialized.HybridDictionary.IsReadOnly property because it is required by the interface.
IsSynchronized
ToString
Gets a value indicating whether the System.Collections.Specialized.HybridDictionary is synchronized (thread-safe). System.Collections.Specialized.HybridDictionary implements the System.Collections.Specialized.HybridDictionary.IsSynchronized property because it is required by the interface.
Item
ToString
Gets or sets the value associated with the specified key.
This property provides the ability to access a specific element in the collection by using the following syntax: myCollection[key]. The key whose value to get or set.
Keys
ToString
Gets an System.Collections.ICollection containing the keys in the System.Collections.Specialized.HybridDictionary.
The order of the values in the System.Collections.ICollection is unspecified, but it is the same order as the associated values in the System.Collections.ICollection returned by the System.Collections.Specialized.HybridDictionary.Values method.
SyncRoot
Gets an object that can be used to synchronize access to the System.Collections.Specialized.HybridDictionary.
Derived classes can provide their own synchronized version of the System.Collections.Specialized.HybridDictionary using the System.Collections.Specialized.HybridDictionary.SyncRoot property. The synchronizing code must perform operations on the System.Collections.Specialized.HybridDictionary.SyncRoot of the System.Collections.Specialized.HybridDictionary, not directly on the System.Collections.Specialized.HybridDictionary. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the System.Collections.Specialized.HybridDictionary object.
Values
ToString
Gets an System.Collections.ICollection containing the values in the System.Collections.Specialized.HybridDictionary.
The order of the values in the System.Collections.ICollection is unspecified, but it is the same order as the associated keys in the System.Collections.ICollection returned by the System.Collections.Specialized.HybridDictionary.Keys method.
Add
Adds an entry with the specified key and value into the System.Collections.Specialized.HybridDictionary.
An object that has no correlation between its state and its hash code value should typically not be used as the key. For example, String objects are better than StringBuilder objects for use as keys. The key of the entry to add. The value of the entry to add.
Clear
Removes all entries from the System.Collections.Specialized.HybridDictionary. System.Collections.Specialized.HybridDictionary.Count is set to zero.
Contains
Determines whether the System.Collections.Specialized.HybridDictionary contains a specific key.
Return Value: true if the System.Collections.Specialized.HybridDictionary contains an entry with the specified key; otherwise, false.
This implementation is close to O(1) in most cases. The key to locate in the System.Collections.Specialized.HybridDictionary.
CopyTo
Copies the System.Collections.Specialized.HybridDictionary entries to a one-dimensional System.Array instance at the specified index.
The elements are copied to the System.Array in the same order in which the enumerator iterates through the System.Collections.Specialized.HybridDictionary. The one-dimensional System.Array that is the destination of the System.Collections.DictionaryEntry objects copied from System.Collections.Specialized.HybridDictionary. The System.Array must have zero-based indexing. The zero-based index in array at which copying begins.
GetEnumerator
Returns an enumerator that can iterate through the System.Collections.Specialized.HybridDictionary.
Return Value: An System.Collections.IDictionaryEnumerator for the System.Collections.Specialized.HybridDictionary.
Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.
Remove
Removes the entry with the specified key from the System.Collections.Specialized.HybridDictionary.
If the System.Collections.Specialized.HybridDictionary does not contain an element with the specified key, the System.Collections.Specialized.HybridDictionary remains unchanged. No exception is thrown. The key of the entry to remove.
IEnumerable.GetEnumerator
ToString
Description
Represents a collection of the System.String keys of a collection.
Count
ToString
Gets the number of keys in the System.Collections.Specialized.NameObjectCollecffonBase.KeysCollection
Item
ToString
Gets the entry at the specified index of the collection.
This property provides the ability to access a specific element in the collection by using the following syntax: myCollection[index] (In Visual Basic, myCollection(index)). The zero-based index of the entry to locate in the collection.
Get
Gets the key at the specified index of the collection.
Return Value: A System.String that contains the key at the specified index of the collection. The zero-based index of the key to get from the collection.
GetEnumerator
Returns an enumerator that can iterate through the System.Collections.Specialized.NamebiectCollectionBase.KeysCollection
Return Value: An System.Collections.IEnumerator for the ISystem.Collections.Specialized.NamebiectCollectionBase.KeysCollection
This enumerator returns the keys of the collection as strings.
ICollection.CopyTo
ListDictionary class (System.Collections.Specialized)
ToString
Description
Implements IDictionary using a singly linked list for collections that contain 10 items or less.
This is a simple implementation of System.Collections.IDictionary using a singly linked list. It is smaller and faster than a System.Collections.Hashtable if the number of elements is 10 or less. This should not be used if performance is important for large numbers of elements.
ListDictionary
Example Syntax:
ToString
Creates an empty System.Collections.Specialized.ListDictionary using the default comparer.
The comparer determines whether two keys are equal. Every key in a System.Collections.Specialized.ListDictionary must be unique. The default comparer is the key's implementation of System.Object.Equals(System.Object).
ListDictionary
Example Syntax:
ToString
Creates an empty System.Collections.Specialized.ListDictionary using the specified comparer.
The comparer determines whether two keys are equal. Every key in a System.Collections.Specialized.ListDictionary must be unique. The default comparer is the key's implementation of System.Object.Equals(System.Object). The System.Collections.IComparer to use to determine whether two keys are equal.
Count
ToString
Gets the number of key-and-value pairs contained in the System.Collections.Specialized.ListDictionary
IsFixedSize
ToString
Gets a value indicating whether the System.Collections.Specialized.ListDictionary has a fixed size.
System.Collections.Specialized.ListDictionary implements the System.Collections.Specialized.ListDictionary.IsFixedSize property because it is required by the interface.
IsReadOnly
ToString
Gets a value indicating whether the System.Collections.Specialized.ListDictionary is read-only.
System.Collections.Specialized.ListDictionary implements the System.Collections.Specialized.ListDictionary.IsReadOnly property because it is required by the interface.
IsSynchronized
ToString
Gets a value indicating whether the System.Collections.Specialized.ListDictionary is synchronized (thread-safe).
System.Collections.Specialized.ListDictionary implements the System.Collections.Specialized.ListDictionary.IsSynchronized property because it is required by the interface.
Item
ToString
Gets or sets the value associated with the specified key.
This property provides the ability to access a specific element in the collection by using the following syntax: myCollection[key]. The key whose value to get or set.
Keys
ToString
Gets an System.Collections.ICollection containing the keys in the System.Collections.Specialized.ListDictionary.
The order of the values in the System.Collections.ICollection is unspecified, but it is the same order as the associated values in the System.Collections.ICollection returned by the System.Collections.Specialized.ListDictionary.Values method.
SyncRoot
ToString
Gets an object that can be used to synchronize access to the System.Collections.Specialized.ListDictionary Derived classes can provide their own synchronized version of the System.Collections.Specialized.ListDictionary using the System.Collections.Specialized.ListDictionary.SyncRoot property. The synchronizing code must perform operations on the System.Collections.Specialized.ListDictionary.SyncRoot of the System.Collections.Specialized.ListDictionary,not directly on the System.Collections.Specialized.ListDictionary.This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the System.Collections.Specialized.ListDictionary object.
Values
ToString
Gets an System.Collections.ICollection containing the values in the System.Collections.Specialized.ListDictionary.
The order of the values in the System.Collections.ICollection is unspecified, but it is the same order as the associated keys in the System.Collections.ICollection returned by the System.Collections.Specialized.ListDictionary.Keys method.
Add
Adds an entry with the specified key and value into the System.Collections.Specialized.ListDictionary.
An object that has no correlation between its state and its hash code value should typically not be used as the key. For example, String objects are better than StringBuilder objects for use as keys. The key of the entry to add. The value of the entry to add.
Clear
Removes all entries from the System.Collections.Specialized.ListDictionary.
System.Collections.Specialized.ListDictionary.Count is set to zero.
Contains
Determines whether the System.Collections.Specialized.ListDictionary contains a specific key.
Return Value: true if the System.Collections.Specialized.ListDictionary contains an entry with the specified key; otherwise, false.
This implementation is close to O(1) in most cases. The key to locate in the System.Collections.Specialized.ListDictionary.
CopyTo
Copies the System.Collections.Specialized.ListDictionary entries to a one-dimensional System.Array instance at the specified index.
The elements are copied to the System.Array in the same order in which the enumerator iterates through the System.Collections.Specialized.ListDictionary. The one-dimensional System.Array that is the destination of the System.Collections.DictionaryEntry objects copied from System.Collections.Specialized.ListDictionary. The System.Array must have zero-based indexing. The zero-based index in array at which copying begins.
GetEnumerator
Returns an enumerator that can iterate through the System.Collections.Specialized.ListDictionary.
Return Value: An System.Collections.IDictionaryEnumerator for the System.Collections.Specialized.ListDictionary.
Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.
Remove
Removes the entry with the specified key from the System.Collections.Specialized.ListDictionary.
If the System.Collections.Specialized.ListDictionary does not contain an element with the specified key, the System.Collections.Specialized.ListDictionary remains unchanged. No exception is thrown. The key of the entry to remove.
IEnumerable.GetEnumerator
NameObjectCollectionBase class (System.Collections.Specialized)
ToString
Description
Provides the abstract base class for a sorted collection of associated System.String keys and System.Object values that can be accessed either with the key or with the index.
The underlying structure for this class is a hashtable.
NameObjectCollectionBase
Example Syntax:
ToString
Initializes a new instance of the System.Collections.Specialized.NameObjectCollectionBase class that is empty.
The capacity is the number of key-and-value pairs that the System.Collections.Specialized.NameObjectCollectionBase instance can contain. The default initial capacity is zero. The capacity is automatically increased as required.
NameObjectCollectionBase
Example Syntax:
ToString
Initializes a new instance of the System.Collections.Specialized.NameObjectCollectionBase class that is empty and has the specified initial capacity.
The capacity is the number of key-and-value pairs that the System.Collections.Specialized.NameObjectCollectionBase instance can contain. Specifying the initial capacity eliminates the need to perform a number of resizing operations while entries are added to the System.Collections.Specialized.NameObjectCollectionBase instance. The capacity is automatically increased as required. The approximate number of entries that the System.Collections.Specialized.NameObjectCollectionBase instance can initially contain.
NameObjectCollectionBase
Example Syntax:
ToString
Initializes a new instance of the System.Collections.Specialized.NameObjectCollectionBase class that is empty and uses the specified hash code provider and the specified comparer. The capacity is the number of key-and-value pairs that the System.Collections.Specialized.NameObjectCollectionBase instance can contain. The default initial capacity is zero. The capacity is automatically increased as required. The System.Collections.IHashCodeProvider that will supply the hash codes for all keys in the System.Collections.Specialized.NameObjectCollectionBase instance. The System.Collections.IComparer to use to determine whether two keys are equal.
NameObjectCollectionBase
Example Syntax:
ToString
Initializes a new instance of the System.Collections.Specialized.NameObjectCollectionBase class that is serializable and uses the specified System.Runtime.Serialization.SerializationInfo and System.Runtime.Serialization.StreamingContext. A System.Runtime.Serialization.SerializationInfo object that contains the information required to serialize the new System.Collections.Specialized.NameObjectCollectionBase instance. A System.Runtime.Serialization.StreamingContext object that contains the source and destination of the serialized stream associated with the new System.Collections.Specialized.NameObjectCollectionBase instance.
NameObjectCollectionBase
Example Syntax:
ToString
Initializes a new instance of the System.Collections.Specialized.NameObjectCollectionBase class that is empty, has the specified initial capacity and uses the specified case-insensitive hash code provider and the specified case-insensitive comparer.
The capacity is the number of key-and-value pairs that the System.Collections.Specialized.NameObjectCollectionBase instance can contain. Specifying the initial capacity eliminates the need to perform a number of resizing operations while entries are added to the System.Collections.Specialized.NameObjectCollectionBase instance. The capacity is automatically increased as required. The approximate number of entries that the System.Collections.Specialized.NameObjectCollectionBase instance can initially contain. The case-insensitive System.Collections.IHashCodeProvider that will supply the hash codes for all keys in the System.Collections.Specialized.NameObjectCollectionBase instance. The case-insensitive System.Collections.IComparer to use to determine whether two keys are equal.
Count
ToString
Gets the number of key-and-value pairs contained in the System.Collections.Specialized.NameObjectCollectionBase instance.
IsReadOnly
ToString
Gets or sets a value indicating whether the System.Collections.Specialized.NameObjectCollectionBase instance is read-only.
Keys
ToString
Gets a System.Collections.Specialized.NameObjectCollectionBase.KeysCollection instance that contains all the keys in the System.Collections.Specialized.NameObjectCollectionBase instance.
BaseAdd
Adds an entry with the specified key and value into the System.Collections.Specialized.NameObjectCollectionBase instance. The System.String key of the entry to add. The key can be null. The System.Object value of the entry to add. The value can be null.
BaseClear
Removes all entries from the System.Collections.Specialized.NameObjectCollectionBase instance.
System.Collections.Specialized.NameObjectCollectionBase.Count is set to zero.
BaseGet
Gets the value of the entry at the specified index of the System.Collections.Specialized.NameObjectCollectionBase instance.
Return Value: An System.Object that represents the value of the entry at the specified index. The zero-based index of the value to get.
BaseGet
Gets the value of the first entry with the specified key from the System.Collections.Specialized.NameObjectCollectionBase instance.
Return Value: An System.Object that represents the value of the first entry with the specified key, if found; otherwise, null.
If the collection contains multiple entries with the specified key, this method returns only the first entry. To get the values of subsequent entries with the same key, use the enumerator to iterate through the collection and compare the keys. The System.String key of the entry to get. The key can be null.
BaseGetAllKeys
Returns a System.String array that contains all the keys in the System.Collections.Specialized.NameObjectCollectionBase instance.
Return Value: A System.String array that contains all the keys in the System.Collections.Specialized.NameObjectCollectionBase instance.
BaseGetAllValues
Returns an System.Object array that contains all the values in the System.Collections.Specialized.NameObjectCollectionBase instance.
Return Value: An System.Object array that contains all the values in the System.Collections.Specialized.NameObjectCollectionBase instance.
BaseGetAllValues
Returns an array of the specified type that contains all the values in the System.Collections.Specialized.NameObjectCollectionBase instance.
Return Value: An array of the specified type that contains all the values in the System.Collections.Specialized.NameObjectCollectionBase instance. A System.Type that represents the type of array to return.
BaseGetKey
Gets the key of the entry at the specified index of the System.Collections.Specialized.NameObjectCollectionBase instance.
Return Value: A System.String that represents the key of the entry at the specified index. The zero-based index of the key to get.
BaseHasKeys
Gets a value indicating whether the System.Collections.Specialized.NameObjectCollectionBase instance contains entries whose keys are not null
Return Value: true if the System.Collections.Specialized.NameObjectCollectionBase instance contains entries whose keys are not null; otherwise, false.
BaseRemove
Removes the entries with the specified key from the System.Collections.Specialized.NameObjectCollectionBase instance.
In collections such as lists, queues and stacks, the elements that follow the removed element move up to occupy the vacated spot. The System.String key of the entries to remove. The key can be null.
BaseRemoveAt
Removes the entry at the specified index of the System.Collections.Specialized.NameObjectCollectionBase instance.
In collections such as lists, queues and stacks, the elements that follow the removed element move up to occupy the vacated spot. The zero-based index of the entry to remove.
BaseSet
Sets the value of the entry at the specified index of the System.Collections.Specialized.NameObjectCollectionBase instance. The zero-based index of the entry to set. The System.Object that represents the new value of the entry to set. The value can be null.
BaseSet
Sets the value of the first entry with the specified key in the System.Collections.Specialized.NameObjectCollectionBase instance, if found; otherwise, adds an entry with the specified key and value into the System.Collections.Specialized.NameObjectCollectionBase instance.
If the collection contains multiple entries with the specified key, this method sets only the first entry. To set the values of subsequent entries with the same key, use the enumerator to iterate through the collection and compare the keys. The System.String key of the entry to set. The key can be null. The System.Object that represents the new value of the entry to set. The value can be null.
GetEnumerator
Returns an enumerator that can iterate through the System.Collections.Specialized.NameObjectCollectionBase.
Return Value: An System.Collections.IEnumerator for the System.Collections.Specialized.NameObjectCollectionBase instance.
This enumerator returns the keys of the collection as strings.
GetObjectData
Implements the System.Runtime.Serialization.ISerializable interface and returns the data needed to serialize the System.Collections.Specialized.NameObjectCollectionBase instance. A System.Runtime.Serialization.SerializationInfo object that contains the information required to serialize the System.Collections.Specialized.NameObjectCollectionBase instance. A System.Runtime.Serialization.StreamingContext object that contains the source and destination of the serialized stream associated with the System.Collections.Specialized.NameObjectCollectionBase instance.
OnDeserialization
Implements the System.Runtime.Serialization.ISerializable interface and raises the deserialization event when the deserialization is complete. The source of the deserialization event.
ICollection.CopyTo
NameValueCollection class (System.Collections.Specialized)
ToString
Description
Represents a sorted collection of associated System.String keys and System.String values that can be accessed either with the key or with the index.
This collection is based on the System.Collections.Specialized.NameObjectCollectionBase class. However, unlike the System.Collections.Specialized.NameObjectCollectionBase, this class stores multiple string values under a single key.
NameValueCollection
Example Syntax:
ToString
Initializes a new instance of the System.Collections.Specialized.NameValueCollection class that is empty, has the default initial capacity and uses the default case-insensitive hash code provider and the default case-insensitive comparer.
The capacity is the number of key-and-value pairs that the System.Collections.Specialized.NameValueCollection can contain. The default initial capacity is zero. The capacity is automatically increased as required.
NameValueCollection
Example Syntax:
ToString
Initializes a new instance of the System.Collections.Specialized.NameValueCollection class that is empty, has the specified initial capacity and uses the default case-insensitive hash code provider and the default case-insensitive comparer.
The capacity is the number of key-and-value pairs that the System.Collections.Specialized.NameValueCollection can contain. The default initial capacity is zero. The capacity is automatically increased as required. The initial number of entries that the System.Collections.Specialized.NameValueCollection can contain.
NameValueCollection
Example Syntax:
ToString
Copies the entries from the specified System.Collections.Specialized.NameValueCollection to a new System.Collections.Specialized.NameValueCollection with the same initial capacity as the number of entries copied and using the same hash code provider and the same comparer as the source collection.
The capacity is the number of key-and-value pairs that the System.Collections.Specialized.NameValueCollection can contain. The default initial capacity is zero. The capacity is automatically increased as required. The System.Collections.Specialized.NameValueCollection to copy to the new System.Collections.Specialized.NameValueCollection instance.
NameValueCollection
Example Syntax:
ToString
Initializes a new instance of the System.Collections.Specialized.NameValueCollection class that is empty, has the default initial capacity and uses the specified hash code provider and the specified comparer.
The capacity is the number of key-and-value pairs that the System.Collections.Specialized.NameValueCollection can contain. The default initial capacity is zero. The capacity is automatically increased as required. The System.Collections.IHashCodeProvider that will supply the hash codes for all keys in the System.Collections.Specialized.NameValueCollection. The System.Collections.IComparer to use to determine whether two keys are equal.
NameValueCollection
Example Syntax:
ToString
Copies the entries from the specified System.Collections.Specialized.NameValueCollection to a new System.Collections.Specialized.NameValueCollection with the specified initial capacity or the same initial capacity as the number of entries copied, whichever is greater, and using the default case-insensitive hash code provider and the default case-insensitive comparer.
The capacity is the number of key-and-value pairs that the System.Collections.Specialized.NameValueCollection can contain. The default initial capacity is zero. The capacity is automatically increased as required. The initial number of entries that the System.Collections.Specialized.NameValueCollection can contain. The System.Collections.Specialized.NameValueCollection to copy to the new System.Collections.Specialized.NameValueCollection instance.
NameValueCollection
Example Syntax:
ToString
Initializes a new instance of the System.Collections.Specialized.NameValueCollection class that is serializable and uses the specified System.Runtime.Serialization.SerializationInfo and System.Runtime.Serialization.StreamingContext. A System.Runtime.Serialization.SerializationInfo object that contains the information required to serialize the new System.Collections.Specialized.NameValueCollection instance. A System.Runtime.Serialization.StrearningContext object that contains the source and destination of the serialized stream associated with the new System.Collections.Specialized.NameValueCollection instance.
NameValueCollection
Example Syntax:
ToString
Initializes a new instance of the System.Collections.Specialized.NameValueCollection class that is empty, has the specified initial capacity and uses the specified hash code provider and the specified comparer.
The capacity is the number of key-and-value pairs that the System.Collections.Specialized.NameValueCollection can contain. The default initial capacity is zero. The capacity is automatically increased as required. The initial number of entries that the System.Collections.Specialized.NameValueCollection can contain. The System.Collections.IHashCodeProvider that will supply the hash codes for all keys in the System.Collections.Specialized.NameValueCollection. The System.Collections.IComparer to use to determine whether two keys are equal.
AllKeys
ToString
Gets all the keys in the System.Collections.Specialized.NameValueCollection. If the collection is empty, this method returns an empty System.String array, not null.
Count
IsReadOnly
Item
ToString
Description
Gets the entry at the specified index of the System.Collections.Specialized.NameValueCollection.
This property provides the ability to access a specific element in the collection by using the following syntax: myCollection[index]. The zero-based index of the entry to locate in the collection.
Item
ToString
Gets or sets the entry with the specified key in the System.Collections.Specialized.NameValueCollection. This property provides the ability to access a specific element in the collection by using the following syntax: myCollection[name]. The System.String key of the entry to locate. The key can be null.
Keys
Add
Copies the entries in the specified System.Collections.Specialized.NameValueCollection to the current System.Collections.Specialized.NameValueCollection.
If a key in c already exists in the target System.Collections.Specialized.NameValueCollection instance, the associated value in c is added to the existing comma-separated list of values associated with the same key in the target System.Collections.Specialized.NameValueCollection instance. The System.Collections.Specialized.NameValueCollection to copy to the current System.Collections.Specialized.NameValueCollection.
Add
Adds an entry with the specified name and value to the System.Collections.Specialized.NameValueCollection.
If the specified key already exists in the target System.Collections.Specialized.NameValueCollection instance, the specified value is added to the existing comma-separated list of values associated with the same key in the target System.Collections.Specialized.NameValueCollection instance. The System.String key of the entry to add. The key can be null. The System.String value of the entry to add. The value can be null.
Clear
Invalidates the cached arrays and removes all entries from the System.Collections.Specialized.NameValueCollection. CopyTo
Copies the entire System.Collections.Specialized.NameValueCollection to a compatible one-dimensional System.Array, starting at the specified index of the target array.
The specified array must be of a compatible type. The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Specialized.NameValueCollection. The System.Array must have zero-based indexing. The zero-based index in dest at which copying begins.
Get
Gets the values at the specified index of the System.Collections.Specialized.NameValueCollection combined into one comma-separated list.
Return Value: A System.String that contains a comma-separated list of the values at the specified index of the System.Collections.Specialized.NameValueCollection, if found; otherwise, null. The zero-based index of the entry that contains the values to get from the collection.
Get
Gets the values associated with the specified key from the System.Collections.Specialized.NameValueCollection combined into one comma-separated list.
Return Value: A System.String that contains a comma-separated list of the values associated with the specified key from the System.Collections.Specialized.NameValueCollection, if found; otherwise, null. The System.String key of the entry that contains the values to get. The key can be null.
GetKey
Gets the key at the specified index of the System.Collections.Specialized.NameValueCollection
Return Value: A System.String that contains the key at the specified index of the System.Collections.Specialized.NameValueCollection, if found; otherwise, null. The zero-based index of the key to get from the collection.
GetValues
Gets the values at the specified index of the System.Collections.Specialized.NameValueCollection so Return Value: A System.String array that contains the values at the specified index of the System.Collections.Specialized.NameValueCollection, if found; otherwise, null. The zero-based index of the entry that contains the values to get from the collection.
GetValues
Gets the values associated with the specified key from the System.Collections.Specialized.NameValueCollection.
Return Value: A System.String array that contains the values associated with the specified key from the System.Collections.Specialized.NameValueCollection, if found; otherwise, null. The System.String key of the entry that contains the values to get. The key can be null.
HasKeys
Gets a value indicating whether the System.Collections.Specialized.NameValueCollection contains keys that are not null.
Return Value: true if the System.Collections.Specialized.NameValueCollection contains keys that are not null; otherwise, false.
InvalidateCachedArrays
Resets the cached arrays of the collection to null.
The arrays returned by System.Collections.Specialized.NameValueCollection.AllKeys are cached for better performance and are automatically refreshed when the collection changes. A derived class can invalidate the cached version by calling System.Collections.Specialized.NameValueCollection.InvalidateCachedArray s, thereby forcing the arrays to be recreated.
Remove
Removes the entries with the specified key from the System.Collections.Specialized.NameObjectCollectionBase instance.
In collections such as lists, queues and stacks, the elements that follow the removed element move up to occupy the vacated spot. The System.String key of the entry to remove. The key can be null.
Set
Sets the value of an entry in the System.Collections.Specialized.NameValueCollection.
If the specified key already exists in the collection, this method overwrites the existing values with the specified value. To add the new value to the existing list of values, use the System.Collections.Specialized.NameValueCollection.Add(System.Collections. Specialized.NameValueCollection) method. The System.String key of the entry to add the new value to. The key can be null. The System.Object that represents the new value to add to the specified entry. The value can be null.
BitVector32.Section structure (System.Collections.Specialized)
ToString
Description
Represents an section of the vector that can contain a integer number.
Use System.Collections.Specialized.BitVector32.CreateSection(System.Int16) to define a new section. A System.Collections.Specialized.BitVector32.Section is a window into the System.Collections.Specialized.BitVector32 and is composed of the smallest number of consecutive bits that can contain the maximum value specified in System.Collections.Specialized.BitVector32.CreateSection(System.Int16). For example, a section with a maximum value of 1 is composed of only one bit, whereas a section with a maximum value of 5 is composed of three bits. You can create a System.Collections.Specialized.BitVector32.Section with a maximum value of 1 to serve as a Boolean, thereby allowing you to store integers and Booleans in the same System.Collections.Specialized.BitVector32.
Mask
ToString
Offset
ToString
Equals
GetHashCode
ToString
ToString
StringCollection class (System.Collections.Specialized)
ToString
Description
Represents a collection of strings.
Duplicate strings are allowed in
System.Collections.Specialized.StringCollection
StringCollection
Example Syntax:
ToString
Count
ToString
Description
Gets the number of strings contained in the System.Collections.Specialized.StringCollection.
IsReadOnly
ToString
Gets a value indicating whether the System.Collections.Specialized.StringCollection is read-only. System.Collections.Specialized.StringCollection implements the System.Collections.Specialized.StringCollection.IsReadOnly property because it is required by the interface.
IsSynchronized
ToString
Gets a value indicating whether access to the System.Collections.Specialized.StringCollection is synchronized (thread-safe). System.Collections.Specialized.StringCollection implements the System.Collections.Specialized.StringCollection.IsSynchronized property because it is required by the interface.
Item
ToString
Gets or sets the element at the specified index.
This property provides the ability to access a specific element in the collection by using the following syntax: myCollection[index]. The zero-based index of the entry to get or set.
SyncRoot
ToString
Gets an object that can be used to synchronize access to the System.Collections.Specialized.StringCollection.
Derived classes can provide their own synchronized version of the System.Collections.Specialized.StringCollection using the System.Collections.Specialized.StringCollection.SyncRoot property. The synchronizing code must perform operations on the System.Collections.Specialized.StringCollection.SyncRoot of the System.Collections.Specialized.StringCollection, not directly on the System.Collections.Specialized.StringCollection. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the System.Collections.Specialized.StringCollection object.
Add
Adds a string to the end of the System.Collections.Specialized.StringCollection
Return Value: The zero-based index at which the new element is inserted.
Duplicate strings are allowed in
System.Collections.Specialized.StringCollection. The string to add to the end of the System.Collections.Specialized.StringCollection.
AddRange
Copies the elements of a string array to the end of the System.Collections.Specialized.StringCollection.
Duplicate strings are allowed in System.Collections.Specialized.StringCollection. An array of strings to add to the end of the System.Collections.Specialized.StringCollection.
Clear
Removes all the strings from the System.Collections.Specialized.StringCollection System.Collections.Specialized.StringCollection.Count is set to zero.
Contains
Determines whether the specified string is in the System.Collections.Specialized.StringCollection.
Return Value: true if value is found in the System.Collections.Specialized.StringCollection; otherwise, false.
The System.Collections.Specialized.StringCollection.Contains(System.String) method can confirm the existence of a string before performing further operations. The string to locate in the System.Collections.Specialized.StringCollection.
CopyTo
Copies the System.Collections.Specialized.StringCollection values to a compatible one-dimensional System.Array, starting at the specified index of the target array.
The specified array must be of a compatible type. The one-dimensional System.Array that is the destination of the values copied from System.Collections.Specialized.StringCollection. The System.Array must have zero-based indexing. The zero-based index in array at which copying begins.
GetEnumerator
Returns an enumerator that can iterate through the System.Collections.Specialized.StringCollection.
Return Value: An System.Collections.IEnumerator for the System.Collections.Specialized.StringCollection. Enumerators are intended to be used only to read data in the collection.
Enumerators cannot be used to modify the underlying collection.
IndexOf
Searches for the specified string and returns the zero-based index of the first occurrence within the System.Collections.Specialized.StringCollection.
Return Value: The zero-based index of the first occurrence of value in the System.Collections.Specialized.StringCollection, if found; otherwise, −1.
This method performs a linear search. On average, this is an O(n/2) operation, where n is System.Collections.Specialized.StringCollection.Count. The longest search is an O(n) operation, where n is System.Collections.Specialized.StringCollection.Count. The string to locate.
Insert
Inserts a string into the System.Collections.Specialized.StringCollection at the specified index.
Duplicate strings are allowed in System.Collections.Specialized.StringCollection. The zero-based index at which value is inserted. The string to insert.
Remove
Removes the first occurrence of a specific string from the System.Collections.Specialized.StringCollection.
Duplicate strings are allowed in System.Collections.Specialized.StringCollection. Only the first occurrence is removed. To remove all occurrences of the specified string, use RemoveAt(IndexOf(value)) repeatedly while System.Collections.Specialized.StringCollection.IndexOf(System.String) does not return−1. The string to remove from the System.Collections.Specialized.StringCollection.
RemoveAt
Removes the string at the specified index of the System.Collections.Specialized.StringCollection.
In collections such as lists, queues and stacks, the elements that follow the removed element move up to occupy the vacated spot. The zero-based index of the string to remove.
ICollection.CopyTo
IEnumerable.GetEnumerator
IList.Add
IList.Contains
IList.IndexOf
IList.Insert
IList.Remove
StringDictionary class (System.Collections. Specialized)
ToString
Description
Implements a hashtable with the key strongly typed to be a string rather than an object.
The key is handled in a case-insensitive manner; it will be translated to lower case before it is used with the string dictionary.
StringDictionary
Example Syntax:
ToString
Initializes a new instance of the System.Collections.Specialized.StringDictionary class.
Count
ToString
Gets the number of key-and-value pairs in the System.Collections.Specialized.StringDictionary.
IsSynchronized
ToString
Indicates whether access to the System.Collections.Specialized.StringDictionary is synchronized (thread-safe). This property is read-only.
Item
ToString
Gets or sets the value associated with the specified key.
The key is handled in a case-insensitive manner; it will be translated to lower case before it is used. The key whose value to get or set.
Keys
ToString
Gets a collection of keys in the System.Collections.Specialized.StringDictionary
The order of the keys in the System.Collections.ICollection is unspecified, but it is the same order as the associated values in the System.Collections.ICollection returned by the System.Collections.Specialized.StringDictionary.Values method.
SyncRoot
ToString
Gets an object that can be used to synchronize access to the System.Collections.Specialized.StringDictionary
Values
ToString
Gets a collection of values in the System.Collections.Specialized.StringDictionary.
The order of the values in the System.Collections.ICollection is unspecified, but it is the same order as the associated keys in the System.Collections.ICollection returned by the System.Collections.Specialized.StringDictionary.Keys method.
Add
Adds an entry with the specified key and value into the System.Collections.Specialized.StringDictionary.
The key is handled in a case-insensitive manner; it will be translated to lower case before it is added to the string dictionary. The key of the entry to add. The value of the entry to add.
Clear
Removes all entries from the System.Collections.Specialized.StringDictionary.
ContainsKey
Determines if the string dictionary contains a specific key
Return Value: true if the System.Collections.Specialized.StringDictionary contains an entry with the specified key; otherwise, false.
This implementation is an O(1) operation. The key to locate in the System.Collections.Specialized.StringDictionary.
ContainsValue
Determines if the System.Collections.Specialized.StringDictionary contains a specific value.
Return Value: true if the System.Collections.Specialized.StringDictionary contains an element with the specified value; otherwise, false.
The values of the elements of the StringDictionary are compared to the specified value using the System.Object.Equals(System.Object) method. The value to locate in the System.Collections.Specialized.StringDictionary.
CopyTo
Copies the string dictionary values to a one-dimensional System.Array instance at the specified index.
System.Collections.Specialized.StringDictionary.CopyTo(System.Array, System.Int32) only copies the values in the StringDictionary, not the keys. The one-dimensional System.Array that is the destination of the values copied from the System.Collections.Specialized.StringDictionary. The index in the array where copying begins.
GetEnumerator
Returns an enumerator that can iterate through the string dictionary.
Return Value: An System.Collections.IEnumerator that can iterate through the string dictionary.
The enumerator does not have exclusive access to the System.Collections.Specialized.StringDictionary; therefore, any changes made to the System.Collections.Specialized.StringDictionary can cause System.Collections.IEnumerator.Current or System.Collections.IEnumerator.MoveNext to throw an exception.
Remove
Removes the entry with the specified key from the string dictionary.
The key is handled in a case-insensitive manner; it will be translated to lower case before it is used to find the entry to remove from the string dictionary. The key of the entry to remove.
StringEnumerator class (System.Collections.Specialized) ToString
Description
Supports a simple iteration over a System.Collections.Specialized.StringCollection.
Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.
Current
ToString
Gets the current element in the collection.
After an enumerator is created or after a System.Collections.Specialized.StringEnumerator.Reset, System.Collections.Specialized.StringEnumerator.MoveNext must be called to advance the enumerator to the first element of the collection before reading the value of System.Collections.Specialized.StringEnumerator.Current; otherwise, System.Collections.Specialized.StringEnumerator.Current is undefined.
MoveNext
Advances the enumerator to the next element of the collection.
Return Value: true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.
After an enumerator is created or after a call to System.Collections.Specialized.StringEnumerator.Reset, an enumerator is positioned before the first element of the collection, and the first call to System.Collections.Specialized.StringEnumerator.MoveNext moves the enumerator over the first element of the collection.
Reset
System.Globalization Namespace
The System.Globalization namespace contains classes that define culture-related information, such as the language, the country/region, the calendars in use, the format patterns for dates, currency and numbers, and the sort order for strings.
The .NET Framework is introducing a distinction to the globalization world. The concept that was previously referred to as “Locale” has been split apart into two separate types that allows much more flexibility. The Locale concept is represented as two different types in the .NET world: CultureInfo and RegionInfo. CultureInfo represents information about the users' culture, what language they specify, how they prefer numbers formatted, what calendar they use, etc. The RegionInfo class represents information about where a person physically is, what currency symbol they use, if they use metric or not, etc.
The following is a more detailed description of the System.Globalization namespace, identifying various classes, interfaces, enumerations, and so forth contained in the System.Globalization namespace.
System.Globalization
The namespace contains classes that define culture-related information, including the language, the country/region, the calendars in use, the format patterns for dates, currency and numbers, and the sort order for strings.
Description
The System.Globalization namespace contains classes that define culture-related information, including the language, the country/region, the calendars in use, the format patterns for dates, currency and numbers, and the sort order for strings.
Calendar class (System.Globalization)
Description
Represents time in divisions, such as weeks, months, and years.
A calendar divides time into measures, such as weeks, months, and years. The number, length, and start of the divisions vary in each calendar.
Represents the current era for the current calendar.
Constructors:
Calendar
Example Syntax:
Initializes a new instance of the System.Globalization.Calendar class.
Properties:
Eras
When implemented by a derived class, gets the list of eras in the current calendar.
TwoDigitYearMax
Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.
This property allows a 2-digit year to be properly translated to a 4-digit year. For example, if this property is set to 2029, the 100-year range is from 1930 to 2029; therefore, a 2-digit value of 30 is interpreted as 1930, while a 2-digit value of 29 is interpreted as 2029.
Methods:
AddDays
Returns a System.DateTime that is the specified number of days away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of days to the specified System.DateTime.
The days value is rounded to the nearest millisecond before it is added to the specified System.DateTime. If days is negative, the resulting System.DateTime would be earlier than the specified System.DateTime. The System.DateTime instance to add. The number of days to add.
AddHours
Returns a System.DateTime that is the specified number of hours away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of hours to the specified System.DateTime.
The hours value is rounded to the nearest millisecond before it is added to the specified System.DateTime. If hours is negative, the resulting System.DateTime would be earlier than the specified System.DateTime. The System.DateTime instance to add. The number of hours to add.
AddMilliseconds
Returns a System.DateTime that is the specified number of milliseconds away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of milliseconds to the specified System.DateTime.
The milliseconds value is rounded to the nearest integer before it is added to the specified System.DateTime. If milliseconds is negative, the resulting System.DateTime would be earlier than the specified System.DateTime. The System.DateTime instance to add. The number of milliseconds to add.
AddMinutes
Returns a System.DateTime that is the specified number of minutes away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of minutes to the specified System.DateTime.
The minutes value is rounded to the nearest millisecond before it is added to the specified System.DateTime. If minutes is negative, the resulting System.DateTime would be earlier than the specified System.DateTime. The System.DateTime instance to add. The number of minutes to add.
AddMonths
When implemented by a derived class, returns a System.DateTime that is the specified number of months away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of months to the specified System.DateTime.
The year part of the resulting System.DateTime is affected if the resulting month is beyond the last month of the current year. The day part of the resulting System.DateTime is also affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting System.DateTime remains the same as the specified System.DateTime. The System.DateTime instance to add. The number of months to add.
AddSeconds
Returns a System.DateTime that is the specified number of seconds away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of seconds to the specified System.DateTime.
The value parameter is rounded to the nearest millisecond before it is added to the specified System.DateTime. If value is negative, the resulting System.DateTime would be earlier than the specified System.DateTime. The System.DateTime instance to add. The number of seconds to add.
AddWeeks
Returns a System.DateTime that is the specified number of weeks away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of weeks to the specified System.DateTime.
If weeks is negative, the resulting System.DateTime would be earlier than the specified System.DateTime. The System.DateTime instance to add. The number of weeks to add.
AddYears
When implemented by a derived class, returns a System.DateTime that is the specified number of years away from the specified System.DateTime
Return Value: The System.DateTime that results from adding the specified number of years to the specified System.DateTime.
The day part of the resulting System.DateTime is affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting System.DateTime remains the same as the specified System.DateTime. The System.DateTime instance to add. The number of years to add.
GetDayOfMonth
When implemented by a derived class, gets the day of the month in the specified System.DateTime.
Return Value: An integer that represents the day of the month in time. The System.DateTime instance to read.
GetDayOfWeek
When implemented by a derived class, gets the day of the week in the specified System.DateTime.
Return Value: A System.DayOfWeek value that represents the day of the week in time.
The System.DayOfWeek values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. The System.DateTime instance to read.
GetDayOfYear
When implemented by a derived class, gets the day of the year in the specified System.DateTime.
Return Value: An integer that represents the day of the year in time. The System.DateTime instance to read.
GetDaysInMonth
Gets the number of days in the month specified by the year and month parameters.
Return Value: The number of days in the specified month in the specified year in the current era.
For example, in the Gregorian calendar, this method might return 28 or 29 for February (month=2), depending on whether year is a leap year. An integer that represents the year. An integer that represents the month.
GetDaysInMonth
When implemented by a derived class, gets the number of days in the month specified by the year, month, and era parameters.
Return Value: The number of days in the specified month in the specified year in the specified era.
For example, in the Gregorian calendar, this method might return 28 or 29 for February (month=2), depending on whether year is a leap year. An integer that represents the year. An integer that represents the month. An integer that represents the era.
GetDaysInYear
Gets the number of days in the year specified by the year parameter.
Return Value: The number of days in the specified year in the current era.
For example, in the Gregorian calendar, this method might return 365 or 366, depending on whether year is a leap year. An integer that represents the year.
GetDaysInYear
When implemented by a derived class, gets the number of days in the year specified by the year and era parameters.
Return Value: The number of days in the specified year in the specified era.
For example, in the Gregorian calendar, this method might return 365 or 366, depending on whether year is a leap year. An integer that represents the year. An integer that represents the era.
GetEra
When implemented by a derived class, gets the era in the specified System.DateTime instance.
Return Value: An integer that represents the era in time. The System.DateTime instance to read.
GetHour
Gets the hours value in the specified System.DateTime.
Return Value: An integer from 0 to 23 that represents the hour in time. The System.DateTime instance to read.
GetMilliseconds
Gets the milliseconds value in the specified System.DateTime.
Return Value: An integer that represents the milliseconds in time.
The returned value is an integer from 0 to 999. The System.DateTime instance to read.
GetMinute
Gets the minutes value in the specified System.DateTime.
Return Value: An integer that represents the minutes in time.
The returned value is an integer from 0 to 59. The System.DateTime instance to read.
GetMonth
When implemented by a derived class, gets the month in the specified System.DateTime.
Return Value: An integer that represents the month in time. The System.DateTime instance to read.
GetMonthsInYear
Gets the number of months in the year specified by the year parameter.
Return Value: The number of months in the specified year in the current era. An integer that represents the year.
GetMonthsInYear
When implemented by a derived class, gets the number of months in the year specified by the year and era parameters.
Return Value: The number of months in the specified year in the specified era. An integer that represents the year. An integer that represents the era.
GetSecond
Gets the seconds value in the specified System.DateTime
Return Value: An integer that represents the seconds in time.
The returned value is an integer from 0 to 59. The System.DateTime instance to read.
GetWeekOfYear
Gets the week of the year that includes the date in the specified System.DateTime
Return Value: An integer that represents the week of the year that includes the date in time.
System.Globalization.DateTimeFormatInfo.FirstDayOfWeek of System.Globalization.CultureInfo.DateTimeFormat contains the default System.DayOfWeek value that represents the first day of the week for a specific culture. The System.DateTime instance to read. A System.Globalization.CalendarWeekRule value that defines a calendar week. A System.DayOfWeek value that represents the first day of the week.
GetYear
When implemented by a derived class, gets the year in the specified System.DateTime.
Return Value: An integer that represents the year in time. The System.DateTime instance to read.
IsLeapDay
Determines whether the date specified by the year, month, and day parameters is a leap day.
Return Value: true if the specified day is a leap day; otherwise, false.
A leap year has a different number of days than a standard calendar year, in order to make up for the difference between the calendar year and the actual time that the earth rotates around the sun. Each System.Globalization.Calendar implementation defines leap years differently. An integer that represents the year. An integer that represents the month. An integer that represents the day.
IsLeapDay
When implemented by a derived class, determines whether the date specified by the year, month, day, and era parameters is a leap day.
Return Value: true if the specified day is a leap day; otherwise, false. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the era.
IsLeapMonth
Determines whether the month specified by the year and month parameters is a leap month.
Return Value: true if the specified month is a leap month; otherwise, false.
A leap year has a different number of days than a standard calendar year, in order to make up for the difference between the calendar year and the actual time that the earth rotates around the sun. Each System.Globalization.Calendar implementation defines leap years differently. An integer that represents the year. An integer that represents the month.
IsLeapMonth
When implemented by a derived class, determines whether the month specified by the year, month, and era parameters is a leap month.
Return Value: true if the specified month is a leap month; otherwise, false. An integer that represents the year. An integer that represents the month. An integer that represents the era.
IsLeapYear
Determines whether the year specified by the year parameter is a leap year.
Return Value: true if the specified year is a leap year; otherwise, false.
A leap year has a different number of days than a standard calendar year, in order to make up for the difference between the calendar year and the actual time that the earth rotates around the sun. Each System.Globalization.Calendar implementation defines leap years differently. An integer that represents the year.
IsLeapYear
When implemented by a derived class, determines whether the year specified by the year and era parameters is a leap year.
Return Value: true if the specified year is a leap year; otherwise, false. An integer that represents the year. An integer that represents the era.
ToDateTime
Returns a System.DateTime that is set to the specified date and time in the current era.
Return Value: The System.DateTime instance set to the specified date and time in the current era. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the hour. An integer that represents the minute. An integer that represents the second. An integer that represents the millisecond.
ToDateTime
When implemented by a derived class, returns a System.DateTime that is set to the specified date and time in the specified era.
Return Value: The System.DateTime instance set to the specified date and time in the current era. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the hour. An integer that represents the minute. An integer that represents the second. An integer that represents the millisecond. An integer that represents the era.
ToFourDigitYear
Converts the specified two-digit year to a four-digit year by using the System.Globalization.Calendar.TwoDigitYearMax property to determine the appropriate century.
Return Value: An integer that contains the four-digit representation of year.
System.Globalization.Calendar.TwoDigitYearMax is the last year in the 100-year range that can be represented by a two-digit year. The century is determined by finding the sole occurrence of the two-digit year within that 100-year range. For example, if System.Globalization.Calendar.TwoDigitYearMax is set to 2029, the 100-year range is from 1930 to 2029; therefore, a 2-digit value of 30 is interpreted as 1930, while a 2-digit value of 29 is interpreted as 2029. A two-digit integer that represents the year to convert.
CalendarWeekRule enumeration (System.Globalization)
ToString
Description
Defines different rules for determining the first week of the year.
These calendar week rules depend on the System.DayOfWeek value that is designated as the first day of the week. The System.Globalization.DateTimeFormatInfo.FirstDayOfWeek property provides the default value for a culture, but any System.DayOfWeek value can be specified as the first day of the week in System.Globalization.Calendar.GetWeekOfYear(System.DateTime,System.Globalization. CalendarWeekRule,System.DayOfWeek).
ToString
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.
ToString
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.
ToString
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.
CompareInfo class (System.Globalization)
ToString
Description
Implements a set of methods for culture-sensitive string comparisons.
The System.Globalization.CultureInfo class includes a System.Globalization.CultureInfo.CompareInfo property that is an instance of this class.
LCID
ToString
Gets the properly formed culture identifier for the current System.Globalization.CompareInfo instance.
Compare
Compares two strings using the default System.Globalization.CompareOptions value.
Return Value: Value Condition zero The two strings are equal. The first string to compare. The second string to compare.
Compare
Compares two strings using the specified System.Globalization.CompareOptions value.
Return Value: Value Condition zero The two strings are equal. The first string to compare. The second string to compare. The System.Globalization.CompareOptions value that defines how the strings should be compared.
Compare
Compares the tail section of a string with the tail section of another string.
Return Value: Value Condition zero The two strings are equal. The first string to compare. The zero-based index of the character in string1 at which to start comparing. The second string to compare. The zero-based index of the character in string2 at which to start comparing.
Compare
Compares the tail section of a string with the tail section of another string using the specified System.Globalization.CompareOptions value.
Return Value: Value Condition zero The two strings are equal. The first string to compare. The zero-based index of the character in string1 at which to start comparing. The second string to compare. The zero-based index of the character in string2 at which to start comparing. The System.Globalization.CompareOptions value that defines how the strings should be compared.
Compare
Compares a section of one string with a section of another string.
Return Value: Value Condition zero The two strings are equal. The first string to compare. The zero-based index of the character in string1 at which to start comparing. The number of consecutive characters in string1 to compare. The second string to compare. The zero-based index of the character in string2 at which to start comparing. The number of consecutive characters in string2 to compare.
Compare
Compares a section of one string with a section of another string using the specified System.Globalization.CompareOptions value.
Return Value: Value Condition zero The two strings are equal. The first string to compare. The zero-based index of the character in string1 at which to start comparing. The number of consecutive characters in string1 to compare. The second string to compare. The zero-based index of the character in string2 at which to start comparing. The number of consecutive characters in string2 to compare. The System.Globalization.CompareOptions value that defines how the strings should be compared.
Equals
Determines whether the specified System.Object is the same instance as the current System.Globalization.CompareInfo.
Return Value: true if the specified System.Object is the same instance as the current System.Globalization.CompareInfo; otherwise, false.
This method overrides System.Object.Equals(System.Object). The System.Object to compare with the current System.Globalization.CompareInfo.
GetCompareInfo
Initializes a new instance of the System.Globalization.CompareInfo class that is associated with the culture having the specified identifier.
Return Value: A new instance of the System.Globalization.CompareInfo class that is associated with the culture having the specified identifier and uses string comparison methods in the current System.Reflection.Assembly. An integer representing the culture identifier.
GetCompareInfo
Initializes a new instance of the System.Globalization.CompareInfo class that is associated with the culture having the specified name.
Return Value: A new instance of the System.Globalization.CompareInfo class that is associated with the culture having the specified name and uses string comparison methods in the current System.Reflection.Assembly. A System.String representing the culture name.
GetCompareInfo
Initializes a new instance of the System.Globalization.CompareInfo class that is associated with the culture having the specified identifier and uses string comparison methods in the specified System.Reflection.Assembly.
Return Value: A new instance of the System.Globalization.CompareInfo class that is associated with the specified culture and uses string comparison methods in the specified System.Reflection.Assembly.
The assembly parameter must be of the same type as System.Reflection.Module.Assembly. An integer representing the culture identifier. An System.Reflection.Assembly that contains the string comparison methods to use.
GetCompareInfo
Initializes a new instance of the System.Globalization.CompareInfo class that is associated with the culture having the specified name and uses string comparison methods in the specified System.Reflection.Assembly.
Return Value: A new instance of the System.Globalization.CompareInfo class that is associated with the culture having the specified name and uses string comparison methods in the specified System.Reflection.Assembly.
The assembly parameter must be of the same type as System.Reflection.Module.Assembly. A System.String representing the culture name. An System.Reflection.Assembly that contains the string comparison methods to use.
GetHashCode
Serves as a hash function for the current System.Globalization.CompareInfo instance, suitable for use in hashing algorithms and data structures, such as a hash table.
Return Value: A hash code for the current System.Globalization.CompareInfo instance.
This method overrides System.Object.GetHashCode.
GetSortKey
Gets the System.Globalization.SortKey of the specified System.String.
Return Value: The System.Globalization.SortKey of the specified System.String
Each character in a string is given several categories of sort weights, including script, alphabetic, case, and diacritic weights. A sort key serves as the repository of these weights for a particular string. For example, a sort key might contain a string of alphabetic weights, followed by a string of case weights, and so on. The System.String for which to get the System.Globalization.SortKey.
GetSortKey
Gets the System.Globalization.SortKey of the specified System.String using the specified System.Globalization.CompareOptions value.
Return Value: The System.Globalization.SortKey of the specified System.String using the specified System.Globalization.CompareOptions value.
Each character in a string is given several categories of sort weights, including script, alphabetic, case, and diacritic weights. A sort key serves as the repository of these weights for a particular string. For example, a sort key might contain a string of alphabetic weights, followed by a string of case weights, and so on. The System.String whose System.Globalization.SortKey to get. The System.Globalization.CompareOptions value that defines how the strings should be compared.
IndexOf
Searches for the specified character and returns the zero-based index of the first occurrence within the entire source System.String.
Return Value: The zero-based index of the first occurrence of value within the entire source, if found; otherwise, −1.
The source System.String is searched forward starting at the beginning of the System.String and ending at the end of the System.String. The System.String to search. The character to locate within source.
IndexOf
Searches for the specified substring and returns the zero-based index of the first occurrence within the entire source System.String.
Return Value: The zero-based index of the first occurrence of value within the entire source, if found; otherwise, −1.
The source System.String is searched forward starting at the beginning of the System.String and ending at the end of the System.String. The System.String to search. The System.String to locate within source.
IndexOf
Searches for the specified character and returns the zero-based index of the first occurrence within the entire source System.String using the specified System.Globalization.CompareOptions value.
Return Value: The zero-based index of the first occurrence of value within the entire source using the specified System.Globalization.CompareOptions value, if found; otherwise, −1.
The source System.String is searched forward starting at the beginning of the System.String and ending at the end of the System.String. The System.String to search. The character to locate within source. The System.Globalization.CompareOptions value that defines how the strings should be compared.
IndexOf
Searches for the specified character and returns the zero-based index of the first occurrence within the section of the source System.String that extends from the specified index to the end of the System.String.
Return Value: The zero-based index of the first occurrence of value within the section of source that extends from startIndex to the end of the System.String, if found; otherwise, −1.
The source System.String is searched forward starting at startIndex and ending at the end of the System.String. The System.String to search. The character to locate within source. The zero-based starting index of the search.
IndexOf
Searches for the specified substring and returns the zero-based index of the first occurrence within the entire source System.String using the specified System.Globalization.CompareOptions value.
Return Value: The zero-based index of the first occurrence of value within the entire source using the specified System.Globalization.CompareOptions value, if found; otherwise, −1.
The source System.String is searched forward starting at the beginning of the System.String and ending at the end of the System.String. The System.String to search. The System.String to locate within source. The System.Globalization.CompareOptions value that defines how the strings should be compared.
IndexOf
Searches for the specified substring and returns the zero-based index of the first occurrence within the section of the source System.String that extends from the specified index to the end of the System.String.
Return Value: The zero-based index of the first occurrence of value within the section of source that extends from startIndex to the end of the System.String, if found; otherwise, −1.
The source System.String is searched forward starting at startIndex and ending at the end of the System.String. The System.String to search. The System.String to locate within source. The zero-based starting index of the search.
IndexOf
Searches for the specified character and returns the zero-based index of the first occurrence within the section of the source System.String that extends from the specified index to the end of the System.String using the specified System.Globalization.CompareOptions value.
Return Value: The zero-based index of the first occurrence of value within the section of source that extends from startIndex to the end of the System.String using the specified System.Globalization.CompareOptions value, if found; otherwise, −1.
The source System.String is searched forward starting at startIndex and ending at the end of the System.String. The System.String to search. The character to locate within source. The zero-based starting index of the search. The System.Globalization.CompareOptions value that defines how the strings should be compared.
IndexOf
Searches for the specified character and returns the zero-based index of the first occurrence within the section of the source System.String that starts at the specified index and contains the specified number of elements.
Return Value: The zero-based index of the first occurrence of value within the section of source that starts at startIndex and contains count number of elements, if found; otherwise, −1.
The source System.String is searched forward starting at startIndex and ending at startIndex+count−1. The System.String to search. The character to locate within source. The zero-based starting index of the search. The number of elements in the section to search.
IndexOf
Searches for the specified substring and returns the zero-based index of the first occurrence within the section of the source System.String that extends from the specified index to the end of the System.String using the specified System.Globalization.CompareOptions value.
Return Value: The zero-based index of the first occurrence of value within the section of source that extends from startIndex to the end of the System.String using the specified System.Globalization.CompareOptions value, if found; otherwise, −1.
The source System.String is searched forward starting at startIndex and ending at the end of the System.String. The System.String to search. The System.String to locate within source. The zero-based starting index of the search. The System.Globalization.CompareOptions value that defines how the strings should be compared.
IndexOf
Searches for the specified substring and returns the zero-based index of the first occurrence within the section of the source System.String that starts at the specified index and contains the specified number of elements.
Return Value: The zero-based index of the first occurrence of value within the section of source that starts at startIndex and contains count number of elements, if found; otherwise, −1.
The source System.String is searched forward starting at startIndex and ending at startIndex+count−1. The System.String to search. The System.String to locate within source. The zero-based starting index of the search. The number of elements in the section to search.
IndexOf
Searches for the specified character and returns the zero-based index of the first occurrence within the section of the source System.String that starts at the specified index and contains the specified number of elements using the specified System.Globalization.CompareOptions value. Return Value: The zero-based index of the first occurrence of value within the section of source that starts at startIndex and contains count number of elements using the specified System.Globalization.CompareOptions value, if found; otherwise, −1.
The source System.String is searched forward starting at startIndex and ending at startIndex+count−1. The System.String to search. The character to locate within source. The zero-based starting index of the search. The number of elements in the section to search. The System.Globalization.CompareOptions value that defines how the strings should be compared.
IndexOf
Searches for the specified substring and returns the zero-based index of the first occurrence within the section of the source System.String that starts at the specified index and contains the specified number of elements using the specified System.Globalization.CompareOptions value.
Return Value: The zero-based index of the first occurrence of value within the section of source that starts at startIndex and contains count number of elements using the specified System.Globalization.CompareOptions value, if found; otherwise, −1.
The source System.String is searched forward starting at startIndex and ending at startIndex+count−1. The System.String to search. The System.String to locate within source. The zero-based starting index of the search. The number of elements in the section to search. The System.Globalization.CompareOptions value that defines how the strings should be compared.
IsPrefix
Determines whether the specified source System.String starts with the specified prefix.
Return Value: true if the length of prefix is less than or equal to the length of source and source starts with prefix; otherwise, false.
Every string starts and ends with an empty substring; therefore, if prefix is an empty string, this method returns true. The System.String to search in. The System.String to compare with the beginning of source.
IsPrefix
Determines whether the specified source System.String starts with the specified prefix using the specified System.Globalization.CompareOptions value.
Return Value: true if the length of prefix is less than or equal to the length of source and source starts with prefix; otherwise, false.
Every string starts and ends with an empty substring; therefore, if prefix is an empty string, this method returns true. The System.String to search in. The System.String to compare with the beginning of source. The System.Globalization.CompareOptions value that defines how the strings should be compared.
IsSuffix
Determines whether the specified source System.String ends with the specified suffix.
Return Value: true if the length of suffix is less than or equal to the length of source and source ends with suffix; otherwise, false.
Every string starts and ends with an empty substring; therefore, if suffix is an empty string, this method returns true. The System.String to search in. The System.String to compare with the end of source.
IsSuffix
Determines whether the specified source System.String ends with the specified suffix using the specified System.Globalization.CompareOptions value.
Return Value: true if the length of suffix is less than or equal to the length of source and source ends with suffix; otherwise, false.
Every string starts and ends with an empty substring; therefore, if suffix is an empty string, this method returns true. The System.String to search in. The System.String to compare with the end of source. The System.Globalization.CompareOptions value that defines how the strings should be compared.
LastIndexOf
Searches for the specified character and returns the zero-based index of the last occurrence within the entire source System.String.
Return Value: The zero-based index of the last occurrence of value within the entire source, if found; otherwise, −1.
The source System.String is searched backward starting at the end of the System.String and ending at the beginning of the System.String. The System.String to search. The character to locate within source.
LastIndexOf
Searches for the specified substring and returns the zero-based index of the last occurrence within the entire source System.String.
Return Value: The zero-based index of the last occurrence of value within the entire source, if found; otherwise, −1.
The source System.String is searched backward starting at the end of the System.String and ending at the beginning of the System.String. The System.String to search. The System.String to locate within source.
LastIndexOf
Searches for the specified character and returns the zero-based index of the last occurrence within the entire source System.String using the specified System.Globalization.CompareOptions value.
Return Value: The zero-based index of the last occurrence of value within the entire source using the specified System.Globalization.CompareOptions value, if found; otherwise, −1.
The source System.String is searched backward starting at the end of the System.String and ending at the beginning of the System.String. The System.String to search. The character to locate within source. The System.Globalization.CompareOptions value that defines how the strings should be compared.
LastIndexOf
Searches for the specified character and returns the zero-based index of the last occurrence within the section of the source System.String that extends from the beginning of the System.String to the specified index.
Return Value: The zero-based index of the last occurrence of value within the section of source that extends from the beginning of the System.String to startIndex, if found; otherwise, −1.
The source System.String is searched backward starting at startIndex and ending at the beginning of the System.String. The System.String to search. The character to locate within source. The zero-based starting index of the backward search.
LastIndexOf
Searches for the specified substring and returns the zero-based index of the last occurrence within the entire source System.String using the specified System.Globalization.CompareOptions value.
Return Value: The zero-based index of the last occurrence of value within the entire source using the specified System.Globalization.CompareOptions value, if found; otherwise, −1.
The source System.String is searched backward starting at the end of the System.String and ending at the beginning of the System.String. The System.String to search. The System.String to locate within source. The System.Globalization.CompareOptions value that defines how the strings should be compared.
LastIndexOf
Searches for the specified substring and returns the zero-based index of the last occurrence within the section of the source System.String that extends from the beginning of the System.String to the specified index.
Return Value: The zero-based index of the last occurrence of value within the section of source that extends from the beginning of the System.String to startIndex, if found; otherwise, −1.
The source System.String is searched backward starting at startIndex and System.String to locate within source. The zero-based starting index of the backward search.
LastIndexOf
Searches for the specified character and returns the zero-based index of the last occurrence within the section of the source System.String that extends from the beginning of the System.String to the specified index using the specified System.Globalization.CompareOptions value.
Return Value: The zero-based index of the last occurrence of value within the section of source that extends from the beginning of the System.String to startIndex using the specified System.Globalization.CompareOptions value, if found; otherwise, −1.
The source System.String is searched backward starting at startIndex and ending at the beginning of the System.String. The System.String to search. The character to locate within source. The zero-based starting index of the backward search. The System.Globalization.CompareOptions value that defines how the strings should be compared.
LastIndexOf
Searches for the specified character and returns the zero-based index of the last occurrence within the section of the source System.String that contains the specified number of elements and ends at the specified index.
Return Value: The zero-based index of the last occurrence of value within the section of source that contains count number of elements and ends at startIndex, if found; otherwise, −1.
The source System.String is searched backward starting at startIndex and ending at startIndex−count+1. The System.String to search. The character to locate within source. The zero-based starting index of the backward search. The number of elements in the section to search.
LastIndexOf
Searches for the specified substring and returns the zero-based index of the last occurrence within the section of the source System.String that extends from the beginning of the System.String to the specified index using the specified System.Globalization.CompareOptions value.
Return Value: The zero-based index of the last occurrence of value within the section of source that extends from the beginning of the System.String to startIndex using the specified System.Globalization.CompareOptions value, if found; otherwise, −1.
The source System.String is searched backward starting at startIndex and ending at the beginning of the System.String. The System.String to search. The System.String to locate within source. The zero-based starting index of the backward search. The System.Globalization.CompareOptions value that defines how the strings should be compared.
LastIndexOf
Searches for the specified substring and returns the zero-based index of the last occurrence within the section of the source System.String that contains the specified number of elements and ends at the specified index.
Return Value: The zero-based index of the last occurrence of value within the section of source that contains count number of elements and ends at startIndex, if found; otherwise, −1.
The source System.String is searched backward starting at startIndex and ending at startIndex−count+1. The System.String to search. The System.String to locate within source. The zero-based starting index of the backward search. The number of elements in the section to search.
LastIndexOf
Searches for the specified character and returns the zero-based index of the last occurrence within the section of the source System.String that contains the specified number of elements and ends at the specified index using the specified System.Globalization.CompareOptions value.
Return Value: The zero-based index of the last occurrence of value within the section of source that contains count number of elements and ends at startIndex using the specified System.Globalization.CompareOptions value, if found; otherwise, −1.
The source System.String is searched backward starting at startIndex and ending at startIndex−count+1. The System.String to search. The character to locate within source. The zero-based starting index of the backward search. The number of elements in the section to search. The System.Globalization.CompareOptions value that defines how the strings should be compared.
LastIndexOf
Searches for the specified substring and returns the zero-based index of the last occurrence within the section of the source System.String that contains the specified number of elements and ends at the specified index using the specified System.Globalization.CompareOptions value.
Return Value: The zero-based index of the last occurrence of value within the section of source that contains count number of elements and ends at startIndex using the specified System.Globalization.CompareOptions value, if found; otherwise, −1.
The source System.String is searched backward starting at startIndex and ending at startIndex−count+1. The System.String to search. The System.String to locate within source. The zero-based starting index of the backward search. The number of elements in the section to search. The System.Globalization.CompareOptions value that defines how the strings should be compared.
IDeserializationCallback.OnDeserialization
ToString
Returns a System.String that represents the current System.Globalization.CompareInfo instance.
Return Value: A System.String that represents the current System.Globalization.CompareInfo instance.
This method overrides System.Object.ToString.
CompareOptions enumeration (System.Globalization)
ToString
Description
Defines the string comparison options to use with System.Globalization.CompareInfo.
These options denote case-sensitivity or whether to ignore types of characters.
ToString
Indicates that the string comparison must ignore case.
ToString
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.
ToString
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. Non-spacing combining characters do not occupy a spacing position by themselves when rendered. For more information on non-spacing combining characters, see The Unicode Standard at http://www.unicode.org.
ToString
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.
ToString
Indicates that the string comparison must ignore the character width. For example, Japanese katakana characters can be written as full-width or half-width and, if this value is selected, the katakana characters written as full-width are considered equal to the same characters written in half-width.
ToString
Indicates the default option settings for string comparisons.
ToString
Indicates that the string comparison must be done using the Unicode values of each character, which is a fast comparison but is culture-insensitive. A string starting with “U+xxxx” comes before a string starting with “U+yyyy”, if xxxx is less than yyyy.
ToString
Indicates that the string comparison must use the string sort method, where the hyphen and the apostrophe, as well as other non-alphanumeric characters, come before alphanumeric symbols.
CultureInfo class (System.Globalization)
ToString
Description
Represents information about a specific culture including the names of the culture, the writing system, and the calendar used, as well as methods for common operations, such as formatting dates and sorting strings.
The System.Globalization.CultureInfo class holds culture-specific information, such as the associated language, sublanguage, country/region, calendar, and cultural conventions. This class also provides the information required for culture-specific operations, such as casing, formatting dates and numbers, and comparing strings.
CultureInfo
Example Syntax:
ToString
Initializes a new instance of the System.Globalization.CultureInfo class based on the culture specified by the culture identifier.
The culture parameter is mapped to the corresponding National Language Support (NLS) locale identifier. The value of the culture parameter becomes the value of the System.Globalization.CultureInfo.LCID property of the new instance. A predefined System.Globalization.CultureInfo identifier or the System.Globalization.CultureInfo.LCID of an existing System.Globalization.CultureInfo instance.
CultureInfo
Example Syntax:
ToString
Initializes a new instance of the System.Globalization.CultureInfo class based on the culture specified by name.
The System.Globalization.CultureInfo names follow the RFC 1766 standard in the format “-”, where is a lowercase two-letter code derived from ISO 639-1 and is an uppercase two-letter code derived from ISO 3166. For example, U.S. English is “en-US”. The predefined System.Globalization.CultureInfo names are listed in the System.Globalization.CultureInfo class topic. A predefined System.Globalization.CultureInfo name or the name of an existing System.Globalization.CultureInfo instance.
CultureInfo
Example Syntax:
ToString
Initializes a new instance of the System.Globalization.CultureInfo class based on the culture specified by the culture identifier and on the Boolean that specifies whether to use the user-selected culture settings from the system.
The culture parameter is mapped to the corresponding National Language Support (NLS) locale identifier. The value of the culture parameter becomes the value of the System.Globalization.CultureInfo.LCID property of the new instance. A predefined System.Globalization.CultureInfo identifier or the System.Globalization.CultureInfo instance. A Boolean that denotes whether to use the user-selected culture settings (true) or the default culture settings (false).
CultureInfo
Example Syntax:
ToString
Initializes a new instance of the System.Globalization.CultureInfo class based on the culture specified by name and on the Boolean that specifies whether to use the user-selected culture settings from the system.
The System.Globalization.CultureInfo names follow the RFC 1766 standard in the format “-”, where is a lowercase two-letter code derived from ISO 639-1 and is an uppercase two-letter code derived from ISO 3166. For example, U.S. English is “en-US”. The predefined System.Globalization.CultureInfo names are listed in the System.Globalization.CultureInfo class topic. A predefined System.Globalization.CultureInfo name or the name of an existing System.Globalization.CultureInfo instance. A Boolean that denotes whether to use the user-selected culture settings (true) or the default culture settings (false).
Calendar
ToString
Gets the default calendar used by the culture.
The System.Globalization.CultureInfo.DateTimeFormat property is an instance of the System.Globalization.DateTimeFormatInfo class which includes properties that allow users to customize the date and time formatting associated with a specific System.Globalization.Calendar.
CompareInfo
ToString
Gets the System.Globalization.CompareInfo instance that defines how to compare strings for the culture.
CurrentCulture
ToString
Gets the System.Globalization.CultureInfo instance that represents the culture used by the current thread.
The culture is a property of the executing thread. This read-only property returns System.Threading.Thread.CurrentCulture. When a thread is started, its culture is initially determined by using GetUserDefaultLCID from the Windows API. To change the culture used by a thread, set System.Threading.Thread.CurrentCulture to the new culture.
CurrentUICulture
ToString
Gets the System.Globalization.CultureInfo instance that represents the current culture used by the ResourceManager to look up culture-specific resources at run time.
The culture is a property of the executing thread. This property returns System.Threading.Thread.CurrentUICulture. When a thread is started, its UI culture is initially determined by using GetUserDefaultUILanguage from the Windows API. To change the UI culture used by a thread, set System.Threading.Thread.CurrentUICulture to the new culture.
DateTimeFormat
ToString
Gets or sets a System.Globalization.DateTimeFormatInfo instance that defines the culturally appropriate format of displaying dates and times.
A System.Globalization.DateTimeFormatInfo instance can be created only for the invariant culture or for specific cultures, not for neutral cultures.
DisplayName
ToString
Gets the culture name in the format “( )” in the localized language of the NET Framework.
For example, if the .NET Framework English version is installed, the System.Globalization.CultureInfo.DisplayName for the specific culture U.S. English is “English (United States)”. If the .NET Framework Spanish version is installed, regardless of the language that the system is set to display, the culture name is displayed in Spanish; therefore, the System.Globalization.CultureInfo.DisplayName for the specific culture U.S. English is “Ingles (Estados Unidos)”.
EnglishName
ToString
Gets the culture name in the format “( )” in English.
For example, the System.Globalization.CultureInfo.EnglishName for the specific culture U.S. English is “English (United States)”.
InstalledUICulture
ToString
Gets the System.Globalization.CultureInfo instance that represents the culture installed with the operating system.
In a localized operating system, such as Japanese Windows 2000 Professional, this property returns the culture of the operating system. This property is the equivalent of GetSystemDefaultUILanguage in the Windows API.
InvariantCulture
ToString
Gets the System.Globalization.CultureInfo instance that is culture-independent (invariant).
The invariant culture is culture-insensitive. You can specify the invariant culture by name using an empty string.
IsNeutralCulture
ToString
Determines whether the current System.Globalization.CultureInfo instance is a neutral culture.
A neutral culture is a culture that is associated with a language but not with a country/region. A specific culture is a culture that is associated with a language and a country/region. For example, “fr” is a neutral culture and “fr-FR” is a specific culture. Note that “zh-CHS” (Simplified Chinese) and “zh-CHT” (Traditional Chinese) are neutral cultures.
IsReadOnly
ToString
Gets a value indicating whether the current System.Globalization.CultureInfo instance is read-only.
LCID
ToString
Gets the culture identifier for the current System.Globalization.CultureInfo instance.
The culture identifier is mapped to the corresponding National Language Support (NLS) locale identifier.
Name
ToString
Gets the culture name in the format
The System.Globalization.CultureInfo names follow the RFC 1766 standard in the format “-”, where is a lowercase two-letter code derived from ISO 1639-1 and is an uppercase two-letter code derived from ISO 3166. For example, the System.Globalization.CultureInfo.Name for the specific culture U.S. English is “en-US”.
NativeName
ToString
Gets the culture name in the format “( )” in the language that the culture is set to display.
The culture's full name might not display properly if the system is not set to display the culture's language correctly. For example, if the System.Globalization.CultureInfo.Name is “ja-JP” for Japanese (Japan), System.Globalization.CultureInfo.NativeName will not display correctly on a system that is set to English only. However, multilingual operating systems, such as Windows 2000, display System.Globalization.CultureInfo.NativeName correctly.
NumberFormat
ToString
Gets or sets a System.Globalization.NumberFormatInfo instance that defines the culturally appropriate format of displaying numbers, currency, and percentage.
A System.Globalization.NumberFormatInfo instance can be created only for the invariant culture or for specific cultures, not for neutral cultures.
OptionalCalendars
ToString
Gets the list of optional calendars that can be used by the culture.
Optional calendars are other calendars that can be used with the culture represented by the current System.Globalization.CultureInfo instance.
Parent
ToString
Gets the System.Globalization.CultureInfo instance that represents the parent culture of the current System.Globalization.CultureInfo instance.
A parent culture is a higher level culture that encompasses a more limited set of information that is common among its children. For example, the parent culture of “en-US” is “en”; the parent culture of “en” is the invariant culture.
TextInfo
ToString
Gets the System.Globalization.TextInfo instance that defines the writing system associated with the culture.
The System.Globalization.CultureInfo.TextInfo property provides culture-specific casing information for strings.
ThreeLetterISOLanguageName
ToString
Gets the ISO 639-2 three-letter code for the language of the current System.Globalization.CultureInfo instance.
For example, the three-letter abbreviation for English is “eng”.
ThreeLetterWindowsLanguageName
ToString
Gets the three-letter code for the language as defined in the Windows API.
For example, the three-letter code for English (U.S.) as defined in the Windows API is “enu”.
TwoLetterISOLanguageName
ToString
Gets the ISO 639-1 two-letter code for the language of the current System.Globalization.CultureInfo instance.
For example, the two-letter abbreviation for English is “en”.
UseUserOverride
ToString
Gets a value indicating whether the current System.Globalization.CultureInfo instance uses the user-selected culture settings.
The user might choose to override some of the values associated with the default culture of the system through the Regional and Language Options (or Regional Options or Regional Settings) applet in Windows Control Panel. For example, the user might choose to display the date in a different format. This property denotes whether the current System.Globalization.CultureInfo instance uses those overrides (true) or whether it uses the default values (false) of the culture settings.
ClearCachedData
Refreshes cached culture-related information.
Information, such as the default culture and format patterns, is cached the first time it is requested. However, that information can change during the life of the System.AppDomain, for example, when the user modifies the Regional and Language Options (or Regional Options or Regional Settings) applet in Windows Control Panel. The System.Globalization.CultureInfo class does not detect changes in the system settings automatically. Use the System.Globalization.CultureInfo.ClearCachedData method to refresh that information in the System.Globalization.CultureInfo class, based on the current system settings.
Clone
Creates a copy of the current System.Globalization.CultureInfo instance.
Return Value: A copy of the current System.Globalization.CultureInfo instance.
The clone is writable even if the original instance is read-only; therefore, the properties of the clone can be modified.
CreateSpecificCulture
Creates a System.Globalization.CultureInfo instance that represents the specific culture that is associated with the specified name.
Return Value: A System.Globalization.CultureInfo instance that represents the invariant culture, if name is “ ” (invariant culture).
The invariant culture is culture-insensitive. You can specify the invariant culture by name using an empty string. A predefined System.Globalization.CultureInfo name or the name of an existing System.Globalization.CultureInfo instance.
Equals
Determines whether the specified System.Object is the same culture as the current System.Globalization.CultureInfo instance.
Return Value: true if the specified System.Object is the same culture as the current System.Globalization.CultureInfo instance; otherwise, false.
This method overrides System.Object.Equals(System.Object). The System.Object to compare with the current System.Globalization.CultureInfo instance.
GetCultures
Gets the list of supported cultures filtered by the specified System.Globalization.CultureTypes.
Return Value: An array of System.Globalization.CultureInfo objects that represent the supported cultures filtered by the specified System.Globalization.CultureTypes. A combination of System.Globalization.CultureTypes values that filter the cultures to retrieve.
GetFormat
Gets an object that defines how to format the specified type.
Return Value: A System.Globalization.NumberFormatInfo object containing the default number format information for the current System.Globalization.CultureInfo instance, if formatType is the System.Type object for the System.Globalization.NumberFormatInfo class. System.Globalization.CultureInfo.GetFormat(System.Type) implements System.IFormatProvider.GetFormat(System.Type). The System.Type for which to get a formatting object. This method only supports the System.Globalization.NumberFormatInfo and System.Globalization.DateTimeFormatInfo types.
GetHashCode
Serves as a hash function for the current System.Globalization.CultureInfo instance, suitable for use in hashing algorithms and data structures, such as a hash table.
Return Value: A hash code for the current System.Globalization.CultureInfo instance.
This method overrides System.Object.GetHashCode.
ReadOnly
Returns a read-only wrapper around the specified System.Globalization.CultureInfo instance.
Return Value: A read-only System.Globalization.CultureInfo wrapper around ci
This wrapper prevents any modifications to ci, to the ci. The System.Globalization.CultureInfo instance to wrap.
ToString
Returns a System.String containing the name of the current System.Globalization.CultureInfo instance in the format “-”
Return Value: A System.String containing the name of the current System.Globalization.CultureInfo instance in the format “-”, where is a lowercase two-letter code derived from ISO 639-1 and is an uppercase two-letter code derived from ISO 3166.
This method overrides System.Object.ToString.
CultureTypes enumeration (System.Globalization)
ToString
Description
Defines the types of culture lists that can be retrieved using System.Globalization.CultureInfo.GetCultures(System.Globalization.Culture Types).
These culture types serve as a filter that limits which cultures are returned by System.Globalization.CultureInfo.GetCultures(System.Globalization.Culture Types).
ToString
Refers to all cultures.
ToString
Refers to all cultures that are installed in the system.
ToString
Refers to cultures that are associated with a language but are not specific to a country/region. The names of these cultures consist of the lowercase two-letter code derived from ISO 639-1. For example: “en”.
ToString
Refers to cultures that are specific to a country/region. The names of these cultures follow the RFC 1766 standard in the format “-”, where is a lowercase two-letter code derived from ISO 639-1 and is an uppercase two-letter code derived from ISO 3166. For example, “en-US”.
DateTimeFormatInfo class (System.Globalization)
ToString
Description
Defines how System.DateTime values are formatted and displayed, depending on the culture.
This class contains information, such as date patterns, time patterns, and AM/PM designators.
DateTimeFormatInfo
Example Syntax:
ToString
Initializes a new writable instance of the System.Globalization.DateTimeFormatInfo class that is culture-independent (invariant).
The properties of this instance can be modified with user-defined patterns.
AbbreviatedDayNames
ToString
Gets or sets a one-dimensional array of type System.String containing the abbreviated names of the days of the week.
If setting this property, the array must be one-dimensional and must have exactly seven elements.
AbbreviatedMonthNames
ToString
Gets or sets a one-dimensional array of type System.String containing the abbreviated names of the months.
If setting this property, the array must be one-dimensional and must have exactly 13 elements.
AMDesignator
ToString
Indicates the System.String designator for hours that are “ante meridiem” (before noon).
If the custom pattern includes the format pattern “tt” and the time is before noon, System.DateTime.ToString displays the value of System.Globalization.DateTimeFormatInfo.AMDesignator in place of the “tt” in the format pattern. If the custom pattern includes the format pattern “t”, only the first character of System.Globalization.DateTimeFormatInfo.AMDesignator is displayed.
Calendar
ToString
Gets or sets the calendar to use for the current culture.
The System.Globalization.DateTimeFormatInfo.Calendar property only accepts calendars that are valid for the current culture of the current thread. The System.Globalization.CultureInfo.Calendar property specifies the default calendar for the culture and the System.Globalization.CultureInfo.OptionalCalendars property specifies other calendars supported by the culture.
CalendarWeekRule
ToString
Gets or sets a value that specifies which rule is used to determine the first calendar week of the year.
This property is affected if the value of the System.Globalization.DateTimeFormatInfo.Calendar property changes.
CurrentInfo
ToString
Gets a read-only System.Globalization.DateTimeFormatInfo instance that formats values based on the current culture.
DateSeparator
ToString
Indicates the System.String that separates the components of a date; that is, the year, month, and day.
If the custom pattern includes the format pattern “/” System.DateTime.ToString displays the value of System.Globalization.DateTimeFormatInfo.DateSeparator in place of the “/” in the format pattern.
DayNames
ToString
Gets or sets a one-dimensional array of type System.String containing the full names of the days of the week.
If setting this property, the array must be one-dimensional and must have exactly seven elements.
FirstDayOfWeek
ToString
Indicates the first day of the week.
This property is affected if the value of the System.Globalization.DateTimeFormatInfo.Calendar property changes.
FullDateTimePattern
ToString
Indicates the format pattern for a long date and long time value, which is associated with the ‘F’ format character. See System.Globalization.DateTimeFormatInfo for patterns that can be combined to construct custom patterns; for example, “dddd, dd MMMM yyyy HH:mm:ss”.
InvariantInfo
ToString
Gets the default read-only System.Globalization.DateTimeFormatInfo instance that is culture-independent (invariant).
This property does not change regardless of the current culture.
IsReadOnly
ToString
Gets a value indicating whether the System.Globalization.DateTimeFormatInfo is read-only.
LongDatePattern
ToString
Indicates the format pattern for a long date value, which is associated with the ‘D’ format character.
See System.Globalization.DateTimeFormatInfo for patterns that can be combined to construct custom patterns; for example, “dddd, dd MMMM yyyy”.
LongTimePattern
ToString
Indicates the format pattern for a long time value, which is associated with the ‘T’ format character.
See System.Globalization.DateTimeFormatInfo for patterns that can be combined to construct custom patterns; for example, “HH:mm:ss”.
MonthDayPattern
ToString
Indicates the format pattern for a month and day value, which is associated with the ‘m’ and ‘M’ format characters.
See System.Globalization.DateTimeFormatInfo for patterns that can be combined to construct custom patterns; for example, “MMMM dd”.
MonthNames
ToString
Gets or sets a one-dimensional array of type System.String containing the full names of the months.
If setting this property, the array must be one-dimensional and must have exactly 13 elements.
PMDesignator
ToString
Indicates the System.String designator for hours that are “post meridiem” (after noon).
If the custom pattern includes the format pattern “tt” and the time is after noon, System.DateTime.ToString displays the value of System.Globalization.DateTimeFormatInfo.PMDesignator in place of the “tt” in the format pattern. If the custom pattern includes the format pattern “t”, only the first character of System.Globalization.DateTimeFormatInfo.PMDesignator is displayed.
RFC1123 Pattern
ToString
Gets the format pattern for a time value, which is based on the Internet Engineering Task Force (IETF) Request for Comments (RFC) 1123 specification and is associated with the ‘r’ and ‘R’ format characters.
ShortDatePattern
ToString
Indicates the format pattern for a short date value, which is associated with the ‘d’ format character.
See System.Globalization.DateTimeFormatInfo for patterns that can be combined to construct custom patterns; for example, “MM/dd/yyyy”.
ShortTimePattern
ToString
Indicates the format pattern for a short time value, which is associated with the ‘t’ format character.
See System.Globalization.DateTimeFormatInfo for patterns that can be combined to construct custom patterns; for example, “HH:mm”.
SortableDateTimePattern
ToString
Gets the format pattern for a sortable date and time value, which is associated with the ‘s’ format character.
TimeSeparator
ToString
Indicates the System.String that separates the components of time; that is, the hour, minutes, and seconds.
If the custom pattern includes the format pattern “:” System.DateTime.ToString displays the value of System.Globalization.DateTimeFormatInfo.TimeSeparator in place of the “:” in the format pattern.
UniversalSortableDateTimePattern
ToString
Gets the format pattern for a universal sortable date and time value, which is associated with the ‘u’ and ‘U’ format characters.
YearMonthPattern
ToString
Indicates the format pattern for a year and month value, which is associated with the ‘y’ and ‘Y’ format characters.
See System.Globalization.DateTimeFormatInfo for patterns that can be combined to construct custom patterns; for example, “yyyy MMMM”.
Clone
Creates a shallow copy of the System.Globalization.DateTimeFormatInfo instance.
Return Value: A new System.Globalization.DateTimeFormatInfo instance copied from the original System.Globalization.DateTimeFormatInfo instance.
The clone is writable even if the original instance is read-only; therefore, the properties of the clone can be modified with user-defined patterns.
GetAbbreviatedDayName
Gets the abbreviated name of the specified day of the week based on the System.Globalization.CultureInfo of the current thread.
Return Value: The abbreviated name of the day of the week represented by dayofweek.
For the default invariant System.Globalization.DateTimeFormatInfo instance, this method returns a string from the System.Globalization.GregorianCalendar: dayofweek Return Value Sunday “Sun” Monday “Mon” Tuesday “Tue” Wednesday “Wed” Thursday “Thu” Friday “Fri” Saturday “Sat” A System.DayOfWeek value.
GetAbbreviatedEraName
Gets the System.String containing the abbreviated name of the specified era, if an abbreviation exists.
Return Value: A System.String containing the abbreviated name of the specified era, if an abbreviation exists.
The valid values for era are listed in the System.Globalization.Calendar.Eras property of the appropriate class derived from System.Globalization.Calendar. For example: System.Globalization.JapaneseCalendar.Eras displays a list of eras that are supported by this implementation. The integer representing the era.
GetAbbreviatedMonthName
Gets the abbreviated name of the specified month based on the System.Globalization.CultureInfo of the current thread.
Return Value: The abbreviated name of the month represented by month. For the default invariant System.Globalization.DateTimeFormatInfo instance, this method returns a string from the System.Globalization.GregorianCalendar: month Return Value 1 “Jan” 2 “Feb” 3 “Mar” 4 “Apr” 5 “May” 6 “Jun” 7 “Jul” 8 “Aug” 9 “Sep” 10 “Oct” 11 “Nov” 12 “Dec” 13 “ ” System.Globalization.Calendar objects can accommodate calendars with 13 months. For 12-month calendars, the empty string is always returned as the name of the 13th month. An integer from 1 through 13 representing the name of the month to retrieve.
GetAllDateTimePatterns
Gets all the standard patterns in which System.DateTime values can be formatted.
Return Value: An array containing the standard patterns in which System.DateTime values can be formatted.
See the summary page of the System.Globalization.DateTimeFormatInfo class for a list of the standard format characters and their associated patterns.
GetAllDateTimePatterns
Gets all the standard patterns in which System.DateTime values can be formatted using the specified format character.
Return Value: An array containing the standard patterns in which System.DateTime values can be formatted using the specified format character.
See the summary page of the System.Globalization.DateTimeFormatInfo class for a list of the standard format characters and their associated patterns. A standard format character.
GetDayName
Gets the full name of the specified day of the week based on the System.Globalization.CultureInfo of the current thread.
Return Value: The full name of the day of the week represented by dayofweek.
For the default invariant System.Globalization.DateTimeFormatInfo instance, this method returns a string from the System.Globalization.GregorianCalendar: dayofweek Return Value Sunday “Sunday” Monday “Monday” Tuesday “Tuesday” Wednesday “Wednesday” Thursday “Thursday” Friday “Friday” Saturday “Saturday” A System.DayOfWeek value.
GetEra
Gets the integer representing the specified era.
Return Value: The integer representing the era, if eraName is valid; otherwise, −1.
The comparison with eraName is case-insensitive; for example, “A.D.” is equivalent to “a.d.”. The System.String containing the name of the era.
GetEraName
Gets the System.String containing the name of the specified era.
Return Value: A System.String containing the name of the era.
The valid values for era are listed in the System.Globalization.Calendar.Eras property of the appropriate class derived from System.Globalization.Calendar. For example: System.Globalization.JapaneseCalendar.Eras displays a list of eras that are supported by this implementation. The integer representing the era.
GetFormat
Gets an object of the specified type that provides a System.DateTime formatting service.
Return Value: The current instance of the System.Globalization.DateTimeFormatInfo class, if formatType is the same as the type of the current instance; otherwise, null.
The Format(String, IFormatProvider) method supported by the base data types invoke this method when the current instance is passed as the System.IFormatProvider parameter. This method implements System.IFormatProvider.GetFormat(System.Type). The System.Type of the required formatting service.
GetInstance
Gets the System.Globalization.DateTimeFormatInfo instance associated with the specified System.IFormatProvider.
Return Value: A System.Globalization.DateTimeFormatInfo instance associated with the specified System.IFormatProvider
This method uses the System.IFormatProvider.GetFormat(System.Type) method of formatProvider using System.Globalization.DateTimeFormatInfo as the Type parameter. If formatProvider is null or if System.IFormatProvider.GetFormat(System.Type) returns null, this method returns System.Globalization.DateTimeFormatInfo.CurrentInfo. The System.IFormatProvider that gets the System.Globalization.DateTimeFormatInfo instance.
GetMonthName
Gets the full name of the specified month based on the System.Globalization.CultureInfo of the current thread.
Return Value: The full name of the month represented by month.
For the default invariant System.Globalization.DateTimeFormatInfo instance, this method returns a string from the System.Globalization.GregorianCalendar: month Return Value 1 “January” 2 “February” 3 “March” 4 “April” 5 “May” 6 “June” 7 “July” 8 “August” 9 “September” 10 “October” 11 “November” 12 “December” 13“ ” System.Globalization.Calendar objects can accommodate calendars with 13 months. For 12-month calendars, the empty string is always returned as the name of the 13th month. An integer from 1 through 13 representing the name of the month to retrieve.
ReadOnly
Returns a read-only System.Globalization.DateTimeFormatInfo wrapper.
Return Value: A read-only System.Globalization.DateTimeFormatInfo wrapper around dtfi.
This wrapper prevents any modifications to dtfi. The System.Globalization.DateTimeFormatInfo to wrap.
DateTimeStyles enumeration (System.Globalization)
ToString
Description
Defines the formatting options that customize how the System.DateTime.Parse(System.String) and System.DateTime.ParseExact(System.String,System.String,System.IFormatProvider) methods parse a string.
The System.Globalization.DateTimeStyles.NoCurrentDateDefault value is the only value that is useful with the System.DateTime.Parse(System.String) method, because System.DateTime.Parse(System.String) always ignores leading, trailing, and inner white-space characters.
ToString
Indicates that the date and time must be converted to Universal Time or Greenwich mean time (GMT).
ToString
Indicates that extra white-space characters in the middle of the string must be ignored.
ToString
Indicates that leading white-space characters must be ignored.
ToString
Indicates that trailing white-space characters must be ignored.
ToString
Indicates that extra white-space characters anywhere in the string must be ignored. This value is a combination of the System.Globalization.DateTimeStyles.AllowLeadingWhite, System.Globalization.DateTimeStyles.AllowTrailingwhite, and System.Globalization.DateTimeStyles.AllowInnerWhite values.
ToString
Indicates that, if the string does not include a date, the year, month, and day will each be set to “1” instead of the current year, month, and day.
ToString
Indicates that the default formatting options must be used. This is the default style for System.DateTime.Parse(System.String) and System.DateTime.ParseExact(System.String,System.String,System.IFormatProvider).
DaylightTime class (System.Globalization)
ToString
Description
Defines the period of daylight saving time. Daylight saving time is a period during the year when the time is advanced, usually by an hour, to take advantage of the extended daylight hours. At the end of the period, the time is set back to the standard time.
DaylightTime
Example Syntax:
ToString
Initializes a new instance of the System.Globalization.DaylightTime class.
The start parameter becomes the value of the System.Globalization.DaylightTime.Start property of the new instance. The end parameter becomes the value of the System.Globalization.DaylightTime.End property of the new instance. The delta parameter becomes the value of the System.Globalization.DaylightTime.Delta property of the new instance. The System.DateTime instance that represents the date and time when the daylight saving period begins. The value must be in local time. The System.DateTime instance that represents the date and time when the daylight saving period ends. The value must be in local time. The System.TimeSpan instance that represents the difference between the standard time and the daylight saving time in ticks.
Delta
ToString
Gets the System.TimeSpan instance that represents the difference between the standard time and the daylight saving time.
At the start of daylight saving time, the clock time is advanced by the length of time specified in this property. At the end of daylight saving time, the clock time is set back by the length of time specified in this property.
End
ToString
Gets the System.DateTime instance that represents the date and time when the daylight saving period ends.
When the daylight saving period ends, the clock time is set back to the standard time.
Start
ToString
Gets the System.DateTime instance that represents the date and time when the daylight saving period begins.
When the daylight saving period begins, the clock time is advanced by the number of ticks defined in System.Globalization.DaylightTime.Delta to take advantage of the extended daylight hours.
GregorianCalendar class (System.Globalization)
ToString
Description
Represents the Gregorian calendar.
The Gregorian calendar recognizes two eras: B.C. (before Christ) or B.C.E. (before common era), and A.D. (Latin “Anno Domini”, which means “in the year of the Lord”) or C.E. (common era). This implementation of the System.Globalization.GregorianCalendar class recognizes only the current era (A.D. or C.E.).
ToString
Represents the current era.
The Gregorian calendar recognizes two eras: B.C. (before Christ) or B.C.E. (before common era), and A.D. (Latin “Anno Domini”, which means “in the year of the Lord”) or C.E. (common era). This implementation of the System.Globalization.GregorianCalendar class recognizes only the current era (A.D. or C.E.). This field always returns 1.
GregorianCalendar
Example Syntax:
ToString
Initializes a new instance of the System.Globalization.GregorianCalendar class using the default System.Globalization.GregorianCalendarTypes value.
The default System.Globalization.GregorianCalendarTypes value is System.Globalization.GregorianCalendarTypes.Localized.
GregorianCalendar
Example Syntax:
ToString
Initializes a new instance of the System.Globalization.GregorianCalendar class using the specified System.Globalization.GregorianCalendarTypes value. The System.Globalization.GregorianCalendarTypes value that denotes which version of the calendar to create.
CalendarType
ToString
Gets or sets the System.Globalization.GregorianCalendarTypes value that denotes the version of the current System.Globalization.GregorianCalendar instance.
Eras
ToString
Gets the list of eras in the System.Globalization.GregorianCalendar.
The Gregorian calendar recognizes two eras: B.C. (before Christ) or B.C.E. (before common era), and A.D. (Latin “Anno Domini”, which means “in the year of the Lord”) or C.E. (common era). This implementation of the System.Globalization.GregorianCalendar class recognizes only the current era (A.D. or C.E.). This property always returns an array with only one element.
TwoDigitYearMax
ToString
Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.
This property allows a 2-digit year to be properly translated to a 4-digit year. For example, if this property is set to 2029, the 100-year range is from 1930 to 2029; therefore, a 2-digit value of 30 is interpreted as 1930, while a 2-digit value of 29 is interpreted as 2029.
AddMonths
Returns a System.DateTime that is the specified number of months away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of months to the specified System.DateTime.
The year part of the resulting System.DateTime is affected if the resulting month is beyond the last month of the current year. The day part of the resulting System.DateTime is also affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting System.DateTime remains the same as the specified System.DateTime. The System.DateTime instance to add. The number of months to add.
AddWeeks
Returns a System.DateTime that is the specified number of weeks away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of weeks to the specified System.DateTime.
If weeks is negative, the resulting System.DateTimne would be earlier than the specified System.DateTime. The System.DateTime instance to add. The number of weeks to add.
AddYears
DateTime;
Description
Returns a System.DateTime that is the specified number of years away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of years to the specified System.DateTime.
The day part of the resulting System.DateTime is affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting System.DateTime remains the same as the specified System.DateTime. The System.DateTime instance to add. The number of years to add.
Gets the day of the month in the specified System.DateTime.
Return Value: An integer from 1 to 31 that represents the day of the month in time. The System.DateTime instance to read.
GetDayOfWeek
Gets the day of the week in the specified System.DateTime.
Return Value: A System.DayOfWeek value that represents the day of the week in time
The System.DayOfWeek values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. The System.DateTime instance to read.
GetDayOfYear
Gets the day of the year in the specified System.DateTime.
Return Value: An integer from 1 to 366 that represents the day of the year in time.
The System.DateTime instance to read.
GetDaysInMonth
Gets the number of days in the month specified by the year, month, and era parameters.
Return Value: The number of days in the specified month in the specified year in the specified era.
For example, this method might return 28 or 29 for February (month=2), depending on whether year is a leap year. An integer that represents the year. An integer that represents the month. An integer that represents the era.
GetDaysInYear
Gets the number of days in the year specified by the year and era parameters.
Return Value: The number of days in the specified year in the specified era.
For example, this method might return 365 or 366, depending on whether year is a leap year. An integer that represents the year. An integer that represents the era.
GetEra
Gets the era in the specified System.DateTime
Return Value: An integer that represents the era in time.
The Gregorian calendar recognizes two eras: B.C. (before Christ) or B.C.E. I(before common era), and A.D. (Latin “Anno Domini”, which means “in the year of the Lord”) or C.E. (common era). This implementation of the System.Globalization.GregorianCalendar class recognizes only the current era (A.D. or C.E.). The System.DateTime instance to read.
GetMonth
Gets the month in the specified System.DateTime.
Return Value: An integer between 1 and 12 that represents the month in time. The System.DateTime instance to read.
GetMonthsInYear
Gets the number of months in the year specified by the year and era parameters.
Return Value: The number of months in the specified year in the specified era. An integer that represents the year. An integer that represents the era.
GetYear
Gets the year in the specified System.DateTime.
Return Value: An integer between 1 and 9999 that represents the year in time. The System.DateTime instance to read.
IsLeapDay
Determines whether the date specified by the year, month, day, and era parameters is a leap day.
Return Value: true if the specified day is a leap day; otherwise, false.
A leap year in the Gregorian calendar is defined as a year that is evenly divisible by four, except if it is divisible by 100; however, years that are divisible by 400 are leap years. For example, the year 1900 was not a leap year, but the year 2000 was. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the era.
IsLeapMonth
Determines whether the month specified by the year, month, and era parameters is a leap month.
Return Value: This method always returns false, unless overridden by a derived class.
A leap year in the Gregorian calendar is defined as a year that is evenly divisible by four, except if it is divisible by 100; however, years that are divisible by 400 are leap years. For example, the year 1900 was not a leap year, but the year 2000 was. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the month. An integer that represents the era.
IsLeapYear
Determines whether the year specified by the year and era parameters is a leap year.
Return Value: true if the specified year is a leap year; otherwise, false.
A leap year in the Gregorian calendar is defined as a year that is evenly divisible by four, except if it is divisible by 100; however, years that are divisible by 400 are leap years. For example, the year 1900 was not a leap year, but the year 2000 was. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the era.
ToDateTime
Returns a System.DateTime that is set to the specified date and time in the specified era.
Return Value: The System.DateTime instance set to the specified date and time in the current era. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the hour. An integer that represents the minute. An integer that represents the second. An integer that represents the millisecond. An integer that represents the era.
ToFourDigitYear
Converts the specified two-digit year to a four-digit year by using the System.Globalization.GregorianCalendar.TwoDigitYearMax property to determine the appropriate century.
Return Value: An integer that contains the four-digit representation of year.
System.Globalization.GregorianCalendar.TwoDigitYearMax is the last year in the 100-year range that can be represented by a two-digit year. The century is determined by finding the sole occurrence of the two-digit year within that 100-year range. For example, if System.Globalization.GregorianCalendar.TwoDigitYearMax is set to 2029, the 100-year range is from 1930 to 2029; therefore, a 2-digit value of 30 is interpreted as 1930, while a 2-digit value of 29 is interpreted as 2029. A two-digit integer that represents the year to convert.
GregorianCalendarTypes enumeration (System. Globalization)
ToString
Description
Defines the different language versions of the Gregorian calendar.
Each version differs by language.
ToString
Refers to the Arabic version of the Gregorian calendar.
ToString
Refers to the localized version of the Gregorian calendar, based on the language of the System.Globalization.CultureInfo that uses the System.Globalization.DateTimeFormatInfo instance.
ToString
Refers to the Middle East French version of the Gregorian calendar. ToString
Refers to the transliterated English version of the Gregorian calendar.
ToString
Refers to the transliterated French version of the Gregorian calendar.
ToString
Refers to the US English version of the Gregorian calendar.
HebrewCalendar class (System.Globalization)
ToString
Description
Represents the Hebrew calendar.
The Hebrew calendar recognizes two eras: B.C.E. (before the common era) and A.M. (Latin “Anno Mundi”, which means “the year of the world”). This implementation of the System.Globalization.HebrewCalendar class recognizes only the current era (A.M.) and only the Hebrew years 5343 to 6000 (1582 to 2240 in the Gregorian calendar).
ToString
Represents the current era.
The Hebrew calendar recognizes two eras: B.C.E. (before the common era) and A.M. (Latin “Anno Mundi”, which means “the year of the world”). This implementation of the System.Globalization.HebrewCalendar class recognizes only the current era (A.M.). This field always returns 1.
HebrewCalendar
Example Syntax:
ToString
Initializes a new instance of the System.Globalization.HebrewCalendar class.
Eras
ToString
Gets the list of eras in the System.Globalization.HebrewCalendar.
The Hebrew calendar recognizes two eras: B.C.E. (before the common era) and A.M. (Latin “Anno Mundi”, which means “the year of the world”). This implementation of the System.Globalization.HebrewCalendar class recognizes only the current era (A.M.). This property always returns an array with only one element.
TwoDigitYearMax
ToString
Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.
This implementation of the System.Globalization.HebrewCalendar class recognizes only the Hebrew years 5343 to 6000 (1582 to 2240 in the Gregorian calendar).
AddMonths
Returns a System.DateTime that is the specified number of months away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of months to the specified System.DateTime
This implementation of the System.Globalization.HebrewCalendar class recognizes only the Hebrew years 5343 to 6000 (1582 to 2240 in the Gregorian calendar). The System.DateTime instance to add. The number of months to add.
AddYears
Returns a System.DateTime that is the specified number of years away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of years to the specified System.DateTime.
This implementation of the System.Globalization.HebrewCalendar class recognizes only the Hebrew years 5343 to 6000 (1582 to 2240 in the Gregorian calendar). The System.DateTime instance to add. The number of years to add.
GetDayOfMonth
Gets the day of the month in the specified System.DateTime
Return Value: An integer from 1 to 30 that represents the day of the month in time. The System.DateTime instance to read.
GetDayOfWeek
Gets the day of the week in the specified System.DateTime.
Return Value: A System.DayOfWeek value that represents the day of the week in time.
The System.DayOfWeek values are Sunday which indicates Yom Rishon, Monday which indicates Yom Sheni, Tuesday which indicates Yom Shlishi, Wednesday which indicates Yom Reviee, Thursday which indicates Yom Chamishi, Friday which indicates Yom Shishi, and Saturday which indicates Shabat. The System.DateTime instance to read.
GetDayOfYear
Gets the day of the year in the specified System.DateTime
Return Value: An integer from 1 to 385 that represents the day of the year in time.
This implementation of the System.Globalization.HebrewCalendar class recognizes only the Hebrew years 5343 to 6000 (1582 to 2240 in the Gregorian calendar). The System.DateTime instance to read.
GetDaysInMonth
Gets the number of days in the month specified by the year, month, and era parameters.
Return Value: The number of days in the specified month in the specified year in the specified era.
For example, this method might return 29 or 30 for Cheshvan, depending on the placement of Jewish holidays. An integer that represents the year. An integer that represents the month. An integer that represents the era.
GetDaysInYear
Gets the number of days in the year specified by the year and era parameters.
Return Value: The number of days in the specified year in the specified era.
For example, this method might return an integer from 353 to 355 or from 383 to 385, depending on the placement of Jewish holidays and depending on whether year is a leap year. An integer that represents the year. An integer that represents the era.
GetEra
Gets the era in the specified System.DateTime.
Return Value: An integer that represents the era in time
The Hebrew calendar recognizes two eras: B.C.E. (before the common era) and A.M. (Latin “Anno Mundi”, which means “the year of the world”). This implementation of the System.Globalization.HebrewCalendar class recognizes only the current era (A.M.) and only the Hebrew years 5343 to 6000 (1582 to 2240 in the Gregorian calendar). The System.DateTime instance to read.
GetMonth
Gets the month in the specified System.DateTime.
Return Value: An integer between 1 and 13 that represents the month in time. The System.DateTime instance to read. GetMonthsInYear
Gets the number of months in the year specified by the year and era parameters.
Return Value: The number of months in the specified year in the specified era.
For example, this method might return 12 or 13, depending on whether year is a leap year. An integer that represents the year. An integer that represents the era.
GetYear
Gets the year in the specified System.DateTime.
Return Value: An integer between 1 and 9999 that represents the year in time.
This implementation of the System.Globalization.HebrewCalendar class recognizes only the Hebrew years 5343 to 6000 (1582 to 2240 in the Gregorian calendar). The System.DateTime instance to read.
IsLeapDay
Determines whether the date specified by the year, month, day, and era parameters is a leap day.
Return Value: true if the specified day is a leap day; otherwise, false.
This implementation of the System.Globalization.HebrewCalendar class recognizes only the Hebrew years 5343 to 6000 (1582 to 2240 in the Gregorian calendar). An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the era.
IsLeapMonth
Determines whether the month specified by the year, month, and era parameters is a leap month.
Return Value: true if the specified month is a leap month; otherwise, false.
This implementation of the System.Globalization.HebrewCalendar class recognizes only the Hebrew years 5343 to 6000 (1582 to 2240 in the Gregorian calendar). An integer that represents the year. An integer that represents the month. An integer that represents the era.
IsLeapYear
Determines whether the year specified by the year and era parameters is a leap year.
Return Value: true if the specified year is a leap year; otherwise, false.
This implementation of the System.Globalization.HebrewCalendar class recognizes only the Hebrew years 5343 to 6000 (1582 to 2240 in the Gregorian calendar). An integer that represents the year. An integer that represents the era.
ToDateTime
Returns a System.DateTime that is set to the specified date and time in the specified era.
Return Value: The System.DateTime instance set to the specified date and time in the current era.
This implementation of the System.Globalization.HebrewCalendar class recognizes only the Hebrew years 5343 to 6000 (1582 to 2240 in the Gregorian calendar). An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the hour. An integer that represents the minute. An integer that represents the second. An integer that represents the millisecond. An integer that represents the era.
ToFourDigitYear
Converts the specified two-digit year to a four-digit year by using the System.Globalization.HebrewCalendar.TwoDigitYearMax property to determine the appropriate century.
Return Value: An integer that contains the four-digit representation of year.
This implementation of the System.Globalization.HebrewCalendar class recognizes only the Hebrew years 5343 to 6000 (1582 to 2240 in the Gregorian calendar). A two-digit integer that represents the year to convert.
HijriCalendar class (System.Globalization)
ToString
Description
Represents the Hijri calendar.
The Hijri calendar recognizes one era: A.H. (Latin “Anno Hegirae”, which means “the year of the migration” in reference to the migration of Muhammad from Mecca).
ToString
Represents the current era.
The Hijri calendar recognizes one era: A.H. (Latin “Anno Hegirae”, which means “the year of the migration” referring to the migration of Muhammad from Mecca).
HijriCalendar
Example Syntax:
ToString
Initializes a new instance of the System.Globalization.HijriCalendar class.
Eras
ToString
Gets the list of eras in the System.Globalization.HijriCalendar.
The Hijri calendar recognizes one era: A.H. (Latin “Anno Hegirae”, which means “the year of the migration” referring to the migration of Muhammad from Mecca).
TwoDigitYearMax
ToString
Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.
This property allows a 2-digit year to be properly translated to a 4-digit year. For example, if this property is set to 1429, the 100-year range is from 1330 to 1429; therefore, a 2-digit value of 30 is interpreted as 1330, while a 2-digit value of 29 is interpreted as 1429.
AddMonths
Returns a System.DateTime that is the specified number of months away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of months to the specified System.DateTime.
The year part of the resulting System.DateTime is affected if the resulting month is beyond the last month of the current year. The day part of the resulting System.DateTime is also affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting System.DateTime remains the same as the specified System.DateTime. The System.DateTime instance to add. The number of months to add.
AddYears
Returns a System.DateTime that is the specified number of years away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of years to the specified System.DateTime.
The day part of the resulting System.DateTime is affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting System.DateTime remains the same as the specified System.DateTime. The System.DateTime instance to add. The number of years to add.
GetDayOfMonth
Gets the day of the month in the specified System.DateTime.
Return Value: An integer from 1 to 30 that represents the day of the month in time. The System.DateTime instance to read.
GetDayOfWeek
Gets the day of the week in the specified System.DateTime.
Return Value: A System.DayOfWeek value that represents the day of the week in time.
The System.DayOfWeek values are Sunday which indicates Al-Ahad, Monday which indicates Al-Ithnayn, Tuesday which indicates At-Thulaathaa', Wednesday which indicates Al-Arbi‘aa’, Thursday which indicates Al-Khamiis, Friday which indicates Al-Jumu'ah, and Saturday which indicates As-Sabt. The System.DateTime instance to read.
GetDayOfYear
Gets the day of the year in the specified System.DateTime.
Return Value: An integer from 1 to 355 that represents the day of the year in time. The System.DateTime instance to read.
GetDaysInMonth
Gets the number of days in the month specified by the year, month, and era parameters.
Return Value: The number of days in the specified month in the specified year in the specified era.
For example, this method might return 29 or 30 for Zulhijjah (month=12), depending on whether year is a leap year. An integer that represents the year. An integer that represents the month. An integer that represents the era.
GetDaysInYear
Gets the number of days in the year specified by the year and era parameters.
Return Value: The number of days in the specified year in the specified era.
For example, this method might return 354 or 355, depending on whether year is a leap year. An integer that represents the year. An integer that represents the era.
GetEra
Description
Gets the era in the specified System.DateTime.
Return Value: An integer that represents the era in time.
The Hijri calendar recognizes one era: A.H. (Latin “Anno Hegirae”, which means “the year of the migration” referring to the migration of Muhammad from Mecca). The System.DateTime instance to read.
GetMonth
Gets the month in the specified System.DateTime.
Return Value: An integer between 1 and 12 that represents the month in time. The System.DateTime instance to read.
GetMonthsInYear
Gets the number of months in the year specified by the year and era parameters.
Return Value: The number of months in the specified year in the specified era. An integer that represents the year. An integer that represents the era.
GetYear
Gets the year in the specified System.DateTime.
Return Value: An integer between 1 and 9999 that represents the year in time. The System.DateTime instance to read.
IsLeapDay
Determines whether the date specified by the year, month, day, and era parameters is a leap day.
Return Value: true if the specified day is a leap day; otherwise, false.
In every 30-year cycle that ends with a year that is evenly divisible by 30, the 2nd, 5th, 7th, 10th, 13th, 16th, 18th, 21st, 24th, 26th, and 29th years are leap years. A common year has 354 days and a leap year has 355 days. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the era.
IsLeapMonth
Determines whether the month specified by the year, month, and era parameters is a leap month.
Return Value: This method always returns false, unless overridden by a derived class.
In every 30-year cycle that ends with a year that is evenly divisible by 30, the 2nd, 5th, 7th, 10th, 13th, 16th, 18th, 21st, 24th, 26th, and 29th years are leap years. A common year has 354 days and a leap year has 355 days. An integer that represents the year. An integer that represents the month. An integer that represents the era.
IsLeapYear
Determines whether the year specified by the year and era parameters is a leap year.
Return Value: true if the specified year is a leap year; otherwise, false.
In every 30-year cycle that ends with a year that is evenly divisible by 30, the 2nd, 5th, 7th, 10th, 13th, 16th, 18th, 21st, 24th, 26th, and 29th years are leap years. A common year has 354 days and a leap year has 355 days. An integer that represents the year. An integer that represents the era.
ToDateTime
Returns a System.DateTime that is set to the specified date and time in the specified era.
Return Value: The System.DateTime instance set to the specified date and time in the current era. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the hour. An integer that represents the minute. An integer that represents the second. An integer that represents the millisecond. An integer that represents the era.
ToFourDigitYear
Converts the specified two-digit year to a four-digit year by using the System.Globalization.HijriCalendar.TwoDigitYearMax property to determine the appropriate century.
Return Value: An integer that contains the four-digit representation of year.
System.Globalization.HijriCalendar.TwoDigitYearMax is the last year in the 100-year range that can be represented by a two-digit year. The century is determined by finding the sole occurrence of the two-digit year within that 100-year range. For example, if System.Globalization.HijriCalendar.TwoDigitYearMax is set to 1429, the 100-year range is from 1330 to 1429; therefore, a 2-digit value of 30 is interpreted as 1330, while a 2-digit value of 29 is interpreted as 1429. A two-digit integer that represents the year to convert.
JapaneseCalendar class (System. Globalization)
ToString
Description
Represents the Japanese calendar.
The Japanese calendar, which is also known as the Wareki calendar, works exactly like the Gregorian calendar, except that the year and era are different.
JapaneseCalendar
Example Syntax:
ToString
Initializes a new instance of the System.Globalization.JapaneseCalendar class.
Eras
ToString
Gets the list of eras in the System.Globalization.JapaneseCalendar.
The Japanese calendar recognizes one era for every emperor's reign. The current era is the Heisei era, which began in the Gregorian calendar year 1989. The era name is typically displayed before the year. For example, the Gregorian calendar year 2001 is the Wareki calendar year Heisei 13. Note that the first year of an era is called “Gannen”; therefore, the Gregorian calendar year 1989 was the Wareki calendar year Heisei Gannen.
TwoDigitYearMax
ToString
Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.
This property implements System.Globalization.Calendar.TwoDigitYearMax.
AddMonths
Returns a System.DateTime that is the specified number of months away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of months to the specified System.DateTime.
The year part of the resulting System.DateTime is affected if the resulting month is beyond the last month of the current year. The day part of the resulting System.DateTime is also affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting System.DateTime remains the same as the specified System.DateTime. The System.DateTime instance to add. The number of months to add.
AddYears
Returns a System.DateTime that is the specified number of years away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of years to the specified System.DateTime.
The day part of the resulting System.DateTime is affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting System.DateTime remains the same as the specified System.DateTime. The System.DateTime instance to add. The number of years to add.
GetDayOfMonth
Gets the day of the month in the specified System.DateTime.
Return Value: An integer from 1 to 31 that represents the day of the month in time. The System.DateTime instance to read.
GetDayOfWeek
Gets the day of the week in the specified System.DateTime
Return Value: A System.DayOfWeek value that represents the day of the week in time.
The System.DayOfWeek values are Sunday which indicates NichiYoubi, Monday which indicates GetsuYoubi, Tuesday which indicates KaYoubi, Wednesday which indicates SuiYoubi, Thursday which indicates MokuYoubi, Friday which indicates KinYoubi, and Saturday which indicates DouYoubi. The System.DateTime instance to read.
GetDayOfYear
Gets the day of the year in the specified System.DateTime.
Return Value: An integer from 1 to 366 that represents the day of the year in time.
The System.DateTime instance to read.
GetDaysInMonth
Gets the number of days in the month specified by the year, month, and era parameters.
Return Value: The number of days in the specified month in the specified year in the specified era.
For example, this method might return 28 or 29 for NiGatsu (February, month=2), depending on whether year is a leap year. An integer that represents the year. An integer that represents the month. An integer that represents the era.
GetDaysInYear
Gets the number of days in the year specified by the year and era parameters.
Return Value: The number of days in the specified year in the specified era.
For example, this method might return 365 or 366, depending on whether year is a leap year. An integer that represents the year. An integer that represents the era.
GetEra
Gets the era in the specified System.DateTime
Return Value: An integer that represents the era in time.
The Japanese calendar recognizes one era for every emperor's reign. The current era is the Heisei era, which began in the Gregorian calendar year 1989. The era name is typically displayed before the year. For example, the Gregorian calendar year 2001 is the Wareki calendar year Heisei 13. Note that the first year of an era is called “Gannen”; therefore, the Gregorian calendar year 1989 was the Wareki calendar year Heisei Gannen. The System.DateTime instance to read.
GetMonth
Gets the month in the specified System.DateTime.
Return Value: An integer between 1 and 12 that represents the month in time. The System.DateTime instance to read.
GetMonthsInYear
Gets the number of months in the year specified by the year and era parameters.
Return Value: The number of months in the specified year in the specified era. An integer that represents the year. An integer that represents the era.
GetYear
Gets the year in the specified System.DateTime.
Return Value: An integer between 1 and 9999 that represents the year in time. The System.DateTime instance to read.
IsLeapDay
Determines whether the date specified by the year, month, day, and era parameters is a leap day.
Return Value: true, if the specified day is a leap day; otherwise, false.
Leap years in the Japanese calendar correspond to the same leap years in the Gregorian calendar. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the era.
IsLeapMonth
Determines whether the month specified by the year, month, and era parameters is a leap month.
Return Value: This method always returns false, unless overridden by a derived class.
Leap years in the Japanese calendar correspond to the same leap years in the Gregorian calendar. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the month. An integer that represents the era.
IsLeapYear
Determines whether the year specified by the year and era parameters is a leap year.
Return Value: true, if the specified year is a leap year; otherwise, false.
Leap years in the Japanese calendar correspond to the same leap years in the Gregorian calendar. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the era.
ToDateTime
Returns a System.DateTime that is set to the specified date and time in the specified era.
Return Value: The System.DateTime instance set to the specified date and time in the current era. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the hour. An integer that represents the minute. An integer that represents the second. An integer that represents the millisecond. An integer that represents the era.
ToFourDigitYear
Converts the specified two-digit year to a four-digit year by using the System.Globalization.JapaneseCalendar.TwoDigitYearMax property to determine the appropriate century.
Return Value: An integer that contains the four-digit representation of year.
This method implements
System.Globalization.Calendar.ToFourDigitYear(System.Int32). A two-digit integer that represents the year to convert.
JulianCalendar class (System.Globalization)
ToString
Description
Represents the Julian calendar.
In 45 B.C., Julius Caesar ordered a calendar reform, which resulted in the calendar called the Julian calendar. The Julian calendar is the predecessor of the Gregorian calendar.
ToString
Represents the current era.
The System.Globalization.JulianCalendar class recognizes only the current era. This field always returns 1.
JulianCalendar
Example Syntax:
ToString
Initializes a new instance of the System.Globalization.JulianCalendar class.
Eras
ToString
Gets the list of eras in the System.Globalization.JulianCalendar
The System.Globalization.JulianCalendar class recognizes only the current era. This property always returns an array with only one element.
TwoDigitYearMax
ToString
Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.
This property allows a 2-digit year to be properly translated to a 4-digit year. For example, if this property is set to 2029, the 100-year range is from 1930 to 2029; therefore, a 2-digit value of 30 is interpreted as 1930, while a 2-digit value of 29 is interpreted as 2029.
AddMonths
Returns a System.DateTime that is the specified number of months away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of months to the specified System.DateTime.
The year part of the resulting System.DateTime is affected if the resulting month is beyond the last month of the current year. The day part of the resulting System.DateTime is also affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting System.DateTime remains the same as the specified System.DateTime. The System.DateTime instance to add. The number of months to add.
AddYears
Returns a System.DateTime that is the specified number of years away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of years to the specified System.DateTime.
The day part of the resulting System.DateTime is affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting System.DateTime remains the same as the specified System.DateTime. The System.DateTime instance to add. The number of years to add.
GetDayOfMonth
Gets the day of the month in the specified System.DateTime.
Return Value: An integer from 1 to 31 that represents the day of the month in time. The System.DateTime instance to read.
GetDayOfWeek
Gets the day of the week in the specified System.DateTime
Return Value: A System.DayOfWeek value that represents the day of the week in time.
The System.DayOfWeek values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. The System.DateTime instance to read.
GetDayOfYear
Gets the day of the year in the specified System.DateTime.
Return Value: An integer from 1 to 366 that represents the day of the year in time. The System.DateTime instance to read.
GetDaysInMonth
Gets the number of days in the month specified by the year, month, and era parameters.
Return Value: The number of days in the specified month in the specified year in the specified era.
For example, this method might return 28 or 29 for February (month=2), depending on whether year is a leap year. An integer that represents the year. An integer that represents the month. An integer that represents the era.
GetDaysInYear
Gets the number of days in the year specified by the year and era parameters.
Return Value: The number of days in the specified year in the specified era.
For example, this method might return 365 or 366, depending on whether year is a leap year. An integer that represents the year. An integer that represents the era.
GetEra
Gets the era in the specified System.DateTime.
Return Value: An integer that represents the era in time.
The System.Globalization.JulianCalendar class recognizes only the current era. The System.DateTime instance to read.
GetMonth
Gets the month in the specified System.DateTime.
Return Value: An integer between 1 and 12 that represents the month in time. The System.DateTime instance to read.
GetMonthsInYear
Gets the number of months in the year specified by the year and era parameters.
Return Value: The number of months in the specified year in the specified era. An integer that represents the year. An integer that represents the era.
GetYear
Gets the year in the specified System.DateTime.
Return Value: An integer between 1 and 9999 that represents the year in time. The System.DateTime instance to read.
IsLeapDay
Determines whether the date specified by the year, month, day, and era parameters is a leap day.
Return Value: true if the specified day is a leap day; otherwise, false.
Unlike the Gregorian calendar, the Julian calendar defines a leap year as a year that is evenly divisible by four with no exceptions; therefore, the calendar is inaccurate by one day every 128 years. For example, the year 1999 was not a leap year, but the year 2000 was. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the era.
IsLeapMonth
Determines whether the month specified by the year, month, and era parameters is a leap month.
Return Value: This method always returns false, unless overridden by a derived class.
Unlike the Gregorian calendar, the Julian calendar defines a leap year as a year that is evenly divisible by four with no exceptions; therefore, the calendar is inaccurate by one day every 128 years. For example, the year 1999 was not a leap year, but the year 2000 was. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the month. An integer that represents the era.
IsLeapYear
Determines whether the year specified by the year and era parameters is a leap year.
Return Value: true if the specified year is a leap year; otherwise, false.
Unlike the Gregorian calendar, the Julian calendar defines a leap year as a year that is evenly divisible by four with no exceptions; therefore, the calendar is inaccurate by one day every 128 years. For example, the year 1999 was not a leap year, but the year 2000 was. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the era.
ToDateTime
Returns a System.DateTime that is set to the specified date and time in the specified era.
Return Value: The System.DateTime instance set to the specified date and time in the current era. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the hour. An integer that represents the minute. An integer that represents the second. An integer that represents the millisecond. An integer that represents the era.
ToFourDigitYear
Converts the specified two-digit year to a four-digit year by using the System.Globalization.JulianCalendar.TwoDigitYearMax property to determine the appropriate century.
Return Value: An integer that contains the four-digit representation of year.
System.Globalization.JulianCalendar.TwoDigitYearMax is the last year in the 100-year range that can be represented by a two-digit year. The century is determined by finding the sole occurrence of the two-digit year within that 100-year range. For example, if System.Globalization.JulianCalendar.TwoDigitYearMax is set to 2029, the 100-year range is from 1930 to 2029; therefore, a 2-digit value of 30 is interpreted as 1930, while a 2-digit value of 29 is interpreted as 2029. A two-digit integer that represents the year to convert.
KoreanCalendar class (System.Globalization)
ToString
Description
Represents the Korean calendar.
The Korean calendar works exactly like the Gregorian calendar, except that the year and era are different.
ToString
Represents the current era.
The System.Globalization.KoreanCalendar class recognizes only the current era. This field always returns 1.
KoreanCalendar
Example Syntax:
ToString
Initializes a new instance of the System.Globalization.KoreanCalendar class.
Eras
ToString
Gets the list of eras in the System.Globalization.KoreanCalendar.
The System.Globalization.KoreanCalendar class recognizes only the current era. This property always returns an array with only one element.
TwoDigitYearMax
ToString
Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.
This property allows a 2-digit year to be properly translated to a 4-digit year. For example, in the Gregorian calendar, if this property is set to 2029, the 100-year range is from 1930 to 2029; therefore, a 2-digit value of 30 is interpreted as 1930, while a 2-digit value of 29 is interpreted as 2029.
AddMonths
Returns a System.DateTime that is the specified number of months away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of months to the specified System.DateTime.
The year part of the resulting System.DateTime is affected if the resulting month is beyond the last month of the current year. The day part of the resulting System.DateTime is also affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting System.DateTime remains the same as the specified System.DateTime. The System.DateTime instance to add. The number of months to add.
AddYears
Returns a System.DateTime that is the specified number of years away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of years to the specified System.DateTime.
The day part of the resulting System.DateTime is affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting System.DateTime remains the same as the specified System.DateTime. The System.DateTime instance to add. The number of years to add.
GetDayOfMonth
Gets the day of the month in the specified System.DateTime.
Return Value: An integer from 1 to 31 that represents the day of the month in time. The System.DateTime instance to read.
GetDayOfWeek
Gets the day of the week in the specified System.DateTime.
Return Value: A System.DayOfWeek value that represents the day of the week in time.
The System.DayOfWeek values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. The System.DateTime instance to read.
GetDayOfYear
Gets the day of the year in the specified System.DateTime.
Return Value: An integer from 1 to 366 that represents the day of the year in time The System.DateTime instance to read.
GetDaysInMonth
Gets the number of days in the month specified by the year, month, and era parameters.
Return Value: The number of days in the specified month in the specified year in the specified era.
For example, this method might return 28 or 29 for February, month=2), depending on whether year is a leap year. An integer that represents the year. An integer that represents the month. An integer that represents the era.
GetDaysInYear
Gets the number of days in the year specified by the year and era parameters.
Return Value: The number of days in the specified year in the specified era.
For example, this method might return 365 or 366, depending on whether year is a leap year. An integer that represents the year. An integer that represents the era.
GetEra
Gets the era in the specified System.DateTime.
Return Value: An integer that represents the era in time.
The System.Globalization.KoreanCalendar class recognizes only the current era. The System.DateTime instance to read.
GetMonth
Gets the month in the specified System.DateTime.
Return Value: An integer between 1 and 12 that represents the month in time. The System.DateTime instance to read.
GetMonthsInYear
Gets the number of months in the year specified by the year and era parameters.
Return Value: The number of months in the specified year in the specified era. An integer that represents the year. An integer that represents the era.
GetYear
Gets the year in the specified System.DateTime
Return Value: An integer between 1 and 9999 that represents the year in time. The System.DateTime instance to read.
IsLeapDay
Determines whether the date specified by the year, month, day, and era parameters is a leap day.
Return Value: true if the specified day is a leap day; otherwise, false.
Leap years in the Korean calendar correspond to the same leap years in the Gregorian calendar. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the era.
IsLeapMonth
Determines whether the month specified by the year, month, and era parameters is a leap month.
Return Value: This method always returns false, unless overridden by a derived class.
Leap years in the Korean calendar correspond to the same leap years in the Gregorian calendar. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the month. An integer that represents the era.
IsLeapYear
Determines whether the year specified by the year and era parameters is a leap year.
Return Value: true if the specified year is a leap year; otherwise, false.
Leap years in the Korean calendar correspond to the same leap years in the Gregorian calendar. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the era.
ToDateTime
Returns a System.DateTime that is set to the specified date and time in the specified era.
Return Value: The System.DateTime instance set to the specified date and time in the current era. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the hour. An integer that represents the minute. An integer that represents the second. An integer that represents the millisecond. An integer that represents the era.
ToFourDigitYear
Converts the specified two-digit year to a four-digit year by using the System.Globalization.KoreanCalendar.TwoDigitYearMax property to determine the appropriate century.
Return Value: An integer that contains the four-digit representation of year.
System.Globalization.KoreanCalendar.TwoDigitYearMax is the last year in the 100-year range that can be represented by a two-digit year. The century is determined by finding the sole occurrence of the two-digit year within that 100 year range. For example, if System.Globalization.KoreanCalendar.TwoDigitYearMax is set to 2029, the 100-year range is from 1930 to 2029; therefore, a 2-digit value of 30 is interpreted as 1930, while a 2-digit value of 29 is interpreted as 2029. A two-digit integer that represents the year to convert.
NumberFormatInfo class (System.Globalization) ToString
Description
Defines how numeric values are formatted and displayed, depending on the culture.
This class contains information, such as currency, decimal separators, and other numeric symbols. Numeric values are formatted using standard or custom patterns stored in the properties of a System.Globalization.NumberFormatInfo instance. To modify how a value is displayed, the System.Globalization.NumberFormatInfo instance must be writable so custom patterns can be saved in its properties.
NumberFormatInfo
Example Syntax:
ToString
Initializes a new writable instance of the System.Globalization.NumberFormatInfo class that is culture-independent (invariant).
The properties of the new instance can be modified if you want user-defined formatting.
CurrencyDecimalDigits
ToString
Indicates the number of decimal places to use in currency values.
CurrencyDecimalSeparator
ToString
Indicates the System.String to use as the decimal separator in currency values.
CurrencyGroupSeparator
ToString
Indicates the System.String that separates groups of digits to the left of the decimal in currency values.
CurrencyGroupSizes
ToString
Indicates the number of digits in each group to the left of the decimal in currency values.
Every element in the one-dimensional array must be an integer from 1 through 9. The last element can be 0.
CurrencyNegativePattern
ToString
Indicates the format pattern for negative currency values.
This property can have one of the values in the following table. The symbol “$” is the System.Globalization.NumberFormatInfo.CurrencySymbol, the symbol “−” is the System.Globalization.NumberFormatInfo.NegativeSign, and n is a number.
CurrencyPositivePattern
ToString
Indicates the format pattern for positive currency values.
This property can have one of the values in the following table. The symbol “$” is the System.Globalization.NumberFormatInfo.CurrencySymbol and n is a number.
CurrencySymbol
ToString
Indicates the System.String to use as the currency symbol.
CurrentInfo
ToString
Gets a read-only System.Globalization.NumberFormatInfo instance that formats values based on the current culture.
InvariantInfo
ToString
Gets the default read-only System.Globalization.NumberFormatInfo instance that is culture-independent (invariant).
This property does not change, regardless of the current culture.
IsReadOnly
ToString
Gets a value indicating whether the System.Globalization.NumberFormatInfo is read-only.
NaNSymbol
ToString
Indicates the System.String that represents the IEEE NaN (not a number) value.
NegativeInfinitySymbol
ToString
Indicates the System.String that represents negative infinity.
NegativeSign
ToString
Indicates the System.String that denotes that the associated number is negative.
NumberDecimalDigits
ToString
Indicates the number of decimal places to use in numeric values.
NumberDecimalSeparator
ToString
Indicates the System-String to use as the decimal separator in numeric values.
NumberGroupSeparator
ToString
Indicates the System.String that separates groups of digits to the left of the decimal in numeric values.
NumberGroupSizes
ToString
Indicates the number of digits in each group to the left of the decimal in numeric values.
Every element in the one-dimensional array must be an integer from 1 through 9. The last element can be 0.
NumberNegativePattern
ToString
Indicates the format pattern for negative numeric values.
This property can have one of the values in the following table. The symbol “−” is the System.Globalization.NumberFormatInfo.NegativeSign and n is a number.
PercentDecimalDigits
ToString
Indicates the number of decimal places to use in percent values.
PercentDecimalSeparator
ToString
Indicates the System.String to use as the decimal separator in percent values.
PercentGroupSeparator
ToString
Indicates the System.String that separates groups of digits to the left of the decimal in percent values.
PercentGroupSizes
ToString
Indicates the number of digits in each group to the left of the decimal in percent values.
Every element in the one-dimensional array must be an integer from 1 through 9. The last element can be 0.
PercentNegativePattern
ToString
Indicates the format pattern for negative percent values.
This property can have one of the values in the following table. The symbol “%” is the System.Globalization.NumberFormatInfo.PercentSymbol, the symbol “−” is the System.Globalization.NumberFormatInfo.NegativeSign, and n is a number.
PercentPositivePattern
ToString
Indicates the format pattern for positive percent values.
This property can have one of the values in the following table. The symbol “%” is the System.Globalization.NumberFormatInfo.PercentSymbol and n is a number.
PercentSymbol
ToString
Indicates the System.String to use as the percent symbol.
PerMilleSymbol
ToString
Indicates the System.String to use as the per mille symbol.
PositiveInfinitySymbol
ToString
Indicates the System.String that represents positive infinity.
PositiveSign
ToString
PositiveSign(String);
Description
Indicates the System.String that denotes that the associated number is positive.
This property is used only for parsing numeric strings, not for formatting.
Clone
Creates a shallow copy of the System.Globalization.NumberFormatInfo instance.
Return Value: A new System.Globalization.NumberFormatInfo instance copied from the original System.Globalization.NumberFormatInfo instance.
The clone is writable even if the original instance is read-only; therefore, the properties of the clone can be modified with user-defined patterns.
GetFormat
Gets an object of the specified type that provides a number formatting service.
Return Value: The current instance of the System.Globalization.NumberFormatInfo class, if formatType is the same as the type of the current instance; otherwise, null.
The Format(String, IFormatProvider) methods supported by the base data types invoke this method when the current instance is passed as the System.IFormatProvider parameter. This method implements System.IFormatProvider.GetFormat(System.Type). The System.Type of the required formatting service.
GetInstance
Gets the System.Globalization.NumberFormatInfo instance associated with the specified System.IFormatProvider.
Return Value: The System.Globalization.NumberFormatInfo instance associated with the specified System.IFormatProvider.
This method uses the System.IFormatProvider.GetFormat(System.Type) method of formatProvider using System.Globalization.NumberFormatInfo as the Type parameter. If formatProvider is null or if System.IFormatProvider.GetFormat(System.Type) returns null, this method returns System.Globalization.NumberFormatInfo.CurrentInfo. The System.IFormatProvider used to get the System.Globalization.NumberFormatInfo instance.
ReadOnly
Returns a read-only System.Globalization.NumberFormatInfo wrapper.
Return Value: A read-only System.Globalization.NumberFormatInfo wrapper around nfi.
This wrapper prevents any modifications to nfi. The System.Globalization.NumberFormatInfo to wrap.
NumberStyles enumeration (System. Globalization)
ToString
Description
Determines the styles permitted in numerical string arguments that are passed to the Parse methods of the numeric base type classes.
The symbols to use for currency symbol, thousands separator, decimal point indicator, and leading sign are specified by System.Globalization.NumberFormatInfo.
ToString
Indicates that a currency symbol is allowed. Valid currency symbols are, determined by the System.Globalization.NumberFormatInfo.CurrencySymbol property of System.Globalization.NumberFormatInfo
ToString
Indicates that a decimal point is allowed. Valid decimal point characters are determined by the System.Globalization.NumberFormatInfo.NumberDecimalSeparator and System.Globalization.NumberFormatInfo.CurrencyDecimalSeparator properties of System.Globalization.NumberFormatInfo.
ToString
Indicates that an exponent is allowed. The format of the number should be {e|E} [{+|−}] n, where n is a number.
ToString
Indicates that hexadecimal numbers are allowed.
ToString
Indicates that a leading sign is allowed. Valid leading sign characters are determined by the System.Globalization.NumberFormatInfo.PositiveSign and System.Globalization.NumberFormatInfo.NegativeSign properties of System.Globalization.NumberFormatInfo.
ToString
Indicates that a leading white-space character is allowed. Valid white-space characters have the Unicode values U+0009, U+000A, U+000B, U+000C, U+000D, and U+0020.
ToString
Indicates that parentheses are allowed.
ToString
Indicates that group separators are allowed; for instance, separating the hundreds from the thousands. Valid group separator characters are determined by the System.Globalization.NumberFormatInfo.NumberGroupSeparator and System.Globalization.NumberFormatInfo.CurrencyGroupSeparator properties of System.Globalization.NumberFormatInfo and the number of digits in each group is determined by the System.Globalization.NumberFormatInfo.NumberGroupSizes and System.Globalization.NumberFormatInfo.CurrencyGroupSizes properties of System.Globalization.NumberFormatInfo.
ToString
Indicates that a trailing sign is allowed. Valid trailing sign characters are determined by the System.Globalization.NumberFormatInfo.PositiveSign and System.Globalization.NumberFormatInfo.NegativeSign properties of System.Globalization.NumberFormatInfo.
ToString
Indicates that trailing white-space character is allowed. Valid white-space characters have the Unicode values U+0009, U+000A, U+000B, U+000C, U+000D, and U+0020.
ToString
Indicates that all the AllowXXX bit styles are used. This is a composite number style.
ToString
Indicates that all styles except AllowExponent are used. This is a composite number style.
ToString
Indicates that the AllowLeadingWhite, AllowTrailingWhite, AllowLeadingSign, AllowDecimalPoint, and AllowExponent styles are used. This is a composite number style.
ToString
Indicates that the AllowLeadingWhite, AllowTrailingWhite, and AllowHexSpecifier styles are used. This is a composite number style.
ToString
Indicates that the AllowLeadingWhite, AllowTrailingWhite, and AllowLeadingSign styles are used. This is a composite number style.
ToString
Indicates that none of the bit styles are allowed.
ToString
Indicates that the AllowLeadingWhite, AllowTrailingWhite, AllowLeadingSign, AllowTrailingSign, AllowDecimalPoint, and AllowThousands styles are used. This is a composite number style.
RegionInfo class (System.Globalization)
ToString
Description
Contains information about the country/region.
In contrast to System.Globalization.CultureInfo, System.Globalization.RegionInfo does not represent preferences of the user and does not depend on the user's language or culture.
RegionInfo
Example Syntax:
ToString
Initializes a new instance of the System.Globalization.RegionInfo class based on the country/region associated with the specified culture identifier.
The culture identifier is mapped to the corresponding National Language Support (NLS) locale identifier. A list of culture identifiers is provided in the System.Globalization.CultureInfo class topic. A culture identifier.
RegionInfo
Example Syntax:
ToString
Initializes a new instance of the System.Globalization.RegionInfo class based on the country/region specified by name.
The System.Globalization.RegionInfo name is one of the two-letter codes defined in ISO 3166 for country/region. A System.String containing one of the two-letter codes defined in ISO 3166 for country/region.
CurrencySymbol
ToString
Gets the currency symbol associated with the country/region.
For example, the currency symbol for the United States is “$”.
CurrentRegion
ToString
Gets the System.Globalization.RegionInfo instance that represents the country/region used by the current thread.
The value of this property is based on the locale selected through the Regional and Language Options (or Regional Options or Regional Settings) applet in Windows Control Panel. However, that information can change during the life of the System.AppDomain. The System.Globalization.RegionInfo class does not detect changes in the system settings automatically.
DisplayName
ToString
Gets the full name of the country/region in the localized language of the .NET Framework.
For example, if the .NET Framework English version is installed, the United States is “United States”. If the .NET Framework Spanish version is installed, regardless of the language that the system is set to display, the country/region name is displayed in Spanish; therefore, the United States is “Estados Unidos”.
EnglishName
ToString
Gets the full name of the country/region in English.
For example, the United States is “United States”.
IsMetric
ToString
Gets a value indicating whether the country/region uses the metric system for measurements.
ISOCurrencySymbol
ToString
Gets the three-character ISO 4217 currency symbol associated with the country/region.
A list of the three-character ISO 4217 currency symbols is provided in the System.Globalization.RegionInfo class topic. For example, the ISO 4217 currency symbol for the United States dollar is “USD”.
Name
ToString
Gets the two-letter code defined in ISO 3166 for the country/region.
The System.Globalization.RegionInfo name is one of the two-letter codes defined in ISO 3166 for country/region. For example, the two-letter code for United States is “US”.
ThreeLetterISORegionName
ToString
Gets the three-letter code defined in ISO 3166 for the country/region.
The System.Globalization.RegionInfo.ThreeLetterISORegionName property contains one of the three-letter codes defined in ISO 3166 for country/region. For example, the three-letter code for United States is “USA”.
ThreeLetterWindowsRegionName
ToString
Gets the Windows version of the three-letter code for the country/region of this System.Globalization.RegionInfo.
For example, the three-letter code for United States is “USA”.
TwoLetterISORegionName
ToString
Gets the two-letter code defined in ISO 3166 for the country/region.
The System.Globalization.RegionInfo name is one of the two-letter codes defined in ISO 3166 for country/region. For example, the two-letter code for United States is “US”.
Equals
Determines whether the specified System.Object is the same instance as the current System.Globalization.RegionInfo instance.
Return Value: true if the specified System.Object is the same instance as the current System.Globalization.RegionInfo instance; otherwise, false.
This method overrides System.Object.Equals(System.Object). The System.Object to compare with the current System.Globalization.RegionInfo instance.
GetHashCode
Serves as a hash function for the current System.Globalization.RegionInfo instance, suitable for use in hashing algorithms and data structures, such as a hash table.
Return Value: A hash code for the current System.Globalization.RegionInfo instance.
This method overrides System.Object.GetHashCode.
ToString
Returns a System.String containing the name of the current System.Globalization.RegionInfo instance, which is one of the three-letter country/region codes defined in ISO 3166.
Return Value: A System.String containing the name of the current System.Globalization.RegionInfo, which is one of the three-letter country/region codes defined in ISO 3166.
This method overrides System.Object.ToString.
SortKey class (System.Globalization)
ToString
Description
Maps strings to their sort keys.
Each character in a string is given several categories of sort weights, including script, alphabetic, case, and diacritic weights. A sort key serves as the repository of these weights for a particular string. For example, a sort key might contain a string of alphabetic weights, followed by a string of case weights, and so on.
KeyData
ToString
Gets the byte array representing the current System.Globalization.SortKey instance.
OriginalString
ToString
Gets the original string used to create the current System.Globalization.SortKey instance.
Compare
Compares two sort keys.
Return Value: Value Condition Zero The two sort keys are equal. The first sort key to compare. The second sort key to compare.
Equals
Determines whether the specified System.Object is the same instance as the current System.Globalization.SortKey.
Return Value: true if the specified System.Object is the same instance as the current System.Globalization.SortKey; otherwise, false.
This method overrides System.Object.Equals(System.Object). The System.Object to compare with the current System.Globalization.SortKey.
GetHashCode
Serves as a hash function for the current System.Globalization.SortKey instance, suitable for use in hashing algorithms and data structures, such as a hash table.
Return Value: A hash code for the current System.Globalization.SortKey instance.
This method overrides System.Object.GetHashCode.
ToString
Returns a System.String that represents the current System.Globalization.SortKey instance.
Return Value: A System.String that represents the current System.Globalization.SortKey instance.
This method overrides System.Object.ToString.
StringInfo class (System. Globalization)
ToString
Description
Provides functionality to split a string into text elements and to iterate through those text elements.
The .NET Framework defines a text element as a unit of text that is displayed as a single character; that is, a grapheme. A text element can be a base character, a surrogate pair, or a combining character sequence. The Unicode Standard defines a surrogate pair as a coded character representation for a single abstract character that consists of a sequence of two code units, where the first unit of the pair is a high-surrogate and the second is a low-surrogate. The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. A surrogate pair can represent a base character or a combining character. For more information on surrogate pairs and combining character sequences, see The Unicode Standard at http://www.unicode.org.
StringInfo
Example Syntax:
ToString
GetNextTextElement
Gets the first text element in a specified string.
Return Value: A System.String containing the first text element in str.
The .NET Framework defines a text element as a unit of text that is displayed as a single character; that is, a grapheme. A text element can be a base character, a surrogate pair, or a combining character sequence. The Unicode Standard defines a surrogate pair as a coded character representation for a single abstract character that consists of a sequence of two code units, where the first unit of the pair is a high-surrogate and the second is a low-surrogate. The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. A surrogate pair can represent a base character or a combining character. For more information on surrogate pairs and combining character sequences, see The Unicode Standard at http://www.unicode.org. The System.String to get the text element from.
GetNextTextElement
Gets the text element at the specified index of the specified string.
Return Value: A System.String containing the text element at index of str.
The .NET Framework defines a text element as a unit of text that is displayed as a single character; that is, a grapheme. A text element can be a base character, a surrogate pair, or a combining character sequence. The Unicode Standard defines a surrogate pair as a coded character representation for a single abstract character that consists of a sequence of two code units, where the first unit of the pair is a high-surrogate and the second is a low-surrogate. The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. A surrogate pair can represent a base character or a combining character. For more information on surrogate pairs and combining character sequences, see The Unicode Standard at http://www.unicode.org. The System.String to get the text element from. The index at which the text element starts.
GetTextElementEnumerator
Returns an enumerator that can iterate through the text elements of the entire System.String.
Return Value: A System.Globalization.TextElementEnumerator for the entire System.String.
The .NET Framework defines a text element as a unit of text that is displayed as a single character; that is, a grapheme. A text element can be a base character, a surrogate pair, or a combining character sequence. The Unicode Standard defines a surrogate pair as a coded character representation for a single abstract character that consists of a sequence of two code units, where the first unit of the pair is a high-surrogate and the second is a low-surrogate. The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. A surrogate pair can represent a base character or a combining character. For more information on surrogate pairs and combining character sequences, see The Unicode Standard at http://www.unicode.org. The System.String to iterate through.
GetTextElementEnumerator
Returns an enumerator that can iterate through the text elements of the System.String starting at the specified index.
Return Value: A System.Globalization.TextElementEnumerator for the System.String starting at the specified index.
The .NET Framework defines a text element as a unit of text that is displayed as a single character; that is, a grapheme. A text element can be a base character, a surrogate pair, or a combining character sequence. The Unicode Standard defines a surrogate pair as a coded character representation for a single abstract character that consists of a sequence of two code units, where the first unit of the pair is a high-surrogate and the second is a low-surrogate. The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. A surrogate pair can represent a base character or a combining character. For more information on surrogate pairs and combining character sequences, see The Unicode Standard at http://www.unicode.org. The System.String to iterate through. The index at which to start iterating.
ParseCombiningCharacters
Integer( )
Returns the indexes of each base character, high-surrogate, or control character within the specified string.
Return Value: An array of integers that contains the indexes of each base character, high-surrogate, or control character within the specified string.
The Unicode Standard defines a surrogate pair as a coded character representation for a single abstract character that consists of a sequence of two code units, where the first unit of the pair is a high-surrogate and the second is a low-surrogate. A high-surrogate is a Unicode code point in the range U+D800 through U+DBFF and a low-surrogate is a Unicode code point in the range U+DC00 through U+DFFF. The System.String to search.
TaiwanCalendar class (System.Globalization)
ToString
Description
Represents the Taiwanese calendar.
The Taiwanese calendar works exactly like the Gregorian calendar, except that the year and era are different.
TaiwanCalendar
Example Syntax:
ToString
Initializes a new instance of the System.Globalization.TaiwanCalendar class.
Eras
ToString
Gets the list of eras in the System.Globalization.TaiwanCalendar.
The System.Globalization.TaiwanCalendar class recognizes only the current era. This property always returns an array with only one element.
TwoDigitYearMax
ToString
Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.
This property allows a 2-digit year to be properly translated to a 4-digit year. For example, in the Gregorian calendar, if this property is set to 2029, the 100-year range is from 1930 to 2029; therefore, a 2-digit value of 30 is interpreted as 1930, while a 2-digit value of 29 is interpreted as 2029.
AddMonths
Returns a System.DateTime that is the specified number of months away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of months to the specified System.DateTime.
The year part of the resulting System.DateTime is affected if the resulting month is beyond the last month of the current year. The day part of the resulting System.DateTime is also affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting System.DateTime remains the same as the specified System.DateTime. The System.DateTime instance to add. The number of months to add.
AddYears
Returns a System.DateTime that is the specified number of years away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of years to the specified System.DateTime.
The day part of the resulting System.DateTime is affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting System.DateTime remains the same as the specified System.DateTime. The System.DateTime instance to add. The number of years to add.
GetDayOfMonth
Gets the day of the month in the specified System.DateTime.
Return Value: An integer from 1 to 31 that represents the day of the month in time. The System.DateTime instance to read.
GetDayOfWeek
Gets the day of the week in the specified System.DateTime.
Return Value: A System.DayOfWeek value that represents the day of the week in time.
The System.DayOfWeek values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. The System.DateTime instance to read.
GetDayOfYear
Gets the day of the year in the specified System.DateTime.
Return Value: An integer from 1 to 366 that represents the day of the year in time. The System.DateTime instance to read.
GetDaysInMonth
Gets the number of days in the month specified by the year, month, and era parameters.
Return Value: The number of days in the specified month in the specified year in the specified era.
For example, this method might return 28 or 29 for February (month=2), depending on whether year is a leap year. An integer that represents the year. An integer that represents the month. An integer that represents the era.
GetDaysInYear
Gets the number of days in the year specified by the year and era parameters.
Return Value: The number of days in the specified year in the specified era.
For example, this method might return 365 or 366, depending on whether year is a leap year. An integer that represents the year. An integer that represents the era.
GetEra
Gets the era in the specified System.DateTime.
Return Value: An integer that represents the era in time.
The System.Globalization.TaiwanCalendar class recognizes only the current era. The System.DateTime instance to read.
GetMonth
Gets the month in the specified System.DateTime.
Return Value: An integer between 1 and 12 that represents the month in time. The System.DateTime instance to read.
GetMonthsInYear
Gets the number of months in the year specified by the year and era parameters.
Return Value: The number of months in the specified year in the specified era. An integer that represents the year. An integer that represents the era.
GetYear
Gets the year in the specified System.DateTime.
Return Value: An integer between 1 and 9999 that represents the year in time. The System.DateTime instance to read.
IsLeapDay
Determines whether the date specified by the year, month, day, and era parameters is a leap day.
Return Value: true if the specified day is a leap day; otherwise, false.
Leap years in the Taiwanese calendar correspond to the same leap years in the Gregorian calendar. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the era.
IsLeapMonth
Determines whether the month specified by the year, month, and era parameters is a leap month.
Return Value: This method always returns false, unless overridden by a derived class.
Leap years in the Taiwanese calendar correspond to the same leap years in the Gregorian calendar. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the month. An integer that represents the era.
IsLeapYear
Determines whether the year specified by the year and era parameters is a leap year.
Return Value: true if the specified year is a leap year; otherwise, false.
Leap years in the Taiwanese calendar correspond to the same leap years in the Gregorian calendar. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the era.
ToDateTime
Returns a System.DateTime that is set to the specified date and time in the specified era.
Return Value: The System.DateTime instance set to the specified date and time in the current era. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the hour. An integer that represents the minute. An integer that represents the second. An integer that represents the millisecond. An integer that represents the era.
ToFourDigitYear
Converts the specified two-digit year to a four-digit year by using the System.Globalization.TaiwanCalendar.TwoDigitYearMax property to determine the appropriate century.
Return Value: An integer that contains the four-digit representation of year.
This method implements System.Globalization.Calendar.ToFourDigitYear(System.Int32). A two-digit integer that represents the year to convert.
TextElementEnumerator class (System.Globalization)
ToString
Description
Enumerates the text elements of a System.String.
The .NET Framework defines a text element as a unit of text that is displayed as a single character; that is, a grapheme. A text element can be a base character, a surrogate pair, or a combining character sequence. The Unicode Standard defines a surrogate pair as a coded character representation for a single abstract character that consists of a sequence of two code units, where the first unit of the pair is a high-surrogate and the second is a low-surrogate. The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. A surrogate pair can represent a base character or a combining character. For more information on surrogate pairs and combining character sequences, see The Unicode Standard at http://www.unicode.org.
Current
ToString
Gets the current text element in the System.String.
The .NET Framework defines a text element as a unit of text that is displayed as a single character; that is, a grapheme. A text element can be a base character, a surrogate pair, or a combining character sequence. The Unicode Standard defines a surrogate pair as a coded character representation for a single abstract character that consists of a sequence of two code units, where the first unit of the pair is a high-surrogate and the second is a low-surrogate. The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. A surrogate pair can represent a base character or a combining character. For more information on surrogate pairs and combining character sequences, see The Unicode Standard at http://www.unicode.org.
ElementIndex
ToString
Gets the index of the text element that the enumerator is currently positioned over.
The .NET Framework defines a text element as a unit of text that is displayed as a single character; that is, a grapheme. A text element can be a base character, a surrogate pair, or a combining character sequence. The Unicode Standard defines a surrogate pair as a coded character representation for a single abstract character that consists of a sequence of two code units, where the first unit of the pair is a high-surrogate and the second is a low-surrogate. The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. A surrogate pair can represent a base character or a combining character. For more information on surrogate pairs and combining character sequences, see The Unicode Standard at http://www.unicode.org.
GetTextElement
Gets the current text element in the System.String.
Return Value: A System.String instance containing the current text element in the System.String.
The .NET Framework defines a text element as a unit of text that is displayed as a single character; that is, a grapheme. A text element can be a base character, a surrogate pair, or a combining character sequence. The Unicode Standard defines a surrogate pair as a coded character representation for a single abstract character that consists of a sequence of two code units, where the first unit of the pair is a high-surrogate and the second is a low-surrogate. The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. A surrogate pair can represent a base character or a combining character. For more information on surrogate pairs and combining character sequences, see The Unicode Standard at http://www.unicode.org.
MoveNext
Advances the enumerator to the next text element of the System.String.
Return Value: true if the enumerator was successfully advanced to the next text element; false if the enumerator has passed the end of the System.String.
The .NET Framework defines a text element as a unit of text that is displayed as a single character; that is, a grapheme. A text element can be a base character, a surrogate pair, or a combining character sequence. The Unicode Standard defines a surrogate pair as a coded character representation for a single abstract character that consists of a sequence of two code units, where the first unit of the pair is a high-surrogate and the second is a low-surrogate. The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. A surrogate pair can represent a base character or a combining character. For more information on surrogate pairs and combining character sequences, see The Unicode Standard at http://www.unicode.org.
Reset
Sets the enumerator to its initial position, which is before the first text element in the System.String.
The .NET Framework defines a text element as a unit of text that is displayed as a single character; that is, a grapheme. A text element can be a base character, a surrogate pair, or a combining character sequence. The Unicode Standard defines a surrogate pair as a coded character representation for a single abstract character that consists of a sequence of two code units, where the first unit of the pair is a high-surrogate and the second is a low-surrogate. The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. A surrogate pair can represent a base character or a combining character. For more information on surrogate pairs and combining character sequences, see The Unicode Standard at http://www.unicode.org.
TextInfo class (System.Globalization)
ToString
Description
Defines properties and behaviors, such as casing, that are specific to a writing system.
A writing system is the collection of scripts and orthographic rules required to represent a language as text.
ANSICodePage
ToString
Gets the American National Standards Institute (ANSI) code page used by the writing system represented by the System.Globalization.TextInfo instance.
EBCDICCodePage
ToString
Gets the Extended Binary Coded Decimal Interchange Code (EBCDIC) code page used by the writing system represented by the System.Globalization.TextInfo instance.
ListSeparator
ToString
Gets the System.String that separates items in a list.
The default for the invariant culture is “,”.
MacCodePage
ToString
Gets the Macintosh code page used by the writing system represented by the System.Globalization.TextInfo instance.
OEMCodePage
ToString
Gets the original equipment manufacturer (OEM) code page used by the writing system represented by the System.Globalization.TextInfo instance.
Equals
Determines whether the specified System.Object represents the same writing system as the current System.Globalization.TextInfo.
Return Value: true if the specified System.Object represents the same writing system as the current System.Globalization.TextInfo; otherwise, false.
This method overrides System.Object.Equals(System.Object). The System.Object to compare with the current System.Globalization.TextInfo.
GetHashCode
Serves as a hash function for the current System.Globalization.TextInfo instance, suitable for use in hashing algorithms and data structures, such as a hash table.
Return Value: A hash code for the current System.Globalization.TextInfo instance.
This method overrides System.Object.GetHashCode.
IDeserializationCallback.OnDeserialization
ToLower
Converts the specified character to lowercase.
Return Value: The specified character converted to lowercase.
Casing semantics depend on the culture in use. If using the invariant culture, the casing semantics are not culture-sensitive. If using a specific culture, the casing semantics are sensitive to that culture. The character to convert to lowercase.
ToLower
Converts the specified string to lowercase.
Return Value: The specified string converted to lowercase.
The returned string might differ in length from the input string. For more information on casing, refer to the Unicode Technical Report #21 “Case Mappings,” published by the Unicode Consortium (http://www.unicode.org). The current implementation preserves the length of the string; however, this behavior is not guaranteed and could change in future implementations. The string to convert to lowercase.
ToString
Returns a System.String that represents the current System.Globalization.TextInfo instance.
Return Value: A System.String that represents the current System.Globalization.TextInfo instance.
This method overrides System.Object.ToString.
ToTitleCase
Converts the specified string to titleCase.
Return Value: The specified string converted to titleCase.
Generally, title casing converts the first character of a word to uppercase and converts the rest of the letters to lowercase. Words that are selected for title casing is dependent on the language. The string to convert to titleCase.
ToUpper
Converts the specified character to uppercase.
Return Value: The specified character converted to uppercase.
Casing semantics depend on the culture in use. If using the invariant culture, the casing semantics are not culture-sensitive. If using a specific culture, the casing semantics are sensitive to that culture. The character to convert to uppercase.
ToUpper
Converts the specified string to uppercase.
Return Value: The specified string converted to uppercase.
The returned string might differ in length from the input string. For more information on casing, refer to the Unicode Technical Report #21 “Case Mappings,” published by the Unicode Consortium (http://www.unicode.org). The current implementation preserves the length of the string; however this behavior might change in future versions of the .NET Framework. The string to convert to uppercase.
ThaiBuddhistCalendar class (System.Globalization)
ToUpper
Description
Represents the Thai Buddhist calendar.
The Thai Buddhist calendar works exactly like the Gregorian calendar, except that the year and era are different.
ToUpper
Represents the current era.
The System.Globalization.ThaiBuddhistCalendar class recognizes only the current era. This field always returns 1.
ThaiBuddhistCalendar
Example Syntax:
ToUpper
Initializes a new instance of the System.Globalization.ThaiBuddhistCalendar class.
Eras
ToUpper
Gets the list of eras in the System.Globalization.ThaiBuddhistCalendar.
The System.Globalization.ThaiBuddhistCalendar class recognizes only the current era. This property always returns an array with only one element.
TwoDigitYearMax
ToUpper
Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.
This property allows a 2-digit year to be properly translated to a 4-digit year. For example, in the Gregorian calendar, if this property is set to 2029, the 100-year range is from 1930 to 2029; therefore, a 2-digit value of 30 is interpreted as 1930, while a 2-digit value of 29 is interpreted as 2029.
AddMonths
Returns a System.DateTime that is the specified number of months away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of months to the specified System.DateTime.
The year part of the resulting System.DateTime is affected if the resulting month is beyond the last month of the current year. The day part of the resulting System.DateTime is also affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting System.DateTime remains the same as the specified System.DateTime. The System.DateTime instance to add. The number of months to add.
AddYears
Returns a System.DateTime that is the specified number of years away from the specified System.DateTime.
Return Value: The System.DateTime that results from adding the specified number of years to the specified System.DateTime.
The day part of the resulting System.DateTime is affected if the resulting day is not a valid day in the resulting month of the resulting year; it is changed to the last valid day in the resulting month of the resulting year. The time-of-day part of the resulting System.DateTime remains the same as the specified System.DateTime. The System.DateTime instance to add. The number of years to add.
GetDayOfMonth
Gets the day of the month in the specified System.DateTime
Return Value: An integer from 1 to 31 that represents the day of the month in time. The System.DateTime instance to read.
GetDayOfWeek
Gets the day of the week in the specified System.DateTime.
Return Value: A System.DayOfVeek value that represents the day of the week in time.
The System.DayOfWeek values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. The System.DateTime instance to read.
GetDayOfYear
Gets the day of the year in the specified System.DateTime.
Return Value: An integer from 1 to 366 that represents the day of the year in time.
The System.DateTime instance to read.
GetDaysInMonth
Gets the number of days in the month specified by the year, month, and era parameters.
Return Value: The number of days in the specified month in the specified year in the specified era.
For example, this method might return 28 or 29 for February (month=2), depending on whether year is a leap year. An integer that represents the year. An integer that represents the month. An integer that represents the era.
GetDaysInYear
Gets the number of days in the year specified by the year and era parameters.
Return Value: The number of days in the specified year in the specified era.
For example, this method might return 365 or 366, depending on whether year is a leap year. An integer that represents the year. An integer that represents the era.
GetEra
Gets the era in the specified System.DateTime.
Return Value: An integer that represents the era in time.
The System.Globalization.ThaiBuddhistCalendar class recognizes only the current era. The System.DateTime instance to read.
GetMonth
Gets the month in the specified System.DateTime.
Return Value: An integer between 1 and 12 that represents the month in time. The System.DateTime instance to read.
GetMonthsInYear
Gets the number of months in the year specified by the year and era parameters.
Return Value: The number of months in the specified year in the specified era. An integer that represents the year. An integer that represents the era.
GetYear
Gets the year in the specified System.DateTime.
Return Value: An integer between 1 and 9999 that represents the year in time.The System.DateTime instance to read.
IsLeapDay
Determines whether the date specified by the year, month, day, and era parameters is a leap day.
Return Value: true if the specified day is a leap day; otherwise, false.
Leap years in the Thai Buddhist calendar correspond to the same leap years in the Gregorian calendar. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the era.
IsLeapMonth
Determines whether the month specified by the year, month, and era parameters is a leap month.
Return Value: This method always returns false, unless overridden by a derived class.
Leap years in the Thai Buddhist calendar correspond to the same leap years in the Gregorian calendar. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the month. An integer that represents the era.
IsLeapYear
Determines whether the year specified by the year and era parameters is a leap year.
Return Value: true if the specified year is a leap year; otherwise, false.
Leap years in the Thai Buddhist calendar correspond to the same leap years in the Gregorian calendar. A common year has 365 days and a leap year has 366 days. An integer that represents the year. An integer that represents the era.
ToDateTime
Returns a System.DateTime that is set to the specified date and time in the specified era.
Return Value: The System.DateTime instance set to the specified date and time in the current era. An integer that represents the year. An integer that represents the month. An integer that represents the day. An integer that represents the hour. An integer that represents the minute. An integer that represents the second. An integer that represents the millisecond. An integer that represents the era.
ToFourDigitYear
Converts the specified two-digit year to a four-digit year by using the System.Globalization.ThaiBuddhistCalendar.TwoDigitYearMax property to determine the appropriate century.
Return Value: An integer that contains the four-digit representation of year.
System.Globalization.ThaiBuddhistCalendar.TwoDigitYearMax is the last year in the 100-year range that can be represented by a two-digit year. The century is determined by finding the sole occurrence of the two-digit year within that 100-year range. For example, if System.Globalization.ThaiBuddhistCalendar.TwoDigitYearMax is set to 2029, the 100-year range is from 1930 to 2029; therefore, a 2-digit value of 30 is interpreted as 1930, while a 2-digit value of 29 is interpreted as 2029. A two-digit integer that represents the year to convert.
UnicodeCategory enumeration (System.Globalization)
ToString
Description
Defines the Unicode category of a character.
The Unicode Standard defines the following: A surrogate pair is a coded character representation for a single abstract character that consists of a sequence of two code units, where the first unit of the pair is a high-surrogate and the Is second is a low-surrogate. A high-surrogate is a Unicode code point in the range U+D800 through U+DBFF and a low-surrogate is a Unicode code point in the range U+DC00 through U+DFFF.
ToString
Indicates that the character is the closing character of one of the paired punctuation marks, such as parentheses, square brackets, and braces. The value is 21.
ToString
Indicates that the character is a connector punctuation, which connects two characters. The value is 18.
ToString
Indicates that the character is a control code, whose Unicode value is U+007F or in the range U+0000 through U+001F or U+0080 through U+009F. The value is 14.
ToString
Indicates that the character is a currency symbol. The value is 26.
ToString
Indicates that the character is a dash or a hyphen. The value is 19.
ToString
Indicates that the character is a decimal digit; that is, in the range 0 through 9. The value is 8.
ToString
Indicates that the character is an enclosing mark, which is a nonspacing combining character that surrounds all previous characters up to and including a base character. The value is 7.
ToString
Indicates that the character is a closing or final quotation mark. The value is 23.
ToString
Indicates that the character is a format character, which is not normally rendered but affects the layout of text or the operation of text processes. The value is 15.
ToString
Indicates that the character is an opening or initial quotation mark. The value is 22.
ToString
Indicates that the character is a number represented by a letter, instead of a decimal digit; for example, the Roman numeral for five, which is ‘V’. The value is 9.
ToString
Indicates that the character is used to separate lines of text. The value is 12.
ToString
Indicates that the character is a lowercase letter. The value is 1.
ToString
Indicates that the character is a mathematical symbol, such as ‘+’ or ‘=’. The value is 25.
ToString
Indicates that the character is a modifier letter, which is free-standing spacing character that indicates modifications of a preceding letter. The value is 3.
ToString
Indicates that the character is a modifier symbol, 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 value is 27.
ToString
Indicates that the character is a nonspacing character, which indicates modifications of a base character. The value is 5.
ToString
Indicates that the character is the opening character of one of the paired punctuation marks, such as parentheses, square brackets, and braces. The value is 20.
ToString
Indicates that the character is a letter that is not an uppercase letter, a lowercase letter, a titlecase letter, or a modifier letter. The value is 4.
ToString
Indicates that the character is not assigned to any Unicode category. The value is 29.
ToString
Indicates that the character is a number that is neither a decimal digit nor a letter number; for example, the fraction ½. The value is 10.
ToString
Indicates that the character is a punctuation that is not a connector punctuation, a dash punctuation, an open punctuation, a close punctuation, an initial quote punctuation, or a final quote punctuation. The value is 24.
ToString
Indicates that the character is a symbol that is not a mathematical symbol, a currency symbol or a modifier symbol. The value is 28.
ToString
Indicates that the character is used to separate paragraphs. The value is 13.
ToString
Indicates that the character is a private-use character, whose Unicode value is in the range U+E000 through U+F8FF. The value is 17.
ToString
Indicates that the character is a space character, which has no glyph but is not a control or format character. The value is 11.
ToString
Indicates that the character is a spacing character, which indicates modifications of a base character and affects the width of the glyph for that base character. The value is 6.
ToString
Indicates that the character is a high-surrogate or a low-surrogate. Surrogate code values are in the range U+D800 through U+DFFF. The value is 16.
ToString
Indicates that the character is a titlecase letter. The value is 2.
ToString
System.Resources Namespace
Creating resources can help developers develop robust, culture-aware programs without having to recompile an application because the resources have changed. Resources are an application-building feature that allows developers to place culture-specific data inside satellite data files (called resource files), rather than directly in a main application. The main assembly does not strong bind to these satellite data files that give developers the flexibility to deploy them in different phases. When building an application, the developer can identify aspects that are culture-specific such as user visible strings, graphics etc., and put these in a different resources file for each culture where the application may be used. At run time, the appropriate set of resources will be loaded, based on the user's culture settings. The specific setting used is the CurrentUICulture for the main thread of execution, which the user can set programmatically.
The ResourceManager class provides the user with the ability to access and control resources stored in the main assembly or in resource satellite assemblies. Use the ResourceManager.GetObject and ResourceManager.GetString methods to retrieve culture-specific objects and strings, as illustrated in the following example.
SYSTEM.NET NAMESPACE
The System.Net namespace provides a simple programming interface to many of the protocols found on the network today. The WebRequest and WebResponse classes form the basis of “pluggable protocols,” an implementation of network services that enables developers to develop applications that use Internet resources without worrying about the specific details of the protocol used.
The System.Net.Sockets namespace provides a managed implementation of the Windows Sockets interface for developers that need to tightly control access to the network. Developers familiar with the Winsock API can readily develop applications using the Socket class.
The TCPClient, TCPListener, and UDPClient classes encapsulate the details of creating TCP and UDP connections to the Internet.
The following is a more detailed description of the System.Net namespace, identifying various classes, interfaces, enumerations, and so forth contained in the System.Net and System.Net.Sockets namespaces.
System.Net
The namespace provides a simple programming interface to many of the protocols found on the network today. The and classes form the basis of “pluggable protocols,” an implementation of network services that enables you to develop applications that use Internet resources without worrying about the specific details of the protocol used.
Description
The System.Net namespace provides a simple programming interface to many of the protocols found on the network today. The System.Net.WebRequest and System.Net.WebResponse classes form the basis of “pluggable protocols,” an implementation of network services that enables you to develop applications that use Internet resources without worrying about the specific details of the protocol used.
AuthenticationManager class (System.Net)
Description
Manages the authentication modules called during the client authentication process.
System.Net.AuthenticationManager is a static class that manages the authentication modules that an application uses. When a request is made to protected resources, the System.Net.AuthenticationManager calls the System.Net.AuthenticationManager.Authenticate(System.String, System.Net. WebRequest,System.Net.ICredentials) method to get an System.Net.Authorization instance to use in subsequent requests.
Properties:
RegisteredModules
Gets a list of authentication modules that are registered with the authentication manager.
The System.Net.AuthenticationManager.RegisteredModules property provides an System.Collections.IEnumerator instance that enables the list of registered authentication modules to be read. The System.Net.AuthenticationManager.Register(System.Net.IAuthenticationModule) method adds modules to the list, and the System.Net.AuthenticationManager.Unregister(System.Net.IAuthentication Module) method removes modules from it.
Methods:
Authenticate
Calls each registered authentication module to find the first module that can respond to the authentication request.
Return Value: An instance of the System.Net.Authorization class containing the result of the authorization attempt. If there is no authentication module to respond to the challenge, this method returns null.
The System.Net.AuthenticationManager.Authenticate(System.String,System.Net. WebRequest,System.Net.ICredentials) method calls the System.Net.IAuthenticationModule.Authenticate(System.String,System.Net. WebRequest,System.Net.ICredentials) method on each registered authentication module until one of the module responds with an System.Net.Authorization instance. The challenge returned by the Internet resource. The System.Net.WebRequest that initiated the authentication challenge. The System.Net.ICredentials associated with this request.
PreAuthenticate
Preauthenticates a request.
Return Value: An instance of the System.Net.Authorization class if the request can be preauthenticated; otherwise, null. If credentials is null, this method returns null.
If the authentication module can preauthenticate the request, the PreAuthenticate method returns an Authentication instance and sends the authorization informaiton to the server preemptively instead of waiting for the resource to issue a challenge. This behavior is outlined in section 3.3 of RFC 2617 (HTTP Authentication: Basic and Digest Access Authentication). Authentication modules that support preauthentication allow clients to improve server efficiency by avoiding extra round trips caused by authentication challenges. A System.Net.WebRequest to an Internet resource. The System.Net.ICredentials associated with the request.
Register
Registers an authentication module with the authentication manager.
The System.Net.AuthenticationManager.Register(System.Net.IAuthenticationModule) method adds authentication modules to the end of the list of modules called by the System.Net.AuthenticationManager.Authenticate(System.String,System.Net. WebRequest,System.Net.ICredentials) method. Authentication modules are called in the order in which they were added to the list. The System.Net.IAuthenticationModule to register with the authentication manager.
Unregister
Removes the specified authentication module from the list of registered modules.
The System.Net.AuthenticationManager.Unregister(System.Net.IAuthentication Module) method removes the specified authentication module from the list of authentication modules called by the System.Net.AuthenticationManager.Authenticate(System.String,System.Net. WebRequest,System.Net.ICredentials) method. The module must have been added to the list using the System.Net.AuthenticationManager.Register(System.Net.IAuthenticationModule) method before it can be removed from the list. The IAuthentication module to remove.
Unregister
Removes authentication modules with the specified authentication scheme from the list of registered modules.
The
System.Net.AuthenticationManager.Unregister(System.Net.IAuthentication Module) method removes the authentication module with the specified authentication scheme from the list of authentication modules called by the System.Net.AuthenticationManager.Authenticate(System.String,System.Net. WebRequest,System.Net.ICredentials) method. The module must have been added to the list using the System.Net.AuthenticationManager.Register(System.Net.IAuthenticationModule) method before it can be removed from the list. The authentication scheme of the module to remove.
Authorization class (System.Net)
Unregister
Description
Contains an authentication message for an Internet server.
The System.Net.AuthenticationManager returns an instance of the System.Net.Authorization class containing the authentication message that is sent to the Internet server to indicate that the client (such as System.Net.WebRequest or one of its descendants) is authorized to access the server.
Constructors:
Authorization
Example Syntax:
Unregister
Creates a new instance of the System.Net.Authorization class with the specified authorization message.
The System.Net.Authorization instance is created with the System.Net.Authorization.Message property set to token and the System.Net.Authorization.Complete property set to true. The encrypted authorization message expected by the server.
Authorization
Example Syntax:
Unregister
Creates a new instance of the System.Net.Authorization class with the specified authorization message and completion status.
The System.Net.Authorization instance is created with the System.Net.Authorization.Message property set to token and the System.Net.Authorization.Complete property set to finished. The encrypted authorization message expected by the server. The completion status of the authorization attempt.
Authorization
Example Syntax:
Unregister
Creates a new instance of the System.Net.Authorization class with the specified authorization message, completion status, and connection group identifier. The encrypted authorization message expected by the server. The completion status of the authorization attempt. A unique identifier that can be used to create private Client-Server connections, that would only be bound to this authentication scheme.
Complete
Unregister
Gets the completion status of the authorization.
The System.Net.Authorization.Complete property is set to true when the authentication process between the client and the server is finished. Some authentication modules, such as the Kerberos module, use multiple round trips between the client and server to complete the authentication process. To keep the System.Net.WebRequest or descendant that initiated the authentication process from interrupting while authorization is taking place, the authentication module sets the System.Net.Authorization.Complete property to false.
ConnectionGroupId
Unregister
Gets a unique identifier for user-specific connections.
The System.Net.Authorization.ConnectionGroupId property is a unique string that associates a connection with a specific authenticating entity. For example, the NTLM authorization module ties the authentication credential information to a specific connection to prevent invalid reuse of the connection.
Message
Unregister
Gets the message returned to the server in response to an authentication challenge.
The System.Net.Authorization.Message property contains the authorization string that the client will return to the server when accessing protected resources. The actual contents of the message is defined by the authentication type the client and server are using. Basic HTTP authentication, for example, uses a different message than Kerberos authentication.
ProtectionRealm
Unregister
Gets or sets the prefix for uniform resource identifiers (URIs) that can be authenticated with the System.Net.Authorization.Message property.
The System.Net.Authorization.ProtectionRealm property contains a list of URI prefixes that the System.Net.Authorization.Message property can be used to authenticate.
Cookie class (System.Net)
ToString
Description
Provides a set of properties and methods used to manage cookies. This class cannot be inherited.
For a list of initial property values for an instance of System.Net.Cookie, see the System.Net.Cookie.#ctor constructors.
Cookie
Example Syntax:
ToString
Initializes a new instance of the System.Net.Cookie class using the empty string for default parameters: name, value, path, domain.
Cookie
Example Syntax:
ToString
Initializes a new instance of the System.Net.Cookie class with specified name and value, using the empty string for default parameters: path, domain. string string
Cookie
Example Syntax:
ToString
Initializes a new instance of the System.Net.Cookie class with specified name, value, and path, using the empty string for default parameter domain. string string string
Cookie
Example Syntax:
ToString
Initializes a new instance of the System.Net.Cookie class with specified name, value, path, and domain. string string string string
Comment
ToString
Gets a comment that the server can add to the cookie.
The client can inspect this optional comment for information added by the server about issues such as the privacy policy and so on.
CommentUri
ToString
Gets a URI that the server can provide with a cookie.
The URI can provide optional information such as how the server uses the cookie.
Discard
ToString
Gets the discard flag set by the server.
When true, this property instructs the Web browser not to save the cookie on the user's hard drive when a session ends.
Domain
ToString
Gets the URI for which the cookie is valid.
A server cannot indicate a domain other than its own. However it can indicate more than one server.
Expired
ToString
Gets the current state of the cookie.
Expires
ToString
Gets the expiration DateTime for the cookie.
Name
ToString
Gets the name for the cookie.
Path
ToString
Gets the URLs to which the cookie applies on the server.
Port
ToString
Gets a list of TCP ports to which the cookie applies.
Secure
ToString
Gets the security level set by the server.
TimeStamp
ToString
Gets the DateTime when the cookie was issued.
Value
ToString
Gets the server-supplied value for the cookie.
Version
ToString
Gets the version of HTTP state maintenance to which the cookie conforms.
Equals
An override of the Object.Equals method. A reference to a Cookie object.
GetHashCode
An override of Object.GetHashCode.
ToString
An override of Object.ToString.
CookieCollection class (System.Net)
ToString
Description
Provides a collection container for Cookie or CookieCollection instances.
The CookieCollection class implements an ICollection interface to provide a general mechanism for handling collections of cookies. For example, this is useful in the case where an application wants to act on behalf of multiple users and store cookies for each user.
CookieCollection
Example Syntax:
ToString
Initializes a new instance of the System.Net.CookieCollection class.
Count
ToString
Gets the number of elements contained in the CookieCollection
IsReadOnly
ToString
Gets or sets a value indicating whether the CoookieCollection instance is read-only.
IsSynchronized
ToString
Gets a value that indicates whether access to a CookieCollection is thread-safe.
SyncRoot returns an object that can be used to synchronize access to the CookieCollection.
Item
ToString
Gets the CookieCollection element with a specific index. The zero-based index of the Cookie.
Item
ToString
Gets the CookieCollection element with a specific name. The name of the
Cookie.
SyncRoot
ToString
Gets an object that you can use to synchronize access to the CookieCollection.
Add
Adds a Cookie to the CookieCollection. The Cookie to be added to the collection
Add
Adds a CookieCollection to the CookieCollection. The CookieCollection to be added to the collection
CopyTo
Copies the elements of the collection to an Array, starting at a particular index.
The Arrayarray must be a one-dimensional array with zero-based indexing. The target Array. The zero-based index in array at which copying begins.
GetEnumerator
Gets an enumerator that you can use to iterate through a CookieCollection
Return Value: An IEnumerator that you can use to iterate through a CookieCollection.
You should only use Enumerators to read data in the collection. Enumerators cannot be used to modify the underlying collection. The enumerator does not have exclusive access to the collection.
CookieContainer class (System.Net)
ToString
Description
Contains CookieCollection objects.
ToString
Gets the maximum size, in bytes, of elements the CookieContainer can hold. This field is constant.
ToString
Gets the maximum number of elements the CookieContainer can hold. This field is constant.
ToString
Gets the maximum number of elements the CookieContainer can reference per domain. This field is constant.
CookieContainer
Example Syntax:
ToString
Initializes a new instance of the System.Net.CookieContainer class with default values for DefaultCookieLimit, DefaultPerDomainCookieLimit, and DefaultCookieLengthLimit.
CookieContainer
Example Syntax:
ToString
Initializes a new instance of the System.Net.CookieContainer class with a specified value for the number of elements the container can hold and default values for DefaultPerDomainCookieLimit, and DefaultCookieLengthLimit. The number of cookies the CookieContainer can hold.
CookieContainer
Example Syntax:
ToString
Initializes a new instance of the System.Net.CookieContainer class with a specified value for the number of elements the container can hold, the number of cookies per domain, and the maximum element length. The number of elements the CookieContainer can hold. The number of elements per domain. The maximum size of the elements CookieContainer can hold.
Capacity
ToString
Gets the number of elements the CookieContainer can hold.
Count
ToString
Gets the number of elements the CookieContainer currently holds.
MaxCookieSize
ToString
Gets the maximum size of the elements held by the CookieContainer.
PerDomainCapacity
ToString
Gets the number of elements allowed per domain.
Add
Description
Adds a Cookie to the CookieContainer. The Cookie to be added to the CookieContainer.
Add
Adds a CookieCollection to the CookieContainer. The CookieCollection to be added to the CookieContainer.
Add
Adds a Cookie to the CookieContainer. The URI of the Cookie to be added to the CookieContainer. The Cookie to be added to the CookieContainer
Add
Adds a CookieCollection to the CookieContainer. The URI of the CookieCollection to be added to the CookieContainer. The CookieCollection to be added to the CookieContainer.
GetCookieHeader
Gets the HTTP header of the element associated with a specific URI. The URI desired.
GetCookies
Gets the elements associated with a specific URI.
Return Value: A CookieCollection containing the elements associated with a specific URI. The URI of the elements desired.
SetCookies
Associates a cookie header with a specific URI. The URI of the header. CookieException class (System.Net)
ToString
Description
The exception that is thrown when XXX.
CookieException
Example Syntax:
ToString
Initializes a new instance of the System.Net.CookieException class using default parameters.
CookieException
Example Syntax:
ToString
Initializes a new instance of the System.Net.CookieException class with specified values of serializationInfo and streamingContext. The SerializationInfo to be used. The StreamingContext to be used.
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
ISerializable.GetObjectData
CredentialCache class (System.Net)
ToString
Description
Provides storage for multiple credentials.
The System.Net.CredentialCache class stores credentials for multiple Internet resources. Applications that need to access multiple resources can store the credentials for those resources in a System.Net.CredentialCache instance that then provides the proper set of credentials to the Internet resource when required. When the System.Net.CredentialCache.GetCredential(System.Uri,System.String) method is called, it compares the URI and authentication type provided with those stored in the cache and returns the first set of credentials that match.
CredentialCache
Example Syntax:
ToString
Creates a new instance of the System.Net.CredentialCache class.
The constructor creates a System.Net.CredentialCache instance with its System.Net.CredentialCache.DefaultCredentials property initialized to the system credentials of the current security context. For client applications, these represent the user name, password, and domain of the user who is currently logged in. For ASP.NET applications, the credential is the process token of the IIS server or the process token being impersonated by the IIS server.
DefaultCredentials
ToString
Gets the system credentials of the application.
The System.Net.CredentialCache.DefaultCredentials property applies only to NTLM, negotiate, and Kerberos-based authentication.
Add
Adds a System.Net.NetworkCredential instance to the credential cache.
The System.Net.CredentialCache.Add(System.Uri,System.String,System.Net.NetworkCredential) method places a System.Net.NetworkCredential instance into the System.Net.CredentialCache. The cache stores credentials in the order in which they are added to it. When the System.Net.CredentialCache.GetCredential(System.Uri,System.String) method is called, it returns the proper matching System.Net.NetworkCredential instance. A System.Uri that specifies the URI prefix of the resources that the credential grants access to. The authentication scheme used by the resource named in uriPrefix. The System.Net.NetworkCredential to add to the credential cache.
GetCredential
Returns the System.Net.NetworkCredential instance associated with the specified URI and authentication type.
Return Value: A System.Net.NetworkCredential or, if there is no matching credential in the cache, null.
The System.Net.CredentialCache.GetCredential(System.Uri,System.String) method searches the System.Net.CredentialCache and returns the System.Net.NetworkCredential instance for the specified URI and authorization type. If the System.Net.CredentialCache contains no matching System.Net.NetworkCredential instance, null is returned. A System.Uri that specifies the URI prefix of the resources that the credential grants access to. The authentication scheme used by the resource named in uriPrefix.
GetEnumerator
Returns an enumerator that can iterate through the System.Net.CredentialCache instance.
Return Value: An System.Collections.IEnumerator for the System.Net.CredentialCache Remove
Deletes a System.Net.NetworkCredential instance from the cache.
The System.Net.CredentialCache.Remove(System.Uri,System.String) method removes the specified System.Net.NetworkCredential instance from the System.Net.CredentialCache. Multiple calls to the System.Net.CredentialCache.Remove(System.Uri,System.String) method for the same System.Net.NetworkCredential have no effect. A System.Uri that specifies the URI prefix of the resources that the credential is used for. The authentication scheme used by the host named in uriPrefix.
Dns class (System.Net)
ToString
Description
Provides simple domain name resolution functionality.
The System.Net.Dns class is a static class that retrieves information about a specific host from the Internet Domain Name System (DNS).
BeginGetHostByName
Begins an asynchronous request for System.Net.IPHostEntry information about the specified DNS host name.
Return Value: An System.IAsyncResult instance that references the asynchronous request.
The System.Net.Dns.BeginGetHostByName(System.String,System.AsyncCallback, System.Object) method starts an asynchronous request for DNS host information. The asynchronous callback method uses the System.Net.Dns.EndGetHostByName(System.IAsyncResult) method to return the actual host information. A string containing the DNS name of the host. The System.AsyncCallback. The State object.
BeginResolve
Begins an asynchronous request to resolve a DNS host name or IP address in dotted-quad notation to an System.Net.IPAddress instance.
Return Value: An System.IAsyncResult instance that references the asynchronous request.
The
System.Net.Dns.BeginResolve(System.String,System.AsyncCallback,System. Object) method starts an asynchronous request for DNS host information. The asynchronous callback method uses the System.Net.Dns.EndResolve(System.IAsyncResult) method to return the actual host information. A string containing the DNS name of the host. The System.AsyncCallback. The State object.
EndGetHostByName
Ends an asynchronous request for DNS information.
Return Value: An System.Net.IPHostEntry object containin DNS information about a host.
The System.Net.Dns.EndGetHostByName(System.IAsyncResult) method completes an asynchronous request for DNS information that was started with a call to System.Net.Dns.BeginGetHostByName(System.String,System.AsyncCallback, System.Object). The pending request for DNS information.
EndResolve
Ends an asynchronous request for DNS information.
Return Value: An System.Net.IPHostEntry object containin DNS information about a host.
The System.Net.Dns.EndResolve(System.IAsyncResult) method completes an asynchronous request for DNS information that was started with a call to System.Net.Dns.BeginResolve(System.String,System.AsyncCallback,System. Object). The pending request for DNS information.
GetHostByAddress
Creates an System.Net.IPHostEntry instance from a specified System.Net.IPAddress instance.
Return Value: An System.Net.IPHostEntry instance. An System.Net.IPAddress instance.
GetHostByAddress
Creates an System.Net.IPHostEntry instance from an address in dotted-quad notation (“198.162.1.2”).
Return Value: An System.Net.IPHostEntry instance. A string that represents an IP address in dotted-quad notation (for example, “192.168.1.2”).
GetHostByName
Gets the DNS information for the specified DNS host name.
Return Value: An System.Net.IPHostEntry object containing host information for the address specified in hostName.
The System.Net.Dns.GetHostByName(System.String) method queries the Internet DNS server for host information. A string containing the DNS name of the host.
GetHostName
Gets the host name of the local machine.
Return Value: A string containing the DNS host name of the local machine.
IpToString
Converts an IP address to a dotted-quad string.
Return Value: The string representation of the IP address.
The System.Net.Dns.IpToString(System.Int32) method converts an IP address expressed as an integer (for example, 33663168) to an IP address expressed in dotted-quad notation (for example, “192.168.1.2”). The IP address to convert.
Resolve
Resolves a DNS host name or IP address in dotted-quad notation to an System.Net.IPHostEntry instance.
Return Value: An System.Net.IPHostEntry instance containing address information about the host specified in hostName.
The System.Net.Dns.Resolve(System.String) method queries a DNS server for the IP address associated with a host name or IP address in dotted-quad notation. A DNS-style host name or IP address in dotted-quad notation. (for example, “www.contoso.com “or “192.168.1.2”).
DnsPermission class (System.Net)
ToString
Description
Controls rights to access Domain Name System (DNS) servers on the network.
The default allows all local and Intranet zone applications to access DNS services, and no DNS permission for Internet zone applications.
DnsPermission
Example Syntax:
ToString
Creates a new instance of the System.Net.DnsPermission class that either passes all demands or fails all demands.
If state is System.Security.Permissions.PermissionState.Unrestricted the System.Net.DnsPermission instance passes all demands. If state contains any other value, the System.Net.DnsPermission instance fails all demands. One of the System.Security.Permissions.PermissionState values.
Copy
Creates an identical copy of the current permission instance.
Return Value: A new instance of the System.Net.DnsPermission class that is an identical copy of the current instance.
A copy of a System.Net.DnsPermission instance provides the same access to DNS servers as the original permission instance.
FromXml
Reconstructs a System.Net.DnsPermission instance from an XML encoding.
The
System.Net.DnsPermission.FromXml(System.Security.SecurityElement) method reconstructs a System.Net.DnsPermission instance from an XML encoding defined by System.Security.SecurityElement class. The XML encoding to use to reconstruct the System.Net.DnsPermission instance.
Intersect
Creates a permission instance that is the intersection of the current permission instance and the specified permission instance.
Return Value: A System.Net.DnsPermission instance that represents the intersection of the current System.Net.DnsPermission instance with the specified System.Net.DnsPermission instance, or null if the intersection is empty.
The System.Net.DnsPermission.Intersect(System.Security.IPermission) method returns a System.Net.DnsPermission instance that allows the access defined by both the current System.Net.DnsPermission instance and the specified System.Net.DnsPermission instance. Any demand must pass both permissions to pass their intersection. The System.Net.DnsPermission instance to combine with the current instance.
IsSubsetOf
Determines whether the current permission instance is a subset of the specified permission instance.
Return Value: true if the current permission instance is a subset of target; otherwise, false.
The current System.Net.DnsPermission instance is a subset of the specified System.Net.DnsPermission instance if the current System.Net.DnsPermission instance specifies a set of operations that is wholly contained by the specified System.Net.DnsPermission instance. The second System.Net.DnsPermission instance to be tested for the subset relationship.
IsUnrestricted
Checks the overall permission state of the object.
Return Value: true if the System.Net.DnsPermission instance was created with System.Security.Permissions.PermissionState.Unrestricted; otherwise, false.
ToXml
Creates an XML encoding of a System.Net.DnsPermission instance and its current state.
Return Value: A System.Security.SecurityElement instance containing an XML-encoded representation of the security object, including state information.
The System.Net.DnsPermission.ToXml method creates a System.Security.SecurityElement instance to XML-encode a representation of the System.Net.DnsPermission instance, including state information.
Union
Creates a permission instance that is the union of the current permission instance and the specified permission instance.
Return Value: A System.Net.DnsPermission instance that represents the union of the current System.Net.DnsPermission instance with the specified System.Net.DnsPermission instance.
The System.Net.DnsPernission.Union(System.Security.IPermission) method returns a System.Net.DnsPermission instance that allows the access defined by either the current System.Net.DnsPermission instance and the specified System.Net.DnsPermission instance. Any demand that passes either permission passes their union. The System.Net.DnsPermission instance to combine with the current instance.
DnsPermissionAttribute class (System.Net)
Union
Description
Enables security actions for System.Net.DnsPermission to be applied to code using declarative security. This class cannot be inherited.
DnsPermissionAttribute
Example Syntax: Union
Initializes a new instance of the System.Net.DnsPermissionAttribute class with the specified System.Security.Permissions.SecurityAction value. One of the System.Security.Permissions.SecurityAction values.
Action
TypeId
Unrestricted
CreatePermission
Creates and returns a new instance of the System.Net.DnsPermission class.
Return Value: An instance of the System.Net.DnsPermission class corresponding to the security declaration.
The System.Net.DnsPermissionAttribute.CreatePermission method is called by the security system, not by application code.
EndPoint class (System.Net)
ToString
Description
Identifies a network address. This is an abstract class.
The System.Net.EndPoint class provides an abstract base class that represents a network resource or service. Descendant classes combine network connection information to form a connection point to a service.
EndPoint
Example Syntax:
ToString
AddressFamily
ToString
Gets the address family to which the endpoint belongs.
The System.Net.EndPoint.AddressFamily property specifies the addressing scheme used by the end point's underlying network protocol.
Create
Creates an System.Net.EndPoint instance from a System.Net.SocketAddress instance.
Return Value: A new System.Net.EndPoint instance initialized from the specified System.Net.SocketAddress instance. The socket address that serves as the endpoint for a connection.
Serialize
Serializes endpoint information into a System.Net.SocketAddress instance.
Return Value: A System.Net.SocketAddress instance containing the endpoint information.
EndpointPermission class (System.Net)
ToString
Description
Defines an endpoint that is authorized by a System.Net.SocketPermission instance.
The System.Net.EndpointPermission class defines a network endpoint, including host name, network port number, and transport type used to make the connection.
Hostname
ToString
Gets the DNS host name or IP address of the server associated with this endpoint.
Port
ToString
Gets the network port number associated with this endpoint.
Transport
ToString
Gets the transport type associated with this endpoint.
Equals
GetHashCode
ToString
Returns a string that represents the current System.Net.EndpointPermission instance.
Return Value: A string that represents the current System.Net.EndpointPermission instance.
The System.Net.EndpointPermission.ToString method returns a string representing the contents for the System.Net.EndpointPermission instance. The string is in the form System.Net.EndpointPermission.Hostname # System.Net.EndpointPermission.Port # System.Net.EndpointPermission.Transport.
FileWebRequest class (System.Net)
ToString
Description
Provides a file system implementation of the System.Net.WebRequest class.
The System.Net.FileWebRequest class implements the System.Net.WebRequestabstract base class for URIs that use the file:// scheme to request local files.
FileWebRequest
Example Syntax:
ToString
Initializes a new instance of the System.Net.FileWebRequest class from the specified instances of the System.Runtime.Serialization.SerializationInfo and System.Runtime.Serialization.StreamingContext classes.
This constructor implements the
System.Runtime.Serialization.ISerializable interface for the System.Net.FileWebRequest class. A System.Runtime.Serialization.SerializationInfo instance that contains the information required to serialize the new System.Net.FileWebRequest instance. An instance of the System.Runtime.Serialization.StreamingContext class that contains the source of the serialized stream associated with the new System.Net.FileWebRequest instance.
ConnectionGroupName
ToString
Gets or sets the name of the connection group for the request. This property is reserved for future use.
The System.Net.FileWebRequest.ConnectionGroupName property is currently not used by the System.Net.FileWebRequest class.
ContentLength
ToString
Gets or sets the content length of the data being sent.
ContentType
ToString
Gets or sets the content type of the data being sent. This property is reserved for future use.
The System.Net.FileWebRequest.ContentType property contains the media type of the data being sent. This is typically the MIME encoding of the content. The System.Net.FileWebRequest.ContentType property is currently not used by the System.Net.FileWebRequest class.
Credentials
ToString
Gets or sets the credentials associated with this request. This property is reserved for future use.
Because the System.Net.FileWebRequest class does not authenticate requests for files from the local file system, it ignores the contents, if any, of the System.Net.FileWebRequest.Credentials property. Authentication for System.Net.FileWebRequest is handled by the access control lists for the file resource in the underlying file system.
Headers
ToString
Gets a collection of the name/value pairs associated with the request. This property is reserved for future use.
The System.Net.FileWebRequest.Headers property is currently not used by the System.Net.FileWebRequest class.
Method
ToString
Gets or sets the protocol method used for the request. This property is reserved for future use.
The System.Net.FileWebRequest.Method property is currently not used by the System.Net.FileWebRequest class.
PreAuthenticate
ToString
Gets or sets a value indicating whether to preauthenticate a request. This property is reserved for future use.
The System.Net.FileWebRequest.PreAuthenticate property is currently not used by the System.Net.FileWebRequest class.
Proxy
ToString
Gets or sets the network proxy to use for this request. This property is reserved for future use.
The System.Net.FileWebRequest.Proxy property is currently not used by the System.Net.FileWebRequest class.
RequestUri
ToString
Gets the URI of the request.
Timeout
ToString
Gets or sets the length of time until the request times out.
BeginGetRequestStream
Begins an asynchronous request for a System.IO.Stream instance to use to write data.
Return Value: An System.IAsyncResult that references the asynchronous request.
The System.Net.FileWebRequest.BeginGetRequestStream(System.AsyncCallback, System.Object) method starts an asynchronous request for a stream used to send data to a file system resource. The callback method that implements the System.AsyncCallback delegate uses the System.Net.FileWebRequest.EndGetRequestStream(System.IAsyncResult) method to return the request stream. The System.AsyncCallback delegate. An object containing state information for this request.
BeginGetResponse
Begins an asynchronous request for a file system resource.
Return Value: An System.IAsyncResult that references the asynchronous request.
The System.Net.FileWebRequest.BeginGetResponse(System.AsyncCallback,System.Object) method starts an asynchronous request for a file system resource. The asynchronous callback method that implements the System.AsyncCallback delegate uses the System.Net.FileWebRequest.EndGetResponse(System.IAsyncResult) method to return the actual System.Net.FileWebResponse. The System.AsyncCallback delegate. An object containing state information for this request.
EndGetRequestStream
Ends an asynchronous request for a System.IO.Stream instance that the application uses to write data.
Return Value: A System.IO.Stream instance that the application uses to write data.
The System.Net.FileWebRequest.EndGetRequestStream(System.IAsyncResult) method completes an asynchronous stream request that was started by the System.Net.FileWebRequest.BeginGetRequestStream(System.AsyncCallback, System.Object) method. An System.IAsyncResult referencing the pending request for a stream.
EndGetResponse
Ends an asynchronous request for a file system resource.
Return Value: A System.Net.WebResponse that contains the response from the file system resource.
The System.Net.FileWebRequest.EndGetResponse(System.IAsyncResult) method completes an asynchronous request for a file system resource that was started with the System.Net.FileWebRequest.BeginGetResponse(System.AsyncCallback,System. Object) method. An System.IAsyncResult referencing the pending request for a response.
GetRequestStream
Returns a System.IO.Stream instance for writing data to the file system resource.
Return Value: A System.IO.Stream for writing data to the file system resource.
The System.Net.FileWebRequest.GetRequestStream method returns a System.IO.Stream instance for writing data to the file system resource.
GetResponse
Returns a response to a file system request.
Return Value: A System.Net.WebResponse that contains the response from the file system resource.
The System.Net.FileWebRequest.GetResponse method returns a System.Net.WebResponse instance containing the response from the file system resource.
ISerializable.GetObjectData
FileWebResponse class (System.Net)
ToString
Description
Provides a file system implementation of the System.Net.WebResponse class.
The System.Net.FileWebResponse class implements the System.Net.WebResponseabstract base class to return file system resources for the System.Net.FileWebRequest class.
FileWebResponse
Example Syntax:
ToString
Initializes a new instance of the System.Net.FileWebResponse class from the specified instances of the System.Runtime.Serialization.SerializationInfo and System.Runtime.Serialization.StreamingContext classes.
This constructor implements the
System.Runtime.Serialization.ISerializable interface for the System.Net.FileWebResponse class. A System.Runtime.Serialization.SerializationInfo instance that contains the information required to serialize the new System.Net.FileWebResponse instance. An instance of the System.Runtime.Serialization.StreamingContext class that contains the source of the serialized stream associated with the new System.Net.FileWebResponse instance.
ContentLength
ToString
Gets the length of the content in the file system resource.
The System.Net.FileWebResponse.ContentLength property contains the length, in bytes, of the file system resource.
ContentType
ToString
Gets the content type of the file system resource.
The System.Net.FileWebResponse.ContentType property contains the content type of the file system resource. The value of System.Net.FileWebResponse.ContentType is always “binary/octet-stream”.
Headers
ToString
Gets a collection of header name/value pairs associated with the response.
The System.Net.FileWebResponse.Headers property contains two name/value pairs, one for content length and one for content type, both of which are also exposed as properties, System.Net.FileWebResponse.ContentLength and System.Net.FileWebResponse.ContentType.
ResponseUri
ToString
Gets the URI of the file system resource that provided the response.
The System.Net.FileWebResponse.ResponseUri property contains the URI of the file system resource that provided the response. This is always the file system resource that was requested.
Close
Closes the response stream.
The System.Net.FileWebResponse.Close method cleans up the resources used by a System.Net.FileWebResponse and closes the response stream by calling the System.IO.Stream.Close method.
Dispose
GetResponseStream
Returns the data stream from the file system resource.
Return Value: A System.IO.Stream for reading data from the file system resource.
The System.Net.FileWebResponse.GetResponseStream method returns the data stream from the file system resource.
IDisposable.Dispose
ToString
Description
Contains a global default proxy instance for all HTTP requests.
The System.Net.GlobalProxySelection stores the proxy settings for the default proxy that System.Net.WebRequest instances use to contact Internet sites beyond the local network. The default proxy setting is initialized from the global or application configuration file, and can be overridden for individual requests, or disabled by setting the System.Net.HttpWebRequest.Proxy property to the result of the System.Net.GlobalProxySelection.GetEmptyWebProxy method.
GlobalProxySelection
Example Syntax:
ToString
Select
ToString
Gets or sets the global HTTP proxy.
The System.Net.GlobalProxySelection.Select method sets the proxy that all System.Net.HttpWebRequest instances use.
GetEmptyWebProxy
Returns an empty proxy instance.
Return Value: An System.Net.IWebProxy that contains no information.
The System.Net.GlobalProxySelection.GetEmptyWebProxy method returns a blank System.Net.IWebProxy instance to indicate that no proxy is used to access an Internet resource.
HttpContinueDelegate Delegate (System.Net)
ToString
Description
Represents the method that notifies callers when a continue response is received by the client. The numeric value of the HTTP status from the server. The headers returned with the 100-continue response from the server.
Use System.Net.HttpContinueDelegate to specify the callback method to be called when an HTTP 100-continue response is received from the server. When set, the delegate is called whenever protocol responses of type System.Net.HttpStatusCode.Continue are received.
HttpStatusCode enumeration (System.Net)
ToString
Description
Contains the values of status codes defined for HTTP.
The System.Net.HttpStatusCode enumeration contains the values of the status codes defined in RFC 2616 for HTTP 1.1.
ToString
Equivalent to HTTP status 202.
ToString
Equivalent to HTTP status 300.
ToString
Equivalent to HTTP status 502.
ToString
Equivalent to HTTP status 400.
ToString
Equivalent to HTTP status 409.
ToString
Equivalent to HTTP status 100.
ToString
Equivalent to HTTP status 201.
ToString
Equivalent to HTTP status 417.
ToString
Equivalent to HTTP status 403.
ToString
Equivalent to HTTP status 302.
ToString
Equivalent to HTTP status 504.
ToString
Equivalent to HTTP status 410.
ToString
Equivalent to HTTP status 505.
ToString
Equivalent to HTTP status 500.
ToString
Equivalent to HTTP status 411.
ToString
Equivalent to HTTP status 405.
ToString
Equivalent to HTTP status 301.
ToString
Equivalent to HTTP status 301.
ToString
Equivalent to HTTP status 300.
ToString
Equivalent to HTTP status 204.
ToString
Equivalent to HTTP status 203.
II ToString
Equivalent to HTTP status 406.
ToString
Equivalent to HTTP status 404.
ToString
Equivalent to HTTP status 501.
ToString
Equivalent to HTTP status 304.
ToString
Equivalent to HTTP status 200.
ToString
Equivalent to HTTP status 206.
ToString
Equivalent to HTTP status 402.
ToString
Equivalent to HTTP status 412.
ToString
Equivalent to HTTP status 407.
ToString
Equivalent to HTTP status 302.
ToString
Equivalent to HTTP status 307.
ToString
Equivalent to HTTP status 303.
ToString
Equivalent to HTTP status 416.
ToString
Equivalent to HTTP status 413.
ToString
Equivalent to HTTP status 408.
ToString
Equivalent to HTTP status 414.
ToString
Equivalent to HTTP status 205.
ToString
Equivalent to HTTP status 303.
ToString
Equivalent to HTTP status 503.
ToString
Equivalent to HTTP status 101.
ToString
Equivalent to HTTP status 307.
ToString
Equivalent to HTTP status 401.
ToString
Equivalent to HTTP status 415.
ToString
Equivalent to HTTP status 306.
ToString
Equivalent to HTTP status 305.
HttpVersion class (System.Net)
ToString
Description
Defines the HTTP version numbers supported by the System.Net.HttpWebRequest and System.Net.HttpWebResponse classes.
The System.Net.HttpVersion class defines the HTTP versions supported by the System.Net.HttpWebRequest and System.Net.HttpWebResponse classes. The HTTP version number is used to control version-specific features of HTTP, such as pipelining and chunking.
ToString
Defines a System.Version instance for HTTP 1.0.
ToString
Defines a System.Version instance for HTTP 1.1.
HttpVersion
Example Syntax:
ToString
HttpWebRequest class (System.Net)
ToString
Description
Provides an HTTP-specific implementation of the System.Net.WebRequest class.
The System.Net.HttpWebRequest class provides support for the properties and methods defined in System.Net.WebRequest and for additional properties and methods that enable the user to interact directly with servers using HTTP.
HttpWebRequest
Example Syntax:
ToString
Initializes a new instance of the System.Net.HttpWebRequest class from the specified instances of the System.Runtime.Serialization.SerializationInfo and System.Runtime.Serialization.StreamingContext classes.
This constructor implements the System.Runtime.Serialization.ISerializable interface for the System.Net.HttpWebRequest class. A System.Runtime.Serialization.SerializationInfo instance containing the information required to serialize the new System.Net.HttpWebRequest instance. A System.Runtime.Serialization.StreamingContext instance containing the source and destination of the serialized stream associated with the new System.Net.HttpWebRequest instance.
Accept
ToString
Gets or sets the value of the Accept HTTP header.
Address
ToString
Gets the URI of the Internet resource that actually responds to the request. The System.Net.HttpWebRequest.Address property is set to the URI that actually responds to a request, after any redirections that might happen during the request are complete.
AllowAutoRedirect
ToString
Gets or sets a value that indicates whether the request should follow redirection responses.
Set System.Net.HttpWebRequest.AllowAutoRedirect to true if you want the request to automatically follow HTTP redirection headers to the new location of the resource. The maximum number of redirections to follow is set by the System.Net.HttpWebRequest.MaximumAutomaticRedirections property.
AllowWriteStreamBuffering
ToString
Gets or sets a value that indicates whether to buffer the data sent to the Internet resource.
When System.Net.HttpWebRequest.AllowWriteStreamBuffering is true, the data is buffered in memory so it is ready to be resent in the event of redirections or authentication requests.
ClientCertificates
ToString
Gets the collection of security certificates associated with this request.
Connection
ToString
Gets or sets the value of the Connection HTTP header.
The request sends the System.Net.HttpWebRequest.Connection property to the Internet resource as the Connection HTTP header. If System.Net.HttpWebRequest.KeepAlive is true, the value “Keep-alive” is appended to the end of the Connection header.
ConnectionGroupName
ToString
Gets or sets the name of the connection group for the request.
The System.Net.HttpWebRequest.ConnectionGroupName property enables you to associate a request with a connection group. This is useful when your application makes requests to one server for different users, such as a Web site that retrieves customer information from a database server.
ContentLength
ToString
The System.Net.HttpWebRequest.ContentLength property contains the value to send as the Content-length HTTP header with the request.
ContentType
ToString
Gets or sets the value of the Content-type HTTP header.
The System.Net.HttpWebRequest.ContentType property contains the media type of the request. Values assigned to the System.Net.HttpWebRequest.ContentType property replace any existing contents when the request sends the Content-type HTTP header.
ContinueDelegate
ToString
Gets or sets the delegate method called when an HTTP 100-continue response is received from the Internet resource.
The System.Net.HttpWebRequest.ContinueDelegate property specifies the callback method to call when the client receives a 100-Continue response.
CookieContainer
ToString
Gets or sets the cookies associated with the request.
The System.Net.HttpWebRequest.CookieContainer property provides an instance of the System.Net.CookieContainer class that contains the cookies associated with this request.
Credentials
ToString
Provides authentication information for the request.
The System.Net.HttpWebRequest.Credentials property contains authentication information to identify the maker of the request. The System.Net.HttpWebRequest.Credentials property can be either an instance of System.Net.NetworkCredential, in which case the user, password, and domain information contained in the System.Net.NetworkCredential instance is used to authenticate the request, or it can be an instance of System.Net.CredentialCache, in which case the uniform resource identifier (URI) of the request is used to determine the user, password, and domain information to use to authenticate the request.
Expect
ToString
Gets or sets the value of the Expect HTTP header.
By default, System.Net.HttpWebRequest.Expect is set to “100-continue”. You can add other values to the list that System.Net.HttpWebRequest.Expect maintains, or you can delete all values except “100-continue” from the list by setting System.Net.HttpWebRequest.Expect to null.
HaveResponse
ToString
Gets a value indicating whether a response has been received from an Internet resource.
Headers
ToString
Gets a collection of the name/value pairs that make up the HTTP headers.
The System.Net.HttpWebRequest.Headers collection contains the protocol headers associated with the request. The following table lists the HTTP headers that are not stored in the System.Net.HttpWebRequest.Headers collection but are either set by the system or set by properties or methods.
IfModifiedSince
ToString
Gets or sets the value of the If-Modified-Since HTTP header.
KeepAlive
ToString
Gets or sets a value indicating whether to make a persistent connection to the Internet resource.
Set this property to true to send an Connection HTTP header with the value Keep-alive. An application uses System.Net.HttpWebRequest.KeepAlive to indicate a preference for persistent connections. When the System.Net.HttpWebRequest.KeepAlive property is true, the application makes persistent connections to the servers that support them.
MaximumAutomaticRedirections
ToString
Gets or sets the maximum number of redirects that the request will follow.
The System.Net.HttpWebRequest.MaximumAutomaticRedirections method property sets the maximum number of redirections for the request to follow if the System.Net.HttpWebRequest.AllowAutoRedirect property is true
MediaType
ToString
Gets or sets the media type of the request.
The value of the System.Net.HttpWebRequest.MediaType property affects the System.Net.HttpWebResponse.CharacterSet property. When you set the System.Net.HttpWebRequest.MediaType in the request, the corresponding media type is chosen from the list of character sets returned in the response Content-type HTTP header.
Method
ToString
Gets or sets the method for the request.
The System.Net.HttpWebRequest.Method property can be set to any of the HTTP 1.1 protocol verbs: GET, HEAD, POST, PUT, DELETE, TRACE, or OPTIONS.
Pipelined
ToString
Gets or sets a value indicating whether to pipeline the request to the Internet resource.
An application uses the System.Net.HttpWebRequest.Pipelined property to indicate a preference for pipelined connections. When System.Net.HttpWebRequest.Pipelined is true, an application makes pipelined connections to the servers that support them.
PreAuthenticate
ToString
Gets or sets a value indicating whether to send a preauthentication header with the request.
When System.Net.HttpWebRequest.PreAuthenticate is true and credentials are supplied, the WWW-authenticate HTTP header is sent with the initial request if its value is known; otherwise the request uses standard authentication procedures.
ProtocolVersion
ToString
Gets or sets the version of HTTP to use for the request.
The System.Net.HttpWebRequest class supports only versions 1.0 and 1.1 of HTTP. Setting System.Net.HttpWebRequest.ProtocolVersion to a different version throws an exception.
Proxy
ToString
Gets or sets proxy information for the request.
The System.Net.HttpWebRequest.Proxy property identifies the System.Net.WebProxy instance to use to process requests to Internet resources. To specify that no proxy should be used, set the System.Net.HttpWebRequest.Proxy property to the proxy instance returned by the System.Net.GlobalProxySelection.GetEmptyWebProxy method.
Referer
ToString
Gets or sets the value of the Referer HTTP header.
If the System.Net.HttpWebRequest.AllowAutoRedirect property is true, the System.Net.HttpWebRequest.Referer property is set automatically when the request is redirected to another site.
RequestUri
ToString
Gets the original URI of the request.
The System.Uri instance passed to System.Net.HttpWebRequest by the call to System.Net.WebRequest.Create(System.Uri,System.Boolean).
SendChunked
ToString
Gets or sets a value indicating whether to send data in segments to the Internet resource.
When System.Net.HttpWebRequest.SendChunked is true, the request sends data to the Internet resource in segments. The Internet resource must support receiving chunked data.
ServicePoint
ToString
Gets the service point to use for the request.
The value of the System.Net.HttpWebRequest.ServicePoint property is null until the System.Net.HttpWebRequest.GetResponse method is called.
Timeout
ToString
Gets or sets the timeout value for a request.
System.Net.HttpWebRequest.Timeout is the number of milliseconds that a synchronous request made with the System.Net.HttpWebRequest.GetResponse method waits for a response. If a resource does not respond within the time-out period, the request throws a System.Net.WebException with the System.Net.WebException.Status property set to System.Net.WebExceptionStatus.Timeout.
TransferEncoding
ToString
Gets or sets the value of the Transfer-encoding HTTP header.
Before you can set the System.Net.HttpWebRequest.TransferEncoding property, you must first set the System.Net.HttpWebRequest.SendChunked property to true. Clearing System.Net.HttpWebRequest.TransferEncoding by setting it to null has no effect on the value of System.Net.HttpWebRequest.SendChunked.
UserAgent
ToString
Gets or sets the value of the User-agent HTTP header. Abort
Cancels a request to an Internet resource. System.Net.HttpWebRequest.Abort cancels a request to a resource. After a request is canceled, calling System.Net.HttpWebRequest.GetResponse, System.Net.HttpwebRequest.BeginGetResponse(System.AsyncCallback,System.Object), System.Net.HttpwebRequest.EndGetResponse(System.IAsyncResult), System.Net.HttpWebRequest.GetRequestStream, System.Net.HttpwebRequest.BeginGetRequestStream(System.AsyncCallback, System.Object), or will cause a System.Net.WebException with System.Net.WebException.Status set to System.Net.WebExceptionStatus.RequestCanceled.
AddRange
Adds a byte range header to a request for a specific range from the beginning or end of the requested data.
System.Net.HttpWebRequest.AddRange(System.Int32,System.Int32) adds a byte range header to the request. The starting or ending point of the range.
AddRange
Adds a byte range header to the request for a specified range.
System.Net.HttpWebRequest.AddRange(System.Int32,System.Int32) adds a byte range header to the request. The position at which to start sending data. The position at which to stop sending data.
AddRange
Adds a range header to a request for a specific range from the beginning or end of the requested data.
If range is positive, the range is from the start of the data to range. The
Description of the range. The starting or ending point of the range.
AddRange
Adds a range header to a request for a specified range. The description of the range. The position at which to start sending data. The position at which to stop sending data.
BeginGetRequestStream
Begins an asynchronous request for a System.IO.Stream instance to use to write data.
Return Value: An System.IAsyncResult that references the asynchronous request.
The System.Net.HttpwebRequest.BeginGetRequestStream(System.AsyncCallback, System.Object) method starts an asynchronous request for a stream used to send data for the System.Net.HttpWebRequest. The asynchronous callback method uses the System.Net.HttpWebRequest.EndGetRequestStream(System.IAsyncResult) method to return the actual stream. The System.AsyncCallback delegate. The state object for this request.
BeginGetResponse
Begins an asynchronous request to an Internet resource.
Return Value: An System.IAsyncResult that references the asynchronous request for a response.
The System.Net.HttpWebRequest.BeginGetResponse(System.AsyncCallback,System. Object) method starts an asynchronous request for a response from the Internet resource. The asynchronous callback method uses the System.Net.HttpWebRequest.EndGetResponse(System.IAsyncResult) method to return the actual System.Net.WebResponse. The System.AsyncCallback delegate The state object for this request.
EndGetRequestStream
Ends an asynchronous request for a System.IO.Stream instance to use to write data.
Return Value: A System.IO.Stream to use to write request data.
The System.Net.HttpWebRequest.EndGetRequestStream(System.IAsyncResult) method completes an asynchronous request for a stream that was started by the System.Net.HttpWebRequest.BeginGetRequestStream(System.AsyncCallback, System.Object) method. Once the System.IO.Stream instance has been returned, you can send data with the System.Net.HttpWebRequest by using the System.IO.Stream.Write(System.Byte[ ],System.Int32,System.Int32) method. The pending request for a stream.
EndGetResponse
Ends an asynchronous request to an Internet resource.
Return Value: A System.Net.WebResponse containing the response from the Internet resource.
The System.Net.HttpWebRequest.EndGetResponse(System.IAsyncResult) method completes an asynchronous request for an Internet resource that was started by calling System.Net.HttpwebRequest.BeginGetResponse(System.AsyncCallback,System. Object). The pending request for a response.
GetHashCode
Gets the hash code for this System.Net.HttpWebRequest.
Return Value: The hash code for the System.Net.HttpWebRequest.
The hash codes for System.Net.HttpWebRequest A and B are guaranteed to be the same when A.Equals(B) is true.
GetRequestStream
Gets a System.IO.Stream instance to use to write request data.
Return Value: A System.IO.Stream to use to write request data.
The System.Net.HttpWebRequest.GetRequestStream method returns a stream to use to send data for the System.Net.HttpWebRequest. Once the System.IO.Stream instance has been returned, you can send data with the System.Net.HttpWebRequest by using the System.IO.Stream.Write(System.Byte[ ],System.Int32,System.Int32) method.
GetResponse
Returns a response from an Internet resource.
Return Value: A System.Net.WebResponse containing the response from the Internet resource.
The System.Net.HttpWebRequest.GetResponse method returns a System.Net.WebResponse instance containing the response from the Internet resource. The actual instance returned is an instance of System.Net.HttpWebResponse, and can be typecast to that class to access HTTP-specific properties.
SetServicePoint
ISerializable.GetObjectData
HttpWebResponse class (System.Net)
ToString
Description
Provides an HTTP-specific implementation of the System.Net.WebResponse class.
The System.Net.HttpWebResponse class contains support for the properties and methods included in System.Net.WebResponse with additional elements that enable the user to interact directly with the HTTP protocol.
HttpWebResponse
Example Syntax:
ToString
Initializes a new instance of the System.Net.HttpWebResponse class from the specified System.Runtime.Serialization.SerializationInfo and System.Runtime.Serialization.StreamingContext instances.
This constructor implements the
System.Runtime.Serialization.ISerializable interface for the System.Net.HttpWebRequest class. A System.Runtime.Serialization.SerializationInfo containing the information required to serialize the new System.Net.HttpWebRequest instance. A System.Runtime.Serialization.StreamingContext containing the source of the serialized stream associated with the new System.Net.HttpWebRequest instance.
CharacterSet
ToString
ContentEncoding
ToString
Gets the method used to encode the body of the response.
The System.Net.HttpWebResponse.ContentEncoding property contains the value of the Content-Encoding header returned with the response.
ContentLength
ToString
Gets the length of the content returned by the request.
The System.Net.HttpWebResponse.ContentLength property contains the value of the Content-length header returned with the response. If the Content-length header is not set in the response, System.Net.HttpWebResponse.ContentLength is set to the value−1.
ContentType
ToString
Gets the content type of the response.
The System.Net.HttpWebResponse.ContentType property contains the value of the Content-Type header returned with the response.
Cookies
ToString
Gets or sets the cookies associated with this request.
The System.Net.HttpWebResponse.Cookies property provides an instance of the System.Net.CookieCollection class holding the cookies associated with this response.
Headers
ToString
Gets the headers associated with this response from the server.
The System.Net.HttpWebResponse.Headers property is a collection of name/value pairs containing the HTTP header values returned with the response. Common headers, listed in the following table, are exposed as properties by the API: Header Property Content-Encoding System.Net.HttpWebResponse.ContentEncoding Content-Length System.Net.HttpWebResponse.ContentLength Content-Type System.Net.HttpWebResponse.ContentType Last-Modified System.Net.HttpWebResponse.LastModified Server System.Net.HttpWebResponse.Server Gets the headers associated with this response from the server.
LastModified
ToString
Gets the last date and time that the contents of the response were modified.
The System.Net.HttpWebResponse.LastModified property contains the value of the Last-Modified header received with the response.
Method
ToString
Gets the method used to return the response.
ProtocolVersion
ToString
Gets the version of the HTTP protocol used in the response.
The System.Net.HttpWebResponse.ProtocolVersion property contains the HTTP protocol version number of the response sent by the Internet resource.
ResponseUri
ToString
Gets the uniform resource identifier (URI) of the Internet resource that responded to the request A System.Uri instance containing the URI of the Internet resource that responded to the request.
The System.Net.HttpWebResponse.ResponseUri property contains the URI of the Internet resource that actually responded to the request. This URI may not be the same as the originally requested URI if the request was redirected by the original server.
Server
ToString
Gets the name of the server that sent the response.
The System.Net.HttpWebResponse.Server property contains the value of the Server header returned with the response.
StatusCode
ToString
Gets the status of the response.
The System.Net.HttpWebResponse.StatusCode parameter is a number indicating the status of the HTTP response. The expected values for status are defined in the System.Net.HttpStatusCode class.
StatusDescription
ToString
Gets the status description returned with the response.
Close
Closes the response stream.
The System.Net.HttpWebResponse.Close method closes the response stream and releases the connection to the Internet resource for reuse by other requests.
Dispose
GetHashCode
GetResponseHeader
Gets a specified header value returned with the response.
Return Value: The value of the header specified.
The System.Net.HttpWebResponse.GetResponseHeader(System.String) method returns the value of the specified header. The header value to return.
GetResponseStream
Gets the stream used for reading the body of the response from the server.
Return Value: A System.IO.Stream containing the body of the response.
The System.Net.HttpWebResponse.GetResponseStream method returns the data stream from the requested Internet resource.
IDisposable.Dispose
IAuthenticationModule interface (System.Net)
ToString
Description
Provides the base authentication interface for Web client authentication modules.
The System.Net.IAuthenticationModule interface defines the properties and methods that custom authentication modules must use.
AuthenticationType
ToString
Gets the authentication type provided by this authentication module.
The System.Net.IAuthenticationModule.AuthenticationType property identifies the authentication type implemented by this authentication module. The System.Net.IAuthenticationModule.AuthenticationType property is used by the System.Net.AuthenticationManager.Register(System.Net.IAuthenticationModule) method to determine if the authentication module has been registered, and by the System.Net.AuthenticationManager.Unregister(System.Net.IAuthentication Module) method to remove a registered authentication module.
CanPreAuthenticate
ToString
Gets a value indicating whether the authentication module supports preauthentication.
The System.Net.IAuthenticationModule.CanPreAuthenticate property is set to true to indicate that the authentication module can respond with a valid System.Net.Authorization instance when the System.Net.IAuthenticationModule.PreAuthenticate(System.Net.WebRequest, System.Net.ICredentials) method is called.
Authenticate
Returns an instance of the System.Net.Authorization class in respose to an authentication challenge from a server.
Return Value: An System.Net.Authorization instance containing the authorization message for the request, or null if the challenge cannot be handled.
The System.Net.IAuthenticationModule.Authenticate(System.String,System.Net. WebRequest,System.Net.ICredentials) method conducts the authentication process with the server and returns an System.Net.Authorization instance to the System.Net.AuthenticationManager. The authentication challenge sent by the server. The System.Net.WebRequest instance associated with the challenge. The credentials associated with the challenge.
PreAuthenticate
Returns an instance of the System.Net.Authorization class for an authentication request to a server.
Return Value: An System.Net.Authorization instance containing the authorization message for the request.
When the System.Net.IAuthenticationModule.CanPreAuthenticate property is true, the System.Net.IAuthenticationModule.PreAuthenticate(System.Net.WebRequest, System.Net.ICredentials) method will return an instance of the System.Net.Authorization class containing an authentication message. The System.Net.WebRequest instance associated with the authentication request. The credentials associated with the authentication request.
ICertificatePolicy Interface (System.Net)
PreAuthenticate
Description
Validates a server certificate.
The System.Net.ICertificatePolicy interface is used to provide custom security certificate validation for an application. The default policy is to allow valid certificates, as well as valid certificates that have expired. To change this policy, implement the System.Net.ICertificatePolicy interface with a different policy, and then assign that policy to System.Net.ServicePointManager.CertificatePolicy.
CheckValidationResult
Validates a server certificate.
Return Value: true if the certificate should be honored; otherwise, false.
The System.Net.ICertificatePolicy.CheckValidationResult(System.Net.ServicePoint, System.Security.Cryptography.X509Certificates.X509Certificate,System.Net. WebRequest,System.Int32) method implements the application certificate validation policy. The method can examine the srvPoint, certificate, request, and certificateProblem parameters to determine whether the certificate should be honored. The System.Net.ServicePoint that will use the certificate. The certificate to validate. The request that received the certificate. The problem encountered when using the certificate.
ICredentials Interface (System.Net)
CheckValidationResult
Description
Provides the base authentication interface for retrieving credentials for Web client authentication.
The System.Net.ICredentials interface provides the System.Net.ICredentials.GetCredential(System.Uri,System.String) method to objects that supply network credentials to applications.
GetCredential
Returns a System.Net.NetworkCredential object that is associated with the specified URI, and authentication type.
Return Value: The System.Net.NetworkCredential associated with the specified URI and authentication type, or if no credentials are available, null.
The System.Net.ICredentials.GetCredential(System.Uri,System.String) method returns a System.Net.NetworkCredential instance that contains the credentials associated with the specified URI and authorization scheme. When no credentials are available, the System.Net.ICredentials.GetCredential(System.Uri,System.String) method returns null. The System.Uri that the client is providing authentication for. The type of authentication, as defined in the System.Net.IAuthenticationModule.AuthenticationType property.
IPAddress class (System.Net)
GetCredential
Description
Provides an Internet Protocol (IP) address.
The System.Net.IPAddress class contains the address of a computer on an IP network.
GetCredential
Provides an IP address indicating that the server should listen for client activity on all network interfaces. This field is read-only.
The System.Net.Sockets.Socket.Bind(System.Net.EndPoint) method uses the System.Net.IPAddress.Any field to indicate that a System.Net.Sockets.Socket instance should listen for client activity on all network interfaces.
GetCredential
Provides the IP broadcast address. This field is read-only.
The System.Net.IPAddress.Broadcast field is equivalent to 255.255.255.255.
GetCredential
Provides the IP loopback address. This field is read-only.
The System.Net.IPAddress.Loopback field is equivalent to 127.0.0.1 in network byte order.
GetCredential
Provides an IP address indicating that no network interface should be used. This field is read-only.
The System.Net.Sockets.Socket.Bind(System.Net.EndPoint) method uses the System.Net.IPAddress.None field to indicate that a System.Net.Sockets.Socket instance should not listen for client activity.
IPAddress
Example Syntax:
GetCredential
Initializes a new instance of the System.Net.IPAddress class with the specified address.
The System.Net.IPAddress instance is created with the System.Net.IPAddress.Address property set to newaddress. The integer value of the IP address.
Address
GetCredential
An Internet Protocol (IP) address.
To convert System.Net.IPAddress.Address to dotted-quad notation, use the System.Net.IPAddress.ToString method.
AddressFamily
GetCredential
Specifies the address family of the IP address.
Equals
Compares two IP addresses.
Return Value: true if the two address are equal; otherwise, false.
The System.Net.IPAddress.Equals(System.Object) method compares the current System.Net.IPAddress instance with the comparand parameter and returns true if the two instance contain the same IP address. An System.Net.IPAddress instance to compare to the current instance.
GetHashCode
Returns a hash value for an IP address.
Return Value: An integer hash value.
The System.Net.IPAddress.GetHashCode method returns a hash code of the IP address. This value can be used as a key in hash tables.
HostToNetworkOrder
Converts a short value from host byte order to network byte order.
Return Value: A short value expressed in network byte order.
Different computers use different conventions for ordering the bytes within multi-byte integer values. Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To enable computers that use different byte ordering, all integer values sent over the network are sent in network byte order. The number to convert expressed in host byte order.
HostToNetworkOrder
Converts an integer value from host byte order to network byte order.
Return Value: An integer value expressed in network byte order.
Different computers use different conventions for ordering the bytes within multi-byte integer values. Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To enable computers that use different byte ordering, all integer values sent over the network are sent in network byte order. The number to convert expressed in host byte order.
HostToNetworkOrder
Converts a long value from host byte order to network byte order.
Return Value: A long value expressed in network byte order.
Different computers use different conventions for ordering the bytes within multi-byte integer values. Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To enable computers that use different byte ordering, all integer values sent over the network are sent in network byte order. The number to convert expressed in host byte order.
IsLoopback
Indicates whether the specified IP address is the loopback address.
Return Value: true if address is the loopback address; otherwise false.
The System.Net.IPAddress.IsLoopback(System.Net.IPAddress) method compares address to System.Net.IPAddress.Loopback and returns true if the two IP address are the same. An IP address.
NetworkToHostOrder
Converts a short value from network byte order to host byte order.
Return Value: A short value expressed in host byte order.
Different computers use different conventions for ordering the bytes within multi-byte integer values. Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To enable computers that use different byte ordering, all integer values sent over the network are sent in network byte order. The number to convert expressed in network byte order.
NetworkToHostOrder
Converts an integer value from network byte order to host byte order.
Return Value: An integer value expressed in host byte order.
Different computers use different conventions for ordering the bytes within multi-byte integer values. Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To enable computers that use different byte ordering, all integer values sent over the network are sent in network byte order. The number to convert expressed in network byte order.
NetworkToHostOrder
Converts a long value from network byte order to host byte order.
Return Value: A long value expressed in host byte order.
Different computers use different conventions for ordering the bytes within multi-byte integer values. Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To enable computers that use different byte ordering, all integer values sent over the network are sent in network byte order. The number to convert expressed in network byte order.
Parse
Converts an IP address string to an System.Net.IPAddress instance.
Return Value: An System.Net.IPAddress instance.
The static System.Net.IPAddress.Parse(System.String) method creates an System.Net.IPAddress instance from an IP address expressed in dotted-quad (” 192.168.1.2”) notation. A string containing an IP address in dotted-quad notation (for example, “192.168.1.2”).
ToString
Converts an Internet address to standard dotted-quad format.
Return Value: A string containing the IP address in dotted-quad format (for example, “192.168.1.2”).
The System.Net.IPAddress.ToString method converts the IP address stored in the System.Net.IPAddress.Address property is converted to dotted-quad notation (for example, “192.168.1.2”).
IPEndPoint class (System.Net)
ToString
Description
Represents a network endpoint as an IP address and a port number.
The System.Net.IPEndPoint class contains the host and port information needed by an application to connect to a service on a host. By combining the host's IP address and port number of a service, the System.Net.IPEndPoint class forms a connection point to a service.
ToString
Specifies the maximum value that can be assigned to the System.Net.IPEndPoint.Port property. This field is read-only.
ToString
Specifies the minimum value that can be assigned to the System.Net.IPEndPoint.Port property. This field is read-only.
IPEndPoint
Example Syntax:
ToString
Initializes a new instance of the System.Net.IPEndPoint class with the specified address and port number. The IP address of the Internet host. The port number associated with the address, or 0 to specify any available port.
IPEndPoint
Example Syntax:
ToString
Initializes a new instance of the System.Net.IPEndPoint class with the specified address and port number. The IP address of the Internet host. The port number associated with address.
Address
ToString
Gets or sets the IP address of the end point.
AddressFamily
ToString
Gets the Internet Protocol (IP) address family.
Port
ToString
Gets or sets the TCP port number of the end point.
Create
Creates an end point from a socket address.
Return Value: An System.Net.EndPoint instance using the specified socket. The network socket to use for the end point.
Equals
GetHashCode
Serialize
Serializes end point information into a System.Net.SocketAddress instance.
Return Value: A System.Net.SocketAddress instance containing the socket address for the end point.
ToString
Returns the IP address and port number for the specified end point.
Return Value: A string containing the IP address, in dotted-quad notation, and the port number for the specified end point (for example, 192.168.1.2:23).
IPHostEntry class (System.Net)
ToString
Description
Provides a container class for Internet host address information.
The System.Net.IPHostEntry class associates a Domain Name System (DNS) host name with an array of aliases and an array of matching IP addresses.
IPHostEntry
Example Syntax:
ToString
AddressList
ToString
Gets or sets a list of IP addresses associated with a host.
Aliases
ToString
Gets or sets a list of aliases associated with a host.
HostName
ToString
Gets or sets the DNS name of the host.
The System.Net.IPHostEntry.HostName property contains the primary host name for a server. If the DNS entry for the server defines additional aliases, they will be available in the System.Net.IPHostEntry.Aliases property.
IWebProxy interface (System.Net)
ToString
Description
Provides the base interface for implementation of proxy access for the System.Net.WebRequest class.
The System.Net.IWebProxy interface provides the methods and properties required by the System.Net.WebRequest class to access proxy servers.
Credentials
ToString
The credentials to submit to the proxy server for authentication.
The System.Net.IWebProxy.Credentials property is an System.Net.ICredentials instance containing the authorization credentials to send to the proxy server in response to an HTTP 407 (proxy authorization) status code.
GetProxy
Returns the URI of a proxy.
Return Value: A System.Uri containing the URI of the proxy used to contact destination.
The System.Net.IWebProxy.GetProxy(System.Uri) method returns the URI of the proxy server that handles requests to the Internet resource specified in the destination parameter. A System.Uri specifying the requested Internet resource.
IsBypassed
Indicates that the proxy should not be used for the specified host.
Return Value: true if the proxy server should not be used for host; otherwise, false.
The System.Net.IWebProxy.IsBypassed(System.Uri) method indicates whether to use the proxy server to access the host specified in the host parameter. If System.Net.IWebProxy.IsBypassed(System.Uri) is true, the proxy is not used to contact the host and the request is passed directly to the server. The System.Uri of the host to check for proxy use.
IWebRequestCreate interface (System.Net)
IsBypassed
Description
Provides the base interface for creating System.Net.WebRequest instances.
The System.Net.IWebRequestCreate interface defines the method that System.Net.WebRequest descendants must use to register with the System.Net.WebRequest.Create(System.Uri,System.Boolean) method.
Create
Creates a System.Net.WebRequest instance.
Return Value: A System.Net.WebRequest instance.
The System.Net.IWebRequestCreate.Create(System.Uri) method must return an initialized instance of the System.Net.WebRequest descendant capable of performing a standard request/response transaction for the protocol without needing any protocol-specific fields modified. The uniform resource identifier (URI) of the Web resource.
NetworkAccess enumeration (System.Net)
Create
Description
Specifies network access permissions.
The System.Net.NetworkAccess enumeration is used with the System.Net.WebPermission and System.Net.SocketPermission classes.
Create
Indicates that the application is allowed to accept connections from the Internet on a local resource.
Create
Indicates that the application is allowed to connect to specific Internet resources.
NetworkCredential class (System.Net)
ToString
Description
Provides credentials for password-based authentication schemes such as basic, digest, NTLM, and Kerberos authentication.
The System.Net.NetworkCredential class is a base class that supplies credentials in password-based authentication schemes such as basic, digest, NTLM, and Kerberos. Classes that implement the System.Net.ICredentials interface, such as the System.Net.CredentialCache class, return System.Net.NetworkCredential instances.
NetworkCredential
Example Syntax:
ToString
NetworkCredential
Example Syntax:
ToString
Initializes a new instance of the System.Net.NetworkCredential class with the specified user name and password.
The constructor initializes a System.Net.NetworkCredential instance is initialized with the System.Net.NetworkCredential.UserName property set to userName and the System.Net.NetworkCredential.Password property set to password. The user name associated with the credentials. The password for the user name associated with the credentials.
NetworkCredential
Example Syntax:
ToString
Initializes a new instance of the System.Net.NetworkCredential class with the specified user name, password, and domain.
The constructor initializes a System.Net.NetworkCredential instance with the System.Net.NetworkCredential.UserName property set to userName, the System.Net.NetworkCredential.Password property set to password, and the System.Net.NetworkCredential.Domain property set to domain. The user name associated with the credentials. The password for the user name associated with the credentials. The domain associated with these credentials.
ToString
Gets or sets the domain or machine name that verifies the credentials.
The System.Net.NetworkCredential.Domain property specifies the domain or realm to which the user name belongs. Typically, this is the host machine name where the application runs or user domain for the currently logged in user.
Password
ToString
Gets or sets the password for the user name associated with the credentials.
UserName
ToString
Gets or sets the user name associated with the credentials.
GetCredential
Returns an instance of the System.Net.NetworkCredential class for the specified URI and authentication type.
Return Value: A System.Net.NetworkCredential instance. The URI that the client is providing authentication for. The type of authentication requested as defined in the System.Net.IAuthenticationModule.AuthenticationType property.
ProtocolViolationException class (System.Net)
ToString
Description
The exception that is thrown when an error is made while using a network protocol.
A System.Net.ProtocolViolationException is thrown by descendants of System.Net.WebRequest and System.Net.WebResponse to indicate an error using the underlying protocol. For example, the System.Net.HttpWebRequest and System.Net.HttpWebResponse classes throw a System.Net.ProtocolViolationException to indicate an error using HTTP.
ProtocolViolationException
Example Syntax:
ToString
Initializes a new instance of the System.Net.ProtocolViolationException class.
The default constructor initializes a new instance of the System.Net.ProtocolViolationException class with all properties set to null.
ProtocolViolationException
Example Syntax:
ToString
Initializes a new instance of the System.Net.ProtocolViolationException class with the specified message.
The System.Net.ProtocolViolationException.#ctor constructor initializes a new instance of the System.Net.ProtocolViolationException class with the System.Exception.Message property set to the value of the message parameter. The error message string.
ProtocolViolationException
Example Syntax: ToString
HelpLink
HResult
InnerException
Message
Source
StackTrace
TargetSite
ISerializable.GetObjectData
ServicePoint class (System.Net)
ToString
Description
Provides connection management for HTTP connections.
The System.Net.ServicePoint class handles connections to an Internet resource based on the host information passed in the resource's URI. The initial connection to the resource determines the information the System.Net.ServicePoint maintains, which is then shared by all subsequent requests to that resource.
Address
ToString
Gets the URI of the System.Net.ServicePoint.
Certificate
ToString
Gets the certificate received for this System.Net.ServicePoint.
Although a System.Net.ServicePoint can make multiple connections to an Internet resource, it can maintain only one certificate.
ClientCertificate
ToString
ConnectionLimit
ToString
Gets or sets the maximum number of connections allowed on this System.Net.ServicePoint.
The System.Net.ServicePoint.ConnectionLimit property sets the maximum number of connections that the System.Net.ServicePoint can make to an Internet resource. The value of the System.Net.ServicePoint.ConnectionLimit property is set to the value of the System.Net.ServicePointManager.DefaultConnectionLimit property when the System.Net.ServicePoint is created; subsequent changes to System.Net.ServicePointManager.DefaultConnectionLimit have no effect on existing System.Net.ServicePoint instances.
ConnectionName
ToString
Gets the connection group name established by the System.Net.WebRequest that created the connection.
The System.Net.ServicePoint.ConnectionName property contains the connection group assigned to the System.Net.WebRequest.ConnectionGroupName property of the System.Net.WebRequest that initiated the connection provided by this System.Net.ServicePoint. If the System.Net.ServicePoint.ConnectionName property is set, only System.Net.WebRequest instances with the same System.Net.WebRequest.ConnectionGroupName can use this System.Net.ServicePoint.
CurrentConnections
ToString
Gets the number of connections associated with this System.Net.ServicePoint.
The System.Net.ServicePoint.CurrentConnections property contains the number of active Internet connections associated with this System.Net.ServicePoint. The value of System.Net.ServicePoint.CurrentConnections cannot exceed that of System.Net.ServicePoint.ConnectionLimit.
IdleSince
ToString
Gets the date and time that the System.Net.ServicePoint was last accessed.
The System.Net.ServicePoint.IdleSince property records the last date and time at which a service point was accessed. When the difference between the current time and System.Net.ServicePoint.IdleSince exceeds the value of System.Net.ServicePoint.MaxIdleTime, the System.Net.ServicePoint is available for recycling to another connection.
MaxIdleTime
ToString
Gets or sets the maximum idle time for the System.Net.ServicePoint.
The System.Net.ServicePoint.MaxIdleTime property contains the length of time, in milliseconds, that the System.Net.ServicePoint is allowed to maintain an idle connection to an Internet resource before it is recycled for use in another connection.
ProtocolVersion
ToString
Gets the version of the HTTP protocol that the System.Net.ServicePoint uses.
SupportsPipelining
ToString
Indicates whether the System.Net.ServicePoint supports pipelined connections.
GetHashCode
Gets the hash code for the System.Net.ServicePoint
Return Value: The hash code for the System.Net.ServicePoint.
The hash code for System.Net.ServicePoint A and B is the same if A.Equals(B) is true.
ServicePointManager class (System.Net)
ToString
Description
Manages the collection of System.Net.ServicePoint instances.
System.Net.ServicePointManager is a static class used to create, maintain, and delete instances of the System.Net.ServicePoint class.
ToString
The default number of nonpersistent connections allowed on a System.Net.ServicePoint connected to an HTTP/1.1 server.
ToString
The default number of persistent connections allowed on a System.Net.ServicePoint connected to an HTTP/1.0 server.
CertificatePolicy
ToString
Gets or sets policy for server certificates.
When the System.Net.ServicePointManager.CertificatePolicy property is set to an System.Net.ICertificatePolicy interface instance, the System.Net.ServicePointManager uses the certifiate policy defined in that instance instead of the default certificate policy.
DefaultConnectionLimit
ToString
The maximum number of concurrent connections allowed by a System.Net.ServicePoint instance.
The System.Net.ServicePointManager.DefaultConnectionLimit property sets the default maximum number of concurrent connections that the System.Net.ServicePointManager assigns to the System.Net.ServicePoint.ConnectionLimit property when creating System.Net.ServicePoint instances.
MaxServicePointIdleTime
ToString
Gets or sets the maximum idle time of a System.Net.ServicePoint instance.
The System.Net.ServicePointManager.MaxServicePointIdleTime property sets the maximum idle time that the System.Net.ServicePointManager assigns to the System.Net.ServicePoint.MaxIdleTime property when creating System.Net.ServicePoint instances. Changes to this value will affect only System.Net.ServicePoint instances that are initialized after the value is changed.
MaxServicePoints
ToString
Gets or sets the maximum number of System.Net.ServicePoint instances to maintain at any time.
When you reduce the
System.Net.ServicePointManager.MaxServicePoints property below the number of System.Net.ServicePoint instances currently in existence, the System.Net.ServicePointManager deletes the System.Net.ServicePoint instances with the longest idle times. If the number of System.Net.ServicePoint instances with active connections is greater than the value of System.Net.ServicePointManager.MaxServicePoints, the System.Net.ServicePointManager will delete the System.Net.ServicePoint instances as they become idle.
FindServicePoint
ServicePoint
Description
Finds an existing System.Net.ServicePoint or creates a new System.Net.ServicePoint to manage communications with the specified System.Uri.
Return Value: The System.Net.ServicePoint that manages communications for the request.
The System.Net.ServicePointManager.FindServicePoint(System.Uri) method returns the System.Net.ServicePoint instance associated with the specified Internet host name. If no System.Net.ServicePoint exists for that host, the System.Net.ServicePointManager creates one. The System.Uri of the Internet resource to contact.
FindServicePoint
Finds an existing System.Net.ServicePoint or creates a new System.Net.ServicePoint to manage communications with the specified URI.
Return Value: The System.Net.ServicePoint that manages communications for the request.
The System.Net.ServicePointManager.FindServicePoint(System.Uri) method returns the System.Net.ServicePoint instance associated with the specified Internet host name. If no System.Net.ServicePoint exists for that host, the System.Net.ServicePointManager creates one. The URI of the Internet resource to be contacted. Proxy data for this request.
FindServicePoint
Finds an existing System.Net.ServicePoint or creates a new System.Net.ServicePoint to manage communications with the specified System.Uri instance.
Return Value: The System.Net.ServicePoint that manages communications for the request.
The System.Net.ServicePointManager.FindServicePoint(System.Uri) method returns the System.Net.ServicePoint instance associated with the specified Internet host name. If no System.Net.ServicePoint exists for that host, the System.Net.ServicePointManager creates one. A System.Uri instance containing the address of the Internet resource to contact. Proxy data for this request.
SocketAddress class (System.Net)
ToString
Description
Identifies a socket address.
SocketAddress
Example Syntax:
ToString
Initializes a new instance of the System.Net.SocketAddress class for the given address family.
SocketAddress
Example Syntax:
ToString
Family
ToString
Item
ToString
Size
ToString
GetHashCode
ToString
SocketPermission class (System.Net)
ToString
Description
Controls rights to make or accept connections on a transport address.
ToString
Defines a constant representing all ports.
SocketPermission
Example Syntax:
ToString
Initializes a new instance of the System.Net.SocketPermission class that passes all demands or fails all demands.
If the System.Net.SocketPermission instance was created with the Unrestricted value from System.Security.Permissions.PermissionState then the for state will result in a System.Net.SocketPermission instance that will fail all demands. One of the System.Security.Permissions.PermissionState values.
SocketPermission
Example Syntax:
ToString
Initializes a new instance of the System.Net.SocketPermission class for the given transport address with the specified permission. One of the System.Net.NetworkAccess values. One of the System.Net.TransportType values. The host name for the transport address. The port number for the transport address.
AcceptList
ToString
Gets a list of System.Net.EndpointPermission instances identifying the endpoints that can be accepted under this permission instance.
ConnectList
ToString
Gets a list of System.Net.EndpointPermission instances identifying the endpoints that can be connected to under this permission instance.
AddPermission
Adds a permission to the set of permissions for a transport address.
Permissions are checked with a logical OR operation. One of the System.Net.NetworkAccess values. One of the System.Net.TransportType values. The host name for the transport address. The port number for the transport address.
Copy
Creates a copy of a System.Net.SocketPermission instance.
Return Value: A new instance of the System.Net.SocketPermission class that is a copy of the current instance.
FromXml
Reconstructs a System.Net.SocketPermission instance for an XML encoding.
The System.Net.SocketPermission.FromXml(System.Security.SecurityElement) method reconstructs a System.Net.SocketPermission instance from an XML encoding defined by the System.Security.SecurityElement class. The XML encoding used to reconstruct the System.Net.SocketPermission instance.
Intersect
Returns the logical intersection between two System.Net.SocketPermission instances.
Return Value: The System.Net.SocketPermission instance that represents the intersection of two System.Net.SocketPermission instances. The System.Net.SocketPermission instance to combine with the current instance.
IsSubsetOf
Compares two System.Net.SocketPermission instances.
Return Value: false if target is null; otherwise, an exception is thrown.
The System.Net.SocketPermission class does not support the System.Net.SocketPermission.IsSubsetOf(System.Security.IPermission) method. The second System.Net.SocketPermission instance to compare.
IsUnrestricted
Checks the overall permission state of the object.
Return Value: true if the System.Net.SocketPermission instance was created with the Unrestricted value from System.Security.Pernissions.PermissionState; otherwise, false.
ToXml
Creates an XML encoding of a System.Net.SocketPermission instance and its current state.
Return Value: A System.Security.SecurityElement instance containing an XML-encoded representation of the System.Net.SocketPermission instance, including state information.
The System.Net.SocketPermission.ToXml method creates a System.Security.SecurityElement instance to encode a representation of the System.Net.SocketPermission instance, including state information, in XML.
Union
Returns the logical union between two System.Net.SocketPermission instances.
Return Value: The System.Net.SocketPermission instance that represents the union of two System.Net.SocketPermission instances. The System.Net.SocketPermission instance to combine with the current instance.
SocketPermissionAttribute class (System.Net)
Union
Description
Enables security actions for System.Net.SocketPermission to be applied to code using declarative security. This class cannot be inherited.
SocketPermissionAttribute
Example Syntax:
Union
Initializes a new instance of the System.Net.SocketPermissionAttribute class with the specified System.Security.Permissions.SecurityAction value. One of the System.Security.Permissions.SecurityAction values.
Access
Union
Gets or sets the network access method allowed by this permission instance.
Action
Host
Union
Description
The DNS host name or IP address associated with this permission instance.
Port
Union
Gets or sets the transport type associated with this permission instance.
Transport
Union
Gets or sets the transport type associated with this permission instance.
TypeId
Unrestricted
CreatePermission
Creates and returns a new instance of the System.Net.SocketPermission class.
Return Value: An instance of the System.Net.SocketPermission class corresponding to the security declaration.
The System.Net.SocketPermissionAttribute.CreatePermission method is called by the security system, not by application code.
TransportType enumeration (System.Net)
ToString
Description
Defines transport types for the System.Net.SocketPermission and System.Net.Sockets.Socket classes.
The System.Net.TransportType enumeration defines transport types for the System.Net.SocketPermission and System.Net.Sockets.Socket classes.
ToString
All transport types.
ToString
The transport type is connectionless, such as UDP.
ToString
The transport is connection oriented, such as TCP.
TCP transport.
ToString
UDP transport.
WebClient class (System.Net)
ToString
Description
Provides common methods for sending data to and receiving data from a resource identified by a URI. This class cannot be inherited.
The System.Net.WebClient class provides common methods for sending data to or receiving data from any local, Intranet, or Internet resource identified by a URI.
WebClient
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebClient class.
The default constructor creates a new instance of the System.Net.WebClient class with all fields set to null
BaseAddress
ToString
Gets or sets the base URI for requests made by a System.Net.WebClient The System.Net.WebClient.BaseAddress property contains a base URI that is combined with the relative address specified when calling an upload or download method.
Container
Credentials
ToString
Description
Gets or sets the network credentials used for authenticating the request with the Internet resource.
The System.Net.WebClient.Credentials property contains the authentication credentials required to access the Internet resource.
DesignMode
Events
Headers
ToString
Description
Gets or sets a collection of header name/value pairs associated with the request.
The System.Net.WebClient.Headers property contains a System.Net.WebHeaderCollection instance containing header information the System.Net.WebClient sends to the Internet resource. This is an unrestricted collection of headers, so setting headers that are restricted by System.Net.WebRequest descendants like System.Net.HttpWebRequest is allowed.
QueryString
ToString
Gets or sets a collection of query name/value pairs associated with the request.
The System.Net.WebClient.QueryString property contains a System.Collections.Specialized.NameValueCollection instance containing name/value pairs that are appended to the URI as a query string. The contents of the System.Net.WebClient.QueryString property are preceded by a question mark (?), and each name/value pair is separated by an ampersand (&).
ResponseHeaders
ToString
Gets a collection of header name/value pairs associated with the response.
The System.Net.WebClient.ResponseHeaders property contains a System.Net.WebHeaderCollection instance containing header information the System.Net.WebClient receives from the Internet resource.
Site
DownloadData
Downloads data from a resource identified by a URI.
Return Value: A byte array containing the data downloaded from the resource specified by address.
The System.Net.WebClient.DownloadData(System.String) method downloads the data from the URI specified by address to a local byte array. The URI from which the data will be downloaded.
DownloadFile
Downloads data from a resource identified by a URI to a local file.
The System.Net.WebClient.DownloadFile(System.String,System.String) method downloads the data from the URI specified by address to a local file. The URI from which the data will be downloaded. The name of the local file to receive the data.
OpenRead
Opens a readable stream for the data downloaded from a resource identified by a URI.
Return Value: A System.IO.Stream used to read data from a resource.
The System.Net.WebClient.OpenRead(System.String) method creates a System.IO.Stream instance used to access the data specified by address. The URI from which the data will be downloaded.
OpenWrite
Opens a stream for writing data to the specified resource.
Return Value: A System.IO.Stream used to write data to the resource.
The System.Net.WebClient.OpenWrite(System.String) method returns a writable stream that is used to send data to a resource. The underlying request is made with the POST method. The URI of the resource to receive the data.
OpenWrite
Opens a stream for writing data to the specified resource identified by a URI using the specified method.
Return Value: A System.IO.Stream used to write data to the resource.
The System.Net.WebClient.OpenWrite(System.String) method returns a writable stream that is used to send data to a resource. The underlying request is made with the method specified in the method parameter. The URI of the resource to receive the data. The method used to send the data to the resource.
UploadData
Uploads a data buffer to the resource identified by a URI.
Return Value: An array of bytes containing the body of any response from the resource.
The System.Net.WebClient.UploadData(System.String,System.Byte[ ]) method sends a data buffer to a resource. The underlying request is made using the POST method. The URI of the resource to receive the data. The data buffer to send to the resource.
UploadData
Uploads a data buffer to the specified resource identified by a URI using the specified method.
Return Value: An array of bytes containing the body of any response from the resource.
The System.Net.WebClient.UploadData(System.String,System.Byte[ ]) method sends a data buffer to a resource using the method specified in the method parameter, and returns any response from the server. The URI of the resource to receive the data. The method used to send the data to the resource. The data buffer to send to the resource.
UploadFile
Uploads the specified local file to the resource identified by a URI.
Return Value: An array of bytes containing the body of any response from the resource.
The System.Net.WebClient.UploadFile(System.String,System.String) method sends a local file to a resource. The underlying request is made using the POST method. The URI of the resource to receive the file. The file to send to the resource.
UploadFile
Uploads the specified local file to the specified resource identified by a URI using the specified method.
Return Value: An array of bytes containing the body of any response from the resource.
The System.Net.WebClient.UploadFile(System.String,System.String) method sends a local file to a resource using the method specified in the method parameter, and returns any response from the server. The URI of the resource to receive the file. The method used to send the file to the resource. The file to send to the resource.
UploadValues
Uploads the specified name/value collection to the specified resource identified by a URI.
Return Value: An array of bytes containing the body of any response from the resource.
The System.Net.WebClient.UploadValues(System.String,System.Collections.Specialized. NameValueCollection) method sends a System.Collections.Specialized.NameValueCollection to an Internet server. The underlying request is made using the POST method. The URI of the resource to receive the collection. The System.Collections.Specialized.NameValueCollection to send to the resource.
UploadValues
Uploads the specified name/value collection to the specified resource identified by a URI using the specified method.
Return Value: An array of bytes containing the body of any response from the resource.
The System.Net.WebClient.UploadValues(System.String,System.Collections.Specialized. NameValueCollection) method sends a System.Collections.Specialized.NameValueCollection to a resource using the method specified in the method parameter, and returns any response from the server. The URI of the resource to receive the collection. The method used to send the file to the resource. The System.Collections.Specialized.NameValueCollection to send to the resource.
WebException class (System.Net)
UploadValues
Description
The exception that is thrown when an error occurs while accessing the network through a pluggable protocol.
The System.Net.WebException class is thrown by classes descended from System.Net.WebRequest and System.Net.WebResponse that implement pluggable protocols for accessing the Internet.
WebException
Example Syntax:
UploadValues
Initializes a new instance of the System.Net.WebException class.
The default constructor initializes a new instance of the System.Net.WebException class with all fields set to null
WebException
Example Syntax:
UploadValues
Initializes a new instance of the System.Net.WebException class with the specified error message.
The System.Net.WebException instance is initialized with the System.Exception.Message property set to the value of message. The text of the error message.
WebException
Example Syntax:
UploadValues
WebException
Example Syntax:
UploadValues
Initializes a new instance of the System.Net.WebException class with the specified error message and nested exception.
The System.Net.WebException instance is initialized with the System.Exception.Message property set to the value of message and the System.Exception.InnerException property set to the value of innerException. The text of the error message. A nested exception.
WebException
Example Syntax:
UploadValues
Initializes a new instance of the System.Net.WebException class with the specified error message and status.
The System.Net.WebException instance is initialized with the System.Exception.Message property set to the value of message and the System.Net.WebException.Status property set to the value of status. The text of the error message. One of the System.Net.WebExceptionStatus values.
WebException
Example Syntax:
UploadValues
Initializes a new instance of the System.Net.WebException class with the specified error message, nested exception, status, and response.
The System.Net.WebException instance is initialized with the System.Exception.Message property set to the value of message, the System.Exception.InnerException property set to the value of innerException, the System.Net.WebException.Status property set to the value of status, and the System.Net.WebException.Response property set to response. The text of the error message. A nested exception. One of the System.Net.WebExceptionStatus values. A System.Net.WebResponse instance containing the response from the remote host.
HelpLink
HResult
InnerException
Message
Response
UploadValues
Description
Gets the response that the remote host returned.
Some Internet protocols, such as HTTP, return otherwise valid responses indicating that an error has occurred at the protocol level. When the response to an Internet request indicates an error, System.Net.WebRequest.GetResponse sets the System.Net.WebException.Status property to System.Net.WebExceptionStatus.ProtocolError and provides the System.Net.WebResponse containing the error message in the System.Net.WebException.Response property of the System.Net.WebException that was thrown. The application can examine the System.Net.WebResponse to determine the actual error.
Source
StackTrace
Status
UploadValues
Description
Gets the status of the response.
The System.Net.WebException.Status property indicates the reason for the System.Net.WebException.
TargetSite
ISerializable.GetObjectData
WebExceptionStatus enumeration (System.Net)
ToString
Description
Defines status codes for the System.Net.WebException class.
The System.Net.WebExceptionStatus enumeration defines the status codes assigned to the System.Net.WebException.Status property.
ToString
The remote service point could not be contacted at the transport level.
ToString
The connection was prematurely closed.
ToString
The connection for a request that specifies the Keep-alive header was closed unexpectedly.
ToString
The name resolver service could not resolve the host name.
ToString
An internal asynchronous request is pending.
ToString
ToString
The response received from the server was complete but indicated a protocol-level error. For example, an HTTP protocol error such as 401 Access Denied would use this status.
ToString
The name resolver service could not resolve the proxy host name.
ToString
A complete response was not received from the remote server.
ToString
The request was canceled or the System.Net.WebRequest.Abort method was called.
ToString
An error occurred in a secure channel link.
ToString
A complete request could not be sent to the remote server.
ToString
The server response was not a valid HTTP response.
ToString
No error was encountered. This is the default value for System.Net.WebException.Status.
ToString
No response was received during the timeout period for a request.
ToString
A server certificate could not be validated.
WebHeaderCollection class (System.Net)
ToString
Description
Contains protocol headers associated with a request or response.
The System.Net.WebHeaderCollection class is generally accessed through System.Net.WebRequest.Headers or System.Net.WebResponse.Headers. Some common headers are considered restricted and are either exposed directly by the API (such as Content-Type) or protected by the system and cannot be changed.
WebHeaderCollection
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebHeaderCollection class.
WebHeaderCollection
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebHeaderCollection class from the specified instances of the System.Runtime.Serialization.SerializationInfo and System.Runtime.Serialization.StreamingContext classes.
This constructor implements the System.Runtime.Serialization.ISerializable interface for the System.Net.WebHeaderCollection class. A System.Runtime.Serialization.SerializationInfo containing the information required to serialize the System.Net.WebHeaderCollection. A System.Runtime.Serialization.StreamingContext containing the source of the serialized stream associated with the new System.Net.WebHeaderCollection.
AllKeys
Count
IsReadOnly
Item
Item
Keys
Add
Inserts the specified header into the collection.
The System.Net.WebHeaderCollection.Add(System.String,System.String) method inserts a new header into the list of header name/value pairs. The header value must be specified in the format “header:value”. The header to add, with the name and value separated by a colon.
Add
Inserts a new header with the specified name and value into the collection.
The System.Net.WebHeaderCollection.Add(System.String,System.String) method inserts a new header into the list of header name/value pairs. The header to add to the collection. The content of the header.
AddWithoutValidate
Inserts a header into the collection without checking whether the header is on the restricted header list.
The System.Net.WebHeaderCollection.AddWithoutValidate(System.String,System. String) method adds a header to the collection without checking whether the header is on the restricted header list. The header to add to the collection. The content of the header.
GetValues
Gets an array of header values stored in a header.
Return Value: An array of header strings. System.Net.WebHeaderCollection.GetValues(System.String) returns the contents of the specified header as an array. The header to return.
IsRestricted
Tests whether the specified HTTP header can be set.
Return Value: true if the header is restricted; otherwise false.
The System.Net.WebHeaderCollection.IsRestricted(System.String) method returns true to indicate that a header is restricted and must be set using properties instead of directly. The restricted headers are: Accept Connection Date Expect Host Range Referer Tests if access to the HTTP header with the provided name is accessible for setting. The header to test.
OnDeserialization
Remove
Removes the specified header from the collection. System.Net.WebHeaderCollection.Remove(System.String) deletes the specified header from the collection. If the same header was added multiple times with System.Net.WebHeaderCollection.Add(System.String,System.String), a single call to System.Net.WebHeaderCollection.Remove(System.String) deletes all of the headers. The name of the header to remove from the collection.
Set
Sets the specified header to the specified value.
The System.Net.WebHeaderCollection.Set(System.String,System.String) method inserts a new header into the list of header name/value pairs. The header value must be specified in the format header: value. The header to set. The content of the header to set.
ISerializable.GetObjectData
ToByteArray
Obsolete.
ToString
Obsolete.
WebPermission class (System.Net)
ToString
Description
Controls rights to access an Internet resource.
WebPermission
Example Syntax:
ToString
Creates a new instance of the System.Net.WebPermission class.
WebPermission
Example Syntax:
ToString
Creates a new instance of the System.Net.WebPermission class that passes all demands or fails all demands.
If System.Net.WebPermission is created with the Unrestricted value from System.Security.Permissions.PermissionState then the System.Net.WebPermission instance will pass all demands. Any other value for state will result in a System.Net.WebPermission instance that will fail all demands. One of the System.Security.Permissions.PermissionState values.
WebPermission
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebPermission class with the specified access rights for the specified URI regular expression. The access right to grant. A regular expression describing the URI to grant the access right to.
WebPermission
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebPermission class with the specified access rights for the specified URI. The access right to grant. A regular expression describing the URI to grant the access right to.
AcceptList
ToString
Returns the enumeration of permissions to export a local URI.
ConnectList
ToString
Returns the enumeration of permissions to connect a remote URI.
AddPermission
Adds a new instance of the System.Net.WebPermission class with the specified access rights for the specified URI pattern. The access right to grant. A regular expression describing the URI to grant the access right to.
AddPermission
Adds a new instance of the System.Net.WebPermission class with the specified access rights for the specified URI. The access right to grant. A string describing the URI to grant the access right to.
Copy
Creates a copy of a System.Net.WebPermission instance.
Return Value: A new instance of the System.Net.WebPermission class that is a copy of the current instance.
FromXml
Reconstructs a System.Net.WebPermission instance from an XML encoding.
The System.Net.WebPermission.FromXml(System.Security.SecurityElement) method reconstructs a System.Net.WebPermission instance from an XML encoding defined by the System.Security.SecurityElement class. The XML encoding to use to reconstruct the System.Net.WebPermission instance.
Intersect
Returns the logical intersection between two System.Net.WebPermission instances.
Return Value: System.Net.WebPermission instance that represents the intersection of two System.Net.WebPermission instances. The System.Net.WebPermission instance to combine with the current instance.
IsSubsetOf
Compares two System.Net.WebPermission instances.
Return Value: false if target is null; otherwise an exception is thrown.
The
System.Net.WebPermission.IsSubsetOf(System.Security.IPermission) method is not supported by the System.Net.WebPermission class. The second System.Net.WebPermission instance to compare.
IsUnrestricted
Checks the overall permission state of the object.
Return Value: true if the System.Net.WebPermission instance was created with the Unrestricted value from System.Security.Permissions.PermissionState; otherwise, false.
ToXml
Creates an XML encoding of a System.Net.WebPermission instance and its current state.
Return Value: A System.Security.SecurityElement instance containing an XML-encoded representation of the System.Net.WebPermission instance, including state information.
The System.Net.WebPermission.ToXml method creates a System.Security.SecurityElement instance to XML-encode a representation of the System.Net.WebPermission instance, including state information.
Union
Returns the logical union between two System.Net.WebPermission instances.
Return Value: System.Net.WebPermission instance that represents the union of two System.Net.WebPermission instances. The System.Net.WebPermission instance to combine with the current instance.
WebPermissionAttribute class (System.Net)
Union
Description
Enables security actions for System.Net.WebPermission to be applied to code using declarative security. This class cannot be inherited.
WebPermissionAttribute
Example Syntax:
Union
Initializes a new instance of the System.Net.WebPermissionAttribute class with the specified System.Security.Permissions.SecurityAction. One of the System.Security.Permissions.SecurityAction values.
Accept
Union
Gets or sets the URI accepted by this permission instance.
AcceptPattern
Union
Gets or sets a regular expression pattern that describes the URI accepted by this permission instance.
Action
Connect
Union
Description
Gets or sets the URI connection controlled by this permission instance.
ConnectPattern
Union
Gets or sets a regular expression pattern that describes the URI connection controlled by this permission instance.
TypeId
Unrestricted
CreatePermission
Creates and returns a new instance of the System.Net.WebPermission class.
Return Value: A System.Net.WebPermission instance corresponding to the security declaration.
WebProxy class (System.Net)
ToString
Description
Contains HTTP proxy settings for the System.Net.WebRequest class.
The System.Net.WebProxy class contains the proxy settings that System.Net.WebRequest instances use to override the proxy settings in System.Net.GlobalProxySelection.
WebProxy
Example Syntax:
ToString
Initializes an empty instance of the System.Net.WebProxy class.
The default constructor initializes an empty instance of the System.Net.WebProxy class initializes an empty instance of the System.Net.WebProxy class with the System.Net.WebProxy.Address property set to null. When the System.Net.WebProxy.Address property is null, the System.Net.WebProxy.IsBypassed(System.Uri) method returns true, and the System.Net.WebProxy.GetProxy(System.Uri) method returns the destination address.
WebProxy
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebProxy class with the specified URI.
The System.Net.WebProxy instance is initialized with the System.Net.WebProxy.Address property set to a System.Uri instance containing Address. The URI of the proxy server.
WebProxy
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebProxy class from the specified System.Uri.
The System.Net.WebProxy instance is initialized with the System.Net.WebProxy.Address property set to the Address parameter. A System.Uri containing the address of the proxy server.
WebProxy
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebProxy class from the specified instances of the System.Runtime.Serialization.SerializationInfo and System.Runtime.Serialization.StreamingContext classes.
This constructor implements the System.Runtime.Serialization.ISerializable interface for the System.Net.WebProxy class. A System.Runtime.Serialization.SerializationInfo containing the information required to serialize the new System.Net.WebProxy instance. A System.Runtime.Serialization.StreamingContext containing the source and destination of the serialized stream associated with the new System.Net.WebProxy.
WebProxy
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebProxy class with the specified URI and bypass setting.
The System.Net.WebProxy instance is initialized with the System.Net.WebProxy.Address property set to a System.Uri instance containing Address and the System.Net.WebProxy.BypassProxyOnLocal property set to BypassOnLocal. The URI of the proxy server. true to bypass the proxy for local addresses; otherwise, false.
WebProxy
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebProxy class with the specified host and port number.
The System.Net.WebProxy instance is initialized with the System.Net.WebProxy.Address property set to a System.Uri instance of the form http://Host: Port. The name of the proxy host. The port number on Host to use.
WebProxy
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebProxy class with the System.Uri and bypass setting.
The System.Net.WebProxy instance is initialized with the System.Net.WebProxy.Address property set to Address and with the System.Net.WebProxy.BypassProxyOnLocal property set to BypassOnLocal. A System.Uri containing the address of the proxy server. true to bypass the proxy for local addresses; otherwise, false.
WebProxy
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebProxy class with the specified URI, bypass setting, and list of URIs to bypass.
The System.Net.WebProxy instance is initialized with the System.Net.WebProxy.Address property set to a System.Uri instance containing Address, the System.Net.WebProxy.BypassProxyOnLocal property set to BypassOnLocal, and the System.Net.WebProxy.BypassList property set to BypassList. The URI of the proxy server. true to bypass the proxy for local addresses; otherwise, false. An array of regular expression strings containing the URIs of the servers to bypass.
WebProxy
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebProxy class with the specified System.Uri, bypass setting, and list of URIs to bypass.
The System.Net.WebProxy instance is initialized with the System.Net.WebProxy.Address property set to Address, the System.Net.WebProxy.BypassProxyOnLocal property set to BypassOnLocal, and the System.Net.WebProxy.BypassList property set to BypassList. A System.Uri containing the address of the proxy server. true to bypass the proxy for local addresses; otherwise, false. An array of regular expression strings containing the URIs of the servers to bypass.
WebProxy
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebProxy class with the specified URI, bypass setting, list of URIs to bypass, and credentials.
The System.Net.WebProxy instance is initialized with the System.Net.WebProxy.Address property set to a System.Uri instance containing Address, the System.Net.WebProxy.BypassProxyOnLocal property set to BypassOnLocal, the System.Net.WebProxy.BypassList property set to BypassList, and the System.Net.WebProxy.Credentials property set to Credentials. The URI of the proxy server. true to bypass the proxy for local addresses; otherwise, false. An array of regular expression strings containing the URIs of the servers to bypass. An System.Net.ICredentials to submit to the proxy server for authentication.
WebProxy
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebProxy class with the specified System.Uri, bypass setting, list of URIs to bypass, and credentials.
The System.Net.WebProxy instance is initialized with the System.Net.WebProxy.Address property set to Address, the System.Net.WebProxy.BypassProxyOnLocal property set to BypassOnLocal, the System.Net.WebProxy.BypassList property set to BypassList, and the System.Net.WebProxy.Credentials property set to Credentials A System.Uri containing the address of the proxy server. true to bypass the proxy for local addresses; otherwise, false. An array of regular expression strings containing the URIs of the servers to bypass. An System.Net.ICredentials to submit to the proxy server for authentication.
Address
ToString
Gets or sets the address of the proxy server.
The System.Net.WebProxy.Address property contains the address of the proxy server. When System.Net.WebProxy.Address is null, all requests bypass the proxy and connect directly to the destination host.
BypassArrayList
ToString
Gets a list of addresses that do not use the proxy server.
The System.Net.WebProxy.BypassList property contains an array of URI strings that a System.Net.WebRequest instance accesses directly instead of through the proxy server.
BypassList
ToString
Gets or sets an array of addresses that do not use the proxy server.
The System.Net.WebProxy.BypassList property contains an array of regular expressions that describe URIs that a System.Net.WebRequest instance accesses directly instead of through the proxy server.
BypassProxyOnLocal
ToString
Gets or sets a value indicating whether to bypass the proxy server for local addresses.
The setting of the System.Net.WebProxy.BypassProxyOnLocal property determines whether System.Net.WebRequest instances use the proxy server when accessing local Internet resources.
Credentials
ToString
Gets or sets the credentials to submit to the proxy server for authentication.
The System.Net.WebProxy.Credentials property contains the authentication credentials to send to the proxy server in response to an HTTP 407 (proxy authorization) status code.
GetDefaultProxy
Reads the Internet Explorer nondynamic proxy settings.
Return Value: A System.Net.WebProxy instance containing the nondynamic proxy settings from Internet Explorer 5.5.
The System.Net.WebProxy.GetDefaultProxy method reads the nondynamic proxy settings stored by Internet Explorer 5.5 and creates a System.Net.WebProxy instance with those settings.
GetProxy
Returns the proxied URI for a request.
Return Value: The System.Uri of the Internet resource, if the resource is on the bypass list; otherwise, the System.Uri of the proxy.
The System.Net.WebProxy.GetProxy(System.Uri) method returns the URI that the System.Net.WebRequest uses to access the Internet resource. The System.Uri of the requested Internet resource.
IsBypassed
Indicates whether to use the proxy server for the specified host.
Return Value: true if the proxy server should not be used for host; otherwise, false.
The System.Net.WebProxy.IsBypassed(System.Uri) method is used to determine whether to bypass the proxy server when accessing an Internet resource. The System.Uri of the host to check for proxy use.
ISerializable.GetObjectData
WebRequest class (System.Net)
ToString
Description
Makes a request to a Uniform Resource Identifier (URI). This is an abstract class.
System.Net.WebRequest is the abstract base class for the .NET Framework's request/response model for accessing data from the Internet. An application that uses the request/response model can request data from the Internet in a protocol-agnostic manner, in which the application works with instances of the System.Net.WebRequest class while protocol-specific descendant classes carry out the details of the request.
WebRequest
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebRequest class.
Use the System.Net.WebRequest.Create(System.Uri,System.Boolean) method to initialize new System.Net.WebRequest instances. Do not use the constructor.
WebRequest
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebRequest class from the specified instances of the System.Runtime.Serialization.SerializationInfo and System.Runtime.Serialization.StreamingContext classes.
When implemented by a descendant class, this constructor implements the System.Runtime.Serialization.ISerializable interface for the System.Net.WebRequest descendant. A System.Runtime.Serialization.SerializationInfo that contains the information required to serialize the new System.Net.WebRequest instance. A System.Runtime.Serialization.StreamingContext that indicates the source of the serialized stream associated with the new System.Net.WebRequest instance.
ConnectionGroupName
ToString
When overridden in a descendant class, gets or sets the name of the connection group for the request.
The System.Net.WebRequest.ConnectionGroupName property associates specific requests within an application to one or more connection pools.
ContentLength
ToString
When overridden in a descendant class, gets or sets the content length of the request data being sent.
The System.Net.WebRequest.ContentLength property contains the number of bytes of data sent to the Internet resource by the System.Net.WebRequest instance.
ContentType
ToString
When overridden in a descendant class, gets or sets the content type of the request data being sent.
The System.Net.WebRequest.ContentType property contains the media type of the request. This is typically the MIME encoding of the content.
Credentials
ToString
When overridden in a descendant class, gets or sets the network credentials used for authenticating the request with the Internet resource.
The System.Net.WebRequest.Credentials property contains the authentication credentials required to access the Internet resource.
Headers
ToString
When overridden in a descendant class, gets or sets the collection of header name/value pairs associated with the request.
The System.Net.WebRequest.Headers property contains a System.Net.WebHeaderCollection instance containing the header information to send to the Internet resource.
Method
ToString
When overridden in a descendant class, gets or sets the protocol method to use in this request.
When overridden in a descendant class, the System.Net.WebRequest.Method property contains the request method to use in this request.
PreAuthenticate
ToString
When overridden in a descendant class, indicates whether to preauthenticate the request.
The System.Net.WebRequest.PreAuthenticate property indicates whether to send authentication information with the initial request. When System.Net.WebRequest.PreAuthenticate is false, the System.Net.WebRequest waits for an authentication challenge before sending authentication information.
Proxy
ToString
When overridden in a descendant class, gets or sets the network proxy to use to access this Internet resource.
The System.Net.WebRequest.Proxy property identifies the network proxy that the request uses to access the Internet resource. The request is made through the proxy server rather than directly to the Internet resource.
RequestUri
ToString
When overridden in a descendant class, gets the URI of the Internet resource associated with the request.
When overridden in a descendant class, the System.Net.WebRequest.RequestUri property contains the System.Uri instance that System.Net.WebRequest.Create(System.Uri,System.Boolean) method uses to create the request.
Timeout
ToString
Gets or sets the length of time before the request times out.
The System.Net.WebRequest.Timeout property indicates the length of time, in milliseconds, until the request times out and throws a System.Net.WebException. The System.Net.WebRequest.Timeout property affects only synchronous requests made with the System.Net.WebRequest.GetResponse method. To time out asynchronous requests, use the System.Net.WebRequest.Abort method.
Abort
Cancels an asynchronous request to an Internet resource.
The System.Net.WebRequest.Abort method cancels asynchronous requests to Internet resources started with the System.Net.WebRequest.BeginGetResponse(System.AsyncCallback,System.Object) method.
BeginGetRequestStream
When overridden in a descendant class, provides an asynchronous version of the System.Net.WebRequest.GetRequestStream method.
Return Value: An System.IAsyncResult that references the asynchronous request.
The System.Net.WebRequest.BeginGetRequestStream(System.AsyncCallback,System. Object) method starts an asynchronous request for a stream used to send data to an Internet resource. The callback method that implements the System.AsyncCallback delegate uses the System.Net.WebRequest.EndGetRequestStream(System.IAsyncResult) method to return the request stream. The System.AsyncCallback delegate. An object containing state information for this asynchronous request.
BeginGetResponse
When overridden in a descendant class, begins an asynchronous request for an Internet resource.
Return Value: An System.IAsyncResult that references the asynchronous request.
The System.Net.WebRequest.BeginGetResponse(System.AsyncCallback,System.Object) method starts an asynchronous request for a response. The callback method that implements the System.AsyncCallback delegate uses the System.Net.WebRequest.EndGetResponse(System.IAsyncResult) method to return the System.Net.WebResponse from the Internet resource. The System.AsyncCallback delegate. An object containing state information for this asynchronous request.
Create
Initializes a new System.Net.WebRequest instance for the specified URI scheme.
Return Value: A System.Net.WebRequest descendant for the specific URI scheme.
The System.Net.WebRequest.Create(System.Uri,System.Boolean) method returns a descendant of the System.Net.WebRequest class determined at run time by the scheme of the URI in requestUriString. For example, when a URI beginning with http:// is passed in requestUriString, an System.Net.HttpWebRequest instance is returned by System.Net.WebRequest.Create(System.Uri,System.Boolean). If a URI beginning with file:// is passed instead, the System.Net.WebRequest.Create(System.Uri,System.Boolean) method will return a System.Net.FileWebRequest instance. The URI that identifies the Internet resource.
Create
Initializes a new System.Net.WebRequest instance for the specified URI scheme.
Return Value: A System.Net.WebRequest descendant for the specified URI scheme.
The System.Net.WebRequest.Create(System.Uri,System.Boolean) method returns a descendant of the System.Net.WebRequest class determined at run time by the scheme of the URI in requestUri. For example, when a URI beginning with http:// is passed in requestUri, an System.Net.HttpWebRequest instance is returned by System.Net.WebRequest.Create(System.Uri,System.Boolean). If a URI beginning with file:// is passed instead, the System.Net.WebRequest.Create(System.Uri,System.Boolean) method will return a System.Net.FileWebRequest instance. A System.Uri containing the URI of the requested resource.
CreateDefault
Initializes a new System.Net.WebRequest instance for the specified URI scheme.
Return Value: A System.Net.WebRequest descendant for the specified URI scheme.
The System.Net.WebRequest.CreateDefault(System.Uri) method returns a System.Net.WebRequest descendant instance based on only the scheme portion of a URI. A System.Uri containing the URI of the requested resource.
EndGetRequestStream
When overridden in a descendant class, returns a System.IO.Stream for writing data to the Internet resource.
Return Value: A System.IO.Stream to write data to.
The System.Net.WebRequest.EndGetRequestStream(System.IAsyncResult) method completes an asynchronous stream request that was started by the System.Net.WebRequest.BeginGetRequestStream(System.AsyncCallback,System. Object) method. An System.IAsyncResult that references a pending request for a stream.
EndGetResponse
When overridden in a descendant class, returns a System.Net.WebResponse.
Return Value: A System.Net.WebResponse that contains a response to the Internet request.
The System.Net.WebRequest.EndGetResponse(System.IAsyncResult) method completes an asynchronous request for an Internet resource that was started with the System.Net.WebRequest.BeginGetResponse(System.AsyncCallback,System.Object) method. An System.IAsyncResult that references a pending request for a response.
GetRequestStream
When overridden in a descendant class, returns a System.IO.Stream for writing data to the Internet resource.
Return Value: A System.IO.Stream for writing data to the Internet resource.
The System.Net.WebRequest.GetRequestStream method initiates a request to send data to the Internet resource and returns a System.IO.Stream instance for sending data to the Internet resource.
GetResponse
When overridden in a descendant class, returns a response to an Internet request.
Return Value: A System.Net.WebResponse containing the response to the Internet request.
The System.Net.WebRequest.GetResponse method sends a request to an Internet resource and returns a System.Net.WebResponse instance. If the request has already been initiated by a call to System.Net.WebRequest.GetRequestStream, the System.Net.WebRequest.GetResponse method completes the request and returns any response.
RegisterPrefix
Registers a System.Net.WebRequest descendant for the specified URI.
Return Value: true if registration is successful; otherwise, false.
The System.Net.WebRequest.RegisterPrefix(System.String,System.Net.IWebRequestCreate) method registers System.Net.WebRequest descendants to service requests. The URI prefix that the System.Net.WebRequest descendant services. The create method that the System.Net.WebRequest calls to create the System.Net.WebRequest descendant.
ISerializable.GetObjectData
WebResponse class (System.Net)
ToString
Description
Provides a response from a Uniform Resource Identifier (URI). This is an abstract class.
The System.Net.WebResponse class is the abstract base class from which protocol-specific response classes are derived. Applications can use the System.Net.WebResponse class to handle responses in a protocol-agnostic manner. In that case, the application works with instances of the System.Net.WebResponse class while the details of the request are carried out by protocol-specific descendant classes.
WebResponse
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebResponse class.
Applications do not call the System.Net.WebResponse constructor directly, use the System.Net.WebRequest.GetResponse method on a System.Net.WebRequest instance.
WebResponse
Example Syntax:
ToString
Initializes a new instance of the System.Net.WebResponse class from the specified instances of the System.Runtime.Serialization.SerializationInfo and System.Runtime.Serialization.StreamingContext classes.
When implemented by a descendant class, this constructor implements the System.Runtime.Serialization.ISerializable interface for the System.Net.WebResponse descendant. An instance of the System.Runtime.Serialization.SerializationInfo class containing the information required to serialize the new System.Net.WebRequest instance. An instance of the System.Runtime.Serialization.StreamingContext class indicating the source of the serialized stream associated with the new System.Net.WebRequest instance.
ContentLength
ToString
When overridden in a descendant class, gets or sets the content length of data being received.
The System.Net.WebResponse.ContentLength property contains the length, in bytes, of the response from the Internet resource. For request methods that contain header information, the System.Net.WebResponse.ContentLength does not include the length of the header information.
ContentType
ToString
When overridden in a derived class, gets or sets the content type of the data being received.
The System.Net.WebResponse.ContentType property contains the MIME content type of the response from the Internet resource, if known.
Headers
ToString
When overridden in a derived class, gets a collection of header name-value pairs associated with this request.
The System.Net.WebResponse.Headers property contains the name-value header pairs returned in the response.
ResponseUri
ToString
When overridden in a derived class, gets the URI of the Internet resource that actually responded to the request. The System.Net.WebResponse.ResponseUri property contains the URI of the Internet resource that actually provided the response data. This resource may not be the originally requested URI if the underlying protocol allows redirection of the request.
Close
When overridden by a descendent class, closes the response stream.
The System.Net.WebResponse.Close method cleans up the resources used by a System.Net.WebResponse and closes the underlying stream by calling the System.IO.Stream.Close method.
GetResponseStream
When overridden in a descendant class, returns the data stream from the Internet resource.
Return Value: An instance of the System.IO.Stream class for reading data from the Internet resource.
The System.Net.WebResponse.GetResponseStream method returns the data stream from the Internet resource.
IDisposable.Dispose
ISerializable.GetObjectData
System.Net.Sockets
The namespace provides a managed implementation of the Windows Sockets interface for developers that need to tightly control access to the network. Developers familiar with the Winsock API should have no problems developing applications using the class.
Description
The System.Net.Sockets namespace provides a managed implementation of the Windows Sockets interface for developers that need to tightly control access to the network. Developers familiar with the Winsock API should have no problems developing applications using the System.Net.Sockets.Socket class.
AddressFamily enumeration (System.Net.Sockets)
Description
Specifies the addressing scheme that an instance of the System.Net.Sockets.Socket class can use.
An System.Net.Sockets.AddressFamily member specifies the addressing scheme that a System.Net.Sockets.Socket instance uses to resolve an address. For example, System.Net.Sockets.AddressFamily.InterNetwork indicates that an IP version 4 address is expected when a System.Net.Sockets.Socket connects to an end point.
AppleTalk address.
Native ATM services address.
Banyan address.
Addresses for CCITT protocols, such as X.25.
Address for MIT CHAOS protocols.
Address for Microsoft cluster products.
Address for Datakit protocols.
Direct data-link interface address.
DECnet address.
European Computer Manufacturers Association (ECMA) address.
FireFox address.
NSC Hyperchannel address.
IEEE 1284.4 workgroup address.
ARPANET IMP address.
Address for IP version 4.
Address for IP version 6.
IPX or SPX address.
IrDA address.
Address for ISO protocols.
LAT address.
MAX address.
NetBios address.
Address for Network Designers OSI gateway-enabled protocols.
Address for Xerox NS protocols.
Address for ISO protocols.
Address for PUP protocols.
IBM SNA address.
Unix local to host address.
Unknown address family.
Unspecified address family.
VoiceView address.
Methods:
LingerOption class (System.Net.Sockets)
ToString
Description
Contains information about a socket's linger time, the amount of time it will remain after closing if data remains to be sent.
The settings of the System.Net.Sockets.LingerOption instance associated with a System.Net.Sockets.Socket instance control the length of time that a socket will remain after closing if data remains to be sent.
Constructors:
LingerOption
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.LingerOption class.
The System.Net.Sockets.LingerOption instance is created with System.Net.Sockets.LingerOption.Enabled property set to enable and the System.Net.Sockets.LingerOption.LingerTime property set to seconds. true to enable remaining connected after System.Net.Sockets.Socket.Close is called; otherwise, false. The number of seconds to remain connected after System.Net.Sockets.Socket.Close is called.
Properties:
Enabled
ToString
Gets or sets a value indicating whether to linger after the socket is closed.
LingerTime
ToString
Gets or sets the amount of time to remain connected after the socket is closed.
MulticastOption class (System.Net.Sockets)
ToString
Description
Contains IP address values for IP multicast packets.
The System.Net.Sockets.MulticastOption class sets IP address values when joining or leaving an IP multicast group. It is used with the System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel, System.Net.Sockets.SocketOptionName,System.Int32) and System.Net.Sockets.Socket.GetSocketOption(System.Net.Sockets.SocketOptionLevel, System.Net.Sockets.SocketOptionName) methods when the optionName parameter is set to System.Net.Sockets.SocketOptionName.AddMembership or System.Net.Sockets.SocketOptionName.DropMembership.
MulticastOption
Example Syntax:
ToString
Initializes a new version of the System.Net.Sockets.MulticastOption class for the specified IP multicast group. The IP address of the multicast group.
MulticastOption
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.MulticastOption class with the specified IP multicast group address and local interface address. The group IP address. The local IP address.
Group
ToString
Gets or sets the IP address of a multicast group.
Valid IP addresses for multicast packets are in the range 224.0.0.0 to 239.255.255.255.
LocalAddress
ToString
Gets or sets the local address associated with a multicast group.
The System.Net.Sockets.MulticastOption.LocalAddress property contains the IP address of the interface associated with the multicast group membership. If System.Net.Sockets.MulticastOption.LocalAddress is set to System.Net.IPAddress.Any, the default interface is used.
NetworkStream class (System.Net.Sockets)
ToString
Description
Provides the underlying stream of data for network access.
System.Net.Sockets.NetworkStream implements the standard .NET Framework stream mechanism to send and receive data through network sockets.
NetworkStream
Example Syntax:
ToString
Creates a new instance of the System.Net.Sockets.NetworkStream class for the specified System.Net.Sockets.Socket.
The System.Net.Sockets.NetworkStream is created with read/write access to the specified socket. The System.Net.Sockets.NetworkStream does not own to the underlying socket, so calling the System.Net.Sockets.NetworkStream.Close method will not close the socket. The System.Net.Sockets.Socket that provides the network data for the new System.Net.Sockets.NetworkStream.
NetworkStream
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.NetworkStream class for the specified socket with the specified System.Net.Sockets.Socket ownership.
The System.Net.Sockets.NetworkStream is created with read/write access to the specified socket. If ownsSocket is true, the System.Net.Sockets.NetworkStream owns the underlying socket, and calling System.Net.Sockets.NetworkStream.Close will also close the underlying socket. The network socket that the new System.Net.Sockets.NetworkStream will encapsulate. true if the socket will be owned by this System.Net.Sockets.NetworkStream instance; otherwise, false.
NetworkStream
Example Syntax:
ToString
Creates a new instance of the System.Net.Sockets.NetworkStream class for the specified System.Net.Sockets.Socket with the specified access rights.
The System.Net.Sockets.NetworkStream is created with the specified access to the specified socket. The System.Net.Sockets.NetworkStream does not own the underlying socket, so calling the System.Net.Sockets.NetworkStream.Close method will not close the socket. The System.Net.Sockets.Socket that provides the network data. One of the System.IO.FileAccess values that sets the System.Net.Sockets.NetworkStream.CanRead and System.Net.Sockets.NetworkStream.CanWrite properties of the System.Net.Sockets.NetworkStream.
NetworkStream
Example Syntax:
ToString
Creates a new instance of the System.Net.Sockets.NetworkStream class for the specified System.Net.Sockets.Socket with the specified access rights and the specified System.Net.Sockets.Socket ownership.
The System.Net.Sockets.NetworkStream is created with the specifed access to the specified socket. If ownsSocket is true, the System.Net.Sockets.NetworkStream owns the underlying socket, and calling System.Net.Sockets.NetworkStream.Close will also close the underlying socket. The System.Net.Sockets.Socket that provides the network data. One of the System.IO.FileAccess values that sets the System.Net.Sockets.NetworkStream.CanRead and System.Net.Sockets.NetworkStream.CanWrite properties of the System.Net.Sockets.NetworkStream. true if the socket will be owned by this System.Net.Sockets.NetworkStream instance; otherwise, false.
CanRead
ToString
Gets a value indicating whether the current stream supports reading.
CanSeek
ToString
Gets a value indicating whether the stream supports seeking. This property always returns false.
CanWrite
ToString
Gets a value that indicates whether the current stream supports writing.
DataAvailable
ToString
Gets a value indicating whether data is available on the stream to be read.
Length
ToString
The length of the data available on the stream. This property always throws a System.NotSupportedException.
Position
ToString
Gets or sets the current position in the stream. This property always throws a System.NotSupportedException.
Readable
ToString
Gets or sets a value indicating that the stream can be read.
The System.Net.Sockets.NetworkStream.Readable property is accessible only through this class or a derived class. Other classes can determine whether a System.Net.Sockets.NetworkStream is readable by checking the System.Net.Sockets.NetworkStream.CanRead property.
Socket
ToString
Gets the underlying network connection.
The System.Net.Sockets.NetworkStream.Socket property represents the underlying network socket that this System.Net.Sockets.NetworkStream encapsulates.
Writeable
ToString
Gets a value that indicates whether the stream is writable.
The System.Net.Sockets.NetworkStream.Writeable property is accessible only through this class or a derived class. Other classes can determine whether a System.Net.Sockets.NetworkStream is writable by checking the System.Net.Sockets.NetworkStream.CanWrite property.
BeginRead
Begins an asynchronous read from a stream.
Return Value: An System.IAsyncResult representing the asynchronous call.
The
System.Net.Sockets.NetworkStream.BeginRead(System.Byte[ ],System.Int32,System. Int32,System.AsyncCallback,System.Object) method begins an asynchronous request for data from a network stream. The method that implements the System.AsyncCallback delegate uses the System.Net.Sockets.NetworkStream.EndRead(System.IAsyncResult) method to return the amount of data read from the stream. The location in memory that stores the data from the stream. The location in buffer to begin storing the data to. The size of buffer. The delegate to call when the asynchronous call is complete. An object containing additional information supplied by the client.
BeginWrite
Begins an asynchronous write to a stream.
Return Value: An System.IAsyncResult representing the asynchronous call.
The System.Net.Sockets.NetworkStream.BeginWrite(System.Byte[ ],System.Int32, System.Int32,System.AsyncCallback,System.Object) method begins to send data asynchronously to the network stream. The method that implements the System.AsyncCallback delegate uses the System.Net.Sockets.NetworkStream.EndRead(System.IAsyncResult) method to complete sending the data. The location in memory that holds the data to send. The location in buffer to begin sending the data. The size of buffer. The delegate to call when the asynchronous call is complete. An object containing additional information supplied by the client.
Close
Closes the stream and optionally closes the underlying socket.
The System.Net.Sockets.NetworkStream.Close method frees resources used by the System.Net.Sockets.NetworkStream instance and, if the System.Net.Sockets.NetworkStream owns the underlying socket, closes the underlying socket.
Dispose
Cleans up a network stream. true if this method was called by another method such as System.Net.Sockets.NetworkStream.Close or System.Net.Sockets.NetworkStream.Dispose(System.Boolean); false if this method was called by the finalizer.
EndRead
Handles the end of an asynchronous read.
Return Value: The number of bytes read from the stream.
The System.Net.Sockets.NetworkStream.EndRead(System.IAsyncResult) method completes an asynchronous read of the network stream started with the System.Net.Sockets.NetworkStream.BeginRead(System.Byte[ ],System.Int32,System. Int32,System.AsyncCallback,System.Object) method. An System.IAsyncResult representing an asynchronous call.
EndWrite
Handles the end of an asynchronous write.
The System.Net.Sockets.NetworkStream.EndWrite(System.IAsyncResult) method completes an asynchronous write to a network stream started with the System.Net.Sockets.NetworkStream.BeginWrite(System.Byte[ ],System.Int32, System.Int32,System.AsyncCallback,System.Object) method. The System.IAsyncResult representing the asynchronous call.
Finalize
Frees resources used by the System.Net.Sockets.NetworkStream.
The System.Net.Sockets.NetworkStream finalizer calls the System.Net.Sockets.NetworkStream.Close method to close the stream.
Flush
Flushes data from the stream. This method is reserved for future use.
The System.Net.Sockets.NetworkStream.Flush method implements the System.IO.Stream.Flush method but, because System.Net.Sockets.NetworkStream is not buffered, has no effect on network streams. Calling the System.Net.Sockets.NetworkStream.Flush method will not throw an exception.
Read
Reads data from the stream.
Return Value: The number of bytes read from the stream.
The System.Net.Sockets.NetworkStream.Read(System.Byte[ ],System.Int32,System. Int32) method reads data from the network stream into a data buffer. The location in memory to store data read from the stream. The location in the buffer to begin storing the data to. The number of bytes to read from the stream.
Seek
Sets the current position of the stream to the given value. This method always throws a System.NotSupportedException. This parameter is not used. This parameter is not used.
SetLength
Sets the length of the stream. This method always throws a System.NotSupportedException. This parameter is not used.
IDisposable.Dispose
Write
Writes data to the stream.
Return Value: The number of bytes written to the stream.
The System.Net.Sockets.NetworkStream.Write(System.Byte[ ],System.Int32,System. Int32) method sends the contents of a data buffer to the network. The data to write to the stream. The location in the buffer to start writing data from. The number of bytes to write to the stream.
ProtocolFamily enumeration (System.Net. Sockets)
WriteByte
Description
Specifies the type of protocol that an instance of the System.Net.Sockets.Socket class can use.
The System.Net.Sockets.ProtocolFamily enumeration specifies the protocol scheme used by the System.Net.Sockets.Socket class to resolve an address. For example, System.Net.Sockets.ProtocolFamily.InterNetwork indicates that the IP version 4 protocol is expected when a System.Net.Sockets.Socket connects to an endpoint.
WriteByte
AppleTalk protocol.
WriteByte
Native ATM services protocol.
WriteByte
Banyan protocol.
WriteByte
CCITT protocol, such as X.25.
WriteByte
MIT CHAOS protocol.
WriteByte
Microsoft Cluster products protocol.
WriteByte
DataKit protocol.
WriteByte
Direct data link protocol.
WriteByte
DECNet protocol.
WriteByte
European Computer Manufactures Association (ECMA) protocol.
WriteByte
FireFox protocol.
WriteByte
NSC HyperChannel protocol.
WriteByte
IEEE 1284.4 workgroup protocol.
WriteByte
ARPANET IMP protocol.
WriteByte
IP version 4 protocol.
WriteByte
IP version 6 protocol.
WriteByte
IPX or SPX protocol.
WriteByte
IrDA protocol.
WriteByte to
ISO protocol.
WriteByte
LAT protocol.
WriteByte
MAX protocol.
WriteByte
NetBios protocol.
WriteByte
Network Designers OSI gateway enabled protocol.
WriteByte
Xerox NS protocol.
WriteByte
OSI protocol.
WriteByte
PUP protocol.
WriteByte
IBM SNA protocol.
WriteByte
Unix local to host protocol.
WriteByte
Unknown protocol.
WriteByte
Unspecified protocol.
WriteByte
VoiceView protocol.
ProtocolType enumeration (System.Net.Sockets)
ToString
Description
Specifies the protocols that the System.Net.Sockets.Socket class supports.
The System.Net.Sockets.ProtocolType enumeration is used by the System.Net.Sockets.Socket class to indicate to the Windows Socket API the requested protocol for the socket. Low-level driver software for the requested protocol must be present on the computer for the System.Net.Sockets.Socket to be created.
ToString
Gateway To Gateway Protocol.
ToString
Internet Control Message Protocol.
ToString
IDP Protocol.
ToString
Internet Group Management Protocol.
ToString
Internet Protocol.
ToString
IPX Protocol.
ToString
Net Disk Protocol (unofficial).
ToString
PUP Protocol.
ToString
Raw UP packet protocol.
ToString
SPX Protocol.
ToString
SPX Version 2 Protocol.
ToString
Transmission Control Protocol.
ToString
User Datagram Protocol.
ToString
Unknown protocol.
ToString
Unspecified protocol.
SelectMode enumeration (System.Net.Sockets)
ToString
Description
Defines the polling modes for the System.Net.Sockets.Socket.Poll(System.Int32,System.Net.Sockets.SelectMode) method.
The System.Net.Sockets.SelectMode enumeration defines the polling modes that can be passed to the System.Net.Sockets.Socket.Poll(System.Int32,System.Net.Sockets.SelectMode) method.
ToString
Error status mode.
ToString
Read status mode.
ToString
Write status mode.
Socket class (System.Net.Sockets)
ToString
Description
Implements the Berkeley sockets interface.
The System.Net.Sockets.Socket class creates a managed version of an Internet transport service. Once the socket is created, it is bound to a specific endpoint through the System.Net.Sockets.Socket.Bind(System.Net.EndPoint) method, and the connection to that endpoint is established through the System.Net.Sockets.Socket.Connect(System.Net.EndPoint) method.
Socket
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.Socket class.
The addressFamily parameter specifies the addressing scheme that the socket uses, the socketType parameter specifies the type of the socket, and the protocolType parameter specifies the protocol used by the socket. The three parameters are not independent. Some address families restrict which protocols can be used with them, and often the socket type is implicit in the protocol. If the combination of address family, socket type, and protocol type results in an invalid socket, a System.Net.Sockets.SocketException is thrown. One of the System.Net.Sockets.AddressFamily values. One of the System.Net.Sockets.SocketType values. One of the System.Net.Sockets.ProtocolType values.
AddressFamily
ToString
Gets the address family of the socket.
Available
ToString
Gets the amount of data that has been received from the network and is available to be read.
Blocking
ToString
Gets or sets a value that indicates whether the socket is in blocking mode.
The System.Net.Sockets.Socket.Blocking property indicates whether a System.Net.Sockets.Socket is in blocking mode.
Connected
ToString
Gets a value indicating whether a socket is connected to a remote resource.
System.Net.Sockets.Socket.Connected returns true if the socket has either connected to a remote resource or accepted a connection from a remote resource.
Handle
ToString
Gets the operating system handle for the socket.
LocalEndPoint
ToString
Gets the local endpoint.
The System.Net.Sockets.Socket.LocalEndPoint property contains the network connection information associated with the local network device.
ProtocolType
ToString
Gets the protocol type of the socket.
RemoteEndPoint
ToString
Gets the remote endpoint.
The System.Net.Sockets.Socket.RemoteEndPoint property gets the network connection information associated with the remote network device.
SocketType
ToString
Gets the type of the socket.
Accept
Creates a new System.Net.Sockets.Socket to handle an incoming connection request.
Return Value: A System.Net.Sockets.Socket instance to handle an incoming connection request.
The System.Net.Sockets.Socket.Accept method extracts the first connection request from the queue of pending requests and creates a new System.Net.Sockets.Socket instance to handle it. The System.Net.Sockets.Socket returned by System.Net.Sockets.Socket.Accept is a duplicate of the current System.Net.Sockets.Socket.
BeginAccept
Begins an asynchronous request to create a new socket to accept an incoming connection request.
Return Value: An System.IAsyncResult that references the asynchronous socket creation.
The
System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object) method starts an asynchronous request to create a socket to handle an incoming connection request. The callback method that implements the System.AsyncCallback delegate uses the System.Net.Sockets.Socket.EndAccept(System.IAsyncResult) method to return the socket. The System.AsyncCallbackdelegate. An object containing state information for this request.
BeginConnect
Begins an asynchronous request for a connection to a network device.
Return Value: An System.IAsyncResult that references the asynchronous connection.
The
System.Net.Sockets.Socket.BeginConnect(System.Net.EndPoint,System.Async Callback,System.Object) method starts an asynchronous request for a connection to a remote device. The callback method that implements the System.AsyncCallback delegate uses the System.Net.Sockets.Socket.EndConnect(System.IAsyncResult) method to return the socket. An System.Net.EndPoint instance that represents the remote device. The System.AsyncCallback delegate. An object that contains state information for this request.
BeginReceive
Begins to asynchronously receive data from a connected socket.
Return Value: An System.IAsyncResult that references the asynchronous read.
The
System.Net.Sockets.Socket.BeginReceive(System.Byte[ ],System.Int32,System. Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object) method starts asynchronously reading data from a socket. The callback method that implements the System.AsyncCallback delegate uses the System.Net.Sockets.Socket.EndReceive(System.IAsyncResult) method to return the data read from the socket. The storage location for the received data. The zero-based position in the buffer at which to store the received data. The number of bytes to receive. A bitwise combination of the System.Net.Sockets.SocketFlags values. The System.AsyncCallback delegate. An object containing state information for this request.
BeginReceiveFrom
Begins to asynchronously receive data from a specified network device.
Return Value: An System.IAsyncResult that references the asynchronous read.
The
System.Net.Sockets.Socket.BeginReceiveFrom(System.Byte[ ],System.Int32,System. Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint @,System.A syncCallback,System.Object) method starts asynchronously reading data from a socket. The callback method that implements the System.AsyncCallback delegate uses the System.Net.Sockets.Socket.EndReceive(System.IAsyncResult) method to return the data read from the socket. The storage location for the received data. The zero-based position in the buffer at which to store the data. The number of bytes to receive. A bitwise combination of the System.Net.Sockets.SocketFlags values. An System.Net.EndPoint that represents the source of the data. The System.AsyncCallback delegate. An object containing state information for this request.
BeginSend
Sends data asynchronously to a connected socket.
Return Value: An System.IAsyncResult that references the asynchronous send.
The
System.Net.Sockets.Socket.BeginSend(System.Byte[ ],System.Int32,System.Int 32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object) method starts asynchronously sending data through a socket. The callback method that implements the System.AsyncCallback delegate uses the System.Net.Sockets.Socket.EndSend(System.IAsyncResult) method to complete sending data. The data to send. The zero-based position in buffer at which to begin sending data. The number of bytes to send. A bitwise combination of the System.Net.Sockets.SocketFlags values. The System.AsyncCallback delegate. An object containing state information for this request.
BeginSendTo
Sends data asynchronously to a specific network device.
Return Value: An System.IAsyncResult that references the asynchronous send.
The System.Net.Sockets.Socket.BeginSendTo(System.Byte[ ],System.Int32,System. Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint,System.AsyncCallback, System.Object) method starts asynchronously sending data through a socket. The callback method that implements the System.AsyncCallback delegate uses the System.Net.Sockets.Socket.EndSendTo(System.IAsyncResult) method to complete sending data. The data to send. The zero-based position in buffer at which to begin sending data. The number of bytes to send. A bitwise combination of the System.Net.Sockets.SocketFlags values. An System.Net.EndPoint that represents the remote device. The System.AsyncCallback delegate. An object containing state information for this request.
Bind
Associates a socket with a local endpoint.
You must call the
System.Net.Sockets.Socket.Bind(System.Net.EndPoint) method before you call the System.Net.Sockets.Socket.Listen(System.Int32) or System.Net.Sockets.Socket.Connect(System.Net.EndPoint) methods. The local System.Net.EndPoint to associate with the socket.
Close
Forces a socket connection to close.
The System.Net.Sockets.Socket.Connected property is set to false when the socket is closed.
Connect
Establishes a connection to a remote device.
The System.Net.Sockets.Socket.Connect(System.Net.EndPoint) method establishes a network connection between System.Net.Sockets.Socket.LocalEndPoint and the device identified by remoteEP. Once the connection has been made, you can send data to the remote device with the System.Net.Sockets.Socket.Send(System.Byte[ ],System.Int32,System.Net.Sockets. SocketFlags) method, or receive data from the remote device with the System.Net.Sockets.Socket.Receive(System.Byte[ ],System.Int32,System.Net.Sockets. SocketFlags) method. An System.Net.EndPoint instance that represents the remote device.
Dispose
EndAccept
Ends an asynchronous request to create a new socket to accept an incoming connection request.
Return Value: A System.Net.Sockets.Socket to handle the incoming connection.
The System.Net.Sockets.Socket.EndAccept(System.IAsyncResult) method completes a request for a connection that was started with the System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object) method. The pending request for an incoming socket.
EndConnect
Ends a pending synchronous connection request. The pending asynchronous connection request.
EndReceive
Ends a pending asynchronous read.
Return Value: The number of bytes received. The pending asynchronous read.
EndReceiveFrom
Ends a pending asynchronous read from a specific endpoint.
Return Value: If successful, the number of bytes received. If unsuccessful, then if the socket was closed with System.Net.Sockets.Socket.Close, returns 0; otherwise, returns an invalid socket error. The pending asynchronous read. The source endpoint.
EndSend
Ends a pending asynchronous send.
Return Value: If successful, the number of bytes sent to the socket; otherwise, an invalid socket error is returned. The pending asynchronous send.
EndSendTo
Ends a pending asynchronous send to a specific location.
Return Value: If successful, the number of bytes sent; otherwise, an invalid socket error is returned. The pending asynchronous send.
Finalize
Frees resources used by the System.Net.Sockets.Socket class.
The System.Net.Sockets.Socket class finalizer calls the System.Net.Sockets.Socket.Close method to close the socket and free resources associated with the socket.
GetHashCode
GetSocketOption
Gets the value of a specified socket option.
Return Value: The value of the option. When optionName is set to System.Net.Sockets.SocketOptionName.Linger the return value is an instance of System.Net.Sockets.LingerOption. When optionName is set to System.Net.Sockets.SocketOptionName.AddMembership or System.Net.Sockets.SocketOptionName.DropMembership, the return value is an instance of System.Net.Sockets.MulticastOption. When optionName is any other value, the return value is an integer. One of the System.Net.Sockets.SocketOptionLevel values. One of the System.Net.Sockets.SocketOptionName values.
GetSocketOption
Gets the specified socket option setting. One of the System.Net.Sockets.SocketOptionLevel values. One of the System.Net.Sockets.SocketOptionName values. The buffer to receive the option setting.
GetSocketOption
Gets the value of the specified socket option and returns an array.
Return Value: An array of bytes containing the value of the socket option.
The optionLength parameter sets the maximum size of the returned byte array. If the option value requires fewer bytes, the array will contain only that many bytes. If the option value requires more bytes, a System.Net.Sockets.SocketException will be thrown. One of the System.Net.Sockets.SocketOptionLevel values. One of the System.Net.Sockets.SocketOptionName values. The length, in bytes, of the expected return value.
IOControl
Sets low-level operating modes for the socket.
Return Value: The number of bytes returned in optionOutValue.
The
System.Net.Sockets.Socket.IOControl(System.Int32,System.Byte[ ],System.Byte[ ]method provides low-level access to the operating system socket underlying the System.Net.Sockets.Socket class instance. For more information about System.Net.Sockets.Socket.IOControl(System.Int32,System.Byte[ ],System.Byte[ ]), see the documentation in MSDN. The control code of the operation to perform. The input data required by the operation. The output data returned by the operation.
Listen
Places a socket in a listening state.
If System.Net.Sockets.Socket.Listen(System.Int32) is successful, System.Net.Sockets.Socket.Connected is set to true. Maximum length of the queue of pending connections.
Poll
Determines the status of the socket.
Return Value: Mode Return Value SelectRead (System.Net.Sockets.SelectMode) true if System.Net.Sockets.Socket.Listen(System.Int32) has been called and a connection is pending, System.Net.Sockets.Socket.Accept will succeed—or—true if data is available for reading—or—true, if connection has been closed, reset, or terminated; otherwise, returns false. The time to wait for a response, in microseconds. One of the System.Net.Sockets.SelectMode values.
Receive
Receives data from a connected socket into a specific location of the receive buffer.
Return Value: The number of bytes received. Storage location for received data.
Receive
Receives data from a connected socket into a specific location of the receive buffer.
Return Value: The number of bytes received. Storage location for received data. A bitwise combination of the System.Net.Sockets.SocketFlags values.
Receive
Receives data from a connected socket into a specific location of the receive buffer.
Return Value: The number of bytes received. Storage location for received data. The number of bytes to receive. A bitwise combination of the System.Net.Sockets.SocketFlags values.
Receive
Receives data from a connected socket into a specific location of the receive buffer.
Return Value: The number of bytes received. Storage location for received data. The location in buffer to store the received data. The number of bytes to receive. A bitwise combination of the System.Net.Sockets.SocketFlags values.
ReceiveFrom
Receives a datagram into a specific location in the data buffer and stores the endpoint.
Return Value: The number of bytes received. Storage location for received data. An System.Net.EndPoint, passed by reference, that represents the remote server.
ReceiveFrom
Receives a datagram into a specific location in the data buffer and stores the endpoint.
Return Value: The number of bytes received. Storage location for, received data. A bitwise combination of the System.Net.Sockets.SocketFlags values. An System.Net.EndPoint, passed by reference, that represents the remote server.
ReceiveFrom
Receives a datagram into a specific location in the data buffer and stores the endpoint.
Return Value: The number of bytes received. Storage location for received data. The number of bytes to receive. A bitwise combination of the System.Net.Sockets.SocketFlags values. An System.Net.EndPoint, passed by reference, that represents the remote server.
ReceiveFrom
Receives a datagram into a specific location in the data buffer and stores the endpoint.
Return Value: The number of bytes received. Storage location for received data. The position in buffer to store the received data. The number of bytes to receive. A bitwise combination of the System.Net.Sockets.SocketFlags values. An System.Net.EndPoint, passed by reference, that represents the remote server. Select
Determines the status of a socket.
System.Net.Sockets.Socket.Select(System.Collections.IList,System.Collections. IList,System.Collections.IList,System.Int32) is a static method that determines the status of a set of System.Net.Sockets.Socket instances. For example, to determine which of a set of System.Net.Sockets.Socket instances has data ready to be read, place the System.Net.Sockets.Socket in an System.Collections.IList instance, and then call System.Net.Sockets.Socket.Select(System.Collections.IList,System.Collections. IList,System.Collections.IList,System.Int32). After the call to System.Net.Sockets.Socket.Select(System.Collections.lList,System.Collections IList,System.Collections.IList,System.Int32), the System.Collections.IList will contain only those System.Net.Sockets.Socket instances with data ready to be read. A list of System.Net.Sockets.Socket instances to check for data to read. A list of System.Net.Sockets.Socket instances to check that are available for writing. A list of System.Net.Sockets.Socket instances to check for errors. The time to wait for a response, in microseconds.
Send
Sends data to a connected socket, starting at the indicated location in the data.
Return Value: The number of bytes sent to the socket. The data to be sent.
Send
Sends data to a connected socket, starting at the indicated location in the data.
Return Value: The number of bytes sent to the socket. The data to be sent. A bitwise combination of the System.Net.Sockets.SocketFlags values.
Send
Sends data to a connected socket, starting at the indicated location in the data.
Return Value: The number of bytes sent to the socket. The data to be sent. The number of bytes to send. A bitwise combination of the System.Net.Sockets.SocketFlags values.
Send
Sends data to a connected socket, starting at the indicated location in the data.
Return Value: The number of bytes sent to the socket. The data to be sent. The position in the data buffer to begin sending data. The number of bytes to send. A bitwise combination of the System.Net.Sockets.SocketFlags values.
SendTo
Sends data to a specific endpoint.
Return Value: The number of bytes sent. The data to be sent. The destination location for the data.
SendTo
Sends data to a specific endpoint.
Return Value: The number of bytes sent. The data to be sent. A bitwise combination of the System.Net.Sockets.SocketFlags values. The destination location for the data.
SendTo
Sends data to a specific endpoint.
Return Value: The number of bytes sent. The data to be sent. The number of bytes to send. A bitwise combination of the System.Net.Sockets.SocketFlags values. The destination location for the data.
SendTo
Sends data to a specific endpoint, starting at the indicated location in the data.
Return Value: The number of bytes sent. The data to be sent. The position in the data buffer to begin sending data. The number of bytes to send. A bitwise combination of the System.Net.Sockets.SocketFlags values. The destination location for the data.
SetSocketOption
Sets the specified option to the specified value. One of the System.Net.Sockets.SocketOptionLevel values. One of the System.Net.Sockets.SocketOptionName values. The value of the option.
SetSocketOption
Sets the specified option to the specified value. One of the System.Net.Sockets.SocketOptionLevel values. One of the System.Net.Sockets.SocketOptionName values. The value of the option.
SetSocketOption
Sets the specified option to the specified value. One of the System.Net.Sockets.SocketOptionLevel values. One of the System.Net.Sockets.SocketOptionName values. An instance of System.Net.Sockets.LingerOption or System.Net.Sockets.MulticastOption containing the value of the option.
Shutdown
Disables sends and receives on a socket.
The System.Net.Sockets.SocketShutdown class contains the valid values for how. The valid values are: Value Description Send Disable sending on this socket. The function that will no longer be allowed.
IDisposable.Dispose
SocketException class (System.Net.Sockets)
ToString
Description
The exception that is thrown when a socket error occurs.
A System.Net.Sockets.SocketException is thrown by the System.Net.Sockets.Socket and System.Net.Dns classes when an error occurs with the network.
SocketException
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.SocketException class with the last operating system error code.
The System.Net.Sockets.SocketException.#ctor constructor sets the System.Net.Sockets.SocketException.ErrorCode property to the last operating system socket error that occurred. For more information about socket error codes, see the Windows Socket Version 2 API error code documentation in MSDN.
SocketException
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.SocketException class with the specified error code.
The System.Net.Sockets.SocketException.#ctor constructor sets the System.Net.Sockets.SocketException.ErrorCode property to errorCode. The error code indicating the error that occurred.
SocketException
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.SocketException class from the specified instances of the System.Runtime.Serialization.SerializationInfo and System.Runtime.Serialization.StrearningContext classes.
This constructor implements the
System.Runtime.Serialization.ISerializable interface for the System.Net.Sockets.SocketException class. A System.Runtime.Serialization.SerializationInfo instance containing the information required to serialize the new System.Net.Sockets.SocketException instance. A System.Runtime.Serialization.StreamingContext containing the source of the serialized stream associated with the new System.Net.Sockets.SocketException instance.
ErrorCode
ToString
Gets the error code associated with this exception.
The System.Net.Sockets.SocketException.ErrorCode property contains the error code associated with the error that caused the exception.
HelpLink
HResult
InnerException
Message
NativeErrorCode
Source
StackTrace
TargetSite
SocketFlags enumeration (System.Net. Sockets)
ToString
Description
Provides constant values for socket messages.
ToString
Send without using routing tables.
ToString
Provides a standard value for the number of WSABUF structures used to send and receive data.
ToString
Use no flags for this call.
ToString
Process out-of-band data.
ToString
Partial send or receive for message.
ToString
Peek at incoming message.
SocketOptionLevel enumeration (System.Net. Sockets)
ToString
Description
Defines socket option levels for the System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel, System.Net.Sockets.SocketOptionName,System.Int32) and System.Net.Sockets.Socket.GetSocketOption(System.Net.Sockets.SocketOptionLevel, System.Net.Sockets.SocketOptionName) methods. The System.Net.Sockets.SocketOptionLevel enumeration defines the socket option levels that can be passed to the System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel, System.Net.Sockets.SocketOptionName,System.Int32) and System.Net.Sockets.Socket.GetSocketOption(System.Net.Sockets.SocketOptionLevel, System.Net.Sockets.SocketOptionName) methods.
ToString
Socket options apply to IP sockets.
ToString
Socket options apply to the socket itself.
ToString
Socket options apply to TCP sockets.
ToString
SocketOptionName enumeration (System.Net.Sockets)
ToString
Description
Defines socket option names for the System.Net.Sockets.Socket class.
ToString
Socket is listening.
ToString
Add an IP group membership.
ToString
Join a source group.
ToString
Block data from a source.
ToString
Permit sending broadcast messages on the socket.
ToString
Use urgent data as defined in RFC-1222. This option can be set only once, and once set, cannot be turned off.
ToString
Set or get UDP checksum coverage.
ToString
Record debugging information.
ToString
Do not fragment IP datagrams.
ToString
Close socket gracefully without lingering.
ToString
Do not route; send directly to interface addresses.
ToString
Drop an IP group membership.
ToString
Drop a source group.
ToString
Get error status and clear.
ToString
Enables a socket to be bound for exclusive access.
ToString
Use expedited data as defined in RFC-1222. This option can be set only once, and once set, cannot be turned off.
ToString
Indicates application is providing the IP header for outgoing datagrams.
ToString
Specifies IP options to be inserted into outgoing datagrams.
ToString
Set the IP header time-to-live field.
ToString
Send keep-alives.
ToString
Linger on close if unsent data is present.
ToString
Maximum queue length that can be specified by System.Net.Sockets.Socket.Listen(System.Int32).
ToString
Set the interface for outgoing multicast packets.
ToString
IP multicast loopback.
ToString
IP multicast time to live.
ToString
Send UDP datagrams with checksum set to zero.
ToString
Disables the Nagle algorithm for send coalescing.
ToString
Receives out-of-band data in the normal data stream.
ToString
Return information about received packets.
ToString
Send low water mark.
ToString
Receive low water mark.
ToString
Receive time out.
ToString
Allows the socket to be bound to an address that is already in use.
ToString
Specifies the total per-socket buffer space reserved for sends. This is unrelated to the maximum message size or the size of a TCP window.
ToString
Specifies the total per-socket buffer space reserved for receives. This is unrelated to the maximum message size or the size of a TCP window.
ToString
Send timeout.
ToString
Get socket type.
ToString
Change the IP header type of service field.
ToString
Unblock a previously blocked source.
ToString
Bypass hardware when possible.
SocketShutdown enumeration (System.Net.Sockets)
ToString
Description
Defines constants used by the System.Net.Sockets.Socket.Shutdown(System.Net.Sockets.SocketShutdown) method.
The System.Net.Sockets.SocketShutdown class is a helper class that defines the values that can be passed to the System.Net.Sockets.Socket.Shutdown(System.Net.Sockets.SocketShutdown) method.
ToString
Shuts down a socket for both sending and receiving. This field is constant.
ToString
Shuts down a socket for receiving. This field is constant.
ToString
Shuts down a socket for sending. This field is constant.
SocketType enumeration (System.Net. Sockets)
ToString
Description
Specifies the type of socket an instance of the System.Net.Sockets.Socket class represents. ToString
ToString
ToString
ToString
ToString
ToString
TcpClient class (System.Net.Sockets)
ToString
Description
Provides client connections for TCP network services.
The System.Net.Sockets.TcpClient class builds upon the System.Net.Sockets.Socket class to provide TCP services at a higher level of abstraction. You can establish a System.Net.Sockets.TcpClient connection can be establish by one of two ways.
TcpClient
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.TcpClient class.
The default constructor sets the IP address to System.Net.IPAddress.Any and the port number to 0.
TcpClient
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.TcpClient class with the local endpoint.
The localEP parameter specifies the local endpoint. This constructor instantiates a socket and binds that socket to the provided local endpoint. The local endpoint to which you bind the TCP connection.
TcpClient
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.TcpClient class and connects to the specified port on the specified host.
This constructor accepts two parameters. Name of the remote host to which youintend to connect. Port number of the remote host to which youintend to connect.
Active
ToString
Gets or set a value that indicates whether a connection has been made.
Client
ToString
Gets or sets the underlying System.Net.Sockets.Socket instance.
Use this property to set or get the underlying System.Net.Sockets.Socket instance of System.Net.Sockets.TcpClient.
LingerState
ToString
Gets or sets the value of the connection's System.Net.Sockets.LingerOption An instance of the System.Net.Sockets.LingerOption class.
This property sets or gets a System.Net.Sockets.LingerOption instance. If the System.Net.Sockets.LingerOption.Enabled property of the System.Net.Sockets.LingerOption instance is true, and data remains to be sent, then System.Net.Sockets.TcpClient remains open even after System.Net.Sockets.TcpClient.Close is called. The amount of time the object remains open is specified by the System.Net.Sockets.LingerOption.LingerTime property of the System.Net.Sockets.LingerOption instance. If the Enabled property of the System.Net.Sockets.LingerOption instance is false, then System.Net.Sockets.TCPClient will close immediately, even if data remains to be sent.
NoDelay
ToString
Gets or sets a value that enables a delay when send or receive buffers are full.
If System.Net.Sockets.TcpClient.NoDelay is set to false, System.Net.Sockets.TcpClient delays the sending and receiving of data while buffers are full. If System.Net.Sockets.TcpClient.NoDelay is set to true, then System.Net.Sockets.TcpClient continues writing to buffers even if there is no capacity left.
ReceiveBufferSize
ToString
Gets or sets the size of the receive buffer.
The System.Net.Sockets.TcpClient.ReceiveBufferSize property gets or sets the amount of bytes that can be stored in the receive buffer. After using System.Net.Sockets.TcpClient.GetStream to retrieve the underlying System.Net.Sockets.NetworkStream instance, you will initiate a read by using one of the System.Net.Sockets.NetworkStream read methods. The amount of data that can be stored from this read, will be determined by the System.Net.Sockets.TcpClient.ReceiveBufferSize property.
ReceiveTimeout
ToString
Gets or sets the amount of time a System.Net.Sockets.TcpClient object will wait to receive data once a read is initiated.
The System.Net.Sockets.TcpClient.ReceiveTimeout property determines the amount of time a System.Net.Sockets.TcpClient object will wait to receive data after a read is initiated. This time is measured in milliseconds.
SendBufferSize
ToString
Gets or sets the size of the send buffer.
The System.Net.Sockets.TcpClient.SendBufferSize property gets or sets the amount of bytes that can be stored in the send buffer. After using System.Net.Sockets.TcpClient.GetStream to retrieve the underlying System.Net.Sockets.NetworkStream instance, you will initiate a send by using one of the System.Net.Sockets.NetworkStream send methods. The amount of data that can be sent for each send, will be determined by the System.Net.Sockets.TcpClient.SendBufferSize property.
SendTimeout
ToString
Gets or sets the amount of time a System.Net.Sockets.TcpClient object will wait to receive confirmation you initiate a send.
After you initiate a send, the underlying System.Net.Sockets.Socket instance returns the number of bytes actually sent to the host. The System.Net.Sockets.TcpClient.SendTimeout property determines the amount of time a System.Net.Sockets.TcpClient object will wait before receiving the number of bytes returned by the System.Net.Sockets.Socket class.
Close
Closes the TCP connection.
Closes the TCP connection.
Connect
Connects the client to a remote TCP host using the specified remote network endpoint. System.Net.Sockets.TcpClient.Connect(System.String,System.Int32) establishes a TCP connection using the specified network endpoint. Before you call System.Net.Sockets.TcpClient.Connect(System.String,System.Int32), you must first instantiate an System.Net.IPEndPoint object using an IP address and port number. This is your network end-point. After you have instantiated the System.Net.Sockets.IPEndPoint object, you can then call System.Net.Sockets.TcpClient.Connect(System.String,System.Int32) and use the System.Net.IPEndPoint object as its argument. The IP endpoint to which you intend to connect.
Connect
Connects the client to a remote TCP host using the specified IP Address and port number.
System.Net.Sockets.TcpClient.Connect(System.String,System.Int32) establishes a TCP connection using the specified port and IP address. This method establishes a connection by calling the System.Net.Sockets.Socket.Connect(System.Net.EndPoint) method of the underlying System.Net.Sockets.Socket instance. After the connection is established, you can use the underlying System.Net.Sockets.NetworkStream instance to send and receive data. Use System.Net.Sockets.TcpClient.GetStream to obtain the underlying System.Net.Sockets.NetworkStream instance. IP address of the host to which youintend to connect. The port number to which you intend to connect.
Connect
Connects the client to the specified port on the specified host.
System.Net.Sockets.TcpClient.Connect(System.String,System.Int32) establishes a TCP connection to the host device using the specified port and hostname specified. This method establishes a connection by calling the System.Net.Sockets.Socket.Connect(System.Net.EndPoint) method of the underlying System.Net.Sockets.Socket instance. After the connection is established, you can use the underlying System.Net.Sockets.NetworkStream instance to send and receive data. Use System.Net.Sockets.TcpClient.GetStream to obtain the underlying System.Net.Sockets.NetworkStream instance. Name of the remote host to which youintend to connect. Port number of the remote host to which youintend to connect.
Dispose
Releases the unmanaged resources used by the System.Net.Sockets.TcpClient and optionally releases the managed resources.
This method releases the underlying System.Net.Sockets.NetworkStream and System.Net.Sockets.Socket instances. There are no managed resources that require releasing. If you call System.Net.Sockets.TcpClient.Dispose(System.Boolean) and specify true as its parameter, then be sure to suppress the finalizer by calling the System.Net.Sockets.TcpClient.suppressfinalize method of the garbage collector. If true, releases both managed and unmanaged resources; if false, releases only unmanaged resources.
Finalize
Frees resources used by the System.Net.Sockets.TcpClient class.
The System.Net.Sockets.TcpClient class finalizer calls the System.Net.Sockets.TcpClient.Close method to close the TCP connection, shut down the network stream, and free the socket.
GetStream
Returns the stream used to send and receive data.
Return Value: The underlying System.Net.Sockets.NetworkStream instance.
System.Net.Sockets.TcpClient.GetStream returns the underlying System.Net.Sockets.NetworkStream used to send and receive data.
IDisposable.Dispose
TcpListener class (System.Net.Sockets)
ToString
Description
Listens for connections from TCP network clients.
The System.Net.Sockets.TcpListener class builds upon the System.Net.Sockets.Socket class to provide TCP services at a higher level of abstraction.
TcpListener
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.TcpListener that listens on the specified port.
The port parameter specifies the local port number on which youintend to listen. This constructor instantiates the underlying System.Net.Sockets.IPEndPoint using the specified port number. When you call System.Net.Sockets.TcpListener.Start, System.Net.Sockets.TcpListener uses the default network interface to listen for connections on the specified port number. The port on which to listen. If this number is 0, a port number will be selected at random.
TcpListener
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.TcpListener class with the specified local endpoint.
The localEP parameter specifies the local endpoint. This constructor sets the underlying System.Net.Sockets.IPEndPoint of System.Net.Sockets.TcpListener to the specified local endpoint. If you call System.Net.Sockets.TcpListener.Start, System.Net.Sockets.TcpListener will listen for connections using this endpoint. The localend point to bind the listener connection to.
TcpListener
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.TcpListener class that listens to the specified IP address and port.
This constructor instantiates the underlying System.Net.Sockets.IPEndPoint of System.Net.Sockets.TcpListener using the specified IP address and port number. If you call System.Net.Sockets.TcpListener.Start, System.Net.Sockets.TcpListener listens for connections using the underlying endpoint. The local IP address to listen to. The port on which to listen. If this is set to 0, a port number will be selected at random.
Active
ToString
Gets or Sets a value that indicates whether System.Net.Sockets.TcpListener is actively listening for client connections.
LocalEndpoint
ToString
Gets the underlying System.Net.Sockets.EndPoint of System.Net.Sockets.TcpListener.
Server
ToString
Used by the class to get or set the underlying network socket.
Use this property to get the underlying System.Net.Sockets.Socket instance of System.Net.Sockets.TcpListener.
AcceptSocket
Accepts a pending connection request.
Return Value: A System.Net.Sockets.Socket instance to handle the incoming connection request.
System.Net.Sockets.TcpListener.AcceptSocket returns a System.Net.Sockets.Socket instance used to facilitate communication with the connecting client. This System.Net.Sockets.Socket is initialized with the IP Address and port number of the connecting client. You can use any of the System.Net.Sockets.Socket.Send(System.Byte[ ],System.Int32,System.Net.Sockets. SocketFlags) and System.Net.Sockets.Socket.Receive(System.Byte[ ],System.Int32,System.Net.Sockets. SocketFlags) methods available in the System.Net.Sockets.Socket class to facilitate communication.
AcceptTcpClient
Accepts a pending connection request
Return Value: A System.Net.Sockets.TcpClient instance to handle the incoming connection request.
System.Net.Sockets.TcpListener.AcceptTcpClient returns System.Net.Sockets.TcpClient instance used to facilitate communication with the connecting client. Use System.Net.Sockets.TcpClient.GetStream to obtain the underlying System.Net.Sockets.NetworkStream instance of System.Net.Sockets.TcpClient. You can use this System.Net.Sockets.TcpClient.NetworkStream to facilitate communication with the client.
Finalize
Frees resources used by the System.Net.Sockets.TcpClient class.
The finalizer for the System.Net.Sockets.TcpListener class calls the System.Net.Sockets.TcpListener.Stop method to free the underlying System.Net.Sockets.Socket.
Pending
Determine if there are pending connection requests.
Return Value: true if connections are pending; otherwise, false.
Before System.Net.Sockets.TcpListener can poll for client connection attempts, it must first initialize its underlying System.Net.Sockets.Socket instance to listen for incoming connection requests. The way you inititailize the underlying System.Net.Sockets.Socket is by calling the System.Net.Sockets.TcpListener.Start method.
Start
Starts listening to network requests.
System.Net.Sockets.TcpListener.Start initializes the underlying System.Net.Sockets.Socket instance. After this initialization, System.Net.Sockets.Start does the following: Binds the underlying System.Net.Sockets.Socket instance using the underlying System.Net.Sockets.IPEndPoint instance Begins listening for client connections by calling the System.Net.Sockets.Socket.Listen(System.Int32) method of the underlying System.Net.Sockets.Socket instance.
Stop
Closes the network connection.
Close closes the network connection.
UdpClient class (System.Net.Sockets)
ToString
Description
Provides UDP (User Datagram Protocol) network services.
The System.Net.Sockets.UdpClient class builds upon the System.Net.Sockets.Socket class to provide UDP services at a higher level of abstraction. Because UDP is a connectionless transport protocol, you do not need to establish a remote host connection prior to sending and receiving data. You do however, have the option to establish a System.Net.Sockets.UdpClient connection with a remote host using one of the following ways.
UdpClient
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.UdpClient class.
The default constructor sets the IP address to System.Net.IPAddress.Any and the port number to 0.
UdpClient
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.UdpClient class that communicates on a specified port.
The port parameter specifies the local port number on which youintend to communicate. This constructor instantiates an underlying System.Net.Sockets.Socket and binds that System.Net.Sockets.Socket using the provided port number. This constructor configures the underlying System.Net.Sockets.Socket to use the default local network interface for communication. The local port number from which youintend to communicate.
UdpClient
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.UdpClient class that communicates on a specified local endpoint.
The localEP parameter specifies the local end point. This constructor instantiates a socket and binds that socket to the local end point provided. The local endpoint to which you bind the Udp connection.
UdpClient
Example Syntax:
ToString
Initializes a new instance of the System.Net.Sockets.UdpClient class and connects to a specified remote host on a specified port.
This constructor accepts two parameters. The remote host name to which youintend to connect The remote port number to which youintend to connect
Active
ToString
Gets or sets a value indicating whether a connection to a remote host has been made.
Client
ToString
Gets or sets the underlying network socket. System.Net.Sockets.UdpClient creates a System.Net.Sockets.Socket instance to handle the actual sending and receiving of data over a network.
Close
Closes the UDP connection.
System.Net.Sockets.TcpClient.Close disposes the UDP connection.
Connect
Connects the client to a remote UDP host using the specified remote network endpoint.
System.Net.Sockets.UdpClient.Connect(System.String,System.Int32) establishes a UDP connection to the host using the specified System.Net.IPEndPoint. The network endpoint to which youintend to connect.
Connect
Connects the client to a remote UDP host using the specified IP Address and port number.
System.Net.Sockets.TcpClient.Connect(System.String,System.Int32) establishes a UDP connection using the port and IP address specified. This method establishes a connection by calling the System.Net.Sockets.Socket.Connect(System.Net.EndPoint) method of the underlying System.Net.Sockets.Socket instance. After a connection is established, you can use the System.Net.Sockets.UdpClient.Send(System.Byte[ ],System.Int32,System.Net.I PEndPoint) and System.Net.Sockets.UdpClient.Receive(System.Net.IPEndPoint@) methods to communicate with the remote host. IP address of the host to which youintend to connect. The port number to which youintend to connect.
Connect
Establishes a connection to the specified port on the specified remote host.
System.Net.Sockets.TcpClient.Connect(System.String,System.Int32) establishes a UDP connection to the host machine using the specified port and hostname. This method establishes a connection by calling the System.Net.Sockets.Socket.Connect(System.Net.EndPoint) method of the underlying System.Net.Sockets.Socket instance. Once a connection is established, you can use the System.Net.Sockets.UdpClient.Send(System.Byte[ ],System.Int32,System.Net.I IPEndPoint) and System.Net.Sockets.UdpClient.Receive(System.Net.IPEndPoint@) methods to communicate with the remote host. Name of the remote host to which youintend to connect. Port number on the remote host to which youintend to connect.
DropMulticastGroup
Leaves a multicast group. System.Net.Sockets.UdpClient.DropMulticastGroup(System.Net.IPAddress) disassociates a System.Net.Sockets.UdpClient instance with a multicast group. In order to remove the System.Net.Sockets.UdpClient instance from a multicast group, you must call System.Net.Sockets.UdpClient.DropMulticastGroup(System.Net.IPAddress) using the System.Net.Sockets.IPAddress of the group from which youintend to withdrawal. The System.Net.IPAddressof the multicast group to leave.
JoinMulticastGroup
Adds a System.Net.Sockets.UdpClient to a multicast group.
System.Net.Sockets.UdpClient.JoinMulticastGroup(System.Net.IPAddress) associates the System.Net.Sockets.UdpClient instance with a multicast group. In order to receive data from this group, you must call System.Net.Sockets.UdpClient.JoinMulticastGroup(System.Net.IPAddress) using the System.Net.Sockets.IPAddress of the group to which youintend to join. The multicast System.Net.Sockets.IPAddress of the group you wish to join.
JoinMulticastGroup
Adds a System.Net.Sockets.UdpClient to a multicast group with the specified Time to Live (TTL). System.Net.Sockets.UdpClient.JoinMulticastGroup(System.Net.IPAddress) associates the System.Net.Sockets.UdpClient instance with a multicast group. This overload requires two parameters. The System.Net.IPAddress of the multicast group to join. The Time to Live (TTL)
Receive
Returns a UDP datagram that was sent by a remote host.
Return Value: An array of 8-bit unsigned integers that contains the datagram data. An System.Net.IPEndPoint representing the remote host from which the data was sent.
Send
Sends a UDP datagram to a remote host. Return Value: The number of bytes sent.
System.Net.Sockets.UdpClient.Send(System.Byte[ ],System.Int32,System. Net.IPEndPoint) sends the provided datagram to a remote host. Before using System.Net.Sockets.UdpClient.Send(System.Byte[ ],System.Int32,System.Net.IPEndPoint), you must first use System.Net.Sockets.UdpClient.Connect(System.String,System.Int32) to establish a remote host connection. The UDP datagram that youintend to send. The number of bytes in the datagram.
Send
Sends a UDP datagram to the host that is at the remote endpoint.
Return Value: The number of bytes sent.
The System.Net.Sockets.UdpChient.Send(System.Byte[ ],System.Int32,System.Net.IPEndPoint) method establishes a UDP connection to the remote host using the specified System.Net.IPEndPoint, and then sends the datagram. The UDP datagram to send. The number of bytes in the datagram. An System.Net.IPEndPoint that represents the host and port to which to send the datagram.
Send
Sends a UDP datagram to a specified port on a specified remote host.
Return Value: The number of bytes sent.
System.Net.Sockets.UdpClient.Send(System.Byte[ ],System.Int32,System. Net.IPEndPoint) establishes a UDP connection to the specified host and port and then sends the datagram. The data is sent by calling the System.Net.Sockets.Socket.SendTo(System.Byte[ ],System.Int32,System.Int32, System.Net.Sockets.SocketFlags,System.Net.EndPoint) method of the underlying System.Net.Sockets.Socket instance. The UDP datagram to send.
System.Security Namespace
The System.Security namespace provides the underlying structure of the security system, including base classes for permissions. Cryptographic classes in the namespace are integrated with streams, allowing the classes to be used with file or network I/O seamlessly. Additionally, security is made available due to isolated storage that allows code running with restricted permissions to use its own private file system. Furthermore, a role-based user identity programming model is unified across different underlying authentication technologies, enabling applications to write to a single API that works for all the authentication technologies. As part of this role-based user identity programming model, an IIdentity interface defines the basic functionality of an identity object (which represents the user on whose behalf the code is running), and an IPrincipal interface defines the basic functionality of a principal object (which represents the security context of the user on whose behalf the code is running, including that user's identity (IIdentity) and any roles to which the user belongs). The System.Security namespace includes a System.Security.Cryptography namespace, a System.Security.Cryptography.X509Certificates namespace, a System.Security.Cryptography.Xml namespace, a System.Security.Permissions namespace, a System.Security.Policy namespace, and a System.Security.Principal namespace.
The System.Security.Cryptography namespace provides cryptographic services, including secure encoding and decoding of data, as well as many other operations, such as hashing, random number generation, and message authentication. The System.Security.Cryptography.X509Certificates namespace contains the common language runtime implementation of the Authenticode X.509 v.3 certificate. This certificate is signed with a private key, uniquely and positively identifying the holder of the certificate. The System.Security.Cryptography.Xml namespace contains an XML model for use within the .net framework security system, allowing XML objects to be signed Is with a digital signature.
The System.Security.Permissions namespace defines classes that control access to operations and resources based on policy. The System.Security.Policy namespace contains three types of classes: code groups, membership conditions, and evidence. These three types of classes are used to create the rules applied by the common language runtime security policy system. Evidence classes are the input to security policy and membership conditions are the switches; together these create policy statements and determine the granted permission set. Policy levels and code groups are the structure of the policy hierarchy. Code groups are the encapsulation of a rule and are arranged hierarchically in a policy level. The System.Security.Principal namespace defines a principal object that represents the security context under which code is running.
System.Management Namespace
The System.Management namespace includes numerous objects and methods that enable rich management through late binding to WMI providers. Various management functionality and capacity is made available, including standard querying on management data, events-publication/subscription, management data retrieval, method invocation (system reboots, process kill, etc.), system/application configuration, discoverability through common schema, support for management relationship hierarchies, etc.
Numerous objects representing management instrumentation are accessible through the System.Management namespace (which includes the System.Management.Instrumentation namespace), from configuration to events that can be consumed by .NET clients to manage devices. The System.Management namespace exposes multiple classes (e.g., ManagementObject( ) and ManagementObjectSearcher( ), etc.) that allow client devices to query and enumerate through management classes and invoke methods, write configurations, subscribe for events, etc. Examples of this functionality include: SNMP management (traps, etc.); WDM management (windows drivers); MSI management (windows installer); DS management (directory services); Security settings management; Network Adapters/bindings management; Computer System management; Memory, CPU, Processor, and Disks management; File and directory management; Application management; System Device management; and so forth.
System.ServiceProcess Namespace
As discussed above, the System.ServiceProcess namespace contains classes that allow developers to install and run services. These allow services (e.g., Windows NT® operating system services) to be written, installed, and run relatively easily. These also allow custom installation actions for services to be packaged into assemblies, easing the installation process.
System.Runtime.Serialization Namespace
The System.Runtime.Serialization namespace contains classes that can be used for serializing and deserializing objects in a relatively simple manner. Serialization is the process of converting an object or a graph of objects into a linear sequence of bytes for either storage or transmission to another location. Deserialization is the process of taking in stored information and recreating objects from it. An ISerializable interface provides a way for classes to control their own serialization behavior. The System.Runtime.Serialization namespace includes three additional namespaces: the System.Runtime.Serialization.Formatters namespace (which contains common enumerations, interfaces and classes that are used by serialization formatters), the System.Runtime.Serialization.Formatters.Binary namespace (which contains a BinaryFormatter class that can be used to serialize and deserialize objects in binary format), and the System.Runtime.Serialization.Formatters.Soap namespace (which contains a SoapFormatter class that can be used to serialize and deserialize objects in the SOAP format).
System.Messaging Namespace
The System.Messaging namespace provides classes that allow connecting to message queues on the network, sending messages to queues, receiving messages from queues, and peeking at (reading without removing) messages from queues. A MessageQueue class supports both synchronous and asynchronous retrieval of messages from a queue. Peek and Receive methods on the MessageQueue class interrupt processing until a message is available in the queue (or until a specified timeout expires), while BeginPeek and BeginReceive methods on the MessageQueue class allow processing to continue and use event notification or callbacks to indicate that a message exists or has arrived in the queue. MessageQueue use an internal connection cache (or pool), allowing repeated instantiation of MessageQueue to bind to the same queue very quickly. Additionally, any object can be sent or received as a message, and the object on the server and client can be of a different type (as long as the schemas are the same).
The MessageQueue class and Message class are the primary classes that provide the functionality for message queuing. MessageQueue provides a means for getting and setting queue properties and default message properties, as well as initiating message send, peek, or receive operations. MessageQueue also provides support for transactional message processing. The Message class is used to peek or receive messages from a queue, or to have fine control over message properties when sending a message to a queue.
System.Diagnostics Namespace
As discussed above, the System.Diagnostics namespace contains classes that are used to debug applications and to trace code execution, as well as start system processes, read and write to event logs, and monitor system performance. These classes allow, for example, easy publishing of performance counter data and writing to event logs (e.g., without having to generate separate dlls in order to do so). A Trace class contains a set of methods and properties that help a developer trace the execution of code. A Debug class contains a set of methods and properties that help a developer debug code. A Process class enables access to local and remote processes, allowing a developer to start and stop local system processes. An EventLog class enables interaction with Windows® operating systems event logs, which record information about important software or hardware events. A PerformanceCounter class represents a Windows NT® operating system performance counter component that can be used for both reading existing predefined or custom counters and publishing (writing) performance data to custom counters.
Exemplary Computing System and Environment
The exemplary computing environment 400 is only one example of a computing environment and is not intended to suggest any limitation as to the scope of use or functionality of the computer and network architectures. Neither should the computing environment 400 be interpreted as having any dependency or requirement relating to any one or combination of components illustrated in the exemplary computing environment 400.
The framework 132 may be implemented with numerous other general purpose or special purpose computing system environments or configurations. Examples of well known computing systems, environments, and/or configurations that may be suitable for use include, but are not limited to, personal computers, server computers, multiprocessor systems, microprocessor-based systems, network PCs, minicomputers, mainframe computers, distributed computing environments that include any of the above systems or devices, and so on. Compact or subset versions of the framework may also be implemented in clients of limited resources, such as cellular phones, personal digital assistants, handheld computers, or other communication/computing devices.
The framework 132 may be described in the general context of computer-executable instructions, such as program modules, being executed by one or more computers or other devices. Generally, program modules include routines, programs, objects, components, data structures, etc. that perform particular tasks or implement particular abstract data types. The framework 132 may also be practiced in distributed computing environments where tasks are performed by remote processing devices that are linked through a communications network. In a distributed computing environment, program modules may be located in both local and remote computer storage media including memory storage devices.
The computing environment 400 includes a general-purpose computing device in the form of a computer 402. The components of computer 402 can include, by are not limited to, one or more processors or processing units 404, a system memory 406, and a system bus 408 that couples various system components including the processor 404 to the system memory 406.
The system bus 408 represents one or more of several possible types of bus structures, including a memory bus or memory controller, a peripheral bus, an accelerated graphics port, and a processor or local bus using any of a variety of bus architectures. By way of example, such architectures can include an Industry Standard Architecture (ISA) bus, a Micro Channel Architecture (MCA) bus, an Enhanced ISA (EISA) bus, a Video Electronics Standards Association (VESA) local bus, and a Peripheral Component Interconnects (PCI) bus also known as a Mezzanine bus.
Computer 402 typically includes a variety of computer readable media. Such media can be any available media that is accessible by computer 402 and includes both volatile and non-volatile media, removable and non-removable media.
The system memory 406 includes computer readable media in the form of volatile memory, such as random access memory (RAM) 410, and/or non-volatile memory, such as read only memory (ROM) 412. A basic input/output system (BIOS) 414, containing the basic routines that help to transfer information between elements within computer 402, such as during start-up, is stored in ROM 412. RAM 410 typically contains data and/or program modules that are immediately accessible to and/or presently operated on by the processing unit 404.
Computer 402 may also include other removable/non-removable, volatile/non-volatile computer storage media. By way of example,
The disk drives and their associated computer-readable media provide non-volatile storage of computer readable instructions, data structures, program modules, and other data for computer 402. Although the example illustrates a hard disk 416, a removable magnetic disk 420, and a removable optical disk 424, it is to be appreciated that other types of computer readable media which can store data that is accessible by a computer, such as magnetic cassettes or other magnetic storage devices, flash memory cards, CD-ROM, digital versatile disks (DVD) or other optical storage, random access memories (RAM), read only memories (ROM), electrically erasable programmable read-only memory (EEPROM), and the like, can also be utilized to implement the exemplary computing system and environment.
Any number of program modules can be stored on the hard disk 416, magnetic disk 420, optical disk 424, ROM 412, and/or RAM 410, including by way of example, an operating system 426, one or more application programs 428, other program modules 430, and program data 432. Each of the operating system 426, one or more application programs 428, other program modules 430, and program data 432 (or some combination thereof) may include elements of the programming framework 132.
A user can enter commands and information into computer 402 via input devices such as a keyboard 434 and a pointing device 436 (e.g., a “mouse”). Other input devices 438 (not shown specifically) may include a microphone, joystick, game pad, satellite dish, serial port, scanner, and/or the like. These and other input devices are connected to the processing unit 404 via input/output interfaces 440 that are coupled to the system bus 408, but may be connected by other interface and bus structures, such as a parallel port, game port, or a universal serial bus (USB).
A monitor 442 or other type of display device can also be connected to the system bus 408 via an interface, such as a video adapter 444. In addition to the monitor 442, other output peripheral devices can include components such as speakers (not shown) and a printer 446 which can be connected to computer 402 via the input/output interfaces 440.
Computer 402 can operate in a networked environment using logical connections to one or more remote computers, such as a remote computing device 448. By way of example, the remote computing device 448 can be a personal computer, portable computer, a server, a router, a network computer, a peer device or other common network node, and so on. The remote computing device 448 is illustrated as a portable computer that can include many or all of the elements and features described herein relative to computer 402.
Logical connections between computer 402 and the remote computer 448 are depicted as a local area network (LAN) 450 and a general wide area network (WAN) 452. Such networking environments are commonplace in offices, enterprise-wide computer networks, intranets, and the Internet.
When implemented in a LAN networking environment, the computer 402 is connected to a local network 450 via a network interface or adapter 454. When implemented in a WAN networking environment, the computer 402 typically includes a modem 456 or other means for establishing communications over the wide network 452. The modem 456, which can be internal or external to computer 402, can be connected to the system bus 408 via the input/output interfaces 440 or other appropriate mechanisms. It is to be appreciated that the illustrated network connections are exemplary and that other means of establishing communication link(s) between the computers 402 and 448 can be employed.
In a networked environment, such as that illustrated with computing environment 400, program modules depicted relative to the computer 402, or portions thereof, may be stored in a remote memory storage device. By way of example, remote application programs 458 reside on a memory device of remote computer 448. For purposes of illustration, application programs and other executable program components such as the operating system are illustrated herein as discrete blocks, although it is recognized that such programs and components reside at various times in different storage components of the computing device 402, and are executed by the data processor(s) of the computer.
An implementation of the framework 132, and particularly, the API 142 or calls made to the API 142, may be stored on or transmitted across some form of computer readable media. Computer readable media can be any available media that can be accessed by a computer. By way of example, and not limitation, computer readable media may comprise “computer storage media” and “communications media.” “Computer storage media” include volatile and non-volatile, removable and non-removable media implemented in any method or technology for storage of information such as computer readable instructions, data structures, program modules, or other data. Computer storage media includes, but is not limited to, RAM, ROM, EEPROM, flash memory or other memory technology, CD-ROM, digital versatile disks (DVD) or other optical storage, magnetic cassettes, magnetic tape, magnetic disk storage or other magnetic storage devices, or any other medium which can be used to store the desired information and which can be accessed by a computer.
“Communication media” typically embodies computer readable instructions, data structures, program modules, or other data in a modulated data signal, such as carrier wave or other transport mechanism. Communication media also includes any information delivery media. The term “modulated data signal” means a signal that has one or more of its characteristics set or changed in such a manner as to encode information in the signal. By way of example, and not limitation, communication media includes wired media such as a wired network or direct-wired connection, and wireless media such as acoustic, RF, infrared, and other wireless media. Combinations of any of the above are also included within the scope of computer readable media.
Alternatively, portions of the framework may be implemented in hardware or a combination of hardware, software, and/or firmware. For example, one or more application specific integrated circuits (ASICs) or programmable logic devices (PLDs) could be designed or programmed to implement one or more portions of the framework.
Although the invention has been described in language specific to structural features and/or methodological acts, it is to be understood that the invention defined in the appended claims is not necessarily limited to the specific features or acts described. Rather, the specific features and acts are disclosed as exemplary forms of implementing the claimed invention.
This application is a continuation of U.S. patent application Ser. No. 09/902,811, filed Jul. 10, 2001, which is hereby incorporated by reference herein.
| Number | Date | Country | |
|---|---|---|---|
| Parent | 09902811 | Jul 2001 | US |
| Child | 11159851 | Jun 2005 | US |
