KeyGenerator.GetInstance Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| GetInstance(String) |
Returns a |
| GetInstance(String, Provider) |
Returns a |
| GetInstance(String, String) |
Returns a |
GetInstance(String)
Returns a KeyGenerator object that generates secret keys
for the specified algorithm.
[Android.Runtime.Register("getInstance", "(Ljava/lang/String;)Ljavax/crypto/KeyGenerator;", "")]
public static Javax.Crypto.KeyGenerator? GetInstance (string? algorithm);[<Android.Runtime.Register("getInstance", "(Ljava/lang/String;)Ljavax/crypto/KeyGenerator;", "")>]
static member GetInstance : string -> Javax.Crypto.KeyGeneratorParameters
- algorithm
- String
the standard name of the requested key algorithm. See the KeyGenerator section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.
Returns
the new KeyGenerator object.
- Attributes
Exceptions
if the specified algorithm is not available by any provider.
if algorithm is null.
Remarks
Returns a KeyGenerator object that generates secret keys for the specified algorithm.
This method traverses the list of registered security Providers, starting with the most preferred Provider. A new KeyGenerator object encapsulating the KeyGeneratorSpi implementation from the first Provider that supports the specified algorithm is returned.
Note that the list of registered providers may be retrieved via the Security#getProviders() Security.getProviders() method.
Java documentation for javax.crypto.KeyGenerator.getInstance(java.lang.String).
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Applies to
GetInstance(String, Provider)
Returns a KeyGenerator object that generates secret keys
for the specified algorithm.
[Android.Runtime.Register("getInstance", "(Ljava/lang/String;Ljava/security/Provider;)Ljavax/crypto/KeyGenerator;", "")]
public static Javax.Crypto.KeyGenerator? GetInstance (string? algorithm, Java.Security.Provider? provider);[<Android.Runtime.Register("getInstance", "(Ljava/lang/String;Ljava/security/Provider;)Ljavax/crypto/KeyGenerator;", "")>]
static member GetInstance : string * Java.Security.Provider -> Javax.Crypto.KeyGeneratorParameters
- algorithm
- String
the standard name of the requested key algorithm. See the KeyGenerator section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.
- provider
- Provider
the provider.
Returns
the new KeyGenerator object.
- Attributes
Exceptions
if the specified algorithm is not provided by the specified provider.
if the specified provider is null.
if the specified algorithm name is null.
Remarks
Returns a KeyGenerator object that generates secret keys for the specified algorithm.
A new KeyGenerator object encapsulating the KeyGeneratorSpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Applies to
GetInstance(String, String)
Returns a KeyGenerator object that generates secret keys
for the specified algorithm.
[Android.Runtime.Register("getInstance", "(Ljava/lang/String;Ljava/lang/String;)Ljavax/crypto/KeyGenerator;", "")]
public static Javax.Crypto.KeyGenerator? GetInstance (string? algorithm, string? provider);[<Android.Runtime.Register("getInstance", "(Ljava/lang/String;Ljava/lang/String;)Ljavax/crypto/KeyGenerator;", "")>]
static member GetInstance : string * string -> Javax.Crypto.KeyGeneratorParameters
- algorithm
- String
the standard name of the requested key algorithm. See the KeyGenerator section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.
- provider
- String
the name of the provider.
Returns
the new KeyGenerator object.
- Attributes
Exceptions
if the specified algorithm is not provided by the specified provider.
if the specified provider is not available.
if the specified provider is name is null or empty.
if the specified algorithm name is null.
Remarks
Returns a KeyGenerator object that generates secret keys for the specified algorithm.
A new KeyGenerator object encapsulating the KeyGeneratorSpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.
Note that the list of registered providers may be retrieved via the Security#getProviders() Security.getProviders() method.
Java documentation for javax.crypto.KeyGenerator.getInstance(java.lang.String, java.lang.String).
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.