GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: fxe_file_close.c Lines: 6 6 100.0 %
Date: 2024-03-11 05:15:45 Branches: 8 8 100.0 %

Line Branch Exec Source
1
/***************************************************************************
2
 * Copyright (c) 2024 Microsoft Corporation
3
 *
4
 * This program and the accompanying materials are made available under the
5
 * terms of the MIT License which is available at
6
 * https://opensource.org/licenses/MIT.
7
 *
8
 * SPDX-License-Identifier: MIT
9
 **************************************************************************/
10
11
12
/**************************************************************************/
13
/**************************************************************************/
14
/**                                                                       */
15
/** FileX Component                                                       */
16
/**                                                                       */
17
/**   File                                                                */
18
/**                                                                       */
19
/**************************************************************************/
20
/**************************************************************************/
21
22
#define FX_SOURCE_CODE
23
24
25
/* Include necessary system files.  */
26
27
#include "fx_api.h"
28
#include "fx_file.h"
29
30
FX_CALLER_CHECKING_EXTERNS
31
32
33
/**************************************************************************/
34
/*                                                                        */
35
/*  FUNCTION                                               RELEASE        */
36
/*                                                                        */
37
/*    _fxe_file_close                                     PORTABLE C      */
38
/*                                                           6.1          */
39
/*  AUTHOR                                                                */
40
/*                                                                        */
41
/*    William E. Lamie, Microsoft Corporation                             */
42
/*                                                                        */
43
/*  DESCRIPTION                                                           */
44
/*                                                                        */
45
/*    This function checks for errors in the close file call.             */
46
/*                                                                        */
47
/*  INPUT                                                                 */
48
/*                                                                        */
49
/*    file_ptr                              File control block pointer    */
50
/*                                                                        */
51
/*  OUTPUT                                                                */
52
/*                                                                        */
53
/*    return status                                                       */
54
/*                                                                        */
55
/*  CALLS                                                                 */
56
/*                                                                        */
57
/*    _fx_file_close                        Actual file close service     */
58
/*                                                                        */
59
/*  CALLED BY                                                             */
60
/*                                                                        */
61
/*    Application Code                                                    */
62
/*                                                                        */
63
/*  RELEASE HISTORY                                                       */
64
/*                                                                        */
65
/*    DATE              NAME                      DESCRIPTION             */
66
/*                                                                        */
67
/*  05-19-2020     William E. Lamie         Initial Version 6.0           */
68
/*  09-30-2020     William E. Lamie         Modified comment(s),          */
69
/*                                            resulting in version 6.1    */
70
/*                                                                        */
71
/**************************************************************************/
72
6669
UINT  _fxe_file_close(FX_FILE *file_ptr)
73
{
74
75
UINT status;
76
77
78
    /* Check for a null file pointer.  */
79
6669
    if (file_ptr == FX_NULL)
80
    {
81
1
        return(FX_PTR_ERROR);
82
    }
83
84
    /* Check for a valid caller.  */
85

6668
    FX_CALLER_CHECKING_CODE
86
87
    /* Call actual file close service.  */
88
6260
    status =  _fx_file_close(file_ptr);
89
90
    /* Return status to the caller.  */
91
6260
    return(status);
92
}
93