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