Developer

API Reference

IPERSISTENTSTORAGE_Read()

deprecated
Items marked as deprecated have been replaced by a more powerful, alternative feature. Deprecated interfaces include a reference to the replacement interface, which should be used for all new application development. Deprecated features are still supported for backward compatibility, but should be avoided when developing new applications.
Brew Release
Brew MP 1.0.2
See Also
Error Codes
Description
Retrieve the value associated with the supplied key.
Parameters
  • storage
    []:
    Pointer to the IPersistentStorage interface object.
  • key
    []:
    A string describing the key component of the key/value pair to retrieve.
  • length
    []:
    [in/out] The length of the supplied buffer. If data is set to -1 when this function is called, length is set to the length of the value at the supplied location.
  • data
    []:
    [in/out] A buffer to copy the data into. If -1, after the call length will contain the length of the value stored at key.
Interface
IPERSISTENTSTORAGE
Prototype
   int IPERSISTENTSTORAGE_Read(IPersistentStorage* storage, const AECHAR* key,
                               uint32* length, void* data);
Return
AEE_SUCCESS : The value was successfully retrieved. AEE_EFAILED : The requested value was not retrieved.
Side Effect
None
Comment
Note that there is no means by which to request that this function allocate you memory (e.g. passing a NULL pointer as the data value).
  • Follow