epoc32/include/tools/certapp-api.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 #ifndef __CERTAPP_API_H__
     2 #define __CERTAPP_API_H__/*
     3 * Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
     4 * All rights reserved.
     5 * This component and the accompanying materials are made available
     6 * under the terms of the License "Eclipse Public License v1.0"
     7 * which accompanies this distribution, and is available
     8 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     9 *
    10 * Initial Contributors:
    11 * Nokia Corporation - initial contribution.
    12 *
    13 * Contributors:
    14 *
    15 * Description: 
    16 *
    17 */
    18 
    19 
    20 /**
    21  @file
    22  @publishedAll
    23  @released
    24 */
    25 
    26 #ifdef  __cplusplus
    27 extern "C" {
    28 #endif
    29 /**
    30    RunCertApp
    31 
    32 This API will run certapp as separate process and returns the 
    33 result. This approach is taken so that the caller is protected from 
    34 any possible certapp failure. Even if certapp crashes, RunCertApp will 
    35 return without crashing the caller. 
    36  
    37 Certapp guarantees to return a non-zero status if it fails, which 
    38 means you don't need to parse its output to deduce if it worked or 
    39 not. 
    40  
    41 The certapp executable must be in the current search path. 
    42  
    43 The caller will be blocked whilst certapp runs. 
    44  
    45 There are two logging arguments, aProgress and aErrors. These may be 
    46 set to either a filename to write the output to or to "-" which means 
    47 standard output. If both logging arguments are identical, then the 
    48 output will be merged to a single location. 
    49  
    50 Progress and warning messages are written to aProgress. 
    51  
    52 Fatal errors will be logged to aErrors, and RunCertApp will return a
    53 non-zero number. An error code of -1 means the certapp executable
    54 failed or was not found, other error codes indicate problems launching
    55 the executable.
    56  
    57 The argc argument should be set to the count of the argv arguments. 
    58  
    59 The argv argument should be set to an array of const char * ptrs to 
    60 the remaining arguments. 
    61  
    62 The argv arguments maybe any of the arguments accepted by the certapp 
    63 executable, run "certapp -h" for further information. 
    64 */
    65 int RunCertApp(const char *aProgress, const char *aErrors,
    66 			   int argc, char **argv);
    67 
    68 #ifdef  __cplusplus
    69 }
    70 #endif
    71 
    72 #endif