API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

ICIPHER1_GETPARAM()

Brew Release
Brew MP 1.0.2
See Also
CIPHER_PARAM_XXX Error Codes ICipher1 ICipher1_SetParam
Description
This function is inherited from IParameters. It retrieves information about the Cipher. This method takes an ID that specifies what information is provided. The pParam contains the information. See CIPHER_PARAM_XXX for details on the supported parameters.
Params
pICipher
[]:
Pointer to ICipher1 interface object.
id
[]:
Type of parameter to fetch.
pParam
[]:
Pointer to a structure for storing the results. If the pointer is NULL, pcParam will contain the required number of bytes to hold the parameter.
pcParam
[]:
On input, size of structure passed in. On return, contains the actual size of the result.
Interface
Prototype
  •    int ICipher1_GetParam(ICipher1* pICipher, int id, void *pParam, unsigned *pcParam);
    
Return
  • AEE_SUCCESS: Parameter fetched successfully. AEE_EBADPARM: Invalid parameter - bad set type. AEE_CRYPT_INVALID_KEY: key is wrong length or otherwise invalid. AEE_EBADSTATE: ICipher1 has not been initialized properly (i.e. key not set).
Side Effect
  • None
Comments
None