GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: fxe_media_volume_get_extended.c Lines: 8 8 100.0 %
Date: 2024-03-11 05:15:45 Branches: 12 12 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
/**   Media                                                               */
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_media.h"
29
30
31
FX_CALLER_CHECKING_EXTERNS
32
33
34
/**************************************************************************/
35
/*                                                                        */
36
/*  FUNCTION                                               RELEASE        */
37
/*                                                                        */
38
/*    _fxe_media_volume_get_extended                      PORTABLE C      */
39
/*                                                           6.1          */
40
/*  AUTHOR                                                                */
41
/*                                                                        */
42
/*    William E. Lamie, Microsoft Corporation                             */
43
/*                                                                        */
44
/*  DESCRIPTION                                                           */
45
/*                                                                        */
46
/*    This function checks for errors in the media volume get service.    */
47
/*                                                                        */
48
/*  INPUT                                                                 */
49
/*                                                                        */
50
/*    media_ptr                             Media control block pointer   */
51
/*    volume_name                           Pointer to destination for    */
52
/*                                            the volume name (maximum    */
53
/*                                            11 characters + NULL)       */
54
/*    volume_name_buffer_length             Buffer length for volume_name */
55
/*    volume_source                         Source of volume              */
56
/*                                                                        */
57
/*  OUTPUT                                                                */
58
/*                                                                        */
59
/*    return status                                                       */
60
/*                                                                        */
61
/*  CALLS                                                                 */
62
/*                                                                        */
63
/*    _fx_media_volume_get_extended         Actual media volume get       */
64
/*                                            service                     */
65
/*                                                                        */
66
/*  CALLED BY                                                             */
67
/*                                                                        */
68
/*    Application Code                                                    */
69
/*                                                                        */
70
/*  RELEASE HISTORY                                                       */
71
/*                                                                        */
72
/*    DATE              NAME                      DESCRIPTION             */
73
/*                                                                        */
74
/*  05-19-2020     William E. Lamie         Initial Version 6.0           */
75
/*  09-30-2020     William E. Lamie         Modified comment(s),          */
76
/*                                            resulting in version 6.1    */
77
/*                                                                        */
78
/**************************************************************************/
79
683
UINT  _fxe_media_volume_get_extended(FX_MEDIA *media_ptr, CHAR *volume_name, UINT volume_name_buffer_length, UINT volume_source)
80
{
81
82
UINT status;
83
84
85
    /* Check for a NULL media or volume name pointer.  */
86

683
    if ((media_ptr == FX_NULL) || (volume_name == FX_NULL))
87
    {
88
137
        return(FX_PTR_ERROR);
89
    }
90
91
    /* Check for zero length buffer.  */
92
546
    if (volume_name_buffer_length == 0)
93
    {
94
136
        return(FX_BUFFER_ERROR);
95
    }
96
97
    /* Check for a valid caller.  */
98

410
    FX_CALLER_CHECKING_CODE
99
100
    /* Call actual media volume get service.  */
101
2
    status =  _fx_media_volume_get_extended(media_ptr, volume_name, volume_name_buffer_length, volume_source);
102
103
    /* Return status to the caller.  */
104
2
    return(status);
105
}
106