epoc32/include/caf/agent.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: 
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
williamr@2
    21
/**
williamr@2
    22
 @file
williamr@2
    23
 @publishedPartner
williamr@2
    24
 @released
williamr@2
    25
*/
williamr@2
    26
williamr@2
    27
#ifndef __CAF_AGENT_H__
williamr@2
    28
#define __CAF_AGENT_H__
williamr@2
    29
williamr@2
    30
#include <e32base.h>
williamr@2
    31
williamr@2
    32
/** Maximum length of an Agent name, a longer name will be truncated */
williamr@2
    33
const TInt KMaxAgentNameLength = KMaxFileName;
williamr@2
    34
const TInt KMaxSIDLength = 8;
williamr@2
    35
williamr@2
    36
namespace ContentAccess
williamr@2
    37
	{
williamr@2
    38
williamr@2
    39
	/** Represents the name of a single CAF agent. This allows 
williamr@2
    40
	applications to reference a particular agent within the 
williamr@2
    41
	Content Access Framework.
williamr@2
    42
williamr@2
    43
	@publishedPartner
williamr@2
    44
	@released
williamr@2
    45
	*/
williamr@2
    46
	class TAgent 
williamr@2
    47
		{
williamr@2
    48
	public:
williamr@2
    49
		/** The name of the agent 
williamr@2
    50
		@return The name of the agent
williamr@2
    51
		*/
williamr@2
    52
		IMPORT_C const TDesC& Name() const;
williamr@2
    53
williamr@2
    54
		/** The UID of the agent DLL
williamr@2
    55
		@return The UID of the agent ECOM implementation DLL 
williamr@2
    56
williamr@2
    57
		@internalComponent
williamr@2
    58
		@released
williamr@2
    59
		*/
williamr@2
    60
		TUid ImplementationUid() const;
williamr@2
    61
williamr@2
    62
		/** Set the value of this TAgent
williamr@2
    63
		@param aName The name of the agent
williamr@2
    64
		@param aUid The agent implementation Uid
williamr@2
    65
		
williamr@2
    66
		@internalComponent
williamr@2
    67
		@released
williamr@2
    68
		*/
williamr@2
    69
		void SetValue(const TDesC& aName, TUid aUid);
williamr@2
    70
williamr@2
    71
	private:
williamr@2
    72
williamr@2
    73
		TBuf <KMaxAgentNameLength> iName;
williamr@2
    74
		TUid iImplementationUid;
williamr@2
    75
		};
williamr@2
    76
	}
williamr@2
    77
williamr@2
    78
#endif