|
|
@@ -78,7 +78,7 @@ namespace Renci.SshNet
|
|
|
/// </summary>
|
|
|
/// <param name="path">The file to append the lines to. The file is created if it does not already exist.</param>
|
|
|
/// <param name="contents">The lines to append to the file.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is<b>null</b> <para>-or-</para> <paramref name="contents"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is<see langword="null"/> <para>-or-</para> <paramref name="contents"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -93,7 +93,7 @@ namespace Renci.SshNet
|
|
|
/// <param name="path">The file to append the lines to. The file is created if it does not already exist.</param>
|
|
|
/// <param name="contents">The lines to append to the file.</param>
|
|
|
/// <param name="encoding">The character encoding to use.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>. <para>-or-</para> <paramref name="contents"/> is <b>null</b>. <para>-or-</para> <paramref name="encoding"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="contents"/> is <see langword="null"/>. <para>-or-</para> <paramref name="encoding"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -104,7 +104,7 @@ namespace Renci.SshNet
|
|
|
/// </summary>
|
|
|
/// <param name="path">The file to append the specified string to.</param>
|
|
|
/// <param name="contents">The string to append to the file.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>. <para>-or-</para> <paramref name="contents"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="contents"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -119,7 +119,7 @@ namespace Renci.SshNet
|
|
|
/// <param name="path">The file to append the specified string to.</param>
|
|
|
/// <param name="contents">The string to append to the file.</param>
|
|
|
/// <param name="encoding">The character encoding to use.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>. <para>-or-</para> <paramref name="contents"/> is <b>null</b>. <para>-or-</para> <paramref name="encoding"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="contents"/> is <see langword="null"/>. <para>-or-</para> <paramref name="encoding"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -134,7 +134,7 @@ namespace Renci.SshNet
|
|
|
/// A <see cref="StreamWriter"/> that appends text to a file using UTF-8 encoding without a
|
|
|
/// Byte-Order Mark (BOM).
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -149,7 +149,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// A <see cref="StreamWriter"/> that appends text to a file using the specified encoding.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>. <para>-or-</para> <paramref name="encoding"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="encoding"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -163,8 +163,8 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// An <see cref="IAsyncResult" /> that references the asynchronous operation.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="output" /> is <b>null</b>.</exception>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="path" /> is <b>null</b> or contains only whitespace characters.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="output" /> is <see langword="null"/>.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to perform the operation was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SshException">A SSH error where <see cref="Exception.Message" /> is the message from the remote host.</exception>
|
|
|
@@ -183,8 +183,8 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// An <see cref="IAsyncResult" /> that references the asynchronous operation.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="output" /> is <b>null</b>.</exception>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="path" /> is <b>null</b> or contains only whitespace characters.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="output" /> is <see langword="null"/>.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to perform the operation was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SshException">A SSH error where <see cref="Exception.Message" /> is the message from the remote host.</exception>
|
|
|
@@ -205,8 +205,8 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// An <see cref="IAsyncResult" /> that references the asynchronous operation.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="output" /> is <b>null</b>.</exception>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="path" /> is <b>null</b> or contains only whitespace characters.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="output" /> is <see langword="null"/>.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
/// <remarks>
|
|
|
/// Method calls made by this method to <paramref name="output" />, may under certain conditions result in exceptions thrown by the stream.
|
|
|
@@ -237,8 +237,8 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// An <see cref="IAsyncResult" /> that represents the asynchronous directory synchronization.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="sourcePath"/> is <c>null</c>.</exception>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="destinationPath"/> is <c>null</c> or contains only whitespace.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="sourcePath"/> is <see langword="null"/>.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="destinationPath"/> is <see langword="null"/> or contains only whitespace.</exception>
|
|
|
/// <exception cref="SshException">If a problem occurs while copying the file</exception>
|
|
|
IAsyncResult BeginSynchronizeDirectories(string sourcePath, string destinationPath, string searchPattern, AsyncCallback asyncCallback, object state);
|
|
|
|
|
|
@@ -250,8 +250,8 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// An <see cref="IAsyncResult" /> that references the asynchronous operation.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="input" /> is <b>null</b>.</exception>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="path" /> is <b>null</b> or contains only whitespace characters.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="input" /> is <see langword="null"/>.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to list the contents of the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SshException">A SSH error where <see cref="Exception.Message" /> is the message from the remote host.</exception>
|
|
|
@@ -275,8 +275,8 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// An <see cref="IAsyncResult" /> that references the asynchronous operation.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="input" /> is <b>null</b>.</exception>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="path" /> is <b>null</b> or contains only whitespace characters.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="input" /> is <see langword="null"/>.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to list the contents of the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SshException">A SSH error where <see cref="Exception.Message" /> is the message from the remote host.</exception>
|
|
|
@@ -302,8 +302,8 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// An <see cref="IAsyncResult" /> that references the asynchronous operation.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="input" /> is <b>null</b>.</exception>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="path" /> is <b>null</b> or contains only whitespace characters.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="input" /> is <see langword="null"/>.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to list the contents of the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SshException">A SSH error where <see cref="Exception.Message" /> is the message from the remote host.</exception>
|
|
|
@@ -330,16 +330,16 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// An <see cref="IAsyncResult" /> that references the asynchronous operation.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="input" /> is <b>null</b>.</exception>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="path" /> is <b>null</b> or contains only whitespace characters.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="input" /> is <see langword="null"/>.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
/// <remarks>
|
|
|
/// <para>
|
|
|
/// Method calls made by this method to <paramref name="input" />, may under certain conditions result in exceptions thrown by the stream.
|
|
|
/// </para>
|
|
|
/// <para>
|
|
|
- /// When <paramref name="path"/> refers to an existing file, set <paramref name="canOverride"/> to <c>true</c> to overwrite and truncate that file.
|
|
|
- /// If <paramref name="canOverride"/> is <c>false</c>, the upload will fail and <see cref="SftpClient.EndUploadFile(IAsyncResult)"/> will throw an
|
|
|
+ /// When <paramref name="path"/> refers to an existing file, set <paramref name="canOverride"/> to <see langword="true"/> to overwrite and truncate that file.
|
|
|
+ /// If <paramref name="canOverride"/> is <see langword="false"/>, the upload will fail and <see cref="SftpClient.EndUploadFile(IAsyncResult)"/> will throw an
|
|
|
/// <see cref="SshException"/>.
|
|
|
/// </para>
|
|
|
/// </remarks>
|
|
|
@@ -349,7 +349,7 @@ namespace Renci.SshNet
|
|
|
/// Changes remote directory to path.
|
|
|
/// </summary>
|
|
|
/// <param name="path">New directory path.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to change directory denied by remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
|
|
@@ -362,7 +362,7 @@ namespace Renci.SshNet
|
|
|
/// </summary>
|
|
|
/// <param name="path">File(s) path, may match multiple files.</param>
|
|
|
/// <param name="mode">The mode.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to change permission on the path(s) was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
|
|
@@ -377,7 +377,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// A <see cref="SftpFileStream"/> that provides read/write access to the file specified in path.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -394,7 +394,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// A <see cref="SftpFileStream"/> that provides read/write access to the file specified in path.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -407,7 +407,7 @@ namespace Renci.SshNet
|
|
|
/// Creates remote directory specified by path.
|
|
|
/// </summary>
|
|
|
/// <param name="path">Directory path to create.</param>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="path"/> is <b>null</b> or contains only whitespace characters.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to create the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SshException">A SSH error where <see cref="Exception.Message"/> is the message from the remote host.</exception>
|
|
|
@@ -422,7 +422,7 @@ namespace Renci.SshNet
|
|
|
/// A <see cref="StreamWriter"/> that writes text to a file using UTF-8 encoding without
|
|
|
/// a Byte-Order Mark (BOM).
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -444,7 +444,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// A <see cref="StreamWriter"/> that writes to a file using the specified encoding.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -462,7 +462,7 @@ namespace Renci.SshNet
|
|
|
/// Deletes the specified file or directory.
|
|
|
/// </summary>
|
|
|
/// <param name="path">The name of the file or directory to be deleted. Wildcard characters are not supported.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -472,7 +472,7 @@ namespace Renci.SshNet
|
|
|
/// Deletes remote directory specified by path.
|
|
|
/// </summary>
|
|
|
/// <param name="path">Directory to be deleted path.</param>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="path"/> is <b>null</b> or contains only whitespace characters.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to delete the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
@@ -484,7 +484,7 @@ namespace Renci.SshNet
|
|
|
/// Deletes remote file specified by path.
|
|
|
/// </summary>
|
|
|
/// <param name="path">File to be deleted path.</param>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="path"/> is <b>null</b> or contains only whitespace characters.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to delete the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
@@ -498,7 +498,7 @@ namespace Renci.SshNet
|
|
|
/// <param name="path">File to be deleted path.</param>
|
|
|
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to observe.</param>
|
|
|
/// <returns>A <see cref="Task"/> that represents the asynchronous delete operation.</returns>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="path"/> is <b>null</b> or contains only whitespace characters.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to delete the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
@@ -512,8 +512,8 @@ namespace Renci.SshNet
|
|
|
/// <param name="path">File to download.</param>
|
|
|
/// <param name="output">Stream to write the file into.</param>
|
|
|
/// <param name="downloadCallback">The download callback.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="output" /> is <b>null</b>.</exception>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="path" /> is <b>null</b> or contains only whitespace characters.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="output" /> is <see langword="null"/>.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to perform the operation was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>///
|
|
|
@@ -572,9 +572,9 @@ namespace Renci.SshNet
|
|
|
/// </summary>
|
|
|
/// <param name="path">The path.</param>
|
|
|
/// <returns>
|
|
|
- /// <c>true</c> if directory or file exists; otherwise <c>false</c>.
|
|
|
+ /// <see langword="true"/> if directory or file exists; otherwise <see langword="false"/>.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="path"/> is <b>null</b> or contains only whitespace characters.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to perform the operation was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SshException">A SSH error where <see cref="Exception.Message"/> is the message from the remote host.</exception>
|
|
|
@@ -590,7 +590,7 @@ namespace Renci.SshNet
|
|
|
/// </returns>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path" /> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
ISftpFile Get(string path);
|
|
|
|
|
|
@@ -601,7 +601,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// The <see cref="SftpFileAttributes"/> of the file on the path.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -615,7 +615,7 @@ namespace Renci.SshNet
|
|
|
/// A <see cref="DateTime"/> structure set to the date and time that the specified file or directory was last accessed.
|
|
|
/// This value is expressed in local time.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
DateTime GetLastAccessTime(string path);
|
|
|
@@ -628,7 +628,7 @@ namespace Renci.SshNet
|
|
|
/// A <see cref="DateTime"/> structure set to the date and time that the specified file or directory was last accessed.
|
|
|
/// This value is expressed in UTC time.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
DateTime GetLastAccessTimeUtc(string path);
|
|
|
@@ -641,7 +641,7 @@ namespace Renci.SshNet
|
|
|
/// A <see cref="DateTime"/> structure set to the date and time that the specified file or directory was last written to.
|
|
|
/// This value is expressed in local time.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
DateTime GetLastWriteTime(string path);
|
|
|
@@ -654,7 +654,7 @@ namespace Renci.SshNet
|
|
|
/// A <see cref="DateTime"/> structure set to the date and time that the specified file or directory was last written to.
|
|
|
/// This value is expressed in UTC time.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
DateTime GetLastWriteTimeUtc(string path);
|
|
|
@@ -667,7 +667,7 @@ namespace Renci.SshNet
|
|
|
/// A <see cref="SftpFileSytemInformation"/> instance that contains file status information.
|
|
|
/// </returns>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path" /> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
SftpFileSytemInformation GetStatus(string path);
|
|
|
|
|
|
@@ -681,7 +681,7 @@ namespace Renci.SshNet
|
|
|
/// The task result contains the <see cref="SftpFileSytemInformation"/> instance that contains file status information.
|
|
|
/// </returns>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path" /> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
Task<SftpFileSytemInformation> GetStatusAsync(string path, CancellationToken cancellationToken);
|
|
|
|
|
|
@@ -693,7 +693,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// A list of files.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path" /> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to list the contents of the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SshException">A SSH error where <see cref="Exception.Message" /> is the message from the remote host.</exception>
|
|
|
@@ -709,7 +709,7 @@ namespace Renci.SshNet
|
|
|
/// An <see cref="IAsyncEnumerable{T}"/> of <see cref="ISftpFile"/> that represents the asynchronous enumeration operation.
|
|
|
/// The enumeration contains an async stream of <see cref="ISftpFile"/> for the files in the directory specified by <paramref name="path" />.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path" /> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to list the contents of the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SshException">A SSH error where <see cref="Exception.Message" /> is the message from the remote host.</exception>
|
|
|
@@ -724,7 +724,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// An unshared <see cref="SftpFileStream"/> that provides access to the specified file, with the specified mode and read/write access.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
SftpFileStream Open(string path, FileMode mode);
|
|
|
@@ -738,7 +738,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// An unshared <see cref="SftpFileStream"/> that provides access to the specified file, with the specified mode and access.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
SftpFileStream Open(string path, FileMode mode, FileAccess access);
|
|
|
@@ -754,7 +754,7 @@ namespace Renci.SshNet
|
|
|
/// A <see cref="Task{SftpFileStream}"/> that represents the asynchronous open operation.
|
|
|
/// The task result contains the <see cref="SftpFileStream"/> that provides access to the specified file, with the specified mode and access.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
Task<SftpFileStream> OpenAsync(string path, FileMode mode, FileAccess access, CancellationToken cancellationToken);
|
|
|
@@ -766,7 +766,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// A read-only <see cref="SftpFileStream"/> on the specified path.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
SftpFileStream OpenRead(string path);
|
|
|
@@ -778,7 +778,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// A <see cref="StreamReader"/> on the specified path.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
StreamReader OpenText(string path);
|
|
|
@@ -790,7 +790,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// An unshared <see cref="SftpFileStream"/> object on the specified path with <see cref="FileAccess.Write"/> access.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
/// <remarks>
|
|
|
@@ -805,7 +805,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// A byte array containing the contents of the file.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
byte[] ReadAllBytes(string path);
|
|
|
@@ -817,7 +817,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// A string array containing all lines of the file.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
string[] ReadAllLines(string path);
|
|
|
@@ -830,7 +830,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// A string array containing all lines of the file.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
string[] ReadAllLines(string path, Encoding encoding);
|
|
|
@@ -842,7 +842,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// A string containing all lines of the file.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
string ReadAllText(string path);
|
|
|
@@ -855,7 +855,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// A string containing all lines of the file.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
string ReadAllText(string path, Encoding encoding);
|
|
|
@@ -867,7 +867,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// The lines of the file.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
IEnumerable<string> ReadLines(string path);
|
|
|
@@ -880,7 +880,7 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// The lines of the file.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
IEnumerable<string> ReadLines(string path, Encoding encoding);
|
|
|
@@ -890,7 +890,7 @@ namespace Renci.SshNet
|
|
|
/// </summary>
|
|
|
/// <param name="oldPath">Path to the old file location.</param>
|
|
|
/// <param name="newPath">Path to the new file location.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="oldPath"/> is <b>null</b>. <para>-or-</para> or <paramref name="newPath"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="oldPath"/> is <see langword="null"/>. <para>-or-</para> or <paramref name="newPath"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to rename the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SshException">A SSH error where <see cref="Exception.Message"/> is the message from the remote host.</exception>
|
|
|
@@ -904,7 +904,7 @@ namespace Renci.SshNet
|
|
|
/// <param name="newPath">Path to the new file location.</param>
|
|
|
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to observe.</param>
|
|
|
/// <returns>A <see cref="Task"/> that represents the asynchronous rename operation.</returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="oldPath"/> is <b>null</b>. <para>-or-</para> or <paramref name="newPath"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="oldPath"/> is <see langword="null"/>. <para>-or-</para> or <paramref name="newPath"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to rename the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SshException">A SSH error where <see cref="Exception.Message"/> is the message from the remote host.</exception>
|
|
|
@@ -916,8 +916,8 @@ namespace Renci.SshNet
|
|
|
/// </summary>
|
|
|
/// <param name="oldPath">Path to the old file location.</param>
|
|
|
/// <param name="newPath">Path to the new file location.</param>
|
|
|
- /// <param name="isPosix">if set to <c>true</c> then perform a posix rename.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="oldPath" /> is <b>null</b>. <para>-or-</para> or <paramref name="newPath" /> is <b>null</b>.</exception>
|
|
|
+ /// <param name="isPosix">if set to <see langword="true"/> then perform a posix rename.</param>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="oldPath" /> is <see langword="null"/>. <para>-or-</para> or <paramref name="newPath" /> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to rename the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SshException">A SSH error where <see cref="Exception.Message" /> is the message from the remote host.</exception>
|
|
|
@@ -957,7 +957,7 @@ namespace Renci.SshNet
|
|
|
/// </summary>
|
|
|
/// <param name="path">The path to the file.</param>
|
|
|
/// <param name="fileAttributes">The desired <see cref="SftpFileAttributes"/>.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
void SetAttributes(string path, SftpFileAttributes fileAttributes);
|
|
|
@@ -967,7 +967,7 @@ namespace Renci.SshNet
|
|
|
/// </summary>
|
|
|
/// <param name="path">The old path.</param>
|
|
|
/// <param name="linkPath">The new path.</param>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="path"/> is <b>null</b>. <para>-or-</para> <paramref name="linkPath"/> is <b>null</b> or contains only whitespace characters.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="linkPath"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to create the symbolic link was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SshException">A SSH error where <see cref="Exception.Message"/> is the message from the remote host.</exception>
|
|
|
@@ -983,8 +983,8 @@ namespace Renci.SshNet
|
|
|
/// <returns>
|
|
|
/// A list of uploaded files.
|
|
|
/// </returns>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="sourcePath"/> is <c>null</c>.</exception>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="destinationPath"/> is <c>null</c> or contains only whitespace.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="sourcePath"/> is <see langword="null"/>.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="destinationPath"/> is <see langword="null"/> or contains only whitespace.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException"><paramref name="destinationPath"/> was not found on the remote host.</exception>
|
|
|
/// <exception cref="SshException">If a problem occurs while copying the file</exception>
|
|
|
IEnumerable<FileInfo> SynchronizeDirectories(string sourcePath, string destinationPath, string searchPattern);
|
|
|
@@ -995,8 +995,8 @@ namespace Renci.SshNet
|
|
|
/// <param name="input">Data input stream.</param>
|
|
|
/// <param name="path">Remote file path.</param>
|
|
|
/// <param name="uploadCallback">The upload callback.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="input" /> is <b>null</b>.</exception>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="path" /> is <b>null</b> or contains only whitespace characters.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="input" /> is <see langword="null"/>.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to upload the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SshException">A SSH error where <see cref="Exception.Message" /> is the message from the remote host.</exception>
|
|
|
@@ -1011,10 +1011,10 @@ namespace Renci.SshNet
|
|
|
/// </summary>
|
|
|
/// <param name="input">Data input stream.</param>
|
|
|
/// <param name="path">Remote file path.</param>
|
|
|
- /// <param name="canOverride">if set to <c>true</c> then existing file will be overwritten.</param>
|
|
|
+ /// <param name="canOverride">if set to <see langword="true"/> then existing file will be overwritten.</param>
|
|
|
/// <param name="uploadCallback">The upload callback.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="input" /> is <b>null</b>.</exception>
|
|
|
- /// <exception cref="ArgumentException"><paramref name="path" /> is <b>null</b> or contains only whitespace characters.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="input" /> is <see langword="null"/>.</exception>
|
|
|
+ /// <exception cref="ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPermissionDeniedException">Permission to upload the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
|
|
/// <exception cref="SshException">A SSH error where <see cref="Exception.Message" /> is the message from the remote host.</exception>
|
|
|
@@ -1029,7 +1029,7 @@ namespace Renci.SshNet
|
|
|
/// </summary>
|
|
|
/// <param name="path">The file to write to.</param>
|
|
|
/// <param name="bytes">The bytes to write to the file.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -1048,7 +1048,7 @@ namespace Renci.SshNet
|
|
|
/// </summary>
|
|
|
/// <param name="path">The file to write to.</param>
|
|
|
/// <param name="contents">The lines to write to the file.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -1071,7 +1071,7 @@ namespace Renci.SshNet
|
|
|
/// <param name="path">The file to write to.</param>
|
|
|
/// <param name="contents">The lines to write to the file.</param>
|
|
|
/// <param name="encoding">The character encoding to use.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -1090,7 +1090,7 @@ namespace Renci.SshNet
|
|
|
/// </summary>
|
|
|
/// <param name="path">The file to write to.</param>
|
|
|
/// <param name="contents">The string array to write to the file.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -1113,7 +1113,7 @@ namespace Renci.SshNet
|
|
|
/// <param name="path">The file to write to.</param>
|
|
|
/// <param name="contents">The string array to write to the file.</param>
|
|
|
/// <param name="encoding">An <see cref="Encoding"/> object that represents the character encoding applied to the string array.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -1132,7 +1132,7 @@ namespace Renci.SshNet
|
|
|
/// </summary>
|
|
|
/// <param name="path">The file to write to.</param>
|
|
|
/// <param name="contents">The string to write to the file.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|
|
|
@@ -1155,7 +1155,7 @@ namespace Renci.SshNet
|
|
|
/// <param name="path">The file to write to.</param>
|
|
|
/// <param name="contents">The string to write to the file.</param>
|
|
|
/// <param name="encoding">The encoding to apply to the string.</param>
|
|
|
- /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
|
|
|
+ /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
|
|
/// <exception cref="SshConnectionException">Client is not connected.</exception>
|
|
|
/// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
|
|
/// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
|