os/security/cryptomgmtlibs/securityutils/inc/miscutil.h
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/security/cryptomgmtlibs/securityutils/inc/miscutil.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,58 @@
     1.4 +/*
     1.5 +* Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of the License "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description: 
    1.18 +* Contains miscellaneous utility functions that can be used by any code in security component
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +/**
    1.24 + @file
    1.25 + @publishedPartner
    1.26 + @released
    1.27 +*/
    1.28 +
    1.29 +#ifndef __MISCUTIL_H__
    1.30 +#define __MISCUTIL_H__
    1.31 +
    1.32 +#include <e32base.h>
    1.33 +#include <f32file.h>
    1.34 +
    1.35 +/**
    1.36 + * This namespace contains common miscellaneous utilitarian functionality meant from use in security code
    1.37 + */
    1.38 +
    1.39 +namespace MiscUtil
    1.40 +	{
    1.41 +	/*
    1.42 +	 * Recursively deletes all folders in the path (as long as they are empty)
    1.43 +	 *
    1.44 +	 * @param aFs		Connected  filesystem session
    1.45 +	 * @param aPath		Fully qualified path to start the recursive delete
    1.46 +	 */
    1.47 +	IMPORT_C void DeletePathIfEmpty(RFs& aFs, const TDesC& aPath);
    1.48 +	/*
    1.49 +	 * Function used to extract lines of text from a buffer. Note that this only works for non-unicode text. It skips
    1.50 +	 * over blank lines and the characters '\n' or '\r' are treated as end-of-line markers.
    1.51 +	 *
    1.52 +	 * @param aBuffer		Input buffer
    1.53 +	 * @param aPos		Starting index into aBuffer (should be within the bounds of zero and length of buffer). 
    1.54 +	 *				It is updated after processing and should be passed in unchanged to correctly identify next line
    1.55 +	 * @param aLine		Set to point to the start of the line identified
    1.56 +	 * @return			ETrue if a line was successfully extracted from the buffer, EFalse if end of buffer reached
    1.57 +	 */
    1.58 +	IMPORT_C TBool ReadNonEmptyLineL(const TDesC8& aBuffer, TInt& aPos, TPtrC8& aLine);
    1.59 +	}
    1.60 +
    1.61 +#endif // __MISCUTIL_H__