1.1 --- a/epoc32/include/mw/mproengprofilenamearray.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/mproengprofilenamearray.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,88 @@
     1.4 -mproengprofilenamearray.h
     1.5 +/*
     1.6 +* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  Profile name array interface.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +
    1.24 +#ifndef MPROENGPROFILENAMEARRAY_H
    1.25 +#define MPROENGPROFILENAMEARRAY_H
    1.26 +
    1.27 +//  INCLUDES
    1.28 +#include <BAMDESCA.H> // MDesCArray
    1.29 +
    1.30 +// FORWARD DECLARATIONS
    1.31 +class MProEngProfileName;
    1.32 +class MProEngProfileNameArrayExt;
    1.33 +
    1.34 +// CLASS DECLARATION
    1.35 +
    1.36 +/**
    1.37 +*  Profile name array interface.
    1.38 +*
    1.39 +*  How to use:
    1.40 +*  Get profile names array with MProEngEngine::ProfileNameArrayLC().
    1.41 +*  @code
    1.42 +*  MProEngProfileNameArray* nameArray =
    1.43 +*      iProfileEngine->ProfileNameArrayLC();
    1.44 +*  @endcode
    1.45 +*
    1.46 +*  @lib ProfileEngine.lib
    1.47 +*  @since 3.1
    1.48 +*/
    1.49 +class MProEngProfileNameArray : public MDesCArray
    1.50 +    {
    1.51 +    public: // New functions
    1.52 +
    1.53 +        /**
    1.54 +        * Return the ID of the profile in the given array index.
    1.55 +        * @since 3.1
    1.56 +        * @param aIndex index of the profile.
    1.57 +        * @return Return the ID of the profile in the given array index.
    1.58 +        *         KErrNotFound if the index is out of bounds.
    1.59 +        */
    1.60 +        virtual TInt ProfileId( TInt aIndex ) const = 0;
    1.61 +
    1.62 +        /**
    1.63 +        * Find profile index by ID of the profile.
    1.64 +        * @since 3.1
    1.65 +        * @param aId ID of the profile.
    1.66 +        * @return Return index of the profile. KErrNotFound if
    1.67 +        *         profile isn't found.
    1.68 +        */
    1.69 +        virtual TInt FindById( TInt aId ) const = 0;
    1.70 +
    1.71 +        /**
    1.72 +        * Find profile index by name of the profile.
    1.73 +        * @since 3.1
    1.74 +        * @param aProfileName name of the profile.
    1.75 +        * @return Return index of the profile. KErrNotFound if
    1.76 +        *         profile isn't found.
    1.77 +        */
    1.78 +        virtual TInt FindByName( const TDesC& aProfileName ) const = 0;
    1.79 +
    1.80 +    private: // Extension interface
    1.81 +
    1.82 +        /**
    1.83 +        * This member is internal and not intended for use.
    1.84 +        */
    1.85 +        virtual MProEngProfileNameArrayExt* Extension() { return NULL; }
    1.86 +
    1.87 +    };
    1.88 +
    1.89 +#endif      // MPROENGPROFILENAMEARRAY_H
    1.90 +
    1.91 +// End of File
    1.92 +