epoc32/include/cryptospi/cryptospistateapi.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
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@4
     1
/*
williamr@4
     2
* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     3
* All rights reserved.
williamr@4
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of the License "Eclipse Public License v1.0"
williamr@4
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     8
*
williamr@4
     9
* Initial Contributors:
williamr@4
    10
* Nokia Corporation - initial contribution.
williamr@4
    11
*
williamr@4
    12
* Contributors:
williamr@4
    13
*
williamr@4
    14
* Description: 
williamr@4
    15
* crypto spi application interface
williamr@4
    16
*
williamr@4
    17
*/
williamr@4
    18
williamr@4
    19
williamr@4
    20
/**
williamr@4
    21
 @file
williamr@4
    22
 @publishedAll
williamr@4
    23
 @released
williamr@4
    24
*/
williamr@4
    25
williamr@4
    26
#ifndef __CRYPTOAPI_CRYPTOSPISTATEAPI_H__
williamr@4
    27
#define __CRYPTOAPI_CRYPTOSPISTATEAPI_H__
williamr@4
    28
williamr@4
    29
#include <e32base.h>
williamr@4
    30
williamr@4
    31
namespace CryptoSpi
williamr@4
    32
	{
williamr@4
    33
	class MPluginSelector;
williamr@4
    34
	class CCharacteristicsAndPluginName;
williamr@4
    35
williamr@4
    36
	/**
williamr@4
    37
	The class provides the APIs to set and unset the rule-based selector.
williamr@4
    38
	*/
williamr@4
    39
	NONSHARABLE_CLASS(CCryptoSpiStateApi)
williamr@4
    40
		{
williamr@4
    41
	public:
williamr@4
    42
williamr@4
    43
		/**
williamr@4
    44
		Set the rule-based selector for the current thread. Once the rule-based 
williamr@4
    45
		selector is set, it will be used by the crypto factory to select appropriate 
williamr@4
    46
		plugin implementation. The owner of the selector is the user, and the ownership 
williamr@4
    47
		is not transferd.
williamr@4
    48
		
williamr@4
    49
		@param aSelector The plugin selector to use
williamr@4
    50
		*/
williamr@4
    51
		IMPORT_C static void SetSelector(MPluginSelector* aSelector);
williamr@4
    52
		
williamr@4
    53
		/**
williamr@4
    54
		The function unsets the selector for the current thread, so that
williamr@4
    55
		the legacy selector will be used to select plugins. 
williamr@4
    56
		*/
williamr@4
    57
		IMPORT_C static void UnsetSelector();
williamr@4
    58
		
williamr@4
    59
		/**
williamr@4
    60
		Enumerate the all characteristics in the system
williamr@4
    61
		@param aCharacteristics the array of characteristic dll list.
williamr@4
    62
		@param aInterface the uid of the interface, 0 means that enumerating characteristics for all the interfaces
williamr@4
    63
		@param aExtended if extended characteristic needs to be retrieved.
williamr@4
    64
		@leave ...	Any of the crypto error codes defined in 
williamr@4
    65
  					cryptospi_errs.h or any of the system-wide error codes.	
williamr@4
    66
		*/
williamr@4
    67
		IMPORT_C static void EnumerateCharacteristicsL(RPointerArray<CCharacteristicsAndPluginName>& aCharacteristics, TInt32 aInterface, TBool aExtended);
williamr@4
    68
		};
williamr@4
    69
	}
williamr@4
    70
	
williamr@4
    71
#endif //__CRYPTOAPI_CRYPTOSPISTATEAPI_H__