os/ossrv/lowlevellibsandfws/pluginfw/Group/ecompatchconstants.hby
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Group/ecompatchconstants.hby	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,96 @@
     1.4 +// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// under the terms of the License "Eclipse Public License v1.0"
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +// ROM-specific macros for syslibs_ecom component.
    1.18 +// Intended for customisation by phone manufacturers.
    1.19 +// Read ECOM How To FAQ.doc if need more information about the
    1.20 +// patchable constants listed below.
    1.21 +// 
    1.22 +//
    1.23 +
    1.24 +#ifndef __ECOMPATCHCONSTANTS_HBY__
    1.25 +#define __ECOMPATCHCONSTANTS_HBY__
    1.26 +
    1.27 +
    1.28 +// Macro ECOM_PATCHDATA_KLISTIMPLBUFFERSIZE represents the
    1.29 +// value of the patchable constant KListImplBufferSize. It is used
    1.30 +// to define the size of the buffer that is pre-allocated on the
    1.31 +// ECOM client side to hold data returned by the
    1.32 +// REComSession::ListImplementations() API. ECOM How To FAQ
    1.33 +// explains how to determine the optimum value for this constant.
    1.34 +// The default value of KListImplBufferSize is 2048.
    1.35 +// 
    1.36 +// This patchable constant was first introduced in Symbian_OS_v9.3.
    1.37 +// At that time ECOM How To FAQ advised device builders to use
    1.38 +// the "patchdata" command directly in any obey file to patch this
    1.39 +// constant. The old scheme has been deprecated and the macro below
    1.40 +// is the supported published mechanism for changing this patchable
    1.41 +// constant. Please ensure that if this constant
    1.42 +// is patched in another obey file, do not uncomment the macro
    1.43 +// definition below. Otherwise this constant will be patched twice
    1.44 +// with unpredictable result.
    1.45 +//
    1.46 +// To patch this constant, remove the comment characters and replace 2048
    1.47 +// with the desired value.
    1.48 +
    1.49 +// #define ECOM_PATCHDATA_KLISTIMPLBUFFERSIZE 2048
    1.50 +
    1.51 +
    1.52 +// Macro ECOM_PATCHDATA_KDISCOVERYDISABLEDDRIVELIST represents the
    1.53 +// value of the patchable constant KDiscoveryDisabledDriveList.
    1.54 +// This constant lets licensees specify a list of drives which they
    1.55 +// do not want ECOM to scan, e.g. because the drives can never have
    1.56 +// valid plug-ins. 
    1.57 +// This is a 32-bit integer with each bit representing a drive to disable:
    1.58 +// 0x1 disables drive A, 0x2 disables drive B etc. There are only 25 drive
    1.59 +// letters supported (A:->Y:) therefore the last 7 bits are ignored.
    1.60 +// Note that Read-only internal drives cannot be disabled.
    1.61 +// The default value of KDiscoveryDisabledDriveList is 0, meaning all
    1.62 +// drives are enabled.
    1.63 +//
    1.64 +// To patch this constant, remove the comment characters and replace 0
    1.65 +// with the desired value.
    1.66 +
    1.67 +// #define ECOM_PATCHDATA_KDISCOVERYDISABLEDDRIVELIST 0x0
    1.68 +
    1.69 +
    1.70 +
    1.71 +// Macro ECOM_PATCHDATA_KCUSTOMRESOLVERCACHESIZE represents the
    1.72 +// value of the patchable constant KCustomResolverCacheSize.
    1.73 +// This constant specifies the maximum number of resolver DLLs ECOM can cache.
    1.74 +// When the cache queue is full, the next custom resolver DLL requested by
    1.75 +// client will bump off the oldest DLL in the cache.
    1.76 +// The default value of KCustomResolverCacheSize is 4, meaning ECOM will
    1.77 +// cache maximum of four resolver DLLs.
    1.78 +//
    1.79 +// To patch this constant, remove the comment characters and replace 4
    1.80 +// with the desired value.
    1.81 +
    1.82 +// #define ECOM_PATCHDATA_KCUSTOMRESOLVERCACHESIZE 4
    1.83 +
    1.84 +
    1.85 +
    1.86 +// Macro ECOM_PATCHDATA_KCUSTOMRESOLVERCACHETIMEOUT represents the
    1.87 +// value of the patchable constant KCustomResolverCacheTimeout.
    1.88 +// This constant specifies the timeout in microseconds that a resolver DLL is
    1.89 +// kept in cache. When the time expires, the resolver DLL is released from
    1.90 +// memory. The default value of KCustomResolverCacheTimeout is 4000000.
    1.91 +// That means if no client uses a cached resolver DLL, the DLL will be
    1.92 +// unloaded after four seconds.
    1.93 +//
    1.94 +// To patch this constant, remove the comment characters and replace 4000000
    1.95 +// with the desired value.
    1.96 +
    1.97 +// #define ECOM_PATCHDATA_KCUSTOMRESOLVERCACHETIMEOUT 4000000
    1.98 +
    1.99 +#endif