epoc32/include/mw/startupitem.rh
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@4
     2
* Copyright (c) 2005-2007 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@4
    14
* Description:   Definitions for the stucture of a configuration file required
williamr@2
    15
*		 for components started at boot time.
williamr@2
    16
*
williamr@2
    17
*/
williamr@2
    18
williamr@2
    19
williamr@2
    20
#ifndef STARTUPITEM_RH
williamr@2
    21
#define STARTUPITEM_RH
williamr@2
    22
williamr@2
    23
#include <StartupItem.hrh>
williamr@2
    24
williamr@2
    25
/** Defines the structure of the startup control resource file providing information about
williamr@2
    26
*   component(s) to be started at boot time.
williamr@2
    27
*
williamr@2
    28
* Example of the resource file:
williamr@2
    29
* 
williamr@2
    30
* @code
williamr@2
    31
* #include <startupitem.rh>
williamr@2
    32
*
williamr@2
    33
* RESOURCE STARTUP_ITEM_INFO example
williamr@2
    34
* {
williamr@2
    35
* executable_name = "c:\\sys\\bin\\example.exe";
williamr@2
    36
* recovery = EStartupItemExPolicyNone;
williamr@2
    37
* }
williamr@2
    38
* @endcode
williamr@2
    39
*
williamr@2
    40
*/
williamr@2
    41
williamr@2
    42
STRUCT STARTUP_ITEM_INFO
williamr@2
    43
    {
williamr@2
    44
    BYTE version = 0;                          ///< Version info. Do NOT use.
williamr@2
    45
    LTEXT executable_name(255);                ///< The path and name of the executable.
williamr@2
    46
    WORD recovery = EStartupItemExPolicyNone;  ///< The exception recovery policy used.
williamr@2
    47
    LONG reserved_1 = 0;                       ///< Reserved for future use.
williamr@2
    48
    BYTE reserved_2 = 0;                       ///< Reserved for future use.
williamr@2
    49
    BYTE reserved_3 = 0;                       ///< Reserved for future use.
williamr@2
    50
    }
williamr@2
    51
williamr@4
    52
#endif // STARTUPITEM_RH
williamr@4
    53