System.Security.Cryptography.ProtectedData.xml 4.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>System.Security.Cryptography.ProtectedData</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.Security.Cryptography.DataProtectionScope">
  8. <summary>Specifies the scope of the data protection to be applied by the <see cref="M:System.Security.Cryptography.ProtectedData.Protect(System.Byte[],System.Byte[],System.Security.Cryptography.DataProtectionScope)" /> method.</summary>
  9. </member>
  10. <member name="F:System.Security.Cryptography.DataProtectionScope.CurrentUser">
  11. <summary>The protected data is associated with the current user. Only threads running under the current user context can unprotect the data.</summary>
  12. </member>
  13. <member name="F:System.Security.Cryptography.DataProtectionScope.LocalMachine">
  14. <summary>The protected data is associated with the machine context. Any process running on the computer can unprotect data. This enumeration value is usually used in server-specific applications that run on a server where untrusted users are not allowed access.</summary>
  15. </member>
  16. <member name="T:System.Security.Cryptography.ProtectedData">
  17. <summary>Provides methods for encrypting and decrypting data. This class cannot be inherited.</summary>
  18. </member>
  19. <member name="M:System.Security.Cryptography.ProtectedData.Protect(System.Byte[],System.Byte[],System.Security.Cryptography.DataProtectionScope)">
  20. <summary>Encrypts the data in a specified byte array and returns a byte array that contains the encrypted data.</summary>
  21. <param name="userData">A byte array that contains data to encrypt.</param>
  22. <param name="optionalEntropy">An optional additional byte array used to increase the complexity of the encryption, or <see langword="null" /> for no additional complexity.</param>
  23. <param name="scope">One of the enumeration values that specifies the scope of encryption.</param>
  24. <returns>A byte array representing the encrypted data.</returns>
  25. <exception cref="T:System.ArgumentNullException">The <paramref name="userData" /> parameter is <see langword="null" />.</exception>
  26. <exception cref="T:System.Security.Cryptography.CryptographicException">The encryption failed.</exception>
  27. <exception cref="T:System.NotSupportedException">The operating system does not support this method.</exception>
  28. <exception cref="T:System.OutOfMemoryException">The system ran out of memory while encrypting the data.</exception>
  29. <exception cref="T:System.PlatformNotSupportedException">.NET Core only: Calls to the <c>Protect</c> method are supported on Windows operating systems only.</exception>
  30. </member>
  31. <member name="M:System.Security.Cryptography.ProtectedData.Unprotect(System.Byte[],System.Byte[],System.Security.Cryptography.DataProtectionScope)">
  32. <summary>Decrypts the data in a specified byte array and returns a byte array that contains the decrypted data.</summary>
  33. <param name="encryptedData">A byte array containing data encrypted using the <see cref="M:System.Security.Cryptography.ProtectedData.Protect(System.Byte[],System.Byte[],System.Security.Cryptography.DataProtectionScope)" /> method.</param>
  34. <param name="optionalEntropy">An optional additional byte array that was used to encrypt the data, or <see langword="null" /> if the additional byte array was not used.</param>
  35. <param name="scope">One of the enumeration values that specifies the scope of data protection that was used to encrypt the data.</param>
  36. <returns>A byte array representing the decrypted data.</returns>
  37. <exception cref="T:System.ArgumentNullException">The <paramref name="encryptedData" /> parameter is <see langword="null" />.</exception>
  38. <exception cref="T:System.Security.Cryptography.CryptographicException">The decryption failed.</exception>
  39. <exception cref="T:System.NotSupportedException">The operating system does not support this method.</exception>
  40. <exception cref="T:System.OutOfMemoryException">Out of memory.</exception>
  41. <exception cref="T:System.PlatformNotSupportedException">.NET Core only: Calls to the <c>Unprotect</c> method are supported on Windows operating systems only.</exception>
  42. </member>
  43. </members>
  44. </doc>