Startup List Management API: Technical Specification

Type of the Interface

Startup List Management API defines rules and policies that allow third party application to make modification to the device’s startup list during the installation / uninstallation process. The API does not define any classes, but it defines a set of resource file structures and enumerations that each client must declare.

Interface Class Structure

This interface has no classes.

Usage

Protocol

To correctly use the Startup List Management API the application developer must create a startup control file containing metadata about the application to be added to the startup list. The metadata contains the full path of the application executable and startup recovery policy used in case of an error in application startup. In order to add several executables into the startup list, the application developer can declare several metadata sections in a single startup control file.

The metadata is in a resource file format and needs to be compiled by Symbian resource file compiler epocrc. The compiled resource file, i.e. the startup control file, must be installed into the import directory of Software Installer UI private folder in Phone memory drive ( c:\private\101f875a\import\). For detailed description about the metadata, see the Detailed description section.

In addition, the following requirements must be met:

If any of the requirements above is not met, the Software Installer UI ignores the startup control file and no items will be added to the startup list.

Error Handling

None.

Memory Overhead

None.

Extensions to the API

There are no extensions to this API.

Example

This example shows how to install a package that adds two executables into the modifiable startup list.

/*
* ==============================================================================
*  Name        : [12345678].rss
*  Part of     : Example application
*  Description : A startup control file to add executables in example application *                to startup list.
*  Version     : 1
*
*  Copyright © 2002-2004 Nokia. All rights reserved.
*  This material, including documentation and any related 
*  computer programs, is protected by copyright controlled by 
*  Nokia. All rights are reserved. Copying, including 
*  reproducing, storing, adapting or translating, any 
*  or all of this material requires the prior written consent of 
*  Nokia. This material also contains confidential 
*  information which may not be disclosed to others without the 
*  prior written consent of Nokia.
* ==============================================================================
*/
#include <startupitem.rh>
RESOURCE STARTUP_ITEM_INFO listener_server
{
executable_name = "c:\\sys\\bin\\listener.exe";
recovery = EStartupItemExPolicyNone;
}
RESOURCE STARTUP_ITEM_INFO dispatcher
{
executable_name = "!:\\sys\\bin\\dispatcher.exe"; // dispatcher can be installed
                                                  // to memory card as well
recovery = EStartupItemExPolicyNone;
}

/*
* ==============================================================================
*  Name        : exapp.pkg
*  Part of     : Example application
*  Description : Installation package file description for example application.
*  Version     : 1
*
*  Copyright © 2002-2004 Nokia. All rights reserved.
*  This material, including documentation and any related 
*  computer programs, is protected by copyright controlled by 
*  Nokia. All rights are reserved. Copying, including 
*  reproducing, storing, adapting or translating, any 
*  or all of this material requires the prior written consent of 
*  Nokia. This material also contains confidential 
*  information which may not be disclosed to others without the 
*  prior written consent of Nokia.
* ==============================================================================
*/
;Languages
&EN,FI
;Header
#{"Example application","Esimerkkisovellus"},(12345678),1,0,0
%{"Nokia Inc","Nokia Oy"}
:"Nokia"
"data\armv5\listener.exe"-"c:\sys\bin\listener.exe"
"data\data\commonresource.rsc"-"c:\resource\apps\commonresource.rsc"
"data\armv5\dispatcher.exe"-"!:\sys\bin\dispatcher.exe"
"data\data\[0x12345678].rsc"-"c:\private\101f875a\import\[12345678].rsc"

Detailed Description

STARTUP_ITEM_INFO

This structure is used to define an executable to be added to the startup list.

Headers:

StartupItem.HRH

Members:

BYTE version Indicates the version of the API. Do not use.
LTEXT Executable_name Full path to the executable.
WORD recovery Recovery policy used in case of failure in executable launch.
TStartupExceptionPolicy

This enumeration is used to define the recovery policy in case of failure when launching the executable at device boot up.

Headers:

StartupItem.RH

Values:

EStartupItemPolicyNone Does nothing.

Copyright © Nokia Corporation 2001-2007
Back to top