Developer

API Reference

IPERSISTENTSTORAGE_GetKey()

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 IPERSISTENTSTORAGE_CountKeys
Description
Retrieve a key specified by the supplied key offset.
Parameters
  • storage
    []:
    Pointer to the IPersistentStorage interface object
  • keyOffset
    []:
    The location of the desired key, counted from 0.
  • data
    []:
    [out] A pointer to a string which will be set and cannot be modified. Note that this pointer is only guaranteed to be valid until the *next* call to IPERSISTENTSTORAGE. If you need to preserve the data beyond that point, copy the string out.
Interface
IPERSISTENTSTORAGE
Prototype
   int IPERSISTENTSTORAGE_GetKey(IPersistentStorage* storage,
                                 uint32 keyOffset, const AECHAR* * data);
Return
AEE_SUCCESS: The key was successfully retrieved. AEE_EFAILED: The requested key does not exist or another error occurred.
Side Effect
None
Comment
To retrieve a key, the keyOffset needs to be in the range 0..[numberOfKeys - 1], where numberOfKeys is calculated by IPERSISTENTSTORAGE_CountKeys().
  • Follow