1/*
2 * Copyright (c) Huawei Technologies Co., Ltd. 2014-2021. All rights reserved.
3 * Licensed under Mulan PSL v2.
4 * You can use this software according to the terms and conditions of the Mulan PSL v2.
5 * You may obtain a copy of Mulan PSL v2 at:
6 *          http://license.coscl.org.cn/MulanPSL2
7 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
8 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
9 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
10 * See the Mulan PSL v2 for more details.
11 * Description: sprintf_s  function
12 * Create: 2014-02-25
13 */
14
15#include "securec.h"
16
17/*
18 * <FUNCTION DESCRIPTION>
19 *    The sprintf_s function is equivalent to the sprintf function
20 *    except for the parameter destMax and the explicit runtime-constraints violation
21 *    The sprintf_s function formats and stores a series of characters and values
22 *    in strDest. Each argument (if any) is converted and output according to
23 *    the corresponding format specification in format. The format consists of
24 *    ordinary characters and has the same form and function as the format argument
25 *    for printf. A null character is appended after the last character written.
26 *    If copying occurs between strings that overlap, the behavior is undefined.
27 *
28 * <INPUT PARAMETERS>
29 *    strDest                 Storage location for output.
30 *    destMax                Maximum number of characters to store.
31 *    format                  Format-control string.
32 *    ...                        Optional arguments
33 *
34 * <OUTPUT PARAMETERS>
35 *    strDest                 is updated
36 *
37 * <RETURN VALUE>
38 *    return the number of bytes stored in strDest, not counting the terminating null character.
39 *    return -1 if an error occurred.
40 *
41 * If there is a runtime-constraint violation, strDest[0] will be set to the '\0' when strDest and destMax valid
42 */
43int sprintf_s(char *strDest, size_t destMax, const char *format, ...)
44{
45    int ret;                    /* If initialization causes  e838 */
46    va_list argList;
47
48    va_start(argList, format);
49    ret = vsprintf_s(strDest, destMax, format, argList);
50    va_end(argList);
51    (void)argList;              /* To clear e438 last value assigned not used , the compiler will optimize this code */
52
53    return ret;
54}
55#if SECUREC_EXPORT_KERNEL_SYMBOL
56EXPORT_SYMBOL(sprintf_s);
57#endif
58
59