|
| virtual | ~NameValuePairs () |
| |
| template<class T > |
| bool | GetThisObject (T &object) const |
| | Get a copy of this object or subobject. More...
|
| |
| template<class T > |
| bool | GetThisPointer (T *&ptr) const |
| | Get a pointer to this object. More...
|
| |
| template<class T > |
| bool | GetValue (const char *name, T &value) const |
| | Get a named value. More...
|
| |
| template<class T > |
| T | GetValueWithDefault (const char *name, T defaultValue) const |
| | Get a named value. More...
|
| |
| CRYPTOPP_DLL std::string | GetValueNames () const |
| | Get a list of value names that can be retrieved. More...
|
| |
| CRYPTOPP_DLL bool | GetIntValue (const char *name, int &value) const |
| | Get a named value with type int. More...
|
| |
| CRYPTOPP_DLL int | GetIntValueWithDefault (const char *name, int defaultValue) const |
| | Get a named value with type int, with default. More...
|
| |
| template<class T > |
| void | GetRequiredParameter (const char *className, const char *name, T &value) const |
| | Retrieves a required name/value pair. More...
|
| |
| CRYPTOPP_DLL void | GetRequiredIntParameter (const char *className, const char *name, int &value) const |
| | Retrieves a required name/value pair. More...
|
| |
| virtual CRYPTOPP_DLL bool | GetVoidValue (const char *name, const std::type_info &valueType, void *pValue) const =0 |
| | Get a named value. More...
|
| |
Interface for retrieving values given their names.
This class is used to safely pass a variable number of arbitrarily typed arguments to functions and to read values from keys and crypto parameters.
To obtain an object that implements NameValuePairs for the purpose of parameter passing, use the MakeParameters() function.
To get a value from NameValuePairs, you need to know the name and the type of the value. Call GetValueNames() on a NameValuePairs object to obtain a list of value names that it supports. then look at the Name namespace documentation to see what the type of each value is, or alternatively, call GetIntValue() with the value name, and if the type is not int, a ValueTypeMismatch exception will be thrown and you can get the actual type from the exception object.
Definition at line 279 of file cryptlib.h.
| virtual CRYPTOPP_DLL bool NameValuePairs::GetVoidValue |
( |
const char * |
name, |
|
|
const std::type_info & |
valueType, |
|
|
void * |
pValue |
|
) |
| const |
|
pure virtual |
Get a named value.
- Parameters
-
| name | the name of the object or value to retrieve |
| valueType | reference to a variable that receives the value |
| pValue | void pointer to a variable that receives the value |
- Returns
- true if the value was retrieved, false otherwise
GetVoidValue() retrieves the value of name if it exists.
- Note
- GetVoidValue() is an internal function and should be implemented by derived classes. Users should use one of the other functions instead.
- See also
- GetValue(), GetValueWithDefault(), GetIntValue(), GetIntValueWithDefault(), GetRequiredParameter() and GetRequiredIntParameter()
Implemented in DL_PublicKeyImpl< GP >, DL_PublicKeyImpl< DL_GroupParameters_EC< EC > >, DL_PrivateKeyImpl< GP >, DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > >, DL_GroupParameters< T >, DL_GroupParameters< Integer >, DL_GroupParameters< typename EcPrecomputation< EC >::Element >, AlgorithmParameters, DL_PrivateKey_ECGDSA_ISO15946< EC >, DL_GroupParameters_LUC, DL_GroupParameters_GFP, TestDataNameValuePairs, CombinedNameValuePairs, DL_GroupParameters_IntegerBasedImpl< GROUP_PRECOMP, BASE_PRECOMP >, DL_GroupParameters_IntegerBasedImpl< DL_GroupPrecomputation_LUC, DL_BasePrecomputation_LUC >, DL_GroupParameters_IntegerBasedImpl< ModExpPrecomputation >, InvertibleRSAFunction, InvertibleLUCFunction, InvertibleRWFunction, InvertibleESIGNFunction, InvertibleRabinFunction, DL_GroupParameters_EC< EC >, DL_GroupParameters_IntegerBased, NullNameValuePairs, LUCFunction, RWFunction, RSAFunction, RabinFunction, ESIGNFunction, and XTR_DH.
1.8.11
