os/security/contentmgmt/contentaccessfwfordrm/source/cafutils/cafutils.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
/*
sl@0
     2
* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     3
* All rights reserved.
sl@0
     4
* This component and the accompanying materials are made available
sl@0
     5
* under the terms of the License "Eclipse Public License v1.0"
sl@0
     6
* which accompanies this distribution, and is available
sl@0
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     8
*
sl@0
     9
* Initial Contributors:
sl@0
    10
* Nokia Corporation - initial contribution.
sl@0
    11
*
sl@0
    12
* Contributors:
sl@0
    13
*
sl@0
    14
* Description: 
sl@0
    15
* This contains constant definitions required by clients accessing the 
sl@0
    16
* Content Access Framework.
sl@0
    17
*
sl@0
    18
*/
sl@0
    19
sl@0
    20
sl@0
    21
/**
sl@0
    22
 @file
sl@0
    23
 @internalComponent
sl@0
    24
 @released
sl@0
    25
*/
sl@0
    26
sl@0
    27
#ifndef __CAFUTILS_H__
sl@0
    28
#define __CAFUTILS_H__
sl@0
    29
sl@0
    30
#include <e32std.h>
sl@0
    31
#include <charconv.h>
sl@0
    32
sl@0
    33
namespace ContentAccess
sl@0
    34
	{
sl@0
    35
	/** Provides static utility functions for the Content Access Framework*/
sl@0
    36
	class TCafUtils
sl@0
    37
		{
sl@0
    38
	public:
sl@0
    39
		/** Utility function to read a descriptor from a stream 
sl@0
    40
		@param aStream The stream
sl@0
    41
		@return An HBufC descriptor populated with the data from the stream
sl@0
    42
		*/
sl@0
    43
		static HBufC* ReadDescriptor16L(RReadStream& aStream);
sl@0
    44
sl@0
    45
		/** Utility function to write a descriptor to a stream 
sl@0
    46
		@param aStream The stream
sl@0
    47
		@param aDescriptor The descriptor
sl@0
    48
		*/
sl@0
    49
		static void WriteDescriptor16L(RWriteStream& aStream, const TDesC& aDescriptor);
sl@0
    50
sl@0
    51
		/** Utility function to read a descriptor from a stream 
sl@0
    52
		@param aStream The stream
sl@0
    53
		@return An HBufC descriptor populated with the data from the stream
sl@0
    54
		*/
sl@0
    55
		static HBufC8* ReadDescriptor8L(RReadStream& aStream);
sl@0
    56
		
sl@0
    57
		/** Utility function to read from a stream into an existing descriptor
sl@0
    58
		@param aStream The stream
sl@0
    59
		@param aBuffer Buffer to receive the data
sl@0
    60
		@leave KErrOverflow If the buffer is not large enough to hold the descriptor
sl@0
    61
		*/
sl@0
    62
		static void ReadDescriptor8L(RReadStream& aStream, TDes8& aBuffer);
sl@0
    63
sl@0
    64
		/** Utility function to write a descriptor to a stream 
sl@0
    65
		@param aStream The stream
sl@0
    66
		@param aDescriptor The descriptor
sl@0
    67
		*/
sl@0
    68
		static void WriteDescriptor8L(RWriteStream& aStream, const TDesC8& aDescriptor);
sl@0
    69
		};
sl@0
    70
	}
sl@0
    71
#endif // __CAF_H__