diff --git a/xml/System.IO/File.xml b/xml/System.IO/File.xml index ca18a64fcd9..1f89926ed5c 100644 --- a/xml/System.IO/File.xml +++ b/xml/System.IO/File.xml @@ -150,10 +150,40 @@ - To be added. - To be added. - To be added. + The file to append to. + The bytes to append to the file. + + Appends the specified byte array to the end of the file at the given path. + If the file doesn't exist, this method creates a new file. + To be added. + + or is . + + + is empty. + The specified path, file name, or both exceed the system-defined maximum length. + The specified path is invalid (for example, it is on an unmapped drive). + An I/O error occurred while opening the file. + + + specified a file that is read-only. + + -or- + + specified a file that is hidden. + + -or- + + specified a directory. + + -or- + The caller does not have the required permission. + -or- + This operation is not supported on the current platform. + + + is in an invalid format. @@ -195,10 +225,38 @@ - To be added. - To be added. - To be added. + The file to append to. + The bytes to append to the file. + + Appends the specified byte array to the end of the file at the given path. + If the file doesn't exist, this method creates a new file. + To be added. + + is . + + is empty. + The specified path, file name, or both exceed the system-defined maximum length. + The specified path is invalid (for example, it is on an unmapped drive). + An I/O error occurred while opening the file. + + + specified a file that is read-only. + + -or- + + specified a file that is hidden. + + -or- + + specified a directory. + + The caller does not have the required permission. + -or- + This operation is not supported on the current platform. + + + is in an invalid format. @@ -230,12 +288,21 @@ - To be added. - To be added. - To be added. - To be added. + The file to append to. + The bytes to append to the file. + The token to monitor for cancellation requests. The default value is . + + Asynchronously appends the specified byte array to the end of the file at the given path. + If the file doesn't exist, this method creates a new file. If the operation is canceled, the task will return in a canceled state. + To be added. To be added. + + or is . + + + is empty. + The cancellation token was canceled. This exception is stored into the returned task. @@ -271,12 +338,20 @@ - To be added. - To be added. - To be added. - To be added. + The file to append to. + The bytes to append to the file. + The token to monitor for cancellation requests. The default value is . + + Asynchronously appends the specified byte array to the end of the file at the given path. + If the file doesn't exist, this method creates a new file. If the operation is canceled, the task will return in a canceled state. + To be added. To be added. + + is . + + is empty. + The cancellation token was canceled. This exception is stored into the returned task. @@ -619,10 +694,40 @@ - To be added. - To be added. - To be added. - To be added. + The file to append to. + The characters to write to the file. + Appends the specified string to the file, creating the file if it does not already exist. + + Given a string and a file path, this method opens the specified file, appends the string to the end of the file using the specified encoding, + and then closes the file. The file handle is guaranteed to be closed by this method, even if exceptions are raised. The method creates the file + if it doesn't exist, but it doesn't create new directories. Therefore, the value of the path parameter must contain existing directories. + + + is . + + is empty. + The specified path, file name, or both exceed the system-defined maximum length. + The specified path is invalid (for example, it is on an unmapped drive). + An I/O error occurred while opening the file. + + + specified a file that is read-only. + + -or- + + specified a file that is hidden. + + -or- + + specified a directory. + + -or- + The caller does not have the required permission. + -or- + This operation is not supported on the current platform. + + + is in an invalid format. @@ -763,11 +868,42 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The file to append to. + The characters to write to the file. + The encoding to apply to the string. + Appends the specified string to the file, creating the file if it does not already exist. + + Given a string and a file path, this method opens the specified file, appends the string to the end of the file using the specified encoding, + and then closes the file. The file handle is guaranteed to be closed by this method, even if exceptions are raised. The method creates the file + if it doesn't exist, but it doesn't create new directories. Therefore, the value of the path parameter must contain existing directories. + + + or is . + + + is empty. + The specified path, file name, or both exceed the system-defined maximum length. + The specified path is invalid (for example, it is on an unmapped drive). + An I/O error occurred while opening the file. + + + specified a file that is read-only. + + -or- + + specified a file that is hidden. + + -or- + + specified a directory. + + -or- + The caller does not have the required permission. + -or- + This operation is not supported on the current platform. + + + is in an invalid format. @@ -909,12 +1045,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The file to append the specified string to. + The characters to append to the file. + The token to monitor for cancellation requests. The default value is . + Asynchronously opens a file or creates a file if it does not already exist, appends the specified string to the file, and then closes the file. + A task that represents the asynchronous append operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -1005,13 +1142,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The file to append the specified string to. + The characters to append to the file. + The character encoding to use. + The token to monitor for cancellation requests. The default value is . + Asynchronously opens a file or creates the file if it does not already exist, appends the specified string to the file using the specified encoding, and then closes the file. + A task that represents the asynchronous append operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -6908,10 +7046,36 @@ It is not possible to change the compression status of a o - To be added. - To be added. - To be added. + The file to write to. + The bytes to write to the file. + Creates a new file, writes the specified byte array to the file, and then closes the file. If the target file already exists, it is truncated and overwritten. To be added. + + is . + + is empty. + The specified path, file name, or both exceed the system-defined maximum length. + The specified path is invalid (for example, it is on an unmapped drive). + An I/O error occurred while opening the file. + + + specified a file that is read-only. + + -or- + + specified a file that is hidden. + + -or- + + specified a directory. + + -or- + The caller does not have the required permission. + -or- + This operation is not supported on the current platform. + + + is in an invalid format. @@ -6993,12 +7157,17 @@ It is not possible to change the compression status of a o - To be added. - To be added. - To be added. - To be added. - To be added. + The file to write to. + The bytes to write to the file. + The token to monitor for cancellation requests. The default value is . + Asynchronously creates a new file, writes the specified byte array to the file, and then closes the file. If the target file already exists, it is truncated and overwritten. + A task that represents the asynchronous write operation. To be added. + + is . + + is empty. + The cancellation token was canceled. This exception is stored into the returned task. @@ -7551,10 +7720,38 @@ It is not possible to change the compression status of a o - To be added. - To be added. - To be added. - To be added. + The file to write to. + The characters to write to the file. + + Creates a new file, writes the specified string to the file, and then closes the file. + If the target file already exists, it is truncated and overwritten. + + This method uses UTF-8 encoding without a Byte-Order Mark (BOM), so using the method will return an empty byte array. If it is necessary to include a UTF-8 identifier, such as a byte order mark, at the beginning of a file, use the method. + + is . + + is empty. + The specified path, file name, or both exceed the system-defined maximum length. + The specified path is invalid (for example, it is on an unmapped drive). + An I/O error occurred while opening the file. + + + specified a file that is read-only. + + -or- + + specified a file that is hidden. + + -or- + + specified a directory. + + -or- + This operation is not supported on the current platform. + The caller does not have the required permission. + + + is in an invalid format. @@ -7699,11 +7896,41 @@ It is not possible to change the compression status of a o - To be added. - To be added. - To be added. - To be added. + The file to write to. + The characters to write to the file. + The encoding to apply to the string. + + Creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. + If the target file already exists, it is truncated and overwritten. + To be added. + + or is . + + + is empty. + The specified path, file name, or both exceed the system-defined maximum length. + The specified path is invalid (for example, it is on an unmapped drive). + An I/O error occurred while opening the file. + + + specified a file that is read-only. + + -or- + + specified a file that is hidden. + + -or- + + specified a directory. + + -or- + The caller does not have the required permission. + -or- + This operation is not supported on the current platform. + + + is in an invalid format. @@ -7847,12 +8074,16 @@ It is not possible to change the compression status of a o - To be added. - To be added. - To be added. - To be added. - To be added. + The file to write to. + The characters to write to the file. + The token to monitor for cancellation requests. The default value is . + + Asynchronously creates a new file, writes the specified string to the file, and then closes the file. + If the target file already exists, it is truncated and overwritten. + + A task that represents the asynchronous write operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. @@ -7943,13 +8174,17 @@ It is not possible to change the compression status of a o - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The file to write to. + The characters to write to the file. + The encoding to apply to the string. + The token to monitor for cancellation requests. The default value is . + + Asynchronously creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. + If the target file already exists, it is truncated and overwritten. + + A task that represents the asynchronous write operation. To be added. + The cancellation token was canceled. This exception is stored into the returned task. diff --git a/xml/System.IO/Path.xml b/xml/System.IO/Path.xml index d362edd8a3a..573ad4d7da5 100644 --- a/xml/System.IO/Path.xml +++ b/xml/System.IO/Path.xml @@ -355,9 +355,9 @@ This method is intended to concatenate individual strings into a single string t - To be added. - To be added. - To be added. + A span of parts of the path. + Combines a span of strings into a path. + The combined paths. To be added. @@ -2890,9 +2890,9 @@ Note that rooted paths can be either absolute (that is, fully qualified) or rela - To be added. - To be added. - To be added. + A span of paths. + Concatenates a span of paths into a single path. + The concatenated path. To be added. diff --git a/xml/System.IO/StreamWriter.xml b/xml/System.IO/StreamWriter.xml index a18ac46a6e7..6e5e92b77d7 100644 --- a/xml/System.IO/StreamWriter.xml +++ b/xml/System.IO/StreamWriter.xml @@ -2117,9 +2117,9 @@ See for a descr - To be added. - To be added. - To be added. + A composite format string. + An object span that contains zero or more objects to format and write. + Writes a formatted string to the stream, using the same semantics as . To be added. @@ -2976,9 +2976,9 @@ See for a d - To be added. - To be added. - To be added. + A composite format string. + An object span that contains zero or more objects to format and write. + Writes out a formatted string and a new line to the stream, using the same semantics as . To be added. diff --git a/xml/System.IO/TextWriter.xml b/xml/System.IO/TextWriter.xml index e8c5c42b973..f1a05c07869 100644 --- a/xml/System.IO/TextWriter.xml +++ b/xml/System.IO/TextWriter.xml @@ -439,10 +439,15 @@ - To be added. - To be added. - To be added. - To be added. + The instances to which all operations should be broadcast (multiplexed). + Creates an instance of that writes supplied inputs to each of the writers in . + An instance of that writes supplied inputs to each of the writers in + + The resulting instance will delegate each operation to each of the writers in . For example, calling will write the specified char to each writer, one after the other. The writers will be written to in the same order as they are specified in . An exception from the operation on one writer will prevent the operation from being performed on subsequent writers. + and will return the corresponding object from first writer in . + + + is or it contains a . @@ -2470,9 +2475,9 @@ This method is equivalent to `Write(stringBuilder.ToString())`, but it uses the - To be added. - To be added. - To be added. + A composite format string. + An object span that contains zero or more objects to format and write. + Writes a formatted string to the text stream, using the same semantics as . To be added. @@ -4627,9 +4632,9 @@ For a list of common I/O tasks, see [Common I/O Tasks](/dotnet/standard/io/commo - To be added. - To be added. - To be added. + A composite format string. + An object span that contains zero or more objects to format and write. + Writes out a formatted string and a new line to the text stream, using the same semantics as . To be added.