wim/inc/ScardReaderQuery.h
changeset 0 164170e6151a
equal deleted inserted replaced
-1:000000000000 0:164170e6151a
       
     1 /*
       
     2 * Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  This class returns all supported readers and reader groups.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef CSCARDREADERQUERY_H
       
    21 #define CSCARDREADERQUERY_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include "ScardDefs.h"
       
    25 
       
    26 
       
    27 // CLASS DECLARATION
       
    28 
       
    29 /**
       
    30 *  Utility class to make queries for readers and reader groups.
       
    31 *  This class is intended for use by all Smart card aware
       
    32 *  applications that need to query the resources available on
       
    33 *  the framework.
       
    34 *
       
    35 *  @lib Scard.lib
       
    36 *  @since Series60 2.1
       
    37 */
       
    38 class CScardReaderQuery : public CBase
       
    39     {
       
    40     public:  // Constructors and destructor
       
    41         
       
    42         /**
       
    43         * Two-phased constructor.
       
    44         */
       
    45         IMPORT_C static CScardReaderQuery* NewL();
       
    46         
       
    47         /**
       
    48         * Destructor.
       
    49         */
       
    50         IMPORT_C virtual ~CScardReaderQuery();
       
    51 
       
    52     public: // New functions
       
    53         
       
    54         /**
       
    55         * Create a list of all the readers belonging to the group.
       
    56         * @param aReaderList Dynamic array that will be filled with the 
       
    57         * names of the readers that belong to the group. The array must 
       
    58         * be already allocated and it must be empty. There is only one 
       
    59         * reader in Series 60. If given group is not what expected, leaves
       
    60         * with KScErrNotSupported
       
    61         * @param aGroupName Name of the reader group to be queried.
       
    62         */
       
    63         IMPORT_C void ListReadersL(
       
    64             CArrayFixFlat<TScardReaderName>* aReaderList,
       
    65             const TScardReaderName& aGroupName );
       
    66 
       
    67         /**
       
    68         * List all groups currently installed to the framework.
       
    69         * @param aGroupList dynamic array that will be filled with the 
       
    70         *        names of the groups. The array must be already allocated and
       
    71         *        it must be empty.
       
    72         */
       
    73         IMPORT_C void ListGroupsL(
       
    74             CArrayFixFlat<TScardReaderName>* aGroupList );
       
    75 
       
    76 
       
    77     private:
       
    78 
       
    79         /**
       
    80         * C++ default constructor.
       
    81         */
       
    82         CScardReaderQuery();
       
    83 
       
    84         /**
       
    85         * Symbian 2nd phase constructor.
       
    86         */
       
    87         void ConstructL();
       
    88     
       
    89     };
       
    90 
       
    91 #endif      // CSCARDREADERQUERY_H   
       
    92             
       
    93 // End of File