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

Developer

API Reference

ISHELL_GETPROPERTY()

Brew Release
Brew MP 1.0.2
See Also
Error Codes IShell ISHELL_GetClassItemID ISHELL_SetProperty MPROP_NETUSAGE MPROP_STATUS MPROP_USAGE Privileges
Description
This method retrieves the property data for the underlying module associated with the input class. Note the following:
- The returned information applies to all classes owned by the specified
module containing the specified class.
- Data is persistent only across handset resets for dynamically downloaded
modules.
- Specifying a NULL input buffer will return the size of the data.

- In case the client-supplied buffer is not large enough,
the method will attempt a partial fill where possible. In this case, the method returns SUCCESS, and *pwSize will contain the buffer size required for complete retrieval.
- Properties with the high-order bit set are reserved for use by callers
with system-level privileges.
- Using 0 (zero) for the input AEECLSID (the cls parameter) specifies the currently running application.

If it encounters a protected property (for example, MPROP_SID), then the caller needs to have system-level privileges. For all other properties, the caller must belong to the same group as the class whose property is requested; either the calling applet's classID must be the same as cls, or the module that contains the calling applet must belong to the same groupID as cls. This can be done by listing cls as a dependency in the MIF of the calling applet.
Params
po
[]:
Pointer to the IShell object.
cls
[]:
Class of the application to query. Zero specifies the currently running application.
wID
[]:
Property ID. The supported properties
pDest
[]:
Destination to fill.
pwSize
[]:
Pointer to the size of the input buffer. Filled with the data size.
Interface
  • ISHELL
Prototype
  •    int  ISHELL_GetProperty
       (
       IShell *po,
       AEECLSID cls,
       uint16 wID,
       void * pDest,
       uint16 * pwSize
       );
    
Return
  • AEE_SUCCESS: The value 0 (zero). No error. The most likely error codes include: AEE_EBADCLASS: The input class was not found. AEE_EBUFFERTOOSMALL: The destination buffer size is too small, and *pwSize is filled with the proper size. This error is returned only if a partial fill is not possible. AEE_EBADPARM: NULL pwSize. AEE_EPRIVLEVEL: The caller does not have sufficient privileges.
Side Effect
  • None
Comments
None