diff --git a/xml/Microsoft.Build.Construction/ProjectElement.xml b/xml/Microsoft.Build.Construction/ProjectElement.xml index a221c4c7fb2..69332675b42 100644 --- a/xml/Microsoft.Build.Construction/ProjectElement.xml +++ b/xml/Microsoft.Build.Construction/ProjectElement.xml @@ -25,7 +25,7 @@ - Abstract base class for MSBuild construction object model elements. + Abstract base class for MSBuild construction object model elements. To be added. @@ -153,8 +153,8 @@ - Gets or sets the Condition value. - It will return empty string IFF a condition attribute is legal but it’s not present or has no value. + Gets or sets the Condition value. + It will return empty string IFF a condition attribute is legal but it’s not present or has no value. It will return null IFF a Condition attribute is illegal on that element. Removes the attribute if the value to set is empty. It is possible for derived classes to throw an if setting the condition is @@ -162,13 +162,13 @@ The Condition attribute value, or an empty string if the attribute is not present. - For the "ProjectExtensions" element, the getter returns null and the setter @@ -320,7 +320,7 @@ System.String - To be added. + Gets the name of the associated element. Useful for display in some circumstances. To be added. To be added. @@ -354,17 +354,17 @@ - Gets or sets the Label value. + Gets or sets the Label value. Returns empty string if it is not present. Removes the attribute if the value to set is empty. The label, or an empty string if no label is present. - @@ -413,7 +413,7 @@ Location of the corresponding Xml element. - May not be correct if file is not saved, or + May not be correct if file is not saved, or file has been edited since it was last saved. In the case of an unsaved edit, the location only contains the path to the file that the element originates from. @@ -486,7 +486,7 @@ System.String - To be added. + The outer markup associated with this project element. To be added. To be added. @@ -594,9 +594,7 @@ To be added. - - Hook for subclasses to specify whether the given should be cloned or not - + Hook for subclasses to specify whether the given should be cloned or not. To be added. To be added. diff --git a/xml/Microsoft.Build.Framework/SdkReference.xml b/xml/Microsoft.Build.Framework/SdkReference.xml index 117547e022f..1dc8c7b83f5 100644 --- a/xml/Microsoft.Build.Framework/SdkReference.xml +++ b/xml/Microsoft.Build.Framework/SdkReference.xml @@ -79,9 +79,10 @@ - - - + An object to compare with this object. + Indicates whether the current object is equal to another object of the same type. + + if the current object is equal to the parameter; otherwise, . To be added. diff --git a/xml/Microsoft.Build.Globbing/CompositeGlob.xml b/xml/Microsoft.Build.Globbing/CompositeGlob.xml index 289d2de68d9..cfacdd8a710 100644 --- a/xml/Microsoft.Build.Globbing/CompositeGlob.xml +++ b/xml/Microsoft.Build.Globbing/CompositeGlob.xml @@ -122,10 +122,24 @@ - To be added. - To be added. - To be added. - To be added. + The string to match. If the string represents a relative path, it will get normalized against the glob's root. Cannot be . + Matches the given against the glob. + + if contains invalid path or file characters; otherwise. + + + diff --git a/xml/Microsoft.Build.Globbing/MSBuildGlob.xml b/xml/Microsoft.Build.Globbing/MSBuildGlob.xml index 844d5c42bfc..69b8d2d3bc9 100644 --- a/xml/Microsoft.Build.Globbing/MSBuildGlob.xml +++ b/xml/Microsoft.Build.Globbing/MSBuildGlob.xml @@ -126,10 +126,22 @@ - To be added. - To be added. - To be added. - To be added. + The string to match. If the string represents a relative path, it will get normalized against the glob's root. Cannot be . + Matches the given against the glob. + + if contains invalid path or file characters; otherwise. + diff --git a/xml/Microsoft.Build.Globbing/MSBuildGlobWithGaps.xml b/xml/Microsoft.Build.Globbing/MSBuildGlobWithGaps.xml index 233d2e9e5f0..5dfe7aa20b4 100644 --- a/xml/Microsoft.Build.Globbing/MSBuildGlobWithGaps.xml +++ b/xml/Microsoft.Build.Globbing/MSBuildGlobWithGaps.xml @@ -146,10 +146,24 @@ - To be added. - To be added. - To be added. - To be added. + The string to match. If the string represents a relative path, it will get normalized against the glob's root. Cannot be . + Matches the given against the glob. + + if contains invalid path or file characters; otherwise. + + + diff --git a/xml/Microsoft.Build.Graph/GraphBuildOptions.xml b/xml/Microsoft.Build.Graph/GraphBuildOptions.xml index 516c3c4d1b8..8462b146330 100644 --- a/xml/Microsoft.Build.Graph/GraphBuildOptions.xml +++ b/xml/Microsoft.Build.Graph/GraphBuildOptions.xml @@ -148,9 +148,10 @@ - To be added. - To be added. - To be added. + An object to compare with this object. + Indicates whether the current object is equal to another object of the same type. + + if the current object is equal to the parameter; otherwise, . To be added. diff --git a/xml/Microsoft.Build.Logging/BinaryLogger.xml b/xml/Microsoft.Build.Logging/BinaryLogger.xml index 9a98d5b67c7..89ba1c6f056 100644 --- a/xml/Microsoft.Build.Logging/BinaryLogger.xml +++ b/xml/Microsoft.Build.Logging/BinaryLogger.xml @@ -18,13 +18,7 @@ - - A logger that serializes all incoming BuildEventArgs in a compressed binary file (*.binlog). The file - can later be played back and piped into other loggers (file, console, etc) to reconstruct the log contents - as if a real build was happening. Additionally, this format can be read by tools for - analysis or visualization. Since the file format preserves structure, tools don't have to parse - text logs that erase a lot of useful information. - + A logger that serializes all incoming BuildEventArgs in a compressed binary file (*.binlog). The file can later be played back and piped into other loggers (file, console, etc) to reconstruct the log contents as if a real build was happening. Additionally, this format can be read by tools for analysis or visualization. Since the file format preserves structure, tools don't have to parse text logs that erase a lot of useful information. The logger is public so that it can be instantiated from MSBuild.exe via command-line switch. @@ -41,7 +35,7 @@ - To be added. + Initializes a new instance. To be added. @@ -61,9 +55,7 @@ Microsoft.Build.Logging.BinaryLogger+ProjectImportsCollectionMode - - Gets or sets whether to capture and embed project and target source files used during the build. - + Gets or sets whether to capture and embed project and target source files used during the build. To be added. To be added. @@ -90,10 +82,8 @@ - To be added. - - Initializes the logger by subscribing to events of IEventSource - + The events available to loggers. + Initializes the logger by subscribing to events of the specified event source. To be added. @@ -116,10 +106,8 @@ System.String - - The only supported parameter is the output log file path (e.g. "msbuild.binlog") - - To be added. + Gets or sets the parameters. The only supported parameter is the output log file path (for example, "msbuild.binlog"). + The parameter string. Can be . To be added. @@ -143,9 +131,7 @@ - - Closes the underlying file stream. - + Closes the underlying file stream. To be added. @@ -168,12 +154,9 @@ Microsoft.Build.Framework.LoggerVerbosity - - The binary logger Verbosity is always maximum (Diagnostic). It tries to capture as much - information as possible. - - To be added. - To be added. + Gets or sets the verbosity level. + The verbosity level. + The binary logger Verbosity is always maximum (Diagnostic). It tries to capture as much information as possible. diff --git a/xml/Microsoft.Build.Logging/BuildEventArgsReader.xml b/xml/Microsoft.Build.Logging/BuildEventArgsReader.xml index bf4e97688e0..685ef7a2ca1 100644 --- a/xml/Microsoft.Build.Logging/BuildEventArgsReader.xml +++ b/xml/Microsoft.Build.Logging/BuildEventArgsReader.xml @@ -18,9 +18,7 @@ - - Deserializes and returns BuildEventArgs-derived objects from a BinaryReader - + Deserializes and returns -derived objects from a . To be added. @@ -41,11 +39,9 @@ - The BinaryReader to read BuildEventArgs from + The to read from. The file format version of the log file being read. - - Initializes a new instance of BuildEventArgsReader using a BinaryReader instance - + Initializes a new instance of using a instance. To be added. @@ -69,7 +65,7 @@ - To be added. + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. To be added. @@ -90,10 +86,8 @@ - - Reads the next log record from the binary reader. If there are no more records, returns null. - - To be added. + Reads the next log record from the . + The next . If there are no more records, returns . To be added. diff --git a/xml/Microsoft.Build.Logging/ProfilerLogger.xml b/xml/Microsoft.Build.Logging/ProfilerLogger.xml index 7f4a7148aae..3a70f5590c9 100644 --- a/xml/Microsoft.Build.Logging/ProfilerLogger.xml +++ b/xml/Microsoft.Build.Logging/ProfilerLogger.xml @@ -91,10 +91,8 @@ - To be added. - - Subscribes to status events, which is the category for the evaluation finished event. - + The events available to loggers. + Subscribes to status events, which is the category for the evaluation finished event. To be added. @@ -117,10 +115,8 @@ System.String - - No specific parameters are used by this logger - - To be added. + No specific parameters are used by this logger. + The parameter string. Can be . To be added. @@ -144,9 +140,7 @@ - - On shutdown, the profiler report is written to disk - + On shutdown, the profiler report is written to disk. To be added. @@ -169,11 +163,9 @@ Microsoft.Build.Framework.LoggerVerbosity - - Verbosity is ignored by this logger - - To be added. - To be added. + Gets or sets the verbosity level. + The verbosity level. + Verbosity is ignored by this logger. diff --git a/xml/Microsoft.Build.Tasks/CodeTaskFactory.xml b/xml/Microsoft.Build.Tasks/CodeTaskFactory.xml index be1390f459b..df0e33e2daf 100644 --- a/xml/Microsoft.Build.Tasks/CodeTaskFactory.xml +++ b/xml/Microsoft.Build.Tasks/CodeTaskFactory.xml @@ -131,10 +131,8 @@ The host that logs information from the task factory. - To be added. - - Create a taskfactory instance which contains the data that needs to be refreshed between task invocations - + The task factory logging host will log messages in the context of the task. + Creates a task factory instance that contains the data that needs to be refreshed between task invocations. The new task. To be added. @@ -193,9 +191,7 @@ - - Get the type information for all task parameters - + Gets the type information for all task parameters. An array of the type information for all task parameters. To be added. @@ -242,9 +238,7 @@ The element contents for the task. To be added. The logging host that gets information about tasks. - - Initialze the task factory - + Initializes the task factory. The new task factory. To be added. @@ -278,9 +272,7 @@ System.Type - - Gets the type of the generated task. - + Gets the type of the generated task. The task type. To be added. diff --git a/xml/Microsoft.Build.Tasks/Copy.xml b/xml/Microsoft.Build.Tasks/Copy.xml index debb6f9a39c..5d4275e249d 100644 --- a/xml/Microsoft.Build.Tasks/Copy.xml +++ b/xml/Microsoft.Build.Tasks/Copy.xml @@ -199,11 +199,11 @@ Gets or sets a list of files to copy the source files to. The list of files to copy the source files to. - property. That is, the first file specified in will be copied to the first location specified in , and so forth. - + property. That is, the first file specified in will be copied to the first location specified in , and so forth. + ]]> @@ -250,11 +250,11 @@ Gets or sets the directory to which you want to copy the files. The directory to which you want to copy the files. - @@ -315,11 +315,9 @@ - - Standard entry point. - - - To be added. + Executes the copy task. + , if successful; otherwise. + This method is the standard entry point. @@ -357,10 +355,7 @@ System.Boolean - - Whether to overwrite files in the destination - that have the read-only attribute set. - + Gets or sets a value that indicates whether to overwrite files in the destination that have the read-only attribute set. if the Copy task should overwrite files even if they are marked as read only files; otherwise, . To be added. @@ -397,13 +392,8 @@ System.Int32 - - How many times to attempt to copy, if all previous - attempts failed. Defaults to zero. - Warning: using retries may mask a synchronization problem in your - build process. - - To be added. + Gets or sets the number of times to attempt to copy, if all previous attempts failed. Warning: using retries may mask a synchronization problem in your build process. + The number of times to attempt to copy, if all previous attempts failed. The default is zero. To be added. @@ -438,10 +428,8 @@ System.Int32 - - Delay between any necessary retries. - Defaults to RetryDelayMillisecondsDefault - To be added. + Gets or sets the delay, in milliseconds, between any necessary retries. + The delay, in milliseconds, between any necessary retries. The default is 1000 milliseconds. To be added. @@ -488,11 +476,11 @@ if the Copy task should skip the copying of files that are unchanged between the source and destination; otherwise, . - @@ -576,9 +564,7 @@ System.Boolean - - Create Hard Links for the copied files rather than copy the files if possible to do so - + Gets or sets a value that indicates whether to use Hard Links for the copied files rather than copy the files, if it's possible to do so. To be added. To be added. @@ -600,9 +586,7 @@ System.Boolean - - Create Symbolic Links for the copied files rather than copy the files if possible to do so - + Gets or sets a value that indicates whether to create Symbolic Links for the copied files rather than copy the files, if it's possible to do so. To be added. To be added. diff --git a/xml/Microsoft.Build.Tasks/DownloadFile.xml b/xml/Microsoft.Build.Tasks/DownloadFile.xml index 84748115e7a..25d7c4e6271 100644 --- a/xml/Microsoft.Build.Tasks/DownloadFile.xml +++ b/xml/Microsoft.Build.Tasks/DownloadFile.xml @@ -64,7 +64,7 @@ - To be added. + Instructs the task to exit as soon as possible, or to immediately exit if Execute is invoked after this method. To be added. @@ -85,9 +85,7 @@ Microsoft.Build.Framework.ITaskItem - - Gets or sets an optional filename for the destination file. By default, the filename is derived from the if possible. - + Gets or sets an optional filename for the destination file. By default, the filename is derived from the if possible. To be added. To be added. @@ -114,9 +112,7 @@ Microsoft.Build.Framework.ITaskItem - - Gets or sets a that specifies the destination folder to download the file to. - + Gets or sets a that specifies the destination folder to download the file to. To be added. To be added. @@ -143,9 +139,7 @@ Microsoft.Build.Framework.ITaskItem - - Gets or sets a that contains details about the downloaded file. - + Gets or sets a that contains details about the downloaded file. To be added. To be added. @@ -170,8 +164,8 @@ - To be added. - To be added. + This method is called by the build engine to begin task execution. A task uses the return value to indicate whether it was successful. If a task throws an exception out of this method, the engine will automatically assume that the task has failed. + , if successful; otherwise. To be added. @@ -191,9 +185,7 @@ System.Int32 - - Gets or sets an optional number of times to retry if possible. - + Gets or sets an optional number of times to retry if possible. To be added. To be added. @@ -214,9 +206,7 @@ System.Int32 - - Gets or sets the number of milliseconds to wait before retrying. - + Gets or sets the number of milliseconds to wait before retrying. To be added. To be added. @@ -237,9 +227,7 @@ System.Boolean - - Gets or sets an optional value indicating whether or not the download should be skipped if the file is up-to-date. - + Gets or sets an optional value indicating whether or not the download should be skipped if the file is up-to-date. To be added. To be added. @@ -266,9 +254,7 @@ System.String - - Gets or sets the URL to download. - + Gets or sets the URL to download. To be added. To be added. diff --git a/xml/Microsoft.Build.Tasks/RoslynCodeTaskFactory.xml b/xml/Microsoft.Build.Tasks/RoslynCodeTaskFactory.xml index c9f438f8e92..51ce27eefb5 100644 --- a/xml/Microsoft.Build.Tasks/RoslynCodeTaskFactory.xml +++ b/xml/Microsoft.Build.Tasks/RoslynCodeTaskFactory.xml @@ -61,8 +61,8 @@ - To be added. - To be added. + The task to clean up. + Cleans up any context or state that may have been built up for a given task. To be added. @@ -89,9 +89,9 @@ - To be added. - To be added. - To be added. + The task factory logging host will log messages in the context of the task. + Creates an instance of the task to be used. + The generated task, or if the task failed to be created. To be added. @@ -115,8 +115,8 @@ System.String - To be added. - To be added. + Gets the name of the factory. + The name of the factory. To be added. @@ -141,8 +141,8 @@ - To be added. - To be added. + Get the descriptions for all the task's parameters. + A non- array of property descriptions. To be added. diff --git a/xml/Microsoft.Build.Tasks/Unzip.xml b/xml/Microsoft.Build.Tasks/Unzip.xml index b5e6ceabaa4..4a0d423a886 100644 --- a/xml/Microsoft.Build.Tasks/Unzip.xml +++ b/xml/Microsoft.Build.Tasks/Unzip.xml @@ -64,7 +64,7 @@ - To be added. + Instructs the task to exit as soon as possible, or to immediately exit if Execute is invoked after this method. To be added. @@ -91,9 +91,7 @@ Microsoft.Build.Framework.ITaskItem - - Gets or sets a with a destination folder path to unzip the files to. - + Gets or sets a with a destination folder path to unzip the files to. To be added. To be added. @@ -114,9 +112,7 @@ System.String - - Gets or sets an MSBuild glob expression that will be used to determine which files to exclude from being unzipped from the archive. - + Gets or sets an MSBuild glob expression that will be used to determine which files to exclude from being unzipped from the archive. To be added. To be added. @@ -141,8 +137,8 @@ - To be added. - To be added. + This method is called by the build engine to begin task execution. A task uses the return value to indicate whether it was successful. If a task throws an exception out of this method, the engine will automatically assume that the task has failed. + , if successful; otherwise. To be added. @@ -163,9 +159,7 @@ System.String - - Gets or sets an MSBuild glob expression that will be used to determine which files to include being unzipped from the archive. - + Gets or sets an MSBuild glob expression that will be used to determine which files to include being unzipped from the archive. To be added. To be added. @@ -186,9 +180,7 @@ System.Boolean - - Gets or sets a value indicating whether read-only files should be overwritten. - + Gets or sets a value indicating whether read-only files should be overwritten. To be added. To be added. @@ -209,9 +201,7 @@ System.Boolean - - Gets or sets a value indicating whether files should be skipped if the destination is unchanged. - + Gets or sets a value indicating whether files should be skipped if the destination is unchanged. To be added. To be added. @@ -238,9 +228,7 @@ Microsoft.Build.Framework.ITaskItem[] - - Gets or sets an array of objects containing the paths to .zip archive files to unzip. - + Gets or sets an array of objects containing the paths to .zip archive files to unzip. To be added. To be added. diff --git a/xml/Microsoft.Extensions.Configuration.EnvironmentVariables/EnvironmentVariablesConfigurationProvider.xml b/xml/Microsoft.Extensions.Configuration.EnvironmentVariables/EnvironmentVariablesConfigurationProvider.xml index edbe5df2802..9163734cb51 100644 --- a/xml/Microsoft.Extensions.Configuration.EnvironmentVariables/EnvironmentVariablesConfigurationProvider.xml +++ b/xml/Microsoft.Extensions.Configuration.EnvironmentVariables/EnvironmentVariablesConfigurationProvider.xml @@ -126,8 +126,8 @@ - To be added. - To be added. + Generates a string representing this provider name and relevant details. + The configuration name. To be added. diff --git a/xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml b/xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml index 3a010817a5f..0e0aa449190 100644 --- a/xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml +++ b/xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml @@ -93,8 +93,7 @@ - - + To be added. Adds the user secrets configuration source. Searches the assembly from for an instance of . @@ -121,8 +120,7 @@ - - + To be added. The assembly with the . Adds the user secrets configuration source. @@ -150,10 +148,8 @@ - - - - + To be added. + To be added. Adds the user secrets configuration source with specified secrets id. To be added. @@ -186,8 +182,7 @@ The type from the assembly to search for an instance of . - - + To be added. Adds the user secrets configuration source. Searches the assembly that contains type for an instance of . @@ -304,9 +299,10 @@ - To be added. + The section to enumerate. Determines whether the section has a or has children. - To be added. + + if the section has values or children; otherwise, . To be added. @@ -365,7 +361,7 @@ - To be added. + The configuration to enumerate. The key of the configuration section. Gets a configuration sub-section with the specified key. The . diff --git a/xml/Microsoft.Extensions.Primitives/StringValues.xml b/xml/Microsoft.Extensions.Primitives/StringValues.xml index f03e2ef6cd2..5347c770e4e 100644 --- a/xml/Microsoft.Extensions.Primitives/StringValues.xml +++ b/xml/Microsoft.Extensions.Primitives/StringValues.xml @@ -853,8 +853,9 @@ In application code, this field is most commonly used to safely represent a To be added. To be added. - To be added. - To be added. + Determines whether the specified and objects have the same values. + + if the value of is the same as the value of ; otherwise, . If is , the method returns . To be added. @@ -888,8 +889,9 @@ In application code, this field is most commonly used to safely represent a To be added. To be added. - To be added. - To be added. + Determines whether the specified and string array objects have the same values. + + if the value of is the same as the value of ; otherwise, . To be added. @@ -959,8 +961,9 @@ In application code, this field is most commonly used to safely represent a To be added. To be added. - To be added. - To be added. + Determines whether the specified and objects have the same values. + + if the value of is the same as the value of ; otherwise, . If is , the method returns . To be added. @@ -994,8 +997,9 @@ In application code, this field is most commonly used to safely represent a To be added. To be added. - To be added. - To be added. + Determines whether the specified string array and objects have the same values. + + if the value of is the same as the value of ; otherwise, . To be added. diff --git a/xml/System.Activities.Presentation.Model/ModelItemCollection.xml b/xml/System.Activities.Presentation.Model/ModelItemCollection.xml index 4fc79e118a1..cf5942ed1b9 100644 --- a/xml/System.Activities.Presentation.Model/ModelItemCollection.xml +++ b/xml/System.Activities.Presentation.Model/ModelItemCollection.xml @@ -806,7 +806,15 @@ The number of elements contained in the is synchronized (thread safe). if access to the is synchronized (thread safe); otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -836,7 +844,15 @@ Gets an object that can be used to synchronize access to the . An object that can be used to synchronize access to the . - To be added. + + instance is cast to an interface. + + ]]> + @@ -872,7 +888,15 @@ Returns an enumerator that iterates through a collection. An enumerator that can be used to iterate through the collection. - To be added. + + instance is cast to an interface. + + ]]> + @@ -930,7 +954,15 @@ Removes all items from the . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1055,7 +1087,15 @@ Gets a value that indicates whether the has a fixed size. if the has a fixed size; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1086,7 +1126,15 @@ Gets a value that indicates whether the is read-only. if the is read-only; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Activities.Presentation.Model/ModelItemDictionary.xml b/xml/System.Activities.Presentation.Model/ModelItemDictionary.xml index 9eafbd13b4a..e0bf23dd4f0 100644 --- a/xml/System.Activities.Presentation.Model/ModelItemDictionary.xml +++ b/xml/System.Activities.Presentation.Model/ModelItemDictionary.xml @@ -880,7 +880,15 @@ Gets a value that indicates whether access to the is synchronized (thread safe). if access to the is synchronized (thread safe); otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -910,7 +918,15 @@ Gets an object that can be used to synchronize access to the . An object that can be used to synchronize access to the . - To be added. + + instance is cast to an interface. + + ]]> + @@ -969,7 +985,15 @@ Removes all elements from the object. - To be added. + + instance is cast to an interface. + + ]]> + @@ -1029,7 +1053,15 @@ Returns the object for the object. An object for the object. - To be added. + + instance is cast to an interface. + + ]]> + @@ -1060,7 +1092,15 @@ Gets a value that indicates whether the object has a fixed size. if the object has a fixed size; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1091,7 +1131,15 @@ Gets a value that indicates whether the object is read-only. if the object is read-only; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1143,7 +1191,15 @@ Gets an object that contains the keys of the object. An object that contains the keys of the object. - To be added. + + instance is cast to an interface. + + ]]> + @@ -1201,7 +1257,15 @@ Gets an object that contains the values in the object. An object that contains the values in the object. - To be added. + + instance is cast to an interface. + + ]]> + @@ -1237,7 +1301,15 @@ Returns an enumerator that iterates through a collection. An object that can be used to iterate through the collection. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Activities.Presentation.Model/ModelMemberCollection`2.xml b/xml/System.Activities.Presentation.Model/ModelMemberCollection`2.xml index 4d38ccdaada..72cad14c3bd 100644 --- a/xml/System.Activities.Presentation.Model/ModelMemberCollection`2.xml +++ b/xml/System.Activities.Presentation.Model/ModelMemberCollection`2.xml @@ -266,7 +266,15 @@ Returns an enumerator that iterates through a collection. Returns . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Activities.Presentation.PropertyEditing/PropertyEntryCollection.xml b/xml/System.Activities.Presentation.PropertyEditing/PropertyEntryCollection.xml index eac16b3cc4b..7ff6f8af683 100644 --- a/xml/System.Activities.Presentation.PropertyEditing/PropertyEntryCollection.xml +++ b/xml/System.Activities.Presentation.PropertyEditing/PropertyEntryCollection.xml @@ -172,7 +172,15 @@ Returns an object that iterates all of the instances in this collection. An object that can be used to iterate through collection of instances. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Activities.Presentation.PropertyEditing/PropertyValueCollection.xml b/xml/System.Activities.Presentation.PropertyEditing/PropertyValueCollection.xml index 3dfc1b53bd4..9da06f60353 100644 --- a/xml/System.Activities.Presentation.PropertyEditing/PropertyValueCollection.xml +++ b/xml/System.Activities.Presentation.PropertyEditing/PropertyValueCollection.xml @@ -358,7 +358,15 @@ Returns a strongly typed for a collection of objects. An object that can be used to iterate through the collection. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Activities.Presentation/ContextItemManager.xml b/xml/System.Activities.Presentation/ContextItemManager.xml index 025bdfc1b29..c22c97055da 100644 --- a/xml/System.Activities.Presentation/ContextItemManager.xml +++ b/xml/System.Activities.Presentation/ContextItemManager.xml @@ -422,7 +422,15 @@ Enumerates the context items in the editing context. Returns . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Activities.Presentation/ServiceManager.xml b/xml/System.Activities.Presentation/ServiceManager.xml index e018ccd5a45..dacf993c8b4 100644 --- a/xml/System.Activities.Presentation/ServiceManager.xml +++ b/xml/System.Activities.Presentation/ServiceManager.xml @@ -495,7 +495,15 @@ Retrieves an enumerator that can be used to enumerate all of the services that this service manager publishes. Returns , which contains an enumeration of published services. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Activities/ExecutionProperties.xml b/xml/System.Activities/ExecutionProperties.xml index 9946915b0ca..03bd21ab6e8 100644 --- a/xml/System.Activities/ExecutionProperties.xml +++ b/xml/System.Activities/ExecutionProperties.xml @@ -251,7 +251,15 @@ Returns an enumerator that iterates through the collection of properties. An enumerator that iterates through the collection of properties. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.ComponentModel.Design.Serialization/DesignerSerializationManager.xml b/xml/System.ComponentModel.Design.Serialization/DesignerSerializationManager.xml index 3c6fbfc10fa..2e5554e2307 100644 --- a/xml/System.ComponentModel.Design.Serialization/DesignerSerializationManager.xml +++ b/xml/System.ComponentModel.Design.Serialization/DesignerSerializationManager.xml @@ -1159,7 +1159,15 @@ Implements the property. A containing the properties to be serialized. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.ComponentModel.Design/DesignerCollection.xml b/xml/System.ComponentModel.Design/DesignerCollection.xml index 5fda2edb4ad..b2912415846 100644 --- a/xml/System.ComponentModel.Design/DesignerCollection.xml +++ b/xml/System.ComponentModel.Design/DesignerCollection.xml @@ -418,7 +418,15 @@ Gets a value indicating whether access to the is synchronized (thread safe). if access to the is synchronized (thread safe); otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -457,7 +465,15 @@ Gets an object that can be used to synchronize access to the collection. An object that can be used to synchronize access to the collection. - To be added. + + instance is cast to an interface. + + ]]> + @@ -504,7 +520,15 @@ Gets a new enumerator for this collection. An that enumerates the collection. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.ComponentModel.Design/EventBindingService.xml b/xml/System.ComponentModel.Design/EventBindingService.xml index b570b11ae07..e3189a0cfc4 100644 --- a/xml/System.ComponentModel.Design/EventBindingService.xml +++ b/xml/System.ComponentModel.Design/EventBindingService.xml @@ -619,7 +619,15 @@ Displays the user code for the designer. if the code is displayed; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Device.Location/GeoCoordinateWatcher.xml b/xml/System.Device.Location/GeoCoordinateWatcher.xml index 2331f70964c..51661036d40 100644 --- a/xml/System.Device.Location/GeoCoordinateWatcher.xml +++ b/xml/System.Device.Location/GeoCoordinateWatcher.xml @@ -816,7 +816,15 @@ Indicates that the property, the property, or the property has changed. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Dynamic/ExpandoObject.xml b/xml/System.Dynamic/ExpandoObject.xml index dc499f2b26a..b35f222ecf4 100644 --- a/xml/System.Dynamic/ExpandoObject.xml +++ b/xml/System.Dynamic/ExpandoObject.xml @@ -946,7 +946,15 @@ End Module Returns an enumerator that iterates through the collection. An that can be used to iterate through the collection. - To be added. + + instance is cast to an interface. + + ]]> + @@ -986,7 +994,15 @@ End Module Occurs when a property value changes. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.IO.Compression/BrotliStream.xml b/xml/System.IO.Compression/BrotliStream.xml index 730250bd201..edf8479d892 100644 --- a/xml/System.IO.Compression/BrotliStream.xml +++ b/xml/System.IO.Compression/BrotliStream.xml @@ -836,9 +836,14 @@ If the operation is canceled before it completes, the returned task contains the - To be added. - To be added. + Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. + The unsigned byte cast to an , or -1 if at the end of the stream. To be added. + Cannot perform read operations on a constructed with . + +-or- + + returned more bytes than requested in read. @@ -1101,9 +1106,14 @@ If the operation is canceled before it completes, the returned task contains the - To be added. - To be added. + The byte to write to the stream. + Writes a byte to the current position in the stream and advances the position within the stream by one byte. To be added. + Cannot perform write operations on a constructed with . + +-or- + +The encoder ran into invalid data. diff --git a/xml/System.IdentityModel.Tokens/SecurityKeyIdentifier.xml b/xml/System.IdentityModel.Tokens/SecurityKeyIdentifier.xml index a86680b5c05..9bd85212a68 100644 --- a/xml/System.IdentityModel.Tokens/SecurityKeyIdentifier.xml +++ b/xml/System.IdentityModel.Tokens/SecurityKeyIdentifier.xml @@ -473,7 +473,15 @@ Returns an enumerator that iterates through the collection of key identifier clauses. A that can be used to iterate through the collection. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Messaging/MessageEnumerator.xml b/xml/System.Messaging/MessageEnumerator.xml index de2c45e9d17..82e65744989 100644 --- a/xml/System.Messaging/MessageEnumerator.xml +++ b/xml/System.Messaging/MessageEnumerator.xml @@ -726,7 +726,15 @@ For more information, see [Finalize Methods and Destructors](https://docs.micros Returns a that references the message at the current cursor position. A that references the message at the current cursor position. - To be added. + + instance is cast to an interface. + + ]]> + You accessed this property before the first call to . The cursor is located before the first element of the message enumeration.-or- You accessed this property after a call to had returned false (indicating the cursor is located after the last element of the message enumeration.) The message the enumerator is currently pointing to no longer exists. It might have been deleted. diff --git a/xml/System.Messaging/MessageQueueEnumerator.xml b/xml/System.Messaging/MessageQueueEnumerator.xml index d18c70eecbd..06659bcc31d 100644 --- a/xml/System.Messaging/MessageQueueEnumerator.xml +++ b/xml/System.Messaging/MessageQueueEnumerator.xml @@ -372,7 +372,15 @@ For more information, see [Finalize Methods and Destructors](https://docs.micros Gets the current of the enumeration. The queue at which the cursor is currently positioned. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Numerics/Vector.xml b/xml/System.Numerics/Vector.xml index 54c9a9ec471..fff35304404 100644 --- a/xml/System.Numerics/Vector.xml +++ b/xml/System.Numerics/Vector.xml @@ -229,12 +229,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The type of the input vector. + The type of the vector should be reinterpreted as. + The vector to reinterpret. + Reinterprets a as a new . + + reinterpreted as a new . To be added. + The type of () or the type of the target () is not supported. @@ -285,6 +287,7 @@ Reinterprets the bits of a specified vector into those of a vector of unsigned bytes. The reinterpreted vector. To be added. + The type of () is not supported. @@ -335,6 +338,7 @@ Reinterprets the bits of a specified vector into those of a double-precision floating-point vector. The reinterpreted vector. To be added. + The type of () is not supported. @@ -385,6 +389,7 @@ Reinterprets the bits of a specified vector into those of a vector of 16-bit integers. The reinterpreted vector. To be added. + The type of () is not supported. @@ -435,6 +440,7 @@ Reinterprets the bits of a specified vector into those of a vector of integers. The reinterpreted vector. To be added. + The type of () is not supported. @@ -485,6 +491,7 @@ Reinterprets the bits of a specified vector into those of a vector of long integers. The reinterpreted vector. To be added. + The type of () is not supported. @@ -518,11 +525,13 @@ - To be added. - To be added. - To be added. - To be added. + The type of the input vector. + The vector to reinterpret. + Reinterprets the bits of a specified vector into those of a vector of native-sized integers. + + reinterpreted as a new . To be added. + The type of () is not supported. @@ -562,11 +571,13 @@ - To be added. - To be added. - To be added. - To be added. + The type of the input vector. + The vector to reinterpret. + Reinterprets the bits of a specified vector into those of a vector of native-sized, unsigned integers. + + reinterpreted as a new . To be added. + The type of () is not supported. @@ -623,6 +634,7 @@ Reinterprets the bits of a specified vector into those of a vector of signed bytes. The reinterpreted vector. To be added. + The type of () is not supported. @@ -673,6 +685,7 @@ Reinterprets the bits of a specified vector into those of a single-precision floating-point vector. The reinterpreted vector. To be added. + The type of () is not supported. @@ -729,6 +742,7 @@ Reinterprets the bits of a specified vector into those of a vector of unsigned 16-bit integers. The reinterpreted vector. To be added. + The type of () is not supported. @@ -785,6 +799,7 @@ Reinterprets the bits of a specified vector into those of a vector of unsigned integers. The reinterpreted vector. To be added. + The type of () is not supported. @@ -841,6 +856,7 @@ Reinterprets the bits of a specified vector into those of a vector of unsigned long integers. The reinterpreted vector. To be added. + The type of () is not supported. @@ -2658,11 +2674,11 @@ Note that this method returns a instead of an integral type if vector operations are subject to hardware acceleration; otherwise, . - @@ -3616,8 +3632,8 @@ Note that this method returns a instead of an integral type The first source vector, whose elements become the lower-index elements of the return value. The second source vector, whose elements become the higher-index elements of the return value. - To be added. - To be added. + The source vector that will be narrowed to the lower half of the result vector. + The source vector that will be narrowed to the upper half of the result vector. Narrows two Vector<Double> instances into one Vector<Single>. A Vector<Single> containing elements narrowed from the source vectors. To be added. @@ -3666,8 +3682,8 @@ Note that this method returns a instead of an integral type The first source vector, whose elements become the lower-index elements of the return value. The second source vector, whose elements become the higher-index elements of the return value. - To be added. - To be added. + The source vector that will be narrowed to the lower half of the result vector. + The source vector that will be narrowed to the upper half of the result vector. Narrows two Vector<Int16> instances into one Vector<SByte>. A Vector<SByte> containing elements narrowed from the source vectors. To be added. @@ -3710,8 +3726,8 @@ Note that this method returns a instead of an integral type The first source vector, whose elements become the lower-index elements of the return value. The second source vector, whose elements become the higher-index elements of the return value. - To be added. - To be added. + The source vector that will be narrowed to the lower half of the result vector. + The source vector that will be narrowed to the upper half of the result vector. Narrows two Vector<Int32> instances into one Vector<Int16>. A Vector<Int16> containing elements narrowed from the source vectors. To be added. @@ -3754,8 +3770,8 @@ Note that this method returns a instead of an integral type The first source vector, whose elements become the lower-index elements of the return value. The second source vector, whose elements become the higher-index elements of the return value. - To be added. - To be added. + The source vector that will be narrowed to the lower half of the result vector. + The source vector that will be narrowed to the upper half of the result vector. Narrows two Vector<Int64> instances into one Vector<Int32>. A Vector<Int32> containing elements narrowed from the source vectors. To be added. @@ -3804,8 +3820,8 @@ Note that this method returns a instead of an integral type The first source vector, whose elements become the lower-index elements of the return value. The second source vector, whose elements become the higher-index elements of the return value. - To be added. - To be added. + The source vector that will be narrowed to the lower half of the result vector. + The source vector that will be narrowed to the upper half of the result vector. Narrows two Vector<UInt16> instances into one Vector<Byte>. A Vector<Byte> containing elements narrowed from the source vectors. To be added. @@ -3854,8 +3870,8 @@ Note that this method returns a instead of an integral type The first source vector, whose elements become the lower-index elements of the return value. The second source vector, whose elements become the higher-index elements of the return value. - To be added. - To be added. + The source vector that will be narrowed to the lower half of the result vector. + The source vector that will be narrowed to the upper half of the result vector. Narrows two Vector<UInt32> instances into one Vector<UInt16>. A Vector<UInt16> containing elements narrowed from the source vectors. To be added. @@ -3904,8 +3920,8 @@ Note that this method returns a instead of an integral type The first source vector, whose elements become the lower-index elements of the return value. The second source vector, whose elements become the higher-index elements of the return value. - To be added. - To be added. + The source vector that will be narrowed to the lower half of the result vector. + The source vector that will be narrowed to the upper half of the result vector. Narrows two Vector<UInt64> instances into one Vector<UInt32>. A Vector<UInt32> containing elements narrowed from the source vectors. To be added. @@ -4144,10 +4160,10 @@ Note that this method returns a instead of an integral type - To be added. - To be added. - To be added. - To be added. + The type of the elements to sum.. + A vector containing the objects of type to sum. + Returns the sum of all the elements inside the specified vector. + The sum of all elements inside the vector. To be added. @@ -4194,10 +4210,10 @@ Note that this method returns a instead of an integral type The source vector whose elements are widened into the outputs. - The first output vector, whose elements will contain the widened elements from lower indices in the source vector. - The second output vector, whose elements will contain the widened elements from higher indices in the source vector. - To be added. - To be added. + When this method returns, contains the widened elements from lower indices in the source vector. + >When this method returns, contains the widened elements from higher indices in the source vector. + When this method returns, contains the widened result of the lower half of . + When this method returns, contains the widened result of the upper half of . Widens a Vector<Byte> into two Vector<UInt16> instances. To be added. @@ -4241,8 +4257,8 @@ Note that this method returns a instead of an integral type The source vector whose elements are widened into the outputs. The first output vector, whose elements will contain the widened elements from lower indices in the source vector. The second output vector, whose elements will contain the widened elements from higher indices in the source vector. - To be added. - To be added. + When this method returns, contains the widened result of the lower half of . + When this method returns, contains the widened result of the upper half of . Widens a Vector<Int16> into two Vector<Int32> instances. To be added. @@ -4286,8 +4302,8 @@ Note that this method returns a instead of an integral type The source vector whose elements are widened into the outputs. The first output vector, whose elements will contain the widened elements from lower indices in the source vector. The second output vector, whose elements will contain the widened elements from higher indices in the source vector. - To be added. - To be added. + When this method returns, contains the widened result of the lower half of . + When this method returns, contains the widened result of the upper half of . Widens a Vector<Int32> into two Vector<Int64> instances. To be added. @@ -4337,8 +4353,8 @@ Note that this method returns a instead of an integral type The source vector whose elements are widened into the outputs. The first output vector, whose elements will contain the widened elements from lower indices in the source vector. The second output vector, whose elements will contain the widened elements from higher indices in the source vector. - To be added. - To be added. + When this method returns, contains the widened result of the lower half of . + When this method returns, contains the widened result of the upper half of . Widens a Vector<SByte> into two Vector<Int16> instances. To be added. @@ -4382,8 +4398,8 @@ Note that this method returns a instead of an integral type The source vector whose elements are widened into the outputs. The first output vector, whose elements will contain the widened elements from lower indices in the source vector. The second output vector, whose elements will contain the widened elements from higher indices in the source vector. - To be added. - To be added. + When this method returns, contains the widened result of the lower half of . + When this method returns, contains the widened result of the upper half of . Widens a Vector<Single> into two Vector<Double> instances. To be added. @@ -4433,8 +4449,8 @@ Note that this method returns a instead of an integral type The source vector whose elements are widened into the outputs. The first output vector, whose elements will contain the widened elements from lower indices in the source vector. The second output vector, whose elements will contain the widened elements from higher indices in the source vector. - To be added. - To be added. + When this method returns, contains the widened result of the lower half of . + When this method returns, contains the widened result of the upper half of . Widens a Vector<UInt16> into two Vector<UInt32> instances. To be added. @@ -4484,8 +4500,8 @@ Note that this method returns a instead of an integral type The source vector whose elements are widened into the outputs. The first output vector, whose elements will contain the widened elements from lower indices in the source vector. The second output vector, whose elements will contain the widened elements from higher indices in the source vector. - To be added. - To be added. + When this method returns, contains the widened result of the lower half of . + When this method returns, contains the widened result of the upper half of . Widens a Vector<UInt32> into two Vector<UInt64> instances. To be added. diff --git a/xml/System.Numerics/Vector2.xml b/xml/System.Numerics/Vector2.xml index c6d5ab86473..fb43d138701 100644 --- a/xml/System.Numerics/Vector2.xml +++ b/xml/System.Numerics/Vector2.xml @@ -90,8 +90,8 @@ - To be added. - To be added. + The span of elements to assign to the vector. + Constructs a vector from the given . The span must contain at least two elements. To be added. @@ -373,6 +373,8 @@ The number of elements in the current instance is greater than in the array. is multidimensional. + + is . @@ -406,9 +408,10 @@ - To be added. - To be added. + The destination span into which the values are copied. + Copies the vector to the given .The length of the destination span must be at least 2. To be added. + The number of elements in the source vector is greater than the number of elements available in destination span. @@ -476,6 +479,8 @@ is greater than or equal to the array length. is multidimensional. + + is . @@ -2499,9 +2504,10 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi - To be added. - To be added. - To be added. + The destination span into which the values are copied. + Attempts to copy the vector to the given . The length of the destination span must be at least 2. + + if the source vector was successfully copied to . if is not large enough to hold the source vector. To be added. diff --git a/xml/System.Numerics/Vector3.xml b/xml/System.Numerics/Vector3.xml index c1490448684..f5284dd0a81 100644 --- a/xml/System.Numerics/Vector3.xml +++ b/xml/System.Numerics/Vector3.xml @@ -90,8 +90,8 @@ - To be added. - To be added. + The span of elements to assign to the vector. + Constructs a vector from the given . The span must contain at least 3 elements. To be added. @@ -415,6 +415,8 @@ The number of elements in the current instance is greater than in the array. is multidimensional. + + is . @@ -448,9 +450,10 @@ - To be added. - To be added. + The destination span into which the values are copied. + Copies the vector to the given . The length of the destination span must be at least 3. To be added. + The number of elements in the source vector is greater than the number of elements available in the destination span. @@ -518,6 +521,8 @@ is greater than or equal to the array length. is multidimensional. + + is . @@ -2478,9 +2483,10 @@ - To be added. - To be added. - To be added. + The destination span into which the values are copied. + Attempts to copy the vector to the given . The length of the destination span must be at least 3. + + if the source vector was successfully copied to . if is not large enough to hold the source vector. To be added. diff --git a/xml/System.Numerics/Vector4.xml b/xml/System.Numerics/Vector4.xml index e2547287129..e7ae3fbbfee 100644 --- a/xml/System.Numerics/Vector4.xml +++ b/xml/System.Numerics/Vector4.xml @@ -90,8 +90,8 @@ - To be added. - To be added. + The span of elements to assign to the vector. + Constructs a vector from the given . The span must contain at least 4 elements. To be added. @@ -459,6 +459,8 @@ The number of elements in the current instance is greater than in the array. is multidimensional. + + is . @@ -492,9 +494,10 @@ - To be added. - To be added. + The destination span which the values are copied into. + Copies the vector to the given . The length of the destination span must be at least 4. To be added. + The number of elements in the source vector is greater than the number of elements available in the destination span. @@ -562,6 +565,8 @@ is greater than or equal to the array length. is multidimensional. + + is . @@ -2581,9 +2586,10 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi - To be added. - To be added. - To be added. + The destination span which the values are copied into. + Attempts to copy the vector to the given . The length of the destination span must be at least 4. + + if the source vector was successfully copied to . if is not large enough to hold the source vector. To be added. diff --git a/xml/System.Numerics/Vector`1.xml b/xml/System.Numerics/Vector`1.xml index d36cf2a921d..bff81e3a565 100644 --- a/xml/System.Numerics/Vector`1.xml +++ b/xml/System.Numerics/Vector`1.xml @@ -153,6 +153,7 @@ The type `T` can be any of the following numeric types: did not contain at least elements. .NET 5 and later: Type is not supported. + The length of is less than sizeof(). @@ -191,6 +192,7 @@ The type `T` can be any of the following numeric types: did not contain at least elements. .NET 5 and later: Type is not supported. + The length of is less than . @@ -231,6 +233,7 @@ The type `T` can be any of the following numeric types: did not contain at least elements. .NET 5 and later: Type is not supported. + The length of is less than . @@ -313,6 +316,9 @@ The type `T` can be any of the following numeric types: is . .NET 5 and later: Type is not supported. + + is . + The length of is less than . @@ -367,6 +373,9 @@ The type `T` can be any of the following numeric types: The length of minus is less than . .NET 5 and later: Type is not supported. + + is . + The length of , starting from , is less than . @@ -498,6 +507,8 @@ The type `T` can be any of the following numeric types: is . The number of elements in the current vector is greater than the number of elements available in the array. .NET 5 and later: Type is not supported. + + is . @@ -557,6 +568,8 @@ The type `T` can be any of the following numeric types: is less than zero or greater than the last index in . .NET 5 and later: Type is not supported. + + is . @@ -805,6 +818,8 @@ The type `T` can be any of the following numeric types: is greater than or equal to . .NET 5 and later: Type is not supported. + + was less than zero or greater than the number of elements. @@ -1395,10 +1410,12 @@ The type `T` can be any of the following numeric types: - To be added. - To be added. - To be added. + The vector to reinterpret. + Reinterprets the bits of a source vector into a vector of native-sized integers. + + reinterpreted as a new . To be added. + The type of () is not supported. @@ -1688,10 +1705,12 @@ The type `T` can be any of the following numeric types: - To be added. - To be added. - To be added. + The vector to reinterpret. + Reinterprets the bits of a source vector into a vector of native-sized, unsigned integers. + + reinterpreted as a new . To be added. + The type of () is not supported. diff --git a/xml/System.Resources.Extensions/DeserializingResourceReader.xml b/xml/System.Resources.Extensions/DeserializingResourceReader.xml index fe4ee9200da..688d582a314 100644 --- a/xml/System.Resources.Extensions/DeserializingResourceReader.xml +++ b/xml/System.Resources.Extensions/DeserializingResourceReader.xml @@ -190,7 +190,15 @@ Returns an enumerator for this object. An enumerator for this object. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Resources/ResourceSet.xml b/xml/System.Resources/ResourceSet.xml index cf1a0afdc32..3bffb5f6b43 100644 --- a/xml/System.Resources/ResourceSet.xml +++ b/xml/System.Resources/ResourceSet.xml @@ -976,7 +976,15 @@ Returns an object to avoid a race condition with . This member is not intended to be used directly from your code. An enumerator for the current object. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Security.Cryptography/AsymmetricAlgorithm.xml b/xml/System.Security.Cryptography/AsymmetricAlgorithm.xml index 7c4dd5a81f8..4de63ded870 100644 --- a/xml/System.Security.Cryptography/AsymmetricAlgorithm.xml +++ b/xml/System.Security.Cryptography/AsymmetricAlgorithm.xml @@ -864,6 +864,37 @@ Because each algorithm may have algorithm-specific PEM labels, the default behav ]]> A derived type has not overridden this member. + + does not contain a PEM-encoded key with a recognized label. + +-or- + + contains multiple PEM-encoded keys with a recognized label. + + + + The password is incorrect. + +-or- + +The base-64 decoded contents of the PEM text from + do not represent an ASN.1-BER-encoded PKCS#8 EncryptedPrivateKeyInfo structure. + +-or- + +The base-64 decoded contents of the PEM text from + indicate the key is for an algorithm other than the algorithm + represented by this instance. + +-or- + +The base-64 decoded contents of the PEM text from + represent the key in a format that is not supported. + +-or- + +The algorithm-specific key import failed. + @@ -903,6 +934,37 @@ Because each algorithm may have algorithm-specific PEM labels, the default behav ]]> A derived type has not overridden this member. + + does not contain a PEM-encoded key with a recognized label. + +-or- + + contains multiple PEM-encoded keys with a recognized label. + + + + The password is incorrect. + +-or- + +The base-64 decoded contents of the PEM text from + do not represent an ASN.1-BER-encoded PKCS#8 EncryptedPrivateKeyInfo structure. + +-or- + +The base-64 decoded contents of the PEM text from + indicate the key is for an algorithm other than the algorithm + represented by this instance. + +-or- + +The base-64 decoded contents of the PEM text from + represent the key in a format that is not supported. + +-or- + +The algorithm-specific key import failed. + @@ -940,6 +1002,17 @@ Because each algorithm may have algorithm-specific PEM labels, the default behav ]]> A derived type has not overridden this member. + + does not contain a PEM-encoded key with a recognized label. + +-or- + + contains multiple PEM-encoded keys with a recognized label. + +-or- + + contains an encrypted PEM-encoded key. + diff --git a/xml/System.Speech.Recognition/SemanticValue.xml b/xml/System.Speech.Recognition/SemanticValue.xml index bcf9d4835f1..d3cd53fa985 100644 --- a/xml/System.Speech.Recognition/SemanticValue.xml +++ b/xml/System.Speech.Recognition/SemanticValue.xml @@ -1219,7 +1219,15 @@ newGrammar.SpeechRecognized += Returns an enumerator that iterates through a collection. Returns an enumerator that iterates through a collection. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Text.Json.Serialization.Metadata/JsonCollectionInfoValues`1.xml b/xml/System.Text.Json.Serialization.Metadata/JsonCollectionInfoValues`1.xml index 2cdcaf8b653..33f0aa6bf81 100644 --- a/xml/System.Text.Json.Serialization.Metadata/JsonCollectionInfoValues`1.xml +++ b/xml/System.Text.Json.Serialization.Metadata/JsonCollectionInfoValues`1.xml @@ -17,7 +17,7 @@ - To be added. + The collection type. Provides serialization metadata about a collection type. This API is for use by the output of the System.Text.Json source generator and should not be called directly. @@ -55,9 +55,17 @@ System.Text.Json.Serialization.Metadata.JsonTypeInfo - To be added. + A instance representing the element type. To be added. - To be added. + + + @@ -76,9 +84,17 @@ System.Text.Json.Serialization.Metadata.JsonTypeInfo - To be added. + If a dictionary type, the instance representing the key type. To be added. - To be added. + + + @@ -97,9 +113,17 @@ System.Text.Json.Serialization.JsonNumberHandling - To be added. + The option to apply to number collection elements. To be added. - To be added. + + + @@ -118,9 +142,17 @@ System.Func<TCollection> - To be added. + A to create an instance of the collection when deserializing. To be added. - To be added. + + + @@ -139,9 +171,17 @@ System.Action<System.Text.Json.Utf8JsonWriter,TCollection> - To be added. + An optimized serialization implementation assuming pre-determined defaults. To be added. - To be added. + + + diff --git a/xml/System.Text.Json.Serialization.Metadata/JsonMetadataServices.xml b/xml/System.Text.Json.Serialization.Metadata/JsonMetadataServices.xml index 5e2e9766819..c14524ad646 100644 --- a/xml/System.Text.Json.Serialization.Metadata/JsonMetadataServices.xml +++ b/xml/System.Text.Json.Serialization.Metadata/JsonMetadataServices.xml @@ -36,7 +36,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -57,7 +65,15 @@ Gets an object that converts byte array values. To be added. - To be added. + + + @@ -78,7 +94,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -99,7 +123,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -125,12 +157,20 @@ - To be added. - To be added. - To be added. + The generic definition of the element type. + The to use. + Provides serialization metadata about the collection type. Creates serialization metadata for an array. - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -161,13 +201,21 @@ - To be added. - To be added. + The generic definition of the type. + The generic definition of the element type. To be added. - To be added. + Provides serialization metadata about the collection type. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -198,13 +246,21 @@ - To be added. - To be added. + The generic definition of the type. + The generic definition of the element type. To be added. - To be added. + Provides serialization metadata about the collection type. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -236,14 +292,22 @@ - To be added. - To be added. - To be added. + The generic definition of the type. + The generic definition of the key type. + The generic definition of the value type. To be added. - To be added. + Provides serialization metadata about the collection type. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -274,13 +338,21 @@ - To be added. - To be added. + The generic definition of the type. + The generic definition of the element type. To be added. - To be added. + Provides serialization metadata about the collection type. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -310,12 +382,20 @@ - To be added. + The generic definition of the type. To be added. - To be added. + Provides serialization metadata about the collection type. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -347,14 +427,22 @@ - To be added. - To be added. - To be added. + The generic definition of the type. + The generic definition of the key type. + The generic definition of the value type. To be added. - To be added. + Provides serialization metadata about the collection type. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -384,12 +472,20 @@ - To be added. + The generic definition of the type. To be added. - To be added. + Provides serialization metadata about the collection type. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -420,13 +516,21 @@ - To be added. - To be added. + The generic definition of the type. + The generic definition of the element type. To be added. - To be added. + Provides serialization metadata about the collection type. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -456,12 +560,20 @@ - To be added. + The generic definition of the type. To be added. - To be added. + Provides serialization metadata about the collection type. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -492,13 +604,21 @@ - To be added. - To be added. + The generic definition of the type. + The generic definition of the element type. To be added. - To be added. + Provides serialization metadata about the collection type. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -531,15 +651,23 @@ - To be added. - To be added. - To be added. + The generic definition of the type. + The generic definition of the key type. + The generic definition of the value type. To be added. - To be added. - To be added. + Provides serialization metadata about the collection type. + A method to create an immutable dictionary instance. Creates metadata for and types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -571,14 +699,22 @@ - To be added. - To be added. + The generic definition of the type. + The generic definition of the element type. To be added. - To be added. - To be added. + Provides serialization metadata about the collection type. + A method to create an immutable dictionary instance. Creates metadata for non-dictionary immutable collection types. - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -610,14 +746,22 @@ - To be added. - To be added. - To be added. + The generic definition of the type. + The generic definition of the key type. + The generic definition of the value type. To be added. - To be added. + Provides serialization metadata about the collection type. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -648,13 +792,21 @@ - To be added. - To be added. + The generic definition of the type. + The generic definition of the element type. To be added. - To be added. + Provides serialization metadata about the collection type. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -685,13 +837,21 @@ - To be added. - To be added. - To be added. - To be added. + The generic definition of the type. + The generic definition of the element type. + The to use. + Provides serialization metadata about the collection type. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -722,7 +882,15 @@ Provides serialization metadata about an object type with constructors, properties, and fields. Creates metadata for a complex class or struct. A instance representing the class or struct. - To be added. + + + or is . @@ -752,10 +920,18 @@ The type that the converter for the property returns or accepts when converting JSON data. The options to initialize the metadata with. - To be added. + Provides serialization metadata about the property or field. Creates metadata for a property or field. A instance initialized with the provided metadata. - To be added. + + + @@ -786,13 +962,21 @@ - To be added. + The generic definition of the type. To be added. - To be added. - To be added. + Provides serialization metadata about the collection type. + A method for adding elements to the collection when using the serializer's code-paths. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -823,13 +1007,21 @@ - To be added. - To be added. + The generic definition of the type. + The generic definition of the element type. To be added. - To be added. + Provides serialization metadata about the collection type. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -860,13 +1052,21 @@ - To be added. + The generic definition of the type. To be added. - To be added. - To be added. + Provides serialization metadata about the collection type. + A method for adding elements to the collection when using the serializer's code-paths. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -897,13 +1097,21 @@ - To be added. - To be added. + The generic definition of the type. + The generic definition of the element type. To be added. - To be added. + Provides serialization metadata about the collection type. Creates metadata for types assignable to . - To be added. - To be added. + Serialization metadata for the given type. + + + @@ -934,7 +1142,15 @@ To be added. Creates metadata for a primitive or a type with a custom converter. A instance representing the type. - To be added. + + + @@ -955,7 +1171,15 @@ Gets an object that converts values. An instance that converts values. - To be added. + + + @@ -976,7 +1200,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -997,7 +1229,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -1018,7 +1258,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -1052,8 +1300,16 @@ The generic definition for the enum type. The to use for serialization and deserialization. Creates a instance that converts values. - To be added. - To be added. + A instance that converts values. + + + @@ -1087,8 +1343,16 @@ The generic definition for the underlying nullable type. Serialization metadata for the underlying nullable type. Creates a instance that converts values. - To be added. - To be added. + A instance that converts values + + + @@ -1111,10 +1375,18 @@ - To be added. + The generic definition for the type. Gets a type converter that throws a . - To be added. - To be added. + A instance that throws + + + @@ -1135,7 +1407,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -1156,7 +1436,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -1177,7 +1465,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -1198,7 +1494,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -1217,9 +1521,17 @@ System.Text.Json.Serialization.JsonConverter<System.Text.Json.Nodes.JsonArray> - Gets an object that converts values. + Gets an object that converts values. To be added. - To be added. + + + @@ -1240,7 +1552,15 @@ Gets a JSON converter that converts values. To be added. - To be added. + + + @@ -1259,9 +1579,17 @@ System.Text.Json.Serialization.JsonConverter<System.Text.Json.Nodes.JsonNode> - Gets an object that converts values. + Gets an object that converts values. To be added. - To be added. + + + @@ -1280,9 +1608,17 @@ System.Text.Json.Serialization.JsonConverter<System.Text.Json.Nodes.JsonObject> - Gets an object that converts values. + Gets an object that converts values. To be added. - To be added. + + + @@ -1301,9 +1637,17 @@ System.Text.Json.Serialization.JsonConverter<System.Text.Json.Nodes.JsonValue> - Gets an object that converts values. + Gets an object that converts values. To be added. - To be added. + + + @@ -1324,7 +1668,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -1351,7 +1703,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -1372,7 +1732,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -1393,7 +1761,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -1414,7 +1790,15 @@ Gets a JSON converter that converts values. To be added. - To be added. + + + @@ -1441,7 +1825,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -1468,7 +1860,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -1495,7 +1895,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -1516,7 +1924,15 @@ Gets an object that converts values. To be added. - To be added. + + + @@ -1537,7 +1953,15 @@ Gets an object that converts values. To be added. - To be added. + + + diff --git a/xml/System.Text.Json.Serialization.Metadata/JsonObjectInfoValues`1.xml b/xml/System.Text.Json.Serialization.Metadata/JsonObjectInfoValues`1.xml index e1b53580340..a81a1ed22a1 100644 --- a/xml/System.Text.Json.Serialization.Metadata/JsonObjectInfoValues`1.xml +++ b/xml/System.Text.Json.Serialization.Metadata/JsonObjectInfoValues`1.xml @@ -19,7 +19,15 @@ The object type to serialize or deserialize. Provides serialization metadata about an object type with constructors, properties, and fields. - To be added. + + + @@ -57,7 +65,15 @@ Provides a mechanism to initialize metadata for a parameterized constructor of the class or struct to be used when deserializing. To be added. - To be added. + + + @@ -78,7 +94,15 @@ Gets or sets an object that specifies how number properties and fields should be processed when serializing and deserializing. To be added. - To be added. + + + @@ -99,7 +123,15 @@ Gets or sets a mechanism to create an instance of the class or struct using a parameterless constructor during deserialization. To be added. - To be added. + + + @@ -120,7 +152,15 @@ Gets or sets a mechanism to create an instance of the class or struct using a parameterized constructor during deserialization. To be added. - To be added. + + + @@ -141,7 +181,15 @@ Gets or sets a mechanism to initialize metadata for properties and fields of the class or struct. To be added. - To be added. + + + @@ -162,7 +210,15 @@ Gets or sets a serialization implementation for instances of the class or struct that assumes options specified by . To be added. - To be added. + + + diff --git a/xml/System.Text.Json.Serialization.Metadata/JsonParameterInfoValues.xml b/xml/System.Text.Json.Serialization.Metadata/JsonParameterInfoValues.xml index bcb9a1c9542..111b3ef46a5 100644 --- a/xml/System.Text.Json.Serialization.Metadata/JsonParameterInfoValues.xml +++ b/xml/System.Text.Json.Serialization.Metadata/JsonParameterInfoValues.xml @@ -15,7 +15,15 @@ Provides information about a constructor parameter required for JSON deserialization. - To be added. + + + @@ -53,7 +61,15 @@ Gets or sets the default value of the parameter. To be added. - To be added. + + + @@ -74,7 +90,15 @@ Gets or sets a value that specifies whether a default value was specified for the parameter. To be added. - To be added. + + + @@ -95,7 +119,15 @@ Gets or sets the name of the parameter. To be added. - To be added. + + + @@ -116,7 +148,15 @@ Gets or sets the type of the parameter. To be added. - To be added. + + + @@ -137,7 +177,15 @@ Gets or sets the zero-based position of the parameter in the formal parameter list. To be added. - To be added. + + + diff --git a/xml/System.Text.Json.Serialization.Metadata/JsonPropertyInfoValues`1.xml b/xml/System.Text.Json.Serialization.Metadata/JsonPropertyInfoValues`1.xml index 0800922f9d5..53633838efb 100644 --- a/xml/System.Text.Json.Serialization.Metadata/JsonPropertyInfoValues`1.xml +++ b/xml/System.Text.Json.Serialization.Metadata/JsonPropertyInfoValues`1.xml @@ -17,8 +17,8 @@ - To be added. - To be added. + The type to convert of the for the property. + Provides serialization metadata about a property or field. To be added. @@ -55,7 +55,7 @@ System.Text.Json.Serialization.JsonConverter<T> - To be added. + A for the property or field, specified by . To be added. To be added. @@ -76,7 +76,7 @@ System.Type - To be added. + The declaring type of the property or field. To be added. To be added. @@ -97,7 +97,7 @@ System.Func<System.Object,T> - To be added. + Provides a mechanism to get the property or field's value. To be added. To be added. @@ -118,7 +118,7 @@ System.Boolean - To be added. + Whether the property was annotated with . To be added. To be added. @@ -139,7 +139,7 @@ System.Nullable<System.Text.Json.Serialization.JsonIgnoreCondition> - To be added. + Specifies a condition for the member to be ignored. To be added. To be added. @@ -160,7 +160,7 @@ System.Boolean - To be added. + Whether the property was annotated with . To be added. To be added. @@ -181,7 +181,7 @@ System.Boolean - To be added. + If , indicates that the member is a property, otherwise indicates the member is a field. To be added. To be added. @@ -202,7 +202,7 @@ System.Boolean - To be added. + Whether the property or field is public. To be added. To be added. @@ -223,7 +223,7 @@ System.Boolean - To be added. + Whether the property or field is a virtual property. To be added. To be added. @@ -244,7 +244,7 @@ System.String - To be added. + The name to be used when processing the property or field, specified by . To be added. To be added. @@ -265,7 +265,7 @@ System.Nullable<System.Text.Json.Serialization.JsonNumberHandling> - To be added. + If the property or field is a number, specifies how it should processed when serializing and deserializing. To be added. To be added. @@ -286,7 +286,7 @@ System.String - To be added. + The name of the property or field. To be added. To be added. @@ -307,7 +307,7 @@ System.Text.Json.Serialization.Metadata.JsonTypeInfo - To be added. + The info for the property or field's type. To be added. To be added. @@ -328,7 +328,7 @@ System.Action<System.Object,T> - To be added. + Provides a mechanism to set the property or field's value. To be added. To be added. diff --git a/xml/System.Text.Json.Serialization.Metadata/JsonTypeInfo.xml b/xml/System.Text.Json.Serialization.Metadata/JsonTypeInfo.xml index 83fdd4c3d41..386bc249139 100644 --- a/xml/System.Text.Json.Serialization.Metadata/JsonTypeInfo.xml +++ b/xml/System.Text.Json.Serialization.Metadata/JsonTypeInfo.xml @@ -15,7 +15,15 @@ Provides JSON serialization-related metadata about a type. - To be added. + + + diff --git a/xml/System.Text.Json.Serialization.Metadata/JsonTypeInfo`1.xml b/xml/System.Text.Json.Serialization.Metadata/JsonTypeInfo`1.xml index 88d7cab5850..715e20055fd 100644 --- a/xml/System.Text.Json.Serialization.Metadata/JsonTypeInfo`1.xml +++ b/xml/System.Text.Json.Serialization.Metadata/JsonTypeInfo`1.xml @@ -40,7 +40,15 @@ Serializes an instance of using values specified at design time. To be added. - To be added. + + + diff --git a/xml/System.Text.Json.Serialization/JsonSerializerContext.xml b/xml/System.Text.Json.Serialization/JsonSerializerContext.xml index 815016b377e..0e2278a7e65 100644 --- a/xml/System.Text.Json.Serialization/JsonSerializerContext.xml +++ b/xml/System.Text.Json.Serialization/JsonSerializerContext.xml @@ -34,9 +34,18 @@ - To be added. - To be added. - To be added. + The run time provided options for the context instance. + Creates an instance of and binds it with the indicated . + + , + or until is called, where a new options instance is created and bound. + + ]]> + diff --git a/xml/System.Transactions/CommittableTransaction.xml b/xml/System.Transactions/CommittableTransaction.xml index d100789845a..842adc6226c 100644 --- a/xml/System.Transactions/CommittableTransaction.xml +++ b/xml/System.Transactions/CommittableTransaction.xml @@ -428,7 +428,15 @@ Gets the object provided as the last parameter of the method call. The object provided as the last parameter of the method call. - To be added. + + instance is cast to an interface. + + ]]> + @@ -467,7 +475,15 @@ Gets a that is used to wait for an asynchronous operation to complete. A that is used to wait for an asynchronous operation to complete. - To be added. + + instance is cast to an interface. + + ]]> + @@ -507,7 +523,15 @@ Gets an indication of whether the asynchronous commit operation completed synchronously. if the asynchronous commit operation completed synchronously; otherwise, . This property always returns even if the operation completed synchronously. - To be added. + + instance is cast to an interface. + + ]]> + @@ -547,7 +571,15 @@ Gets an indication whether the asynchronous commit operation has completed. if the operation is complete; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -580,9 +612,9 @@ - To be added. - To be added. - To be added. + The to populate with data. + The destination (see ) for this serialization. + Populates a with the data needed to serialize the target object. To be added. diff --git a/xml/System.Transactions/DependentTransaction.xml b/xml/System.Transactions/DependentTransaction.xml index 22378c7f51c..c02d88b9fc8 100644 --- a/xml/System.Transactions/DependentTransaction.xml +++ b/xml/System.Transactions/DependentTransaction.xml @@ -156,9 +156,9 @@ - To be added. - To be added. - To be added. + The to populate with data. + The destination (see ) for this serialization. + Populates a with the data needed to serialize the target object. To be added. diff --git a/xml/System.Web.Caching/Cache.xml b/xml/System.Web.Caching/Cache.xml index 299ee78fcc9..e6b6e66e3a8 100644 --- a/xml/System.Web.Caching/Cache.xml +++ b/xml/System.Web.Caching/Cache.xml @@ -816,7 +816,15 @@ Returns an enumerator that can iterate through the object collection. An enumerator that can iterate through the object collection. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.Compilation/ClientBuildManager.xml b/xml/System.Web.Compilation/ClientBuildManager.xml index a3f954d98c1..73223b71056 100644 --- a/xml/System.Web.Compilation/ClientBuildManager.xml +++ b/xml/System.Web.Compilation/ClientBuildManager.xml @@ -1181,7 +1181,15 @@ Terminates the current ASP.NET application. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.DynamicData/DynamicFilter.xml b/xml/System.Web.DynamicData/DynamicFilter.xml index e3ffe381790..5ea5cd8b78d 100644 --- a/xml/System.Web.DynamicData/DynamicFilter.xml +++ b/xml/System.Web.DynamicData/DynamicFilter.xml @@ -417,9 +417,9 @@ - To be added. - To be added. - To be added. + The data source query. + Returns the filter repeater. + The filter. To be added. @@ -445,8 +445,8 @@ - To be added. - To be added. + The data source. + Initializes the data source. To be added. diff --git a/xml/System.Web.DynamicData/FilterUserControlBase.xml b/xml/System.Web.DynamicData/FilterUserControlBase.xml index fb5299982f3..a8c8c8a0873 100644 --- a/xml/System.Web.DynamicData/FilterUserControlBase.xml +++ b/xml/System.Web.DynamicData/FilterUserControlBase.xml @@ -276,7 +276,15 @@ Gets the data column that is filtered. The data column that is filtered. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.DynamicData/QueryableFilterRepeater.xml b/xml/System.Web.DynamicData/QueryableFilterRepeater.xml index 4435a4bb402..df8577a56b0 100644 --- a/xml/System.Web.DynamicData/QueryableFilterRepeater.xml +++ b/xml/System.Web.DynamicData/QueryableFilterRepeater.xml @@ -310,9 +310,9 @@ - To be added. - To be added. - To be added. + The data source query. + Returns the filter repeater. + The filter. To be added. @@ -338,8 +338,8 @@ - To be added. - To be added. + The data source. + Initializes the data source. To be added. diff --git a/xml/System.Web.Handlers/ScriptModule.xml b/xml/System.Web.Handlers/ScriptModule.xml index 15aef18ebfa..6f828e8624d 100644 --- a/xml/System.Web.Handlers/ScriptModule.xml +++ b/xml/System.Web.Handlers/ScriptModule.xml @@ -146,7 +146,15 @@ Performs application-defined tasks that are associated with freeing, releasing, or resetting unmanaged resources. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.Mobile/ErrorHandlerModule.xml b/xml/System.Web.Mobile/ErrorHandlerModule.xml index 4b58c249af8..5c61435c028 100644 --- a/xml/System.Web.Mobile/ErrorHandlerModule.xml +++ b/xml/System.Web.Mobile/ErrorHandlerModule.xml @@ -76,7 +76,15 @@ Disposes of the resources (other than memory) used by the module. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. - To be added. + + instance is cast to an interface. + + ]]> + Best Practices for Handling Exceptions Server Event Handling in ASP.NET Web Pages diff --git a/xml/System.Web.Services.Description/BasicProfileViolationEnumerator.xml b/xml/System.Web.Services.Description/BasicProfileViolationEnumerator.xml index 709da5fbefd..f327188ff53 100644 --- a/xml/System.Web.Services.Description/BasicProfileViolationEnumerator.xml +++ b/xml/System.Web.Services.Description/BasicProfileViolationEnumerator.xml @@ -164,7 +164,15 @@ Gets the current element in the . The current element in the collection. - To be added. + + instance is cast to an interface. + + ]]> + @@ -189,7 +197,15 @@ Sets the enumerator to its initial position, which is before the first element in the . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.DataVisualization.Charting/ChartHttpHandler.xml b/xml/System.Web.UI.DataVisualization.Charting/ChartHttpHandler.xml index 6e5300d04aa..5f9b837f5d0 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/ChartHttpHandler.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/ChartHttpHandler.xml @@ -91,7 +91,15 @@ Gets a value indicating whether another request can use the object. if the object is reusable; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.HtmlControls/HtmlInputCheckBox.xml b/xml/System.Web.UI.HtmlControls/HtmlInputCheckBox.xml index c1162549e01..312b549948d 100644 --- a/xml/System.Web.UI.HtmlControls/HtmlInputCheckBox.xml +++ b/xml/System.Web.UI.HtmlControls/HtmlInputCheckBox.xml @@ -449,7 +449,15 @@ Implements the method by calling the method. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.HtmlControls/HtmlInputHidden.xml b/xml/System.Web.UI.HtmlControls/HtmlInputHidden.xml index eceafb58b01..119a4fd3cc2 100644 --- a/xml/System.Web.UI.HtmlControls/HtmlInputHidden.xml +++ b/xml/System.Web.UI.HtmlControls/HtmlInputHidden.xml @@ -386,7 +386,15 @@ Implements the interface method by calling the method. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.HtmlControls/HtmlInputImage.xml b/xml/System.Web.UI.HtmlControls/HtmlInputImage.xml index 78ede56c9bc..57bcd088fb3 100644 --- a/xml/System.Web.UI.HtmlControls/HtmlInputImage.xml +++ b/xml/System.Web.UI.HtmlControls/HtmlInputImage.xml @@ -755,7 +755,15 @@ Implements the interface method by calling the method. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.HtmlControls/HtmlInputText.xml b/xml/System.Web.UI.HtmlControls/HtmlInputText.xml index 1a49fafeb5c..8892aad60db 100644 --- a/xml/System.Web.UI.HtmlControls/HtmlInputText.xml +++ b/xml/System.Web.UI.HtmlControls/HtmlInputText.xml @@ -573,7 +573,15 @@ Implements the interface method by calling the method. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.MobileControls/ObjectListField.xml b/xml/System.Web.UI.MobileControls/ObjectListField.xml index d79a98f14ba..dec97c03e84 100644 --- a/xml/System.Web.UI.MobileControls/ObjectListField.xml +++ b/xml/System.Web.UI.MobileControls/ObjectListField.xml @@ -252,7 +252,8 @@ For a description of this member, see . This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. - To be added. + + if a server control is tracking its view state changes; otherwise, . For a description of this member, see . This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. - To be added. + + if a server control is tracking its view state changes; otherwise, . For a description of this member, see . This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. - To be added. + + if a server control is tracking its view state changes; otherwise, . For a description of this member, see . This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. - To be added. + The object that contains the view state changes. This method is added only to implement the interface. - To be added. + + instance is cast to an interface. + + ]]> + @@ -295,7 +303,15 @@ This method is added only to implement the interface. - To be added. + + instance is cast to an interface. + + ]]> + @@ -326,7 +342,15 @@ Implements the interface and calls the method. - To be added. + + instance is cast to an interface. + + ]]> + @@ -351,7 +375,15 @@ This method is added only to implement the interface. - To be added. + + instance is cast to an interface. + + ]]> + @@ -377,7 +409,15 @@ Gets a value that indicates whether the control tracks the status of its changes. if the Web Parts control is responsible for determining when the control is considered changed; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.WebControls.WebParts/Part.xml b/xml/System.Web.UI.WebControls.WebParts/Part.xml index 2045dcac350..b6efa8551fe 100644 --- a/xml/System.Web.UI.WebControls.WebParts/Part.xml +++ b/xml/System.Web.UI.WebControls.WebParts/Part.xml @@ -330,7 +330,15 @@ Allows the developer of a designer for a composite part control to recreate the control's child controls on the design surface. - To be added. + + instance is cast to an interface. + + ]]> + ASP.NET Web Parts Controls diff --git a/xml/System.Web.UI.WebControls.WebParts/WebPartMenuStyle.xml b/xml/System.Web.UI.WebControls.WebParts/WebPartMenuStyle.xml index 9472b3c0b3d..4d5d5e79728 100644 --- a/xml/System.Web.UI.WebControls.WebParts/WebPartMenuStyle.xml +++ b/xml/System.Web.UI.WebControls.WebParts/WebPartMenuStyle.xml @@ -336,7 +336,15 @@ Returns a collection of custom attributes for this instance of a component. Implements the method. An containing the attributes for this object. - To be added. + + instance is cast to an interface. + + ]]> + ASP.NET Web Parts Controls @@ -363,7 +371,15 @@ Returns the class name of this instance of a component. This method implements the method. A string that contains the class name of the object, or if the class has no name. - To be added. + + instance is cast to an interface. + + ]]> + ASP.NET Web Parts Controls @@ -390,7 +406,15 @@ Returns the name of this instance of a component. This method implements the method. A string that contains the object name, or if the object has no name. - To be added. + + instance is cast to an interface. + + ]]> + ASP.NET Web Parts Controls @@ -417,7 +441,15 @@ Returns a type converter for this instance of a component. This method implements the method. A used for this object, or if there is no . - To be added. + + instance is cast to an interface. + + ]]> + ASP.NET Web Parts Controls @@ -538,7 +570,15 @@ Returns the events for this instance of a component. This method implements the method overload. An that represents the events for this object. - To be added. + + instance is cast to an interface. + + ]]> + ASP.NET Web Parts Controls @@ -605,7 +645,15 @@ Returns the properties for this instance of a component. This method implements the method overload. A that represents the properties for this object. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.WebControls/CompositeControl.xml b/xml/System.Web.UI.WebControls/CompositeControl.xml index 39109cf628b..fff74732523 100644 --- a/xml/System.Web.UI.WebControls/CompositeControl.xml +++ b/xml/System.Web.UI.WebControls/CompositeControl.xml @@ -270,7 +270,15 @@ Enables a designer to recreate the composite control's collection of child controls in the design-time environment. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.WebControls/DataControlField.xml b/xml/System.Web.UI.WebControls/DataControlField.xml index 747179f5d3a..15c77b07c0f 100644 --- a/xml/System.Web.UI.WebControls/DataControlField.xml +++ b/xml/System.Web.UI.WebControls/DataControlField.xml @@ -1126,7 +1126,15 @@ Gets or sets the schema associated with this object. The schema associated with this . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1158,7 +1166,15 @@ Gets a value indicating whether the object is saving changes to its view state. to indicate that the is saving changes to its view state; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1226,7 +1242,15 @@ Saves the changes made to the view state since the time the page was posted back to the server. An that contains the saved view state values for the control. - To be added. + + instance is cast to an interface. + + ]]> + @@ -1258,7 +1282,15 @@ Causes the object to track changes to its view state so they can be stored in the control's property and persisted across requests for the same page. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.WebControls/DataGridColumn.xml b/xml/System.Web.UI.WebControls/DataGridColumn.xml index b601eb18631..49f42826bcd 100644 --- a/xml/System.Web.UI.WebControls/DataGridColumn.xml +++ b/xml/System.Web.UI.WebControls/DataGridColumn.xml @@ -836,7 +836,15 @@ Returns an object containing state changes. The that contains the view state changes. - To be added. + + instance is cast to an interface. + + ]]> + @@ -868,7 +876,15 @@ Starts tracking state changes. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.WebControls/DataGridColumnCollection.xml b/xml/System.Web.UI.WebControls/DataGridColumnCollection.xml index 61592d4beb1..8637f4345cf 100644 --- a/xml/System.Web.UI.WebControls/DataGridColumnCollection.xml +++ b/xml/System.Web.UI.WebControls/DataGridColumnCollection.xml @@ -857,7 +857,15 @@ Returns an object containing state changes. An that contains the saved view state values for the control. - To be added. + + instance is cast to an interface. + + ]]> + @@ -883,7 +891,15 @@ Starts tracking state changes. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.WebControls/DataKey.xml b/xml/System.Web.UI.WebControls/DataKey.xml index 27d3294dafc..daf2fede69d 100644 --- a/xml/System.Web.UI.WebControls/DataKey.xml +++ b/xml/System.Web.UI.WebControls/DataKey.xml @@ -173,7 +173,8 @@ The object to compare to the current . object. Determines whether the specified array is equal to the current data key. - To be added. + + if the current object is equal to the parameter; otherwise, . To be added. diff --git a/xml/System.Web.UI.WebControls/DataList.xml b/xml/System.Web.UI.WebControls/DataList.xml index 50e3ddfc72e..70c0abbcbb6 100644 --- a/xml/System.Web.UI.WebControls/DataList.xml +++ b/xml/System.Web.UI.WebControls/DataList.xml @@ -3404,7 +3404,8 @@ For a description of this member, see . - To be added. + + if the list control contains a footer section; otherwise, . For a description of this member, see . - To be added. + + if the list control contains a heading section; otherwise, . For a description of this member, see . - To be added. + + if the list control contains a separator; otherwise, . For a description of this member, see . - To be added. + The number of items in the list control. Raises events for the control on postback. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.WebControls/EntityDataSourceView.xml b/xml/System.Web.UI.WebControls/EntityDataSourceView.xml index e9b4c9491d3..b436951a6e6 100644 --- a/xml/System.Web.UI.WebControls/EntityDataSourceView.xml +++ b/xml/System.Web.UI.WebControls/EntityDataSourceView.xml @@ -587,7 +587,15 @@ Gets a value that indicates whether the object is saving changes to its view state. if the data source view is marked to save its state; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -641,7 +649,15 @@ Saves the changes to view state for the control since the time that the page was posted back to the server. The object that contains the changes to the control's view state, or ( in Visual Basic) if there is no view state associated with the object. - To be added. + + instance is cast to an interface. + + ]]> + @@ -666,7 +682,15 @@ Tracks view state changes. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.WebControls/ListItem.xml b/xml/System.Web.UI.WebControls/ListItem.xml index 5fa15918889..a340c0178a3 100644 --- a/xml/System.Web.UI.WebControls/ListItem.xml +++ b/xml/System.Web.UI.WebControls/ListItem.xml @@ -838,7 +838,15 @@ For a description of this member, see . if view state is being tracked; otherwise . The default is . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.WebControls/ListView.xml b/xml/System.Web.UI.WebControls/ListView.xml index 2fec29092dd..0b0c6828684 100644 --- a/xml/System.Web.UI.WebControls/ListView.xml +++ b/xml/System.Web.UI.WebControls/ListView.xml @@ -6866,7 +6866,15 @@ For a description of this member, see . - To be added. + + instance is cast to an interface. + + ]]> + ListView Web Server Control diff --git a/xml/System.Web.UI.WebControls/MenuItem.xml b/xml/System.Web.UI.WebControls/MenuItem.xml index 2a88f4b89f5..e4cadf3ec73 100644 --- a/xml/System.Web.UI.WebControls/MenuItem.xml +++ b/xml/System.Web.UI.WebControls/MenuItem.xml @@ -1475,7 +1475,15 @@ Saves the view-state changes to an . The that contains the view-state changes. - To be added. + + instance is cast to an interface. + + ]]> + ASP.NET State Management Overview diff --git a/xml/System.Web.UI.WebControls/MenuItemBinding.xml b/xml/System.Web.UI.WebControls/MenuItemBinding.xml index fc4534ba7ad..bed4fe376d0 100644 --- a/xml/System.Web.UI.WebControls/MenuItemBinding.xml +++ b/xml/System.Web.UI.WebControls/MenuItemBinding.xml @@ -1971,7 +1971,7 @@ For a description of this member, see . - To be added. + An object that represents the schema. Gets a value that indicates whether the object is saving changes to its view state. if the control is marked to save its state; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -2071,7 +2079,15 @@ Saves the view state changes to an . An that contains the view state changes. - To be added. + + instance is cast to an interface. + + ]]> + ASP.NET State Management Overview diff --git a/xml/System.Web.UI.WebControls/MenuItemCollection.xml b/xml/System.Web.UI.WebControls/MenuItemCollection.xml index f32222f2671..1d23c311054 100644 --- a/xml/System.Web.UI.WebControls/MenuItemCollection.xml +++ b/xml/System.Web.UI.WebControls/MenuItemCollection.xml @@ -891,7 +891,15 @@ Gets a value that indicates whether the object is saving changes to its view state. if the control is marked to save its state; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -951,7 +959,15 @@ Saves the changes to view state to an . The that contains the view state changes. - To be added. + + instance is cast to an interface. + + ]]> + ASP.NET State Management Overview diff --git a/xml/System.Web.UI.WebControls/MenuItemTemplateContainer.xml b/xml/System.Web.UI.WebControls/MenuItemTemplateContainer.xml index ff82d8d20b7..ffa0aa9fa21 100644 --- a/xml/System.Web.UI.WebControls/MenuItemTemplateContainer.xml +++ b/xml/System.Web.UI.WebControls/MenuItemTemplateContainer.xml @@ -228,7 +228,15 @@ Gets the menu item associated with the container. A object that represents the menu item associated with the container. - To be added. + + instance is cast to an interface. + + ]]> + @@ -259,7 +267,15 @@ Gets the index value of the object associated with the container. The index value of the object associated with the container. - To be added. + + instance is cast to an interface. + + ]]> + @@ -290,7 +306,15 @@ Gets the index value of the menu item for the container. The index value of the menu item for the container. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.WebControls/Parameter.xml b/xml/System.Web.UI.WebControls/Parameter.xml index 6fad7f9a5b7..cdc42c92717 100644 --- a/xml/System.Web.UI.WebControls/Parameter.xml +++ b/xml/System.Web.UI.WebControls/Parameter.xml @@ -1053,7 +1053,15 @@ Gets a value indicating whether the object is saving changes to its view state. if the data source view is marked to save its state; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1182,7 +1190,15 @@ Causes the object to track changes to its view state so they can be stored in the control's object and persisted across requests for the same page. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI.WebControls/TreeNode.xml b/xml/System.Web.UI.WebControls/TreeNode.xml index 7a7ed2c5c32..0a03ecaec2c 100644 --- a/xml/System.Web.UI.WebControls/TreeNode.xml +++ b/xml/System.Web.UI.WebControls/TreeNode.xml @@ -2024,7 +2024,15 @@ if( TreeView1.Nodes[0].Expanded == true ) { //some work here} Saves the view state changes to a . The that contains the view state changes. - To be added. + + instance is cast to an interface. + + ]]> + ASP.NET State Management Overview diff --git a/xml/System.Web.UI.WebControls/TreeNodeBinding.xml b/xml/System.Web.UI.WebControls/TreeNodeBinding.xml index 30d53314148..1eb76ba5548 100644 --- a/xml/System.Web.UI.WebControls/TreeNodeBinding.xml +++ b/xml/System.Web.UI.WebControls/TreeNodeBinding.xml @@ -1631,7 +1631,15 @@ Saves the view state changes to an object. The object that contains the view state changes. - To be added. + + instance is cast to an interface. + + ]]> + ASP.NET State Management Overview diff --git a/xml/System.Web.UI.WebControls/TreeNodeCollection.xml b/xml/System.Web.UI.WebControls/TreeNodeCollection.xml index e3425a45968..c9353374534 100644 --- a/xml/System.Web.UI.WebControls/TreeNodeCollection.xml +++ b/xml/System.Web.UI.WebControls/TreeNodeCollection.xml @@ -892,7 +892,15 @@ Gets a value indicating whether the object is saving changes to its view state. if the control is marked to save its state; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -953,7 +961,15 @@ Saves the changes to view state to a . The that contains the view state changes. - To be added. + + instance is cast to an interface. + + ]]> + ASP.NET State Management Overview diff --git a/xml/System.Web.UI.WebControls/WizardStepCollection.xml b/xml/System.Web.UI.WebControls/WizardStepCollection.xml index b6413570934..52fbbff6681 100644 --- a/xml/System.Web.UI.WebControls/WizardStepCollection.xml +++ b/xml/System.Web.UI.WebControls/WizardStepCollection.xml @@ -840,7 +840,15 @@ Gets a value indicating whether the collection has a fixed size. if the collection has a fixed size; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + Wizard Web Server Control diff --git a/xml/System.Web.UI/ScriptControl.xml b/xml/System.Web.UI/ScriptControl.xml index 989823e8b42..2b0a86802a3 100644 --- a/xml/System.Web.UI/ScriptControl.xml +++ b/xml/System.Web.UI/ScriptControl.xml @@ -191,7 +191,15 @@ When overridden in a derived class, registers the objects for the control. An collection of objects. - To be added. + + instance is cast to an interface. + + ]]> + @@ -223,7 +231,15 @@ When overridden in a derived class, registers script files for the control. An collection that contains ECMAScript (JavaScript) files that have been registered as embedded resources. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI/StateBag.xml b/xml/System.Web.UI/StateBag.xml index f86b3d9d526..8526d7639af 100644 --- a/xml/System.Web.UI/StateBag.xml +++ b/xml/System.Web.UI/StateBag.xml @@ -920,7 +920,15 @@ Gets a value indicating whether state changes are being tracked. if the is marked to save changes to its state; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1047,7 +1055,15 @@ Causes the object to track changes to its state so that it can be persisted across requests. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI/StateManagedCollection.xml b/xml/System.Web.UI/StateManagedCollection.xml index 0f33dfba197..1e8df1be8de 100644 --- a/xml/System.Web.UI/StateManagedCollection.xml +++ b/xml/System.Web.UI/StateManagedCollection.xml @@ -667,7 +667,15 @@ Gets a value indicating whether the collection is synchronized (thread safe). This method returns in all cases. in all cases. - To be added. + + instance is cast to an interface. + + ]]> + @@ -694,7 +702,15 @@ Gets an object that can be used to synchronize access to the collection. This method returns in all cases. in all cases. - To be added. + + instance is cast to an interface. + + ]]> + @@ -727,7 +743,15 @@ Returns an iterator that iterates through the collection. An that can be used to iterate through the . - To be added. + + instance is cast to an interface. + + ]]> + @@ -952,7 +976,15 @@ Gets a value indicating whether the collection has a fixed size. This method returns in all cases. in all cases. - To be added. + + instance is cast to an interface. + + ]]> + @@ -979,7 +1011,15 @@ Gets a value indicating whether the collection is read-only. if the is read-only; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1115,7 +1155,15 @@ Gets a value indicating whether the collection is saving changes to its view state. if the collection is marked to save its own state and the state of all the items it contains; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web.UI/UserControl.xml b/xml/System.Web.UI/UserControl.xml index 50ccddf45f0..8ca68a69c5a 100644 --- a/xml/System.Web.UI/UserControl.xml +++ b/xml/System.Web.UI/UserControl.xml @@ -940,7 +940,15 @@ Gets or sets the text that appears between the opening and closing tags of a user control. The text that appears between the opening and closing tabs of a user control. - To be added. + + instance is cast to an interface. + + ]]> + @@ -966,7 +974,15 @@ Gets or sets the full tag name of the user control. The full tag name of the user control. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Web/SiteMapNodeCollection.xml b/xml/System.Web/SiteMapNodeCollection.xml index dc35629e35c..0ef57dcbcc1 100644 --- a/xml/System.Web/SiteMapNodeCollection.xml +++ b/xml/System.Web/SiteMapNodeCollection.xml @@ -1221,7 +1221,15 @@ Gets a value indicating whether access to the interface is synchronized (thread safe). This class cannot be inherited. if access to the is synchronized (thread safe); otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1254,7 +1262,15 @@ Gets an object that can be used to synchronize access to the interface. This class cannot be inherited. An object that can be used to synchronize access to the . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1288,7 +1304,15 @@ Returns an enumerator that iterates through a collection. For a description of this member, see . An that can be used to iterate through the . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1352,7 +1376,15 @@ Removes all items from the collection in the interface. For a description of this member, see . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1481,7 +1513,15 @@ Gets a value indicating whether the collection has a fixed size. For a description of this member, see . if the is read-only; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1513,7 +1553,15 @@ Gets a value indicating whether the collection is read-only. For a description of this member, see . if the is read-only; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Workflow.Activities/ActiveDirectoryRole.xml b/xml/System.Workflow.Activities/ActiveDirectoryRole.xml index ee4ed61d79c..3e971828d79 100644 --- a/xml/System.Workflow.Activities/ActiveDirectoryRole.xml +++ b/xml/System.Workflow.Activities/ActiveDirectoryRole.xml @@ -404,7 +404,15 @@ Releases all resources used by the . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Workflow.Activities/OperationParameterInfoCollection.xml b/xml/System.Workflow.Activities/OperationParameterInfoCollection.xml index dc1362866d9..8ca679acea3 100644 --- a/xml/System.Workflow.Activities/OperationParameterInfoCollection.xml +++ b/xml/System.Workflow.Activities/OperationParameterInfoCollection.xml @@ -825,7 +825,15 @@ Gets a value indicating whether access to the is synchronized (thread safe). if access to the is synchronized (thread safe); otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -850,7 +858,15 @@ Gets an object that can be used to synchronize access to the . An object that can be used to synchronize access to the . - To be added. + + instance is cast to an interface. + + ]]> + @@ -876,7 +892,15 @@ Returns an enumerator that iterates through a collection. An object that can be used to iterate through the collection. - To be added. + + instance is cast to an interface. + + ]]> + @@ -930,7 +954,15 @@ Removes all items from the . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1045,7 +1077,15 @@ Gets a value indicating whether the has a fixed size. if the has a fixed size; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1071,7 +1111,15 @@ Gets a value indicating whether the is read-only. if the is read-only; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Workflow.ComponentModel.Design/ActivityDesigner.xml b/xml/System.Workflow.ComponentModel.Design/ActivityDesigner.xml index 6096e127c74..1cf8fd968d5 100644 --- a/xml/System.Workflow.ComponentModel.Design/ActivityDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/ActivityDesigner.xml @@ -3369,7 +3369,15 @@ Gets the design-time verbs associated with the activity designer. The design-time verbs associated with the activity designer. - To be added. + + instance is cast to an interface. + + ]]> + @@ -3760,7 +3768,15 @@ Gets or sets the that requested the activity designer be initialized. The that requested the activity designer be initialized. - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Workflow.ComponentModel.Design/Connector.xml b/xml/System.Workflow.ComponentModel.Design/Connector.xml index a4076218159..4140bc144e4 100644 --- a/xml/System.Workflow.ComponentModel.Design/Connector.xml +++ b/xml/System.Workflow.ComponentModel.Design/Connector.xml @@ -639,7 +639,15 @@ Releases all resources used by the . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Workflow.ComponentModel.Design/WorkflowTheme.xml b/xml/System.Workflow.ComponentModel.Design/WorkflowTheme.xml index 1ca6082cc11..74029aea15c 100644 --- a/xml/System.Workflow.ComponentModel.Design/WorkflowTheme.xml +++ b/xml/System.Workflow.ComponentModel.Design/WorkflowTheme.xml @@ -799,7 +799,15 @@ Releases the managed resources used by the . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Workflow.ComponentModel/ActivityCollection.xml b/xml/System.Workflow.ComponentModel/ActivityCollection.xml index 78d037696db..e436b4b4465 100644 --- a/xml/System.Workflow.ComponentModel/ActivityCollection.xml +++ b/xml/System.Workflow.ComponentModel/ActivityCollection.xml @@ -1162,7 +1162,15 @@ Removes all from the . - To be added. + + instance is cast to an interface. + + ]]> + @@ -1311,7 +1319,15 @@ Gets a value indicating whether the is read-only. if the is read-only; otherwise, . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System.Workflow.ComponentModel/ActivityExecutionContext.xml b/xml/System.Workflow.ComponentModel/ActivityExecutionContext.xml index e2219692848..54aaf64ef59 100644 --- a/xml/System.Workflow.ComponentModel/ActivityExecutionContext.xml +++ b/xml/System.Workflow.ComponentModel/ActivityExecutionContext.xml @@ -307,7 +307,15 @@ Releases all resources used by the . - To be added. + + instance is cast to an interface. + + ]]> + diff --git a/xml/System/MemoryExtensions+TryWriteInterpolatedStringHandler.xml b/xml/System/MemoryExtensions+TryWriteInterpolatedStringHandler.xml index 4e405a29cf0..b1897600c31 100644 --- a/xml/System/MemoryExtensions+TryWriteInterpolatedStringHandler.xml +++ b/xml/System/MemoryExtensions+TryWriteInterpolatedStringHandler.xml @@ -85,7 +85,7 @@ The number of constant characters outside of interpolation expressions in the interpolated string. The number of interpolation expressions in the interpolated string. The destination buffer. - To be added. + An object that supplies culture-specific formatting information. Upon return, if the destination may be long enough to support the formatting, or if it won't be. Creates a handler used to write an interpolated string into a span of characters. This is intended to be called only by compiler-generated code. Arguments are not validated as they'd otherwise be for members intended to be used directly. diff --git a/xml/System/Uri.xml b/xml/System/Uri.xml index 2ffecd693ba..e18281c8811 100644 --- a/xml/System/Uri.xml +++ b/xml/System/Uri.xml @@ -67,37 +67,37 @@ Provides an object representation of a uniform resource identifier (URI) and easy access to the parts of the URI. - class defines the properties and methods for handling URIs, including parsing, comparing, and combining. The class properties are read-only; to create a modifiable object, use the class. - - Relative URIs (for example, "/new/index.htm") must be expanded with respect to a base URI so that they are absolute. The method is provided to convert absolute URIs to relative URIs when necessary. - - The constructors do not escape URI strings if the string is a well-formed URI including a scheme identifier. - - The properties return a canonical data representation in escaped encoding, with all characters with Unicode values greater than 127 replaced with their hexadecimal equivalents. To put the URI in canonical form, the constructor performs the following steps: - -- Converts the URI scheme to lowercase. - -- Converts the host name to lowercase. - -- If the host name is an IPv6 address, the canonical IPv6 address is used. ScopeId and other optional IPv6 data are removed. - + class defines the properties and methods for handling URIs, including parsing, comparing, and combining. The class properties are read-only; to create a modifiable object, use the class. + + Relative URIs (for example, "/new/index.htm") must be expanded with respect to a base URI so that they are absolute. The method is provided to convert absolute URIs to relative URIs when necessary. + + The constructors do not escape URI strings if the string is a well-formed URI including a scheme identifier. + + The properties return a canonical data representation in escaped encoding, with all characters with Unicode values greater than 127 replaced with their hexadecimal equivalents. To put the URI in canonical form, the constructor performs the following steps: + +- Converts the URI scheme to lowercase. + +- Converts the host name to lowercase. + +- If the host name is an IPv6 address, the canonical IPv6 address is used. ScopeId and other optional IPv6 data are removed. + - Removes default and empty port numbers. - + - Converts implicit file paths without the file:// scheme (for example, "C:\my\file") to explicit file paths with the file:// scheme. - + - Escaped characters (also known as percent-encoded octets) that don't have a reserved purpose are decoded (also known as being unescaped). These unreserved characters include uppercase and lowercase letters (%41-%5A and %61-%7A), decimal digits (%30-%39), hyphen (%2D), period (%2E), underscore (%5F), and tilde (%7E). - Canonicalizes the path for hierarchical URIs by compacting sequences such as /./, /../, and // (whether or not the sequence is escaped). Note that there are some schemes for which these sequences are not compacted. - -- For hierarchical URIs, if the host is not terminated with a forward slash (/), one is added. - + +- For hierarchical URIs, if the host is not terminated with a forward slash (/), one is added. + - By default, any reserved characters in the URI are escaped in accordance with RFC 2396. This behavior changes if International Resource Identifiers or International Domain Name parsing is enabled in which case reserved characters in the URI are escaped in accordance with RFC 3986 and RFC 3987. As part of canonicalization in the constructor for some schemes, dot-segments and empty segments (`/./`, `/../`, and `//`) are compacted (in other words, they are removed). The schemes for which compacts segments include http, https, tcp, net.pipe, and net.tcp. For some other schemes, these sequences are not compacted. The following code snippet shows how compacting looks in practice. The escaped sequences are unescaped, if necessary, and then compacted. - + ```csharp var uri = new Uri("http://myUrl/../.."); // http scheme, unescaped OR @@ -109,83 +109,83 @@ var uri = new Uri("ftp://myUrl/%2E%2E/%2E%2E"); // ftp scheme, escaped Console.WriteLine($"AbsoluteUri: {uri.AbsoluteUri}"); Console.WriteLine($"PathAndQuery: {uri.PathAndQuery}"); -``` +``` When this code executes, it returns output similar to the following text. -``` +``` AbsoluteUri: http://myurl/ PathAndQuery: / -``` - - You can transform the contents of the class from an escape encoded URI reference to a readable URI reference by using the method. Note that some reserved characters might still be escaped in the output of the method. This is to support unambiguous reconstruction of a URI from the value returned by . - - Some URIs include a fragment identifier or a query or both. A fragment identifier is any text that follows a number sign (#), not including the number sign; the fragment text is stored in the property. Query information is any text that follows a question mark (?) in the URI; the query text is stored in the property. - - In .NET Framework version 1.1, if the string specified to a constructor contains an unknown scheme and "c:\\", the Uri class inserts "//" after the colon. For example, the URI `xyz:c:\abc` is converted to `xyz://c:/abc`. In the .NET Framework version 2.0, this behavior has been removed, and the example string is converted to `xyz:c:/abc`. - +``` + + You can transform the contents of the class from an escape encoded URI reference to a readable URI reference by using the method. Note that some reserved characters might still be escaped in the output of the method. This is to support unambiguous reconstruction of a URI from the value returned by . + + Some URIs include a fragment identifier or a query or both. A fragment identifier is any text that follows a number sign (#), not including the number sign; the fragment text is stored in the property. Query information is any text that follows a question mark (?) in the URI; the query text is stored in the property. + + In .NET Framework version 1.1, if the string specified to a constructor contains an unknown scheme and "c:\\", the Uri class inserts "//" after the colon. For example, the URI `xyz:c:\abc` is converted to `xyz://c:/abc`. In the .NET Framework version 2.0, this behavior has been removed, and the example string is converted to `xyz:c:/abc`. + > [!NOTE] -> The URI class supports the use of IP addresses in both quad-notation for IPv4 protocol and colon-hexadecimal for IPv6 protocol. Remember to enclose the IPv6 address in square brackets, as in http://[::1]. - +> The URI class supports the use of IP addresses in both quad-notation for IPv4 protocol and colon-hexadecimal for IPv6 protocol. Remember to enclose the IPv6 address in square brackets, as in http://[::1]. + ## International Resource Identifier Support -Web addresses are typically expressed using uniform resource identifiers that consist of a very restricted set of characters: - -- Upper and lower case ASCII letters from the English alphabet. - -- Digits from 0 to 9. - -- A small number of other ASCII symbols. - - The specifications for URIs are documented in RFC 2396, RFC 2732, RFC 3986, and RFC 3987 published by the Internet Engineering Task Force (IETF). - - With the growth of the Internet, there is a growing need to identify resources using languages other than English. Identifiers which facilitate this need and allow non-ASCII characters (characters in the Unicode/ISO 10646 character set) are known as International Resource Identifiers (IRIs). The specifications for IRIs are documented in RFC 3987 published by IETF. Using IRIs allows a URL to contain Unicode characters. - - The existing class has been extended in .NET Framework v3.5, 3.0 SP1, and 2.0 SP1 to provide IRI support based on RFC 3987. Users of .NET Framework versions before version 4.5 will not see any change from the .NET Framework 2.0 behavior unless they specifically enable IRI. This ensures application compatibility with prior versions of .NET Framework. - +Web addresses are typically expressed using uniform resource identifiers that consist of a very restricted set of characters: + +- Upper and lower case ASCII letters from the English alphabet. + +- Digits from 0 to 9. + +- A small number of other ASCII symbols. + + The specifications for URIs are documented in RFC 2396, RFC 2732, RFC 3986, and RFC 3987 published by the Internet Engineering Task Force (IETF). + + With the growth of the Internet, there is a growing need to identify resources using languages other than English. Identifiers which facilitate this need and allow non-ASCII characters (characters in the Unicode/ISO 10646 character set) are known as International Resource Identifiers (IRIs). The specifications for IRIs are documented in RFC 3987 published by IETF. Using IRIs allows a URL to contain Unicode characters. + + The existing class has been extended in .NET Framework v3.5, 3.0 SP1, and 2.0 SP1 to provide IRI support based on RFC 3987. Users of .NET Framework versions before version 4.5 will not see any change from the .NET Framework 2.0 behavior unless they specifically enable IRI. This ensures application compatibility with prior versions of .NET Framework. + In .NET Framework 4.5 and later versions, IRI is always enabled and can't be changed using a configuration option. To enable support for IRI in .NET Framework versions prior to .NET Framework 4.5, set a configuration option in the *machine.config* or in the *app.config* file. Specify whether you want Internationalized Domain Name (IDN) parsing applied to the domain name and whether IRI parsing rules should be applied. For example: -```xml - - - - - - +```xml + + + + + + ``` - - Enabling IDN converts all Unicode labels in a domain name to their Punycode equivalents. Punycode names contain only ASCII characters and always start with the xn-- prefix. The reason for this is to support existing DNS servers on the Internet, since most DNS servers only support ASCII characters (see RFC 3940). - - Enabling IRI and IDN affects the value of the property. Enabling IRI and IDN can also change the behavior of the , , , and methods. - -There are three possible values for IDN depending on the DNS servers that are used: - + + Enabling IDN converts all Unicode labels in a domain name to their Punycode equivalents. Punycode names contain only ASCII characters and always start with the xn-- prefix. The reason for this is to support existing DNS servers on the Internet, since most DNS servers only support ASCII characters (see RFC 3940). + + Enabling IRI and IDN affects the value of the property. Enabling IRI and IDN can also change the behavior of the , , , and methods. + +There are three possible values for IDN depending on the DNS servers that are used: + - idn enabled = All - This value will convert any Unicode domain names to their Punycode equivalents (IDN names). - + This value will convert any Unicode domain names to their Punycode equivalents (IDN names). + - idn enabled = AllExceptIntranet - This value will convert all Unicode domain names not on the local Intranet to use the Punycode equivalents (IDN names). In this case to handle international names on the local Intranet, the DNS servers that are used for the Intranet should support Unicode name resolution. - + This value will convert all Unicode domain names not on the local Intranet to use the Punycode equivalents (IDN names). In this case to handle international names on the local Intranet, the DNS servers that are used for the Intranet should support Unicode name resolution. + - idn enabled = None - This value will not convert any Unicode domain names to use Punycode. This is the default value which is consistent with the .NET Framework 2.0 behaviour. - - When IRI parsing is enabled (iriParsing enabled = `true`), normalization and character checking are done according to the latest IRI rules in RFC 3986 and RFC 3987. When IRI parsing is disabled, normalization and character checking are performed according to RFC 2396 and RFC 2732 (for IPv6 literals). In versions of .NET Framework before version 4.5, the default value is `false`. In .NET Framework 4.5+, .NET Core, and .NET 5+, the default value is `true`, and the enabled state of IRI parsing cannot be modified by settings in a *.config* file. - - IRI and IDN processing in the class can also be controlled using the , , and configuration setting classes. The setting enables or disables IRI processing in the class. The setting enables or disables IDN processing in the class. The setting also indirectly controls IDN. IRI processing must be enabled for IDN processing to be possible. If IRI processing is disabled, then IDN processing will be set to the default setting where the .NET Framework 2.0 behavior is used for compatibility and IDN names are not used. - - The configuration setting for the and are read once when the first class is constructed. Changes to configuration settings after that time are ignored. - - The class has also been extended to allow creating a customizable parser that supports IRI and IDN. The behavior of a object is specified by passing a bitwise combination of the values available in the enumeration to the constructor. The type indicates the parser supports the parsing rules specified in RFC 3987 for International Resource Identifiers (IRI). Whether IRI is used is dictated by the configuration values previously discussed. - - The type indicates that the parser supports Internationalized Domain Name (IDN) parsing of host names. In .NET 5 and later versions (including .NET Core) and .NET Framework 4.5+, IDN is always used. In previous versions, a configuration option determines whether IDN is used. - + This value will not convert any Unicode domain names to use Punycode. This is the default value which is consistent with the .NET Framework 2.0 behaviour. + + When IRI parsing is enabled (iriParsing enabled = `true`), normalization and character checking are done according to the latest IRI rules in RFC 3986 and RFC 3987. When IRI parsing is disabled, normalization and character checking are performed according to RFC 2396 and RFC 2732 (for IPv6 literals). In versions of .NET Framework before version 4.5, the default value is `false`. In .NET Framework 4.5+, .NET Core, and .NET 5+, the default value is `true`, and the enabled state of IRI parsing cannot be modified by settings in a *.config* file. + + IRI and IDN processing in the class can also be controlled using the , , and configuration setting classes. The setting enables or disables IRI processing in the class. The setting enables or disables IDN processing in the class. The setting also indirectly controls IDN. IRI processing must be enabled for IDN processing to be possible. If IRI processing is disabled, then IDN processing will be set to the default setting where the .NET Framework 2.0 behavior is used for compatibility and IDN names are not used. + + The configuration setting for the and are read once when the first class is constructed. Changes to configuration settings after that time are ignored. + + The class has also been extended to allow creating a customizable parser that supports IRI and IDN. The behavior of a object is specified by passing a bitwise combination of the values available in the enumeration to the constructor. The type indicates the parser supports the parsing rules specified in RFC 3987 for International Resource Identifiers (IRI). Whether IRI is used is dictated by the configuration values previously discussed. + + The type indicates that the parser supports Internationalized Domain Name (IDN) parsing of host names. In .NET 5 and later versions (including .NET Core) and .NET Framework 4.5+, IDN is always used. In previous versions, a configuration option determines whether IDN is used. + ## Implicit File Path Support can also be used to represent local file system paths. These paths can be represented *explicitly* in URIs that begin with the file:// scheme, and *implicitly* in URIs that do not have the file:// scheme. As a concrete example, the following two URIs are both valid, and represent the same file path: - + ```csharp Uri uri1 = new Uri("C:/test/path/file.txt") // Implicit file path. Uri uri2 = new Uri("file:///C:/test/path/file.txt") // Explicit file path. @@ -224,11 +224,11 @@ Uri baseUri = new Uri(@"\\host\share\some\directory\name\"); ## Performance Considerations If you use a *Web.config *file that contains URIs to initialize your application, additional time is required to process the URIs if their scheme identifiers are nonstandard. In such a case, initialize the affected parts of your application when the URIs are needed, not at start time. - + ## Examples -The following example creates an instance of the class and uses it to create a instance. - +The following example creates an instance of the class and uses it to create a instance. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/Classic Uri Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/Classic Uri Example/CS/source.cs" id="Snippet1"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri Example/VB/source.vb" id="Snippet1"::: @@ -304,76 +304,76 @@ The following code snippet shows example values of the various properties on the A string that identifies the resource to be represented by the instance. Note that an IPv6 address in string form must be enclosed within brackets. For example, "http://[2607:f8b0:400d:c06::69]". Initializes a new instance of the class with the specified URI. - instance from a URI string. It parses the URI, puts it in canonical format, and makes any required escape encodings. - - This constructor does not ensure that the refers to an accessible resource. - + instance from a URI string. It parses the URI, puts it in canonical format, and makes any required escape encodings. + + This constructor does not ensure that the refers to an accessible resource. + This constructor assumes that the `string` parameter references an absolute URI and is equivalent to calling the constructor with set to . If the `string` parameter passed to the constructor is a relative URI, this constructor will throw a . - -## Examples - The following example creates a instance with the URI `http://www.contoso.com/`. - + +## Examples + The following example creates a instance with the URI `http://www.contoso.com/`. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/Classic Uri.Uri Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/Classic Uri.Uri Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.Uri Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.Uri Example/VB/source.vb" id="Snippet1"::: + ]]> is . Note: In the .NET for Windows Store apps or the Portable Class Library, catch the base class exception, , instead. - is empty. - - -or- - - The scheme specified in is not correctly formed. See . - - -or- - - contains too many slashes. - - -or- - - The password specified in is not valid. - - -or- - - The host name specified in is not valid. - - -or- - - The file name specified in is not valid. - - -or- - - The user name specified in is not valid. - - -or- - - The host or authority name specified in cannot be terminated by backslashes. - - -or- - - The port number specified in is not valid or cannot be parsed. - - -or- - - The length of exceeds 65519 characters. - - -or- - - The length of the scheme specified in exceeds 1023 characters. - - -or- - - There is an invalid character sequence in . - - -or- - + is empty. + + -or- + + The scheme specified in is not correctly formed. See . + + -or- + + contains too many slashes. + + -or- + + The password specified in is not valid. + + -or- + + The host name specified in is not valid. + + -or- + + The file name specified in is not valid. + + -or- + + The user name specified in is not valid. + + -or- + + The host or authority name specified in cannot be terminated by backslashes. + + -or- + + The port number specified in is not valid or cannot be parsed. + + -or- + + The length of exceeds 65519 characters. + + -or- + + The length of the scheme specified in exceeds 1023 characters. + + -or- + + There is an invalid character sequence in . + + -or- + The MS-DOS path specified in must start with c:\\\\. @@ -414,62 +414,62 @@ The following code snippet shows example values of the various properties on the An instance of the class containing the source of the serialized stream associated with the new instance. Initializes a new instance of the class from the specified instances of the and classes. - interface for the class. - + interface for the class. + ]]> The parameter contains a URI. - The parameter contains a URI that is empty. - - -or- - - The scheme specified is not correctly formed. See . - - -or- - - The URI contains too many slashes. - - -or- - - The password specified in the URI is not valid. - - -or- - - The host name specified in URI is not valid. - - -or- - - The file name specified in the URI is not valid. - - -or- - - The user name specified in the URI is not valid. - - -or- - - The host or authority name specified in the URI cannot be terminated by backslashes. - - -or- - - The port number specified in the URI is not valid or cannot be parsed. - - -or- - - The length of URI exceeds 65519 characters. - - -or- - - The length of the scheme specified in the URI exceeds 1023 characters. - - -or- - - There is an invalid character sequence in the URI. - - -or- - + The parameter contains a URI that is empty. + + -or- + + The scheme specified is not correctly formed. See . + + -or- + + The URI contains too many slashes. + + -or- + + The password specified in the URI is not valid. + + -or- + + The host name specified in URI is not valid. + + -or- + + The file name specified in the URI is not valid. + + -or- + + The user name specified in the URI is not valid. + + -or- + + The host or authority name specified in the URI cannot be terminated by backslashes. + + -or- + + The port number specified in the URI is not valid or cannot be parsed. + + -or- + + The length of URI exceeds 65519 characters. + + -or- + + The length of the scheme specified in the URI exceeds 1023 characters. + + -or- + + There is an invalid character sequence in the URI. + + -or- + The MS-DOS path specified in the URI must start with c:\\\\. XML and SOAP Serialization @@ -526,77 +526,77 @@ The following code snippet shows example values of the various properties on the if is completely escaped; otherwise, . Initializes a new instance of the class with the specified URI, with explicit control of character escaping. - instance from a URI string. It parses the URI and puts it in canonical format. - - The `dontEscape` parameter controls whether reserved characters are translated into escape sequences. This parameter should be set to `true` only if you are certain that all reserved characters in the URI have been escaped. Setting the value to `true` for a URI that has not been completely escaped can cause unexpected behavior. It is strongly recommended that you always set this parameter to `false`. - - If `dontEscape` is set to `false`, the constructor escapes any reserved characters by checking that all occurrences of percent (%) are followed by a valid escape sequence. If the character sequence following a percent is not valid, the percent is replaced by %25. - + instance from a URI string. It parses the URI and puts it in canonical format. + + The `dontEscape` parameter controls whether reserved characters are translated into escape sequences. This parameter should be set to `true` only if you are certain that all reserved characters in the URI have been escaped. Setting the value to `true` for a URI that has not been completely escaped can cause unexpected behavior. It is strongly recommended that you always set this parameter to `false`. + + If `dontEscape` is set to `false`, the constructor escapes any reserved characters by checking that all occurrences of percent (%) are followed by a valid escape sequence. If the character sequence following a percent is not valid, the percent is replaced by %25. + This constructor does not ensure that the refers to an accessible resource. - -## Examples - The following example creates a instance for the URI `http://www.contoso.com/Hello%20World.htm`. Because the contained URI is completely escaped and is in canonical form, the `dontEscape` parameter can be set to `true`. - + +## Examples + The following example creates a instance for the URI `http://www.contoso.com/Hello%20World.htm`. Because the contained URI is completely escaped and is in canonical form, the `dontEscape` parameter can be set to `true`. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/Classic Uri.Uri1 Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/Classic Uri.Uri1 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.Uri1 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.Uri1 Example/VB/source.vb" id="Snippet1"::: + ]]> is . - is empty or contains only spaces. - - -or- - - The scheme specified in is not valid. - - -or- - - contains too many slashes. - - -or- - - The password specified in is not valid. - - -or- - - The host name specified in is not valid. - - -or- - - The file name specified in is not valid. - - -or- - - The user name specified in is not valid. - - -or- - - The host or authority name specified in cannot be terminated by backslashes. - - -or- - - The port number specified in is not valid or cannot be parsed. - - -or- - - The length of exceeds 65519 characters. - - -or- - - The length of the scheme specified in exceeds 1023 characters. - - -or- - - There is an invalid character sequence in . - - -or- - + is empty or contains only spaces. + + -or- + + The scheme specified in is not valid. + + -or- + + contains too many slashes. + + -or- + + The password specified in is not valid. + + -or- + + The host name specified in is not valid. + + -or- + + The file name specified in is not valid. + + -or- + + The user name specified in is not valid. + + -or- + + The host or authority name specified in cannot be terminated by backslashes. + + -or- + + The port number specified in is not valid or cannot be parsed. + + -or- + + The length of exceeds 65519 characters. + + -or- + + The length of the scheme specified in exceeds 1023 characters. + + -or- + + There is an invalid character sequence in . + + -or- + The MS-DOS path specified in must start with c:\\\\. @@ -630,9 +630,9 @@ The following code snippet shows example values of the various properties on the - To be added. - To be added. - To be added. + A string that identifies the resource to be represented by the instance. + Options that control how the is created and behaves. + Initializes a new instance of the class with the specified URI and additional . To be added. @@ -676,11 +676,11 @@ The following code snippet shows example values of the various properties on the Specifies whether the URI string is a relative URI, absolute URI, or is indeterminate. Initializes a new instance of the class with the specified URI. This constructor allows you to specify if the URI string is a relative URI, absolute URI, or is indeterminate. - is specified, the URI string can be relative or absolute. - + is specified, the URI string can be relative or absolute. + ]]> @@ -689,62 +689,62 @@ The following code snippet shows example values of the various properties on the is . Note: In the .NET for Windows Store apps or the Portable Class Library, catch the base class exception, , instead. - contains a relative URI and is . - - or - - contains an absolute URI and is . - - or - - is empty. - - -or- - - The scheme specified in is not correctly formed. See . - - -or- - - contains too many slashes. - - -or- - - The password specified in is not valid. - - -or- - - The host name specified in is not valid. - - -or- - - The file name specified in is not valid. - - -or- - - The user name specified in is not valid. - - -or- - - The host or authority name specified in cannot be terminated by backslashes. - - -or- - - The port number specified in is not valid or cannot be parsed. - - -or- - - The length of exceeds 65519 characters. - - -or- - - The length of the scheme specified in exceeds 1023 characters. - - -or- - - There is an invalid character sequence in . - - -or- - + contains a relative URI and is . + + or + + contains an absolute URI and is . + + or + + is empty. + + -or- + + The scheme specified in is not correctly formed. See . + + -or- + + contains too many slashes. + + -or- + + The password specified in is not valid. + + -or- + + The host name specified in is not valid. + + -or- + + The file name specified in is not valid. + + -or- + + The user name specified in is not valid. + + -or- + + The host or authority name specified in cannot be terminated by backslashes. + + -or- + + The port number specified in is not valid or cannot be parsed. + + -or- + + The length of exceeds 65519 characters. + + -or- + + The length of the scheme specified in exceeds 1023 characters. + + -or- + + There is an invalid character sequence in . + + -or- + The MS-DOS path specified in must start with c:\\\\. @@ -790,23 +790,23 @@ The following code snippet shows example values of the various properties on the The relative URI to add to the base URI. Initializes a new instance of the class based on the specified base URI and relative URI string. - instance by combining the `baseUri` and the `relativeUri`. If `relativeUri` is an absolute URI (containing a scheme, host name, and optionally a port number), the instance is created using only `relativeUri`. - - If the `baseUri` has relative parts (like `/api`), then the relative part must be terminated with a slash, (like `/api/`), if the relative part of `baseUri` is to be preserved in the constructed . + instance by combining the `baseUri` and the `relativeUri`. If `relativeUri` is an absolute URI (containing a scheme, host name, and optionally a port number), the instance is created using only `relativeUri`. + + If the `baseUri` has relative parts (like `/api`), then the relative part must be terminated with a slash, (like `/api/`), if the relative part of `baseUri` is to be preserved in the constructed . Additionally, if the `relativeUri` begins with a slash, then it will replace any relative part of the `baseUri` This constructor does not ensure that the refers to an accessible resource. - -## Examples - The following example creates a new instance of the class by combining the relative URIs `http://www.contoso.com` and `catalog/shownew.htm` to form the absolute URI `http://www.contoso.com/catalog/shownew.htm`. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/Classic Uri.Uri3 Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/Classic Uri.Uri3 Example/CS/source.cs" interactive="try-dotnet-method" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.Uri3 Example/VB/source.vb" id="Snippet1"::: + +## Examples + The following example creates a new instance of the class by combining the relative URIs `http://www.contoso.com` and `catalog/shownew.htm` to form the absolute URI `http://www.contoso.com/catalog/shownew.htm`. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/Classic Uri.Uri3 Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/Classic Uri.Uri3 Example/CS/source.cs" interactive="try-dotnet-method" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.Uri3 Example/VB/source.vb" id="Snippet1"::: ]]> @@ -816,54 +816,54 @@ The following code snippet shows example values of the various properties on the is not an absolute instance. Note: In the .NET for Windows Store apps or the Portable Class Library, catch the base class exception, , instead. - The URI formed by combining and is empty or contains only spaces. - - -or- - - The scheme specified in the URI formed by combining and is not valid. - - -or- - - The URI formed by combining and contains too many slashes. - - -or- - - The password specified in the URI formed by combining and is not valid. - - -or- - - The host name specified in the URI formed by combining and is not valid. - - -or- - - The file name specified in the URI formed by combining and is not valid. - - -or- - - The user name specified in the URI formed by combining and is not valid. - - -or- - - The host or authority name specified in the URI formed by combining and cannot be terminated by backslashes. - - -or- - - The port number specified in the URI formed by combining and is not valid or cannot be parsed. - - -or- - - The length of the URI formed by combining and exceeds 65519 characters. - - -or- - - The length of the scheme specified in the URI formed by combining and exceeds 1023 characters. - - -or- - - There is an invalid character sequence in the URI formed by combining and . - - -or- - + The URI formed by combining and is empty or contains only spaces. + + -or- + + The scheme specified in the URI formed by combining and is not valid. + + -or- + + The URI formed by combining and contains too many slashes. + + -or- + + The password specified in the URI formed by combining and is not valid. + + -or- + + The host name specified in the URI formed by combining and is not valid. + + -or- + + The file name specified in the URI formed by combining and is not valid. + + -or- + + The user name specified in the URI formed by combining and is not valid. + + -or- + + The host or authority name specified in the URI formed by combining and cannot be terminated by backslashes. + + -or- + + The port number specified in the URI formed by combining and is not valid or cannot be parsed. + + -or- + + The length of the URI formed by combining and exceeds 65519 characters. + + -or- + + The length of the scheme specified in the URI formed by combining and exceeds 1023 characters. + + -or- + + There is an invalid character sequence in the URI formed by combining and . + + -or- + The MS-DOS path specified in must start with c:\\\\. @@ -907,20 +907,20 @@ The following code snippet shows example values of the various properties on the A relative instance that is combined with . Initializes a new instance of the class based on the combination of a specified base instance and a relative instance. - instance by combining an absolute instance, `baseUri`, with a relative instance, `relativeUri`. If `relativeUri` is an absolute instance (containing a scheme, host name, and optionally a port number), the instance is created using only `relativeUri`. - - If the `baseUri` has relative parts (like `/api`), then the relative part must be terminated with a slash, (like `/api/`), if the relative part of `baseUri` is to be preserved in the constructed . + instance by combining an absolute instance, `baseUri`, with a relative instance, `relativeUri`. If `relativeUri` is an absolute instance (containing a scheme, host name, and optionally a port number), the instance is created using only `relativeUri`. + + If the `baseUri` has relative parts (like `/api`), then the relative part must be terminated with a slash, (like `/api/`), if the relative part of `baseUri` is to be preserved in the constructed . Additionally, if the `relativeUri` begins with a slash, then it will replace any relative part of the `baseUri` - + This constructor does not ensure that the refers to an accessible resource. - -## Examples - This example creates an absolute instance, `absoluteUri`, and a relative instance, `relativeUri`. A new instance, `combinedUri`, is then created from these two instances. - + +## Examples + This example creates an absolute instance, `absoluteUri`, and a relative instance, `relativeUri`. A new instance, `combinedUri`, is then created from these two instances. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriEnhancements/CPP/nclurienhancements.cpp" id="Snippet2"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriEnhancements/CS/nclurienhancements.cs" interactive="try-dotnet-method" id="Snippet2"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriEnhancements/VB/nclurienhancements.vb" id="Snippet2"::: @@ -935,54 +935,54 @@ The following code snippet shows example values of the various properties on the is not an absolute instance. Note: In the .NET for Windows Store apps or the Portable Class Library, catch the base class exception, , instead. -The URI formed by combining and is empty or contains only spaces. - - -or- - - The scheme specified in the URI formed by combining and is not valid. - - -or- - - The URI formed by combining and contains too many slashes. - - -or- - - The password specified in the URI formed by combining and is not valid. - - -or- - - The host name specified in the URI formed by combining and is not valid. - - -or- - - The file name specified in the URI formed by combining and is not valid. - - -or- - - The user name specified in the URI formed by combining and is not valid. - - -or- - - The host or authority name specified in the URI formed by combining and cannot be terminated by backslashes. - - -or- - - The port number specified in the URI formed by combining and is not valid or cannot be parsed. - - -or- - - The length of the URI formed by combining and exceeds 65519 characters. - - -or- - - The length of the scheme specified in the URI formed by combining and exceeds 1023 characters. - - -or- - - There is an invalid character sequence in the URI formed by combining and . - - -or- - +The URI formed by combining and is empty or contains only spaces. + + -or- + + The scheme specified in the URI formed by combining and is not valid. + + -or- + + The URI formed by combining and contains too many slashes. + + -or- + + The password specified in the URI formed by combining and is not valid. + + -or- + + The host name specified in the URI formed by combining and is not valid. + + -or- + + The file name specified in the URI formed by combining and is not valid. + + -or- + + The user name specified in the URI formed by combining and is not valid. + + -or- + + The host or authority name specified in the URI formed by combining and cannot be terminated by backslashes. + + -or- + + The port number specified in the URI formed by combining and is not valid or cannot be parsed. + + -or- + + The length of the URI formed by combining and exceeds 65519 characters. + + -or- + + The length of the scheme specified in the URI formed by combining and exceeds 1023 characters. + + -or- + + There is an invalid character sequence in the URI formed by combining and . + + -or- + The MS-DOS path specified in must start with c:\\\\. @@ -1041,76 +1041,76 @@ The URI formed by combining and if is completely escaped; otherwise, . Initializes a new instance of the class based on the specified base and relative URIs, with explicit control of character escaping. - instance by combining `baseUri` and `relativeUri`. If the URI passed in `relativeUri` is an absolute URI (containing a scheme, host name, and optionally a port number), the instance is created using only `relativeUri`. - - The `dontEscape` parameter controls whether reserved characters are translated into escape sequences. This parameter should be set to `true` only if you are certain that all reserved characters in the URI have been escaped. Setting the value to `true` for a URI that has not been completely escaped can cause unexpected behavior. It is strongly recommended that you always set this parameter to `false`. If `dontEscape` is set to `false`, the constructor escapes any reserved characters by checking that all occurrences of percent (%) are followed by a valid escape sequence. If the character sequence following a percent is not valid, the percent is replaced by %25. - + instance by combining `baseUri` and `relativeUri`. If the URI passed in `relativeUri` is an absolute URI (containing a scheme, host name, and optionally a port number), the instance is created using only `relativeUri`. + + The `dontEscape` parameter controls whether reserved characters are translated into escape sequences. This parameter should be set to `true` only if you are certain that all reserved characters in the URI have been escaped. Setting the value to `true` for a URI that has not been completely escaped can cause unexpected behavior. It is strongly recommended that you always set this parameter to `false`. If `dontEscape` is set to `false`, the constructor escapes any reserved characters by checking that all occurrences of percent (%) are followed by a valid escape sequence. If the character sequence following a percent is not valid, the percent is replaced by %25. + This constructor does not ensure that the refers to an accessible resource. - -## Examples - The following example creates a new instance of the class by combining the relative URIs `http://www.contoso.com` and `Hello%20World.htm` to form an absolute URI. - + +## Examples + The following example creates a new instance of the class by combining the relative URIs `http://www.contoso.com` and `Hello%20World.htm` to form an absolute URI. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/Classic Uri.Uri4 Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/Classic Uri.Uri4 Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.Uri4 Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.Uri4 Example/VB/source.vb" id="Snippet1"::: + ]]> is . is not an absolute instance. - The URI formed by combining and is empty or contains only spaces. - - -or- - - The scheme specified in the URI formed by combining and is not valid. - - -or- - - The URI formed by combining and contains too many slashes. - - -or- - - The password specified in the URI formed by combining and is not valid. - - -or- - - The host name specified in the URI formed by combining and is not valid. - - -or- - - The file name specified in the URI formed by combining and is not valid. - - -or- - - The user name specified in the URI formed by combining and is not valid. - - -or- - - The host or authority name specified in the URI formed by combining and cannot be terminated by backslashes. - - -or- - - The port number specified in the URI formed by combining and is not valid or cannot be parsed. - - -or- - - The length of the URI formed by combining and exceeds 65519 characters. - - -or- - - The length of the scheme specified in the URI formed by combining and exceeds 1023 characters. - - -or- - - There is an invalid character sequence in the URI formed by combining and . - - -or- - + The URI formed by combining and is empty or contains only spaces. + + -or- + + The scheme specified in the URI formed by combining and is not valid. + + -or- + + The URI formed by combining and contains too many slashes. + + -or- + + The password specified in the URI formed by combining and is not valid. + + -or- + + The host name specified in the URI formed by combining and is not valid. + + -or- + + The file name specified in the URI formed by combining and is not valid. + + -or- + + The user name specified in the URI formed by combining and is not valid. + + -or- + + The host or authority name specified in the URI formed by combining and cannot be terminated by backslashes. + + -or- + + The port number specified in the URI formed by combining and is not valid or cannot be parsed. + + -or- + + The length of the URI formed by combining and exceeds 65519 characters. + + -or- + + The length of the scheme specified in the URI formed by combining and exceeds 1023 characters. + + -or- + + There is an invalid character sequence in the URI formed by combining and . + + -or- + The MS-DOS path specified in must start with c:\\\\. Because of security concerns, your application should not call this constructor with URI strings from untrusted sources and with set to . Alternately, you can check a URI string for validity by calling the method prior to calling this constructor. @@ -1156,16 +1156,16 @@ The URI formed by combining and 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. - + 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. + The path information does not include the scheme, host name, or query portion of the URI. - -## Examples - The following example writes the path `/catalog/shownew.htm` to the console. - + +## Examples + The following example writes the path `/catalog/shownew.htm` to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/Classic Uri.AbsolutePath Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/Classic Uri.AbsolutePath Example/CS/source.cs" interactive="try-dotnet-method" id="Snippet1"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.AbsolutePath Example/VB/source.vb" id="Snippet1"::: @@ -1214,18 +1214,18 @@ The URI formed by combining and property includes the entire URI stored in the instance, including all fragments and query strings. - -## Examples - The following example writes the complete contents of the instance to the console. In the example shown, `http://www.contoso.com/catalog/shownew.htm?date=today` is written to the console. - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/Classic Uri.AbsoluteUri Example/CPP/source.cpp" id="Snippet1"::: - :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/Classic Uri.AbsoluteUri Example/CS/source.cs" interactive="try-dotnet-method" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.AbsoluteUri Example/VB/source.vb" id="Snippet1"::: - + +## Examples + The following example writes the complete contents of the instance to the console. In the example shown, `http://www.contoso.com/catalog/shownew.htm?date=today` is written to the console. + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/Classic Uri.AbsoluteUri Example/CPP/source.cpp" id="Snippet1"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/Classic Uri.AbsoluteUri Example/CS/source.cs" interactive="try-dotnet-method" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.AbsoluteUri Example/VB/source.vb" id="Snippet1"::: + ]]> This instance represents a relative URI, and this property is valid only for absolute URIs. @@ -1270,18 +1270,18 @@ The URI formed by combining and property is typically a server DNS host name or IP address. This property might include the service port number if it differs from the default port for the URI. If the component contains reserved characters, these are escaped in the string value returned by this property. - -## Examples - The following example writes the host name (`www.contoso.com`) and port number (8080) of the server to the console. - + +## Examples + The following example writes the host name (`www.contoso.com`) and port number (8080) of the server to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/Classic Uri.Authority Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/Classic Uri.Authority Example/CS/source.cs" interactive="try-dotnet-method" id="Snippet1"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.Authority Example/VB/source.vb" id="Snippet1"::: - + ]]> This instance represents a relative URI, and this property is valid only for absolute URIs. @@ -1336,11 +1336,11 @@ The URI formed by combining and This instance represents a relative URI, and this method is valid only for absolute URIs. @@ -1391,17 +1391,17 @@ The URI formed by combining and or a zero-length string, this method returns . - 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. - -## Examples - The following example checks whether the host name is valid. - + +## Examples + The following example checks whether the host name is valid. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/Classic Uri.CheckHostName Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/Classic Uri.CheckHostName Example/CS/source.cs" interactive="try-dotnet-method" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.CheckHostName Example/VB/source.vb" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.CheckHostName Example/VB/source.vb" id="Snippet1"::: ]]> @@ -1452,16 +1452,16 @@ The URI formed by combining and if the scheme name is valid; otherwise, . - class. - -## Examples - The following example creates a instance and checks whether the scheme name is valid. - + +## Examples + The following example creates a instance and checks whether the scheme name is valid. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet9"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet9"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet9"::: @@ -1570,31 +1570,31 @@ The URI formed by combining and One of the enumeration values that specifies the character escaping used when the URI components are compared. One of the enumeration values that specifies the the culture, case, and sort rules for the comparison. Compares the specified parts of two URIs using the specified comparison rules. - A value that indicates the lexical relationship between the compared components. - - Value - - Meaning - - Less than zero - - is less than . - - Zero - - equals . - - Greater than zero - - is greater than . - + A value that indicates the lexical relationship between the compared components. + + Value + + Meaning + + Less than zero + + is less than . + + Zero + + equals . + + Greater than zero + + is greater than . + - method performs the comparison. - + method performs the comparison. + ]]> @@ -1639,57 +1639,57 @@ The URI formed by combining and property is set, if one was specified when this instance was constructed. If you used an escaped string to construct this instance (for example, `"http://[fe80::200:39ff:fe36:1a2d%254]/temp/example.htm"`), then DnsSafeHost returns an escaped string. Unescape any escaped string returned from `DnsSafeHost` before using that string for DNS resolution (see the Example). If you used an invalid unescaped string to construct this instance (for example, "http://[fe80::200:39ff:fe36:1a2d%4]/temp/example.htm"), then DnsSafeHost returns an unescaped string. - - The property is dependent on configuration settings, as discussed later in this topic. Configuration settings cannot be changed by Windows Store applications, which can lead to inconsistent results when using . The property is provided as the preferred alternative to using , because is guaranteed to always be DNS safe, no matter what the current *app.config* settings might be. - - The property has been extended in .NET Framework v3.5, 3.0 SP1, and 2.0 SP1 to provide International Resource Identifier (IRI) support based on RFC 3987. Current users will not see any change from the .NET Framework 2.0 behavior unless they specifically enable IRI. This ensures application compatibility with prior versions of the .NET Framework. - - To enable support for IRI, the following two changes are required: - -1. Add the following line to the *machine.config* file under the .NET Framework 2.0 directory \
- + + The property is dependent on configuration settings, as discussed later in this topic. Configuration settings cannot be changed by Windows Store applications, which can lead to inconsistent results when using . The property is provided as the preferred alternative to using , because is guaranteed to always be DNS safe, no matter what the current *app.config* settings might be. + + The property has been extended in .NET Framework v3.5, 3.0 SP1, and 2.0 SP1 to provide International Resource Identifier (IRI) support based on RFC 3987. Current users will not see any change from the .NET Framework 2.0 behavior unless they specifically enable IRI. This ensures application compatibility with prior versions of the .NET Framework. + + To enable support for IRI, the following two changes are required: + +1. Add the following line to the *machine.config* file under the .NET Framework 2.0 directory \
+ 2. Specify whether you want Internationalized Domain Name (IDN) parsing applied to the domain name and whether IRI parsing rules should be applied. This can be done in the *machine.config* or in the *app.config* file. For example, add the following: - ```xml - - - - - - - ``` - - Enabling IDN will convert all Unicode labels in a domain name to their Punycode equivalents. Punycode names contain only ASCII characters and always start with the xn-- prefix. The reason for this is to support existing DNS servers on the Internet, since most DNS servers only support ASCII characters (see RFC 3940). - - Enabling IDN only affects the value of the property. - - There are three possible values for IDN depending on the DNS servers that are used: - + ```xml + + + + + + + ``` + + Enabling IDN will convert all Unicode labels in a domain name to their Punycode equivalents. Punycode names contain only ASCII characters and always start with the xn-- prefix. The reason for this is to support existing DNS servers on the Internet, since most DNS servers only support ASCII characters (see RFC 3940). + + Enabling IDN only affects the value of the property. + + There are three possible values for IDN depending on the DNS servers that are used: + - idn enabled = All - This value will convert any Unicode domain names to their Punycode equivalents (IDN names). - + This value will convert any Unicode domain names to their Punycode equivalents (IDN names). + - idn enabled = AllExceptIntranet - This value will convert all external Unicode domain names to use the Punycode equivalents (IDN names). In this case to handle international names on the local Intranet, the DNS servers that are used for the Intranet should support Unicode names. - + This value will convert all external Unicode domain names to use the Punycode equivalents (IDN names). In this case to handle international names on the local Intranet, the DNS servers that are used for the Intranet should support Unicode names. + - idn enabled = None - This value will not convert any Unicode domain names to use Punycode. This is the default value which is consistent with the .NET Framework 2.0 behaviour. - - Enabling IRI parsing (iriParsing enabled = `true`) will do normalization and character checking according to the latest IRI rules in RFC 3987. The default value is `false` and will do normalization and character checking according to RFC 2396 and RFC 2732 (for IPv6 literals). - - For more information on IRI support, see the Remarks section for the class. - -## Examples - The following example creates a instance from a string. It illustrates the difference between the value returned from , which returns the host name or address specified in the URI, and the value returned from , which returns an address that is safe to use in DNS resolution. - + This value will not convert any Unicode domain names to use Punycode. This is the default value which is consistent with the .NET Framework 2.0 behaviour. + + Enabling IRI parsing (iriParsing enabled = `true`) will do normalization and character checking according to the latest IRI rules in RFC 3987. The default value is `false` and will do normalization and character checking according to RFC 2396 and RFC 2732 (for IPv6 literals). + + For more information on IRI support, see the Remarks section for the class. + +## Examples + The following example creates a instance from a string. It illustrates the difference between the value returned from , which returns the host name or address specified in the URI, and the value returned from , which returns an address that is safe to use in DNS resolution. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriEnhancements/CPP/nclurienhancements.cpp" id="Snippet4"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriEnhancements/CS/nclurienhancements.cs" interactive="try-dotnet-method" id="Snippet4"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriEnhancements/VB/nclurienhancements.vb" id="Snippet4"::: @@ -1746,24 +1746,24 @@ If you used an escaped string to construct this instance (for example, `"http:// if the two instances represent the same URI; otherwise, . - method compares the two instances without regard to user information () and fragment () parts that they might contain. For example, given the URIs `http://www.contoso.com/index.htm#search` and `http://user:password@www.contoso.com/index.htm`, the method would return `true`. - - If one instance is formed with a Unicode host name and `comparand` parameter contains a instance or identifier that is formed with a host name that has the equivalent Punycode host name, then returns `true` only if International Resource Identifier (IRI) and Internationalized Domain Name (IDN) support are enabled. Punycode names contain only ASCII characters and always start with the xn-- prefix. - - For more information on IRI support, see the Remarks section for the class. - + method compares the two instances without regard to user information () and fragment () parts that they might contain. For example, given the URIs `http://www.contoso.com/index.htm#search` and `http://user:password@www.contoso.com/index.htm`, the method would return `true`. + + If one instance is formed with a Unicode host name and `comparand` parameter contains a instance or identifier that is formed with a host name that has the equivalent Punycode host name, then returns `true` only if International Resource Identifier (IRI) and Internationalized Domain Name (IDN) support are enabled. Punycode names contain only ASCII characters and always start with the xn-- prefix. + + For more information on IRI support, see the Remarks section for the class. + > [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, the is also ignored. - +> In the .NET Framework versions 1.0 and 1.1, the is also ignored. + > [!NOTE] > The method can be overridden in a derived class; use caution as a malicious entity could modify the method. You should not use this method to perform security checks unless you know that this instance came from a trusted source. - -## Examples - This example creates two instances from strings and compares them to determine whether they represent the same value. `address1` and `address2` are the same because the portion is ignored for this comparison. The outcome is written to the console. - + +## Examples + This example creates two instances from strings and compares them to determine whether they represent the same value. `address1` and `address2` are the same because the portion is ignored for this comparison. The outcome is written to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet8"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet8"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet8"::: @@ -1866,23 +1866,23 @@ If you used an escaped string to construct this instance (for example, `"http:// Converts a string to its escaped representation. The escaped representation of . - method converts all characters except for RFC 2396 unreserved characters to their hexadecimal representation. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the method converts all characters, except for RFC 3986 unreserved characters, to their hexadecimal representation. All Unicode characters are converted to UTF-8 format before being escaped. - - This method assumes that `stringToEscape` has no escape sequences in it. - - By default, the string is escaped according to RFC 2396. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the string is escaped according to RFC 3986 and RFC 3987. See these RFCs for a definition of reserved and unreserved characters. - - For more information on IRI support, see the Remarks section for the class. - + method converts all characters except for RFC 2396 unreserved characters to their hexadecimal representation. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the method converts all characters, except for RFC 3986 unreserved characters, to their hexadecimal representation. All Unicode characters are converted to UTF-8 format before being escaped. + + This method assumes that `stringToEscape` has no escape sequences in it. + + By default, the string is escaped according to RFC 2396. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the string is escaped according to RFC 3986 and RFC 3987. See these RFCs for a definition of reserved and unreserved characters. + + For more information on IRI support, see the Remarks section for the class. + ]]> is . Note: In the .NET for Windows Store apps or the Portable Class Library, catch the base class exception, , instead. - + The length of exceeds 32766 characters. @@ -1940,15 +1940,15 @@ If you used an escaped string to construct this instance (for example, `"http:// Converts a string to its escaped representation. The escaped representation of the string. - method converts RFC 2396 reserved characters and all characters with a character value greater than 127 to hexadecimal representation. All Unicode characters are converted to UTF-8 format before being escaped. - - By default, the string is escaped according to RFC 2396. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the string is escaped according to RFC 3986 and RFC 3987. - - For more information on IRI support, see the Remarks section for the class. - + method converts RFC 2396 reserved characters and all characters with a character value greater than 127 to hexadecimal representation. All Unicode characters are converted to UTF-8 format before being escaped. + + By default, the string is escaped according to RFC 2396. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the string is escaped according to RFC 3986 and RFC 3987. + + For more information on IRI support, see the Remarks section for the class. + ]]> @@ -2001,19 +2001,19 @@ If you used an escaped string to construct this instance (for example, `"http:// Converts a URI string to its escaped representation. The escaped representation of . - method to prepare an unescaped URI string to be a parameter to the constructor. - - By default, the method converts all characters, except RFC 2396 unreserved characters, to their hexadecimal representation. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the method converts all characters, except for RFC 3986 unreserved characters, to their hexadecimal representation. All Unicode characters are converted to UTF-8 format before being escaped. - - This method assumes that `stringToEscape` has no escape sequences in it. - - By default, the string is escaped according to RFC 2396. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the string is escaped according to RFC 3986 and RFC 3987. See these RFCs for a definition of reserved and unreserved characters. - - For more information on IRI support, see the Remarks section for the class. - + method to prepare an unescaped URI string to be a parameter to the constructor. + + By default, the method converts all characters, except RFC 2396 unreserved characters, to their hexadecimal representation. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the method converts all characters, except for RFC 3986 unreserved characters, to their hexadecimal representation. All Unicode characters are converted to UTF-8 format before being escaped. + + This method assumes that `stringToEscape` has no escape sequences in it. + + By default, the string is escaped according to RFC 2396. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the string is escaped according to RFC 3986 and RFC 3987. See these RFCs for a definition of reserved and unreserved characters. + + For more information on IRI support, see the Remarks section for the class. + ]]> @@ -2062,16 +2062,16 @@ The length of exceeds 32766 characters.Gets the escaped URI fragment.
URI fragment information. - 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 property would return #main. - + 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 property would return #main. + The property is not considered in any comparison. - -## Examples - The following example creates a instance and writes the fragment information to the console. - + +## Examples + The following example creates a instance and writes the fragment information to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet4"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet4"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet4"::: @@ -2120,17 +2120,17 @@ The length of exceeds 32766 characters.Gets the decimal value of a hexadecimal digit. A number from 0 to 15 that corresponds to the specified hexadecimal digit. - method converts a character representing a hexadecimal digit (0-9, a-f, A-F) to its decimal value (0 to 15). If `digit` is not a valid hexadecimal digit, an exception is thrown. - -## Examples - The following example determines whether a character is a hexadecimal character and, if it is, writes the corresponding decimal value to the console. - + +## Examples + The following example determines whether a character is a hexadecimal character and, if it is, writes the corresponding decimal value to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet1"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet1"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet1"::: ]]> @@ -2182,20 +2182,20 @@ The length of exceeds 32766 characters.Gets the specified components of the current instance using the specified escaping for special characters. The components of the current instance. - , , , , , , and components do not include the delimiter. You can combine the flag (using the bitwise OR operator) with any of those values to get the value with the delimiter. For all other values, and combinations of values, the delimiters are included in the returned value. - - The components are returned in the order that they appear in the URI. For example, if is specified, it appears first. - - When International Resource Identifier (IRI) and Internationalized Domain Name (IDN) support are enabled, the number of characters returned in the increases. Punycode names used to support IRI contain only ASCII characters and always start with the xn-- prefix. When IRI and IDN are enabled, Unicode surrogate characters are handled correctly by the method. - - For more information on IRI support, see the Remarks section for the class. - + , , , , , , and components do not include the delimiter. You can combine the flag (using the bitwise OR operator) with any of those values to get the value with the delimiter. For all other values, and combinations of values, the delimiters are included in the returned value. + + The components are returned in the order that they appear in the URI. For example, if is specified, it appears first. + + When International Resource Identifier (IRI) and Internationalized Domain Name (IDN) support are enabled, the number of characters returned in the increases. Punycode names used to support IRI contain only ASCII characters and always start with the xn-- prefix. When IRI and IDN are enabled, Unicode surrogate characters are handled correctly by the method. + + For more information on IRI support, see the Remarks section for the class. + > [!NOTE] -> If the method is called with `format` set to , you cannot use the return value as an argument to a constructor to create an equivalent . - +> If the method is called with `format` set to , you cannot use the return value as an argument to a constructor to create an equivalent . + ]]> @@ -2243,11 +2243,11 @@ The length of exceeds 32766 characters.Gets the hash code for the URI. The hash value generated for this URI. - instance and writes the hash code to the console. - + instance and writes the hash code to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet4"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet4"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet4"::: @@ -2295,35 +2295,35 @@ The length of exceeds 32766 characters.Gets the specified portion of a instance. The specified portion of the instance. - method returns a string containing the leftmost portion of the URI string, ending with the portion specified by `part`. - - includes delimiters in the following cases: - -- includes the scheme delimiter. - -- does not include the path delimiter. - -- includes any delimiters in the original URI up to the query or fragment delimiter. - -- includes the , plus the query and its delimiter. - - The following examples show a URI and the results of calling with , , , or . - -|URI|Scheme|Authority|Path|Query| -|---------|------------|---------------|----------|-----------| -|`http://www.contoso.com/index.htm?date=today`|`http://`|`http://www.contoso.com`|`http://www.contoso.com/index.htm`|`http://www.contoso.com/index.htm?date=today`| -|`http://www.contoso.com/index.htm#main`|`http://`|`http://www.contoso.com`|`http://www.contoso.com/index.htm`|`http://www.contoso.com/index.htm`| -|`mailto:user@contoso.com?subject=uri`|`mailto:`|`mailto:user@contoso.com`|`mailto:user@contoso.com?subject=uri`|``| -|`nntp://news.contoso.com/123456@contoso.com`|`nntp://`|`nntp://news.contoso.com`|`nntp://news.contoso.com/123456@contoso.com`|`nntp://news.contoso.com/123456@contoso.com`| -|`news:123456@contoso.com`|`news:`|`news:123456@contoso.com`|`news:123456@contoso.com`|``| + method returns a string containing the leftmost portion of the URI string, ending with the portion specified by `part`. + + includes delimiters in the following cases: + +- includes the scheme delimiter. + +- does not include the path delimiter. + +- includes any delimiters in the original URI up to the query or fragment delimiter. + +- includes the , plus the query and its delimiter. + + The following examples show a URI and the results of calling with , , , or . + +|URI|Scheme|Authority|Path|Query| +|---------|------------|---------------|----------|-----------| +|`http://www.contoso.com/index.htm?date=today`|`http://`|`http://www.contoso.com`|`http://www.contoso.com/index.htm`|`http://www.contoso.com/index.htm?date=today`| +|`http://www.contoso.com/index.htm#main`|`http://`|`http://www.contoso.com`|`http://www.contoso.com/index.htm`|`http://www.contoso.com/index.htm`| +|`mailto:user@contoso.com?subject=uri`|`mailto:`|`mailto:user@contoso.com`|`mailto:user@contoso.com?subject=uri`|``| +|`nntp://news.contoso.com/123456@contoso.com`|`nntp://`|`nntp://news.contoso.com`|`nntp://news.contoso.com/123456@contoso.com`|`nntp://news.contoso.com/123456@contoso.com`| +|`news:123456@contoso.com`|`news:`|`news:123456@contoso.com`|`news:123456@contoso.com`|``| |`file://server/filename.ext`|`file://`|`file://server`|`file://server/filename.ext`|`file://server/filename.ext`| - -## Examples - The following example creates a instance and writes the path to the console. - + +## Examples + The following example creates a instance and writes the path to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet4"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet4"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet4"::: @@ -2414,11 +2414,11 @@ The length of exceeds 32766 characters.Converts a specified character into its hexadecimal equivalent. The hexadecimal representation of the specified character. - exceeds 32766 characters.Converts a specified hexadecimal representation of a character to the character. The character represented by the hexadecimal encoding at position . If the character at is not hexadecimal encoded, the character at is returned. The value of is incremented to point to the character following the one returned. - exceeds 32766 characters.Gets the host component of this instance. The host name. This is usually the DNS host name or IP address of the server. - property, this property value does not include the port number. - -## Examples - The following example writes the host name (`www.contoso.com`) of the server to the console. - + +## Examples + The following example writes the host name (`www.contoso.com`) of the server to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/Classic Uri.Host Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/Classic Uri.Host Example/CS/source.cs" interactive="try-dotnet-method" id="Snippet1"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.Host Example/VB/source.vb" id="Snippet1"::: @@ -2580,14 +2580,14 @@ The length of exceeds 32766 characters.Gets the type of the host name specified in the URI. A member of the enumeration. - instance and writes the to the console. - + instance and writes the to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet9"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet9"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet9"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet9"::: ]]> @@ -2629,12 +2629,12 @@ The length of exceeds 32766 characters.Gets the RFC 3490 compliant International Domain Name of the host, using Punycode as appropriate. This string, after being unescaped if necessary, is safe to use for DNS resolution. The hostname, formatted with Punycode according to the IDN standard. - for the hostname. - - The deprecated property is dependent on *app.config* settings, which cannot be changed by Windows Store applications. IdnHost is provided as the preferred alternative to using , because is guaranteed to always be DNS safe, no matter what the current *app.config* settings might be. + for the hostname. + + The deprecated property is dependent on *app.config* settings, which cannot be changed by Windows Store applications. IdnHost is provided as the preferred alternative to using , because is guaranteed to always be DNS safe, no matter what the current *app.config* settings might be. If you used an escaped string to construct this instance (for example, `"http://[fe80::200:39ff:fe36:1a2d%254]/temp/example.htm"`), then IdnHost returns an escaped string. You should unescape any escaped string returned from IdnHost before using that string for DNS resolution. Be aware that if you used an invalid unescaped string to construct this instance (for example, "http://[fe80::200:39ff:fe36:1a2d%4]/temp/example.htm"), then IdnHost returns an unescaped string. @@ -2682,11 +2682,11 @@ The length of exceeds 32766 characters. if the instance is absolute; otherwise, . - instance that was passed into the constructor can be parsed as an absolute instance, which contains a scheme, an authority, and a path. Otherwise, the instance is treated as relative and might omit the scheme or other URI components. - + instance that was passed into the constructor can be parsed as an absolute instance, which contains a scheme, an authority, and a path. Otherwise, the instance is treated as relative and might omit the scheme or other URI components. + ]]>
@@ -2745,11 +2745,11 @@ The length of exceeds 32766 characters. if the specified character is invalid; otherwise, . -
@@ -2797,29 +2797,29 @@ The length of exceeds 32766 characters. if the current instance is a base of ; otherwise, . - is used to compare the current instance to a specified to determine whether this URI is a base for the specified . When comparing two objects to determine a base relationship, the user information () is not evaluated. When comparing two URIs (uri1 and uri2), uri1 is the base of uri2 if, when you ignore everything in uri2 after the last slash (/), the two URIs are identical. Using http://host/path/path/file?query as the base URI, the following table shows whether it is a base for other URIs. - -|URI|http://host/path/path/file?query is base of| -|---------|------------------------------------------------------| -|http://host/path/path/file/|yes| -|http://host/path/path/#fragment|yes| -|http://host/path/path/MoreDir/"|yes| -|http://host/path/path/OtherFile?Query|yes| -|http://host/path/path/|yes| -|http://host/path/path/file|yes| -|http://host/path/path|no| -|http://host/path/path?query|no| -|http://host/path/path#Fragment|no| -|http://host/path/path2/|no| -://host/path/path2/MoreDir|no| + is used to compare the current instance to a specified to determine whether this URI is a base for the specified . When comparing two objects to determine a base relationship, the user information () is not evaluated. When comparing two URIs (uri1 and uri2), uri1 is the base of uri2 if, when you ignore everything in uri2 after the last slash (/), the two URIs are identical. Using http://host/path/path/file?query as the base URI, the following table shows whether it is a base for other URIs. + +|URI|http://host/path/path/file?query is base of| +|---------|------------------------------------------------------| +|http://host/path/path/file/|yes| +|http://host/path/path/#fragment|yes| +|http://host/path/path/MoreDir/"|yes| +|http://host/path/path/OtherFile?Query|yes| +|http://host/path/path/|yes| +|http://host/path/path/file|yes| +|http://host/path/path|no| +|http://host/path/path?query|no| +|http://host/path/path#Fragment|no| +|http://host/path/path2/|no| +://host/path/path2/MoreDir|no| |http://host/path/File|no| - -## Examples - This example creates a instance that represents a base instance. It then creates a second instance from a string. It calls to determine whether the base instance is the base of the second instance. The outcome is written to the console. - + +## Examples + This example creates a instance that represents a base instance. It then creates a second instance from a string. It calls to determine whether the base instance is the base of the second instance. The outcome is written to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriEnhancements/CPP/nclurienhancements.cpp" id="Snippet6"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriEnhancements/CS/nclurienhancements.cs" interactive="try-dotnet-method" id="Snippet6"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriEnhancements/VB/nclurienhancements.vb" id="Snippet6"::: @@ -2870,11 +2870,11 @@ The length of exceeds 32766 characters. if the value in the property is the default port for this scheme; otherwise, . - instance and checks whether it uses the default port. - + instance and checks whether it uses the default port. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet4"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet4"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet4"::: @@ -2980,14 +2980,14 @@ The length of exceeds 32766 characters. if the is a file URI; otherwise, . - property is `true` when the property equals . - -## Examples - The following example creates a instance and determines whether it is a file URI. - + +## Examples + The following example creates a instance and determines whether it is a file URI. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet6"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" id="Snippet6"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet6"::: @@ -3037,14 +3037,14 @@ The length of exceeds 32766 characters. if the character is a valid hexadecimal digit; otherwise, . - exceeds 32766 characters. if is hexadecimal encoded at the specified location; otherwise, . - method checks for hexadecimal encoding that follows the pattern "%hexhex" in a string, where "hex" is a digit from 0 to 9 or a letter from A-F (case-insensitive). - -## Examples - The following code example determines whether a character is hexadecimal encoded and, if so, writes the equivalent character to the console. - + +## Examples + The following code example determines whether a character is hexadecimal encoded and, if so, writes the equivalent character to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet2"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet2"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet2"::: - + ]]>
@@ -3151,14 +3151,14 @@ The length of exceeds 32766 characters. if this references the local host; otherwise, . - returns `true` if the URI specified when this instance was created was 127.0.0.1, loopback, or localhost, or if the URI did not specify host information (for example, file:///c:Dir/file.txt). All other URIs return `false`. - -## Examples - The following example creates a instance and determines whether it references a local host. - + +## Examples + The following example creates a instance and determines whether it references a local host. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet6"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" id="Snippet6"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet6"::: @@ -3264,18 +3264,18 @@ The length of exceeds 32766 characters. if the is a UNC path; otherwise, . - property is `true` if the specified instance is a UNC path (such as `\\server\folder`, //server, or `file://server/folder`). This property always returns `true` if the URI has the file:// scheme and specifies a host component. - -## Examples - The following example creates a instance and determines whether it is a UNC path. - + +## Examples + The following example creates a instance and determines whether it is a UNC path. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet6"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet6"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet6"::: - + ]]> This instance represents a relative URI, and this property is valid only for absolute URIs. @@ -3321,28 +3321,28 @@ The length of exceeds 32766 characters. if the string was well-formed; otherwise, . - that represents an implicit file .|`c:\\directory\filename`| -|The string is an absolute URI that is missing a slash before the path.|`file://c:/directory/filename`| -|The string contains unescaped backslashes even if they are treated as forward slashes.|`http:\\\host/path/file`| -|The string represents a hierarchical absolute and does not contain "://".|`www.contoso.com/path/file`| -|The parser for the indicates that the original string was not well-formed.|The example depends on the scheme of the URI.| - - By default, the string used to construct this are considered well-formed in accordance with RFC 2396 and RFC 2732. - - When International Resource Identifier (IRI) and Internationalized Domain Name (IDN) support are enabled, the string used to construct this are considered well-formed in accordance with RFC 3986 and RFC 3987. Punycode names used to support IRI contain only ASCII characters and always start with the xn-- prefix. - - For more information on IRI support, see the Remarks section for the class. - + that represents an implicit file .|`c:\\directory\filename`| +|The string is an absolute URI that is missing a slash before the path.|`file://c:/directory/filename`| +|The string contains unescaped backslashes even if they are treated as forward slashes.|`http:\\\host/path/file`| +|The string represents a hierarchical absolute and does not contain "://".|`www.contoso.com/path/file`| +|The parser for the indicates that the original string was not well-formed.|The example depends on the scheme of the URI.| + + By default, the string used to construct this are considered well-formed in accordance with RFC 2396 and RFC 2732. + + When International Resource Identifier (IRI) and Internationalized Domain Name (IDN) support are enabled, the string used to construct this are considered well-formed in accordance with RFC 3986 and RFC 3987. Punycode names used to support IRI contain only ASCII characters and always start with the xn-- prefix. + + For more information on IRI support, see the Remarks section for the class. + ]]> Internet Engineering Task Force (IETF) @@ -3394,27 +3394,27 @@ The length of exceeds 32766 characters. if the string was well-formed; otherwise, . - that represents an implicit file .|`c:\\directory\filename`| -|The string is an absolute URI that is missing a slash before the path.|`file://c:/directory/filename`| -|The string contains unescaped backslashes even if they will be treated as forward slashes|`http:\\\host/path/file`| -|The string represents a hierarchical absolute and does not contain "://"|`www.contoso.com/path/file`| -|The parser for the indicates that the original string was not well-formed.|The example depends on the scheme of the URI.| -|Beginning with .NET 4.5, relative URIs with a colon (':') in their first segment are not considered well-formed.|`2013.05.29_14:33:41`| - - For more information on IRI support, see the Remarks section for the class. - + that represents an implicit file .|`c:\\directory\filename`| +|The string is an absolute URI that is missing a slash before the path.|`file://c:/directory/filename`| +|The string contains unescaped backslashes even if they will be treated as forward slashes|`http:\\\host/path/file`| +|The string represents a hierarchical absolute and does not contain "://"|`www.contoso.com/path/file`| +|The parser for the indicates that the original string was not well-formed.|The example depends on the scheme of the URI.| +|Beginning with .NET 4.5, relative URIs with a colon (':') in their first segment are not considered well-formed.|`2013.05.29_14:33:41`| + + For more information on IRI support, see the Remarks section for the class. + ]]> Internet Engineering Task Force (IETF) @@ -3459,19 +3459,19 @@ The length of exceeds 32766 characters.Gets a local operating-system representation of a file name. The local operating-system representation of a file name. - instance and writes the local path to the console. - + +## Examples + The following example creates a instance and writes the local path to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet6"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" id="Snippet6"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet6"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet6"::: ]]> @@ -3529,27 +3529,27 @@ The length of exceeds 32766 characters. The URI to compare to the current URI. Determines the difference between two instances. - If the hostname and scheme of this URI instance and are the same, then this method returns a that represents a relative URI that, when appended to the current URI instance, yields the parameter. - + If the hostname and scheme of this URI instance and are the same, then this method returns a that represents a relative URI that, when appended to the current URI instance, yields the parameter. + If the hostname or scheme is different, then this method returns a that represents the parameter. - . - -|Current URI instance|`toUri`|Return value| -|--------------------------|-------------|------------------| -|`http://www.contoso.com/`|`http://www.contoso.com/test/test.htm`|`test/test.htm`| -|`http://www.contoso.com/test1/`|`http://www.contoso.com/`|`../`| -|`http://www.contoso.com:8000/`|`http://www.contoso.com/test/test.htm`|`http://www.contoso.com/test/test.htm`| -|`http://username@www.contoso.com/`|`http://www.contoso.com/test1/test1.txt`|`test1/test1.txt`| - + . + +|Current URI instance|`toUri`|Return value| +|--------------------------|-------------|------------------| +|`http://www.contoso.com/`|`http://www.contoso.com/test/test.htm`|`test/test.htm`| +|`http://www.contoso.com/test1/`|`http://www.contoso.com/`|`../`| +|`http://www.contoso.com:8000/`|`http://www.contoso.com/test/test.htm`|`http://www.contoso.com/test/test.htm`| +|`http://username@www.contoso.com/`|`http://www.contoso.com/test1/test1.txt`|`test1/test1.txt`| + User information, if present in the URI, is ignored. - -## Examples - The following example creates 2 instances. The difference in the path information is written to the console. - + +## Examples + The following example creates 2 instances. The difference in the path information is written to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet3"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet3"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet3"::: @@ -3601,27 +3601,27 @@ The length of exceeds 32766 characters. The URI to compare to the current URI. Determines the difference between two instances. - If the hostname and scheme of this URI instance and are the same, then this method returns a relative that, when appended to the current URI instance, yields . - + If the hostname and scheme of this URI instance and are the same, then this method returns a relative that, when appended to the current URI instance, yields . + If the hostname or scheme is different, then this method returns a that represents the parameter. - . - -|Current URI instance|`toUri`|Return value| -|--------------------------|-------------|------------------| -|`http://www.contoso.com/`|`http://www.contoso.com/test/test.htm`|`test/test.htm`| -|`http://www.contoso.com/test1/`|`http://www.contoso.com/`|`../`| -|`http://www.contoso.com:8000/`|`http://www.contoso.com/test/test.htm`|`http://www.contoso.com/test/test.htm`| -|`http://username@www.contoso.com/`|`http://www.contoso.com/test1/test1.txt`|`test1/test1.txt`| - + . + +|Current URI instance|`toUri`|Return value| +|--------------------------|-------------|------------------| +|`http://www.contoso.com/`|`http://www.contoso.com/test/test.htm`|`test/test.htm`| +|`http://www.contoso.com/test1/`|`http://www.contoso.com/`|`../`| +|`http://www.contoso.com:8000/`|`http://www.contoso.com/test/test.htm`|`http://www.contoso.com/test/test.htm`| +|`http://username@www.contoso.com/`|`http://www.contoso.com/test1/test1.txt`|`test1/test1.txt`| + User information, if present in the URI, is ignored. - -## Examples - The following example creates 2 instances. The difference in the path information is written to the console. - + +## Examples + The following example creates 2 instances. The difference in the path information is written to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet3"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet3"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet3"::: @@ -3679,17 +3679,17 @@ The length of exceeds 32766 characters. if the instances are equivalent; otherwise, . - method to determine whether the two instances are equivalent. and content is ignored when making this comparison. - -## Examples - This example creates three instances from strings and compares them to determine whether they represent the same value. `Address1` and `Address2` are the same because the portion is ignored for this comparison. The outcome is written to the console. - + +## Examples + This example creates three instances from strings and compares them to determine whether they represent the same value. `Address1` and `Address2` are the same because the portion is ignored for this comparison. The outcome is written to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriEnhancements/CPP/nclurienhancements.cpp" id="Snippet5"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriEnhancements/CS/nclurienhancements.cs" interactive="try-dotnet-method" id="Snippet5"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriEnhancements/VB/nclurienhancements.vb" id="Snippet5"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriEnhancements/VB/nclurienhancements.vb" id="Snippet5"::: ]]> @@ -3741,17 +3741,17 @@ The length of exceeds 32766 characters. if the two instances are not equal; otherwise, . If either parameter is , this method returns . - method to determine whether the two instances are not equivalent. and content is ignored when making this comparison. - -## Examples - This example creates three instances from strings and compares them to determine whether they represent the same value. `Address2` and `Address3` are not the same because `Address3` contains a that is not found in `Address2`. The outcome is written to the console. - + +## Examples + This example creates three instances from strings and compares them to determine whether they represent the same value. `Address2` and `Address3` are not the same because `Address3` contains a that is not found in `Address2`. The outcome is written to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriEnhancements/CPP/nclurienhancements.cpp" id="Snippet5"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriEnhancements/CS/nclurienhancements.cs" interactive="try-dotnet-method" id="Snippet5"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriEnhancements/VB/nclurienhancements.vb" id="Snippet5"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriEnhancements/VB/nclurienhancements.vb" id="Snippet5"::: ]]> @@ -3795,26 +3795,26 @@ The length of exceeds 32766 characters.Gets the original URI string that was passed to the constructor. The exact URI specified when this instance was constructed; otherwise, . - and . returns the canonically unescaped form of the URI. returns the canonically escaped form of the URI. - - When International Resource Identifier (IRI) and Internationalized Domain Name (IDN) support are enabled, returns the original non normalized string with Punycode host name if one was used to initialize the instance. Punycode names contain only ASCII characters and always start with the xn-- prefix. - - For more information on IRI support, see the Remarks section for the class. - + and . returns the canonically unescaped form of the URI. returns the canonically escaped form of the URI. + + When International Resource Identifier (IRI) and Internationalized Domain Name (IDN) support are enabled, returns the original non normalized string with Punycode host name if one was used to initialize the instance. Punycode names contain only ASCII characters and always start with the xn-- prefix. + + For more information on IRI support, see the Remarks section for the class. + When a object is serialized, the is not preserved. The serialization process uses the fully escaped and canonicalized property when serializing. For a that contains an IPv6 address, the IPv6 address and the scope ID are included in the serialized object. - -## Examples - The following example creates a new instance from a string. It illustrates the difference between the value returned from , which returns the string that was passed to the constructor, and from a call to , which returns the canonical form of the string. + +## Examples + The following example creates a new instance from a string. It illustrates the difference between the value returned from , which returns the string that was passed to the constructor, and from a call to , which returns the canonical form of the string. :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriEnhancements/CPP/nclurienhancements.cpp" id="Snippet3"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriEnhancements/CS/nclurienhancements.cs" interactive="try-dotnet-method" id="Snippet3"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriEnhancements/VB/nclurienhancements.vb" id="Snippet3"::: - + ]]> @@ -3910,18 +3910,18 @@ The length of exceeds 32766 characters.Gets the and properties separated by a question mark (?). The and properties separated by a question mark (?). - property contains the absolute path on the server and the query information sent with the request. It is identical to concatenating the and properties. - - The property is escaped according to RFC 2396 by default. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the property is escaped according to RFC 3986 and RFC 3987. - + property contains the absolute path on the server and the query information sent with the request. It is identical to concatenating the and properties. + + The property is escaped according to RFC 2396 by default. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the property is escaped according to RFC 3986 and RFC 3987. + For more information on IRI support, see the Remarks section for the class. - -## Examples + +## Examples The following example writes the URI path (`/catalog/shownew.htm`) and query (`?date=today`) information to the console. - + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/Classic Uri.PathAndQuery Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/Classic Uri.PathAndQuery Example/CS/source.cs" interactive="try-dotnet-method" id="Snippet1"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.PathAndQuery Example/VB/source.vb" id="Snippet1"::: @@ -3970,18 +3970,18 @@ The length of exceeds 32766 characters.Gets the port number of this URI. The port number for this URI. - property returns the default value for the protocol. If there is no default port number, this property returns -1. - -## Examples - The following example writes the URI port number to the console. In this case, the value is the default port number for HTTP, port 80. - + +## Examples + The following example writes the URI port number to the console. In this case, the value is the default port number for HTTP, port 80. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/Classic Uri.Port Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/Classic Uri.Port Example/CS/source.cs" interactive="try-dotnet-method" id="Snippet1"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.Port Example/VB/source.vb" id="Snippet1"::: - + ]]> This instance represents a relative URI, and this property is valid only for absolute URIs. @@ -4026,18 +4026,18 @@ The length of exceeds 32766 characters.Gets any query information included in the specified URI. Any query information included in the specified URI. - 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. - - The query information is escaped according to RFC 2396 by default. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the query information is escaped according to RFC 3986 and RFC 3987. - + 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. + + The query information is escaped according to RFC 2396 by default. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the query information is escaped according to RFC 3986 and RFC 3987. + For more information on IRI support, see the Remarks section for the class. - -## Examples - The following example writes the query `?date=today` to the console. - + +## Examples + The following example writes the query `?date=today` to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/Classic Uri.PathAndQuery Example/CPP/source.cpp" id="Snippet2"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/Classic Uri.PathAndQuery Example/CS/source.cs" interactive="try-dotnet-method" id="Snippet2"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.PathAndQuery Example/VB/source.vb" id="Snippet2"::: @@ -4086,32 +4086,32 @@ The length of exceeds 32766 characters.Gets the scheme name for this URI. The scheme for this URI, converted to lowercase. - property returns the scheme used to initialize the instance. This property does not indicate that the scheme used to initialize the instance was recognized. - - The following table shows examples of some possible values returned by the property. - -|Scheme|Description| -|------------|-----------------| -|file|The resource is a file on the local computer.| -|ftp|The resource is accessed through FTP.| -|gopher|The resource is accessed through the Gopher protocol.| -|http|The resource is accessed through HTTP.| -|https|The resource is accessed through SSL-encrypted HTTP.| -|ldap|The resource is accessed through the LDAP protocol.| -|mailto|The resource is an email address and accessed through the SMTP protocol.| -|net.pipe|The resource is accessed through a named pipe.| -|net.tcp|The resource is accessed from TCP endpoint.| -|news|The resource is accessed through the NNTP protocol.| -|nntp|The resource is accessed through the NNTP protocol.| -|telnet|The resource is accessed through the TELNET protocol.| + property returns the scheme used to initialize the instance. This property does not indicate that the scheme used to initialize the instance was recognized. + + The following table shows examples of some possible values returned by the property. + +|Scheme|Description| +|------------|-----------------| +|file|The resource is a file on the local computer.| +|ftp|The resource is accessed through FTP.| +|gopher|The resource is accessed through the Gopher protocol.| +|http|The resource is accessed through HTTP.| +|https|The resource is accessed through SSL-encrypted HTTP.| +|ldap|The resource is accessed through the LDAP protocol.| +|mailto|The resource is an email address and accessed through the SMTP protocol.| +|net.pipe|The resource is accessed through a named pipe.| +|net.tcp|The resource is accessed from TCP endpoint.| +|news|The resource is accessed through the NNTP protocol.| +|nntp|The resource is accessed through the NNTP protocol.| +|telnet|The resource is accessed through the TELNET protocol.| |uuid|The resource is accessed through a unique UUID endpoint name for communicating with a service.| - -## Examples - The following example writes the scheme name (http) to the console for the `http://www.contoso.com/` URI. - + +## Examples + The following example writes the scheme name (http) to the console for the `http://www.contoso.com/` URI. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/Classic Uri.Scheme Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/Classic Uri.Scheme Example/CS/source.cs" interactive="try-dotnet-method" id="Snippet1"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/Classic Uri.Scheme Example/VB/source.vb" id="Snippet1"::: @@ -4155,15 +4155,15 @@ The length of exceeds 32766 characters. Specifies the characters that separate the communication protocol scheme from the address portion of the URI. This field is read-only. - , , and an address. A instance is then created from the string. - + , , and an address. A instance is then created from the string. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet17"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet17"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet17"::: - + ]]> @@ -4207,44 +4207,44 @@ The length of exceeds 32766 characters.Gets an array containing the path segments that make up the specified URI. The path segments that make up the specified URI. - property returns an array of strings containing the "segments" (substrings) that form the URI's absolute path. The first segment is obtained by parsing the absolute path from its first character until you reach a slash (/) or the end of the path. Each additional segment begins at the first character after the preceding segment, and terminates with the next slash or the end of the path. (A URI's absolute path contains everything after the host and port and before the query and fragment.) - - The following example shows the absolute path and segments for two URIs. The second example illustrates that the fragment and query are not part of the absolute path and therefore are not segments. - - Absolute URI: + property returns an array of strings containing the "segments" (substrings) that form the URI's absolute path. The first segment is obtained by parsing the absolute path from its first character until you reach a slash (/) or the end of the path. Each additional segment begins at the first character after the preceding segment, and terminates with the next slash or the end of the path. (A URI's absolute path contains everything after the host and port and before the query and fragment.) + + The following example shows the absolute path and segments for two URIs. The second example illustrates that the fragment and query are not part of the absolute path and therefore are not segments. + + Absolute URI: `http://www.contoso.com/Chapters/Chapter1/Sections/Section1.htm` - - Absolute path: - /Chapters/Chapter1/Sections/Section1.htm - - Segments: + + Absolute path: + /Chapters/Chapter1/Sections/Section1.htm + + Segments: - / - Chapters/ - Chapter1/ - Sections/ - - Section1.htm - - Absolute URI: + - Section1.htm + + Absolute URI: `http://www.contoso.com/Chapters/Chapter1/Sections/Section1.htm#page1?answer=NO` - - Absolute path: - /Chapters/Chapter1/Sections/Section1.htm - - Segments: + + Absolute path: + /Chapters/Chapter1/Sections/Section1.htm + + Segments: - / - Chapters/ - Chapter1/ - Sections/ - - Section1.htm - + - Section1.htm + Note that because the absolute path starts with a '/', the first segment contains it and nothing else. - -## Examples - The following example creates a instance with 3 segments and displays the segments on the screen. - + +## Examples + The following example creates a instance with 3 segments and displays the segments on the screen. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet5"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet5"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet5"::: @@ -4345,17 +4345,17 @@ The length of exceeds 32766 characters.Gets a canonical string representation for the specified instance. The unescaped canonical representation of the instance. All characters are unescaped except #, ?, and %. - [!NOTE] > The string returned by the method may contain control characters, which can corrupt the state of a console application. You can use the method with the format to remove control characters from the returned string. - -## Examples - The following example creates a new instance from a string. It illustrates the difference between the value returned from , which returns the string that was passed to the constructor, and from a call to , which returns the canonical form of the string. - + +## Examples + The following example creates a new instance from a string. It illustrates the difference between the value returned from , which returns the string that was passed to the constructor, and from a call to , which returns the canonical form of the string. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet7"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet7"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet7"::: @@ -4425,11 +4425,12 @@ The length of exceeds 32766 characters. - To be added. - To be added. - To be added. - To be added. - To be added. + The string representation of the . + Options that control how the is created and behaves. + The constructed . + Creates a new using the specified instance and . + + if the was successfully created; otherwise, . To be added. @@ -4481,11 +4482,11 @@ The length of exceeds 32766 characters. if the was successfully created; otherwise, . - is in `result`. - + is in `result`. + ]]> @@ -4538,11 +4539,11 @@ The length of exceeds 32766 characters. if the was successfully created; otherwise, . - is in `result`. - + is in `result`. + ]]> @@ -4595,13 +4596,13 @@ The length of exceeds 32766 characters. if the was successfully created; otherwise, . - is in `result`. - - This method constructs the URI, puts it in canonical form, and validates it. If an unhandled exception occurs, this method catches it. If you want to create a and get exceptions use one of the constructors. - + is in `result`. + + This method constructs the URI, puts it in canonical form, and validates it. If an unhandled exception occurs, this method catches it. If you want to create a and get exceptions use one of the constructors. + ]]> @@ -4705,17 +4706,17 @@ The length of exceeds 32766 characters.Converts a string to its unescaped representation. The unescaped representation of . - @@ -4759,14 +4760,14 @@ The length of exceeds 32766 characters. Specifies that the URI is a pointer to a file. This field is read-only. - instance and determines whether the scheme is . - + +## Examples + The following example creates a instance and determines whether the scheme is . + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet10"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet10"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet10"::: @@ -4809,11 +4810,11 @@ The length of exceeds 32766 characters. Specifies that the URI is accessed through the File Transfer Protocol (FTP). This field is read-only. - instance and determines whether the scheme is . - + instance and determines whether the scheme is . + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet15"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet15"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet15"::: @@ -4882,11 +4883,11 @@ The length of exceeds 32766 characters. Specifies that the URI is accessed through the Gopher protocol. This field is read-only. - instance and determines whether the scheme is . - + instance and determines whether the scheme is . + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet14"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet14"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet14"::: @@ -4929,14 +4930,14 @@ The length of exceeds 32766 characters. Specifies that the URI is accessed through the Hypertext Transfer Protocol (HTTP). This field is read-only. - instance and determines whether the scheme is . - + instance and determines whether the scheme is . + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet9"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet9"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet9"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet9"::: ]]> @@ -4976,11 +4977,11 @@ The length of exceeds 32766 characters. Specifies that the URI is accessed through the Secure Hypertext Transfer Protocol (HTTPS). This field is read-only. - instance and determines whether the scheme is . - + instance and determines whether the scheme is . + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet16"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet16"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet16"::: @@ -5023,11 +5024,11 @@ The length of exceeds 32766 characters. Specifies that the URI is an email address and is accessed through the Simple Mail Transport Protocol (SMTP). This field is read-only. - instance and determines whether the scheme is . - + instance and determines whether the scheme is . + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet11"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet11"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet11"::: @@ -5140,11 +5141,11 @@ The length of exceeds 32766 characters. Specifies that the URI is an Internet news group and is accessed through the Network News Transport Protocol (NNTP). This field is read-only. - instance and determines whether the scheme is . - + instance and determines whether the scheme is . + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet12"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet12"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet12"::: @@ -5187,15 +5188,15 @@ The length of exceeds 32766 characters. Specifies that the URI is an Internet news group and is accessed through the Network News Transport Protocol (NNTP). This field is read-only. - parsing errors in .NET Framework version 1.1 have been corrected. - -## Examples - The following example creates a instance and determines whether the scheme is . - - :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet13"::: + +## Examples + The following example creates a instance and determines whether the scheme is . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet13"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet13"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet13"::: @@ -5373,14 +5374,14 @@ The length of exceeds 32766 characters. if the parameter was set to when the instance was created; otherwise, . - property is set to `true` to indicate that the string used to create the instance was completely escaped before it was passed to the constructor; that is, the `dontEscape` parameter of the constructor call was set to `true`. - -## Examples - The following example creates a instance and determines whether it was fully escaped when it was created. - + +## Examples + The following example creates a instance and determines whether it was fully escaped when it was created. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet18"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet18"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet18"::: @@ -5428,17 +5429,17 @@ The length of exceeds 32766 characters.Gets the user name, password, or other user-specific information associated with the specified URI. The user information associated with the URI. The returned value does not include the '@' character reserved for delimiting the user information part of the URI. - instance and writes the user information to the console. - + +## Examples + The following example creates a instance and writes the user information to the console. + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Remoting/NCLUriExamples/CPP/uriexamples.cpp" id="Snippet18"::: :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Remoting/NCLUriExamples/CS/uriexamples.cs" interactive="try-dotnet-method" id="Snippet18"::: - :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet18"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Remoting/NCLUriExamples/VB/uriexamples.vb" id="Snippet18"::: ]]>