1 // Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 //

    15 

    16 #ifndef __SSMCUSTOMCOMMANDINFO_H__

    17 #define __SSMCUSTOMCOMMANDINFO_H__

    18 

    19 #include <e32base.h>

    20 #include <ssm/ssmcmd.hrh>

    21 

    22 class RReadStream;

    23 class RWriteStream;

    24 

    25 /** 

    26 The maximum size of user-specific (TDesC8) data passed to a Custom Command.

    27 @see CCmdCustomCommand

    28 @see CSsmCustomCommandInfo

    29 @publishedPartner

    30 @released

    31 */

    32 const TInt KMaxDLLParams = 4096;

    33 

    34 /** 

    35 Information required to construct a custom command.

    36 @see TCmdCustomCommandLibUnloading

    37 @see CCmdCustomCommand

    38 @publishedPartner

    39 @released

    40 */

    41 class CSsmCustomCommandInfo : public CBase

    42 	{

    43 public:

    44 	IMPORT_C CSsmCustomCommandInfo();

    45 	IMPORT_C ~CSsmCustomCommandInfo();

    46 

    47 	IMPORT_C void SetL(const TDesC& aFileName, TInt32 aOrdinal, TCmdCustomCommandLibUnloading aUnloading, TInt16 aRetries, const TDesC8& aParams);

    48 	IMPORT_C void Clear();

    49 	

    50 	IMPORT_C const TFileName& FileName() const;

    51 	IMPORT_C TInt32 Ordinal() const;

    52 	IMPORT_C TCmdCustomCommandLibUnloading Unloading() const;

    53 	IMPORT_C TInt16 Retries() const;

    54 	IMPORT_C const TPtrC8 Params() const;

    55 

    56 	IMPORT_C void InternalizeL(RReadStream& aReadStream);

    57 	IMPORT_C void ExternalizeL(RWriteStream& aWriteStream) const;

    58 

    59 	IMPORT_C CSsmCustomCommandInfo& operator=(const CSsmCustomCommandInfo& aInfo);

    60 

    61 private:

    62 	CSsmCustomCommandInfo(const CSsmCustomCommandInfo& aInfo);

    63 

    64 private:

    65 	TFileName iFileName;

    66 	TInt32 iOrdinal;

    67 	TCmdCustomCommandLibUnloading iUnloading;

    68 	TInt16 iRetries;

    69 	HBufC8* iParams;

    70 	};

    71 

    72 #endif // __SSMCUSTOMCOMMANDINFO_H__