最新版本的C# SSH.NET库Renci.SshNet.dll

<?xml version="1.0"?> <doc> <assembly> <name>Renci.SshNet</name> </assembly> <members> <member name="M:Renci.SshNet.Abstractions.CryptoAbstraction.GenerateRandom(System.Int32)"> <summary> Generates a <see cref="T:System.Byte"/> array of the specified length, and fills it with a cryptographically strong random sequence of values. </summary> <param name="length">The length of the array generate.</param> </member> <member name="M:Renci.SshNet.Abstractions.CryptoAbstraction.GenerateRandom(System.Byte[])"> <summary> Fills an array of bytes with a cryptographically strong random sequence of values. </summary> <param name="data">The array to fill with cryptographically strong random bytes.</param> <exception cref="T:System.ArgumentNullException"><paramref name="data"/> is <c>null</c>.</exception> <remarks> The length of the byte array determines how many random bytes are produced. </remarks> </member> <member name="M:Renci.SshNet.Abstractions.DnsAbstraction.GetHostAddresses(System.String)"> <summary> Returns the Internet Protocol (IP) addresses for the specified host. </summary> <param name="hostNameOrAddress">The host name or IP address to resolve</param> <returns> An array of type <see cref="T:System.Net.IPAddress"/> that holds the IP addresses for the host that is specified by the <paramref name="hostNameOrAddress"/> parameter. </returns> <exception cref="T:System.ArgumentNullException"><paramref name="hostNameOrAddress"/> is <c>null</c>.</exception> <exception cref="T:System.Net.Sockets.SocketException">An error is encountered when resolving <paramref name="hostNameOrAddress"/>.</exception> </member> <member name="M:Renci.SshNet.Abstractions.FileSystemAbstraction.EnumerateFiles(System.IO.DirectoryInfo,System.String)"> <summary> Returns an enumerable collection of file information that matches a search pattern. </summary> <param name="directoryInfo"></param> <param name="searchPattern">The search string to match against the names of files.</param> <returns> An enumerable collection of files that matches <paramref name="searchPattern"/>. </returns> <exception cref="T:System.ArgumentNullException"><paramref name="directoryInfo"/> is <c>null</c>.</exception> <exception cref="T:System.ArgumentNullException"><paramref name="searchPattern"/> is <c>null</c>.</exception> <exception cref="T:System.IO.DirectoryNotFoundException">The path represented by <paramref name="directoryInfo"/> does not exist or is not valid.</exception> </member> <member name="M:Renci.SshNet.Abstractions.SocketAbstraction.CanWrite(System.Net.Sockets.Socket)"> <summary> Returns a value indicating whether the specified <see cref="T:System.Net.Sockets.Socket"/> can be used to send data. </summary> <param name="socket">The <see cref="T:System.Net.Sockets.Socket"/> to check.</param> <returns> <c>true</c> if <paramref name="socket"/> can be written to; otherwise, <c>false</c>. </returns> </member> <member name="M:Renci.SshNet.Abstractions.SocketAbstraction.ReadByte(System.Net.Sockets.Socket,System.TimeSpan)"> <summary> Reads a byte from the specified <see cref="T:System.Net.Sockets.Socket"/>. </summary> <param name="socket">The <see cref="T:System.Net.Sockets.Socket"/> to read from.</param> <param name="timeout">Specifies the amount of time after which the call will time out.</param> <returns> The byte read, or <c>-1</c> if the socket was closed. </returns> <exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The read operation timed out.</exception> <exception cref="T:System.Net.Sockets.SocketException">The read failed.</exception> </member> <member name="M:Renci.SshNet.Abstractions.SocketAbstraction.SendByte(System.Net.Sockets.Socket,System.Byte)"> <summary> Sends a byte using the specified <see cref="T:System.Net.Sockets.Socket"/>. </summary> <param name="socket">The <see cref="T:System.Net.Sockets.Socket"/> to write to.</param> <param name="value">The value to send.</param> <exception cref="T:System.Net.Sockets.SocketException">The write failed.</exception> </member> <member name="M:Renci.SshNet.Abstractions.SocketAbstraction.Read(System.Net.Sockets.Socket,System.Int32,System.TimeSpan)"> <summary> Receives data from a bound <see cref="T:System.Net.Sockets.Socket"/>. </summary> <param name="socket"></param> <param name="size">The number of bytes to receive.</param> <param name="timeout">Specifies the amount of time after which the call will time out.</param> <returns> The bytes received. </returns> <remarks> If no data is available for reading, the <see cref="M:Renci.SshNet.Abstractions.SocketAbstraction.Read(System.Net.Sockets.Socket,System.Int32,System.TimeSpan)"/> method will block until data is available or the time-out value is exceeded. If the time-out value is exceeded, the <see cref="M:Renci.SshNet.Abstractions.SocketAbstraction.Read(System.Net.Sockets.Socket,System.Int32,System.TimeSpan)"/> call will throw a <see cref="T:Renci.SshNet.Common.SshOperationTimeoutException"/>. If you are in non-blocking mode, and there is no data available in the in the protocol stack buffer, the <see cref="M:Renci.SshNet.Abstractions.SocketAbstraction.Read(System.Net.Sockets.Socket,System.Int32,System.TimeSpan)"/> method will complete immediately and throw a <see cref="T:System.Net.Sockets.SocketException"/>. </remarks> </member> <member name="M:Renci.SshNet.Abstractions.SocketAbstraction.Read(System.Net.Sockets.Socket,System.Byte[],System.Int32,System.Int32,System.TimeSpan)"> <summary> Receives data from a bound <see cref="T:System.Net.Sockets.Socket"/> into a receive buffer. </summary> <param name="socket"></param> <param name="buffer">An array of type <see cref="T:System.Byte"/> that is the storage location for the received data. </param> <param name="offset">The position in <paramref name="buffer"/> parameter to store the received data.</param> <param name="size">The number of bytes to receive.</param> <param name="readTimeout">The maximum time to wait until <paramref name="size"/> bytes have been received.</param> <returns> The number of bytes received. </returns> <remarks> <para> If no data is available for reading, the <see cref="M:Renci.SshNet.Abstractions.SocketAbstraction.Read(System.Net.Sockets.Socket,System.Byte[],System.Int32,System.Int32,System.TimeSpan)"/> method will block until data is available or the time-out value is exceeded. If the time-out value is exceeded, the <see cref="M:Renci.SshNet.Abstractions.SocketAbstraction.Read(System.Net.Sockets.Socket,System.Byte[],System.Int32,System.Int32,System.TimeSpan)"/> call will throw a <see cref="T:Renci.SshNet.Common.SshOperationTimeoutException"/>. </para> <para>