cryptomgmtlibs/securityutils/inc/miscutil.h
changeset 0 2c201484c85f
child 8 35751d3474b7
equal deleted inserted replaced
-1:000000000000 0:2c201484c85f
       
     1 /*
       
     2 * Copyright (c) 2008-2009 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 the License "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: 
       
    15 * Contains miscellaneous utility functions that can be used by any code in security component
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 /**
       
    23  @file
       
    24  @internalComponent
       
    25 */
       
    26 
       
    27 #ifndef __MISCUTIL_H__
       
    28 #define __MISCUTIL_H__
       
    29 
       
    30 #include <e32base.h>
       
    31 
       
    32 /**
       
    33  * This namespace contains common miscellaneous utilitarian functionality meant from use in security code
       
    34  */
       
    35 namespace MiscUtil
       
    36 	{
       
    37 	/*
       
    38 	 * Function used to extract lines of text from a buffer. Note that this only works for non-unicode text. It skips
       
    39 	 * over blank lines and the characters '\n' or '\r' are treated as end-of-line markers.
       
    40 	 *
       
    41 	 * @param aBuffer		Input buffer
       
    42 	 * @param aPos		Starting index into aBuffer (should be within the bounds of zero and length of buffer). 
       
    43 	 *				It is updated after processing and should be passed in unchanged to correctly identify next line
       
    44 	 * @param aLine		Set to point to the start of the line identified
       
    45 	 * @return			ETrue if a line was successfully extracted from the buffer, EFalse if end of buffer reached
       
    46 	 */
       
    47 	IMPORT_C TBool ReadNonEmptyLineL(const TDesC8& aBuffer, TInt& aPos, TPtrC8& aLine);
       
    48 	}
       
    49 
       
    50 #endif // __MISCUTIL_H__