os/ossrv/lowlevellibsandfws/pluginfw/Group/ecompatchconstants.hby
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
     1 // Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of the License "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 // ROM-specific macros for syslibs_ecom component.
    15 // Intended for customisation by phone manufacturers.
    16 // Read ECOM How To FAQ.doc if need more information about the
    17 // patchable constants listed below.
    18 // 
    19 //
    20 
    21 #ifndef __ECOMPATCHCONSTANTS_HBY__
    22 #define __ECOMPATCHCONSTANTS_HBY__
    23 
    24 
    25 // Macro ECOM_PATCHDATA_KLISTIMPLBUFFERSIZE represents the
    26 // value of the patchable constant KListImplBufferSize. It is used
    27 // to define the size of the buffer that is pre-allocated on the
    28 // ECOM client side to hold data returned by the
    29 // REComSession::ListImplementations() API. ECOM How To FAQ
    30 // explains how to determine the optimum value for this constant.
    31 // The default value of KListImplBufferSize is 2048.
    32 // 
    33 // This patchable constant was first introduced in Symbian_OS_v9.3.
    34 // At that time ECOM How To FAQ advised device builders to use
    35 // the "patchdata" command directly in any obey file to patch this
    36 // constant. The old scheme has been deprecated and the macro below
    37 // is the supported published mechanism for changing this patchable
    38 // constant. Please ensure that if this constant
    39 // is patched in another obey file, do not uncomment the macro
    40 // definition below. Otherwise this constant will be patched twice
    41 // with unpredictable result.
    42 //
    43 // To patch this constant, remove the comment characters and replace 2048
    44 // with the desired value.
    45 
    46 // #define ECOM_PATCHDATA_KLISTIMPLBUFFERSIZE 2048
    47 
    48 
    49 // Macro ECOM_PATCHDATA_KDISCOVERYDISABLEDDRIVELIST represents the
    50 // value of the patchable constant KDiscoveryDisabledDriveList.
    51 // This constant lets licensees specify a list of drives which they
    52 // do not want ECOM to scan, e.g. because the drives can never have
    53 // valid plug-ins. 
    54 // This is a 32-bit integer with each bit representing a drive to disable:
    55 // 0x1 disables drive A, 0x2 disables drive B etc. There are only 25 drive
    56 // letters supported (A:->Y:) therefore the last 7 bits are ignored.
    57 // Note that Read-only internal drives cannot be disabled.
    58 // The default value of KDiscoveryDisabledDriveList is 0, meaning all
    59 // drives are enabled.
    60 //
    61 // To patch this constant, remove the comment characters and replace 0
    62 // with the desired value.
    63 
    64 // #define ECOM_PATCHDATA_KDISCOVERYDISABLEDDRIVELIST 0x0
    65 
    66 
    67 
    68 // Macro ECOM_PATCHDATA_KCUSTOMRESOLVERCACHESIZE represents the
    69 // value of the patchable constant KCustomResolverCacheSize.
    70 // This constant specifies the maximum number of resolver DLLs ECOM can cache.
    71 // When the cache queue is full, the next custom resolver DLL requested by
    72 // client will bump off the oldest DLL in the cache.
    73 // The default value of KCustomResolverCacheSize is 4, meaning ECOM will
    74 // cache maximum of four resolver DLLs.
    75 //
    76 // To patch this constant, remove the comment characters and replace 4
    77 // with the desired value.
    78 
    79 // #define ECOM_PATCHDATA_KCUSTOMRESOLVERCACHESIZE 4
    80 
    81 
    82 
    83 // Macro ECOM_PATCHDATA_KCUSTOMRESOLVERCACHETIMEOUT represents the
    84 // value of the patchable constant KCustomResolverCacheTimeout.
    85 // This constant specifies the timeout in microseconds that a resolver DLL is
    86 // kept in cache. When the time expires, the resolver DLL is released from
    87 // memory. The default value of KCustomResolverCacheTimeout is 4000000.
    88 // That means if no client uses a cached resolver DLL, the DLL will be
    89 // unloaded after four seconds.
    90 //
    91 // To patch this constant, remove the comment characters and replace 4000000
    92 // with the desired value.
    93 
    94 // #define ECOM_PATCHDATA_KCUSTOMRESOLVERCACHETIMEOUT 4000000
    95 
    96 #endif