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 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_source Source of volume */
55 /* */
56 /* OUTPUT */
57 /* */
58 /* return status */
59 /* */
60 /* CALLS */
61 /* */
62 /* _fx_media_volume_get Actual media volume get */
63 /* service */
64 /* */
65 /* CALLED BY */
66 /* */
67 /* Application Code */
68 /* */
69 /* RELEASE HISTORY */
70 /* */
71 /* DATE NAME DESCRIPTION */
72 /* */
73 /* 05-19-2020 William E. Lamie Initial Version 6.0 */
74 /* 09-30-2020 William E. Lamie Modified comment(s), */
75 /* resulting in version 6.1 */
76 /* */
77 /**************************************************************************/
_fxe_media_volume_get(FX_MEDIA * media_ptr,CHAR * volume_name,UINT volume_source)78 UINT _fxe_media_volume_get(FX_MEDIA *media_ptr, CHAR *volume_name, UINT volume_source)
79 {
80
81 UINT status;
82
83
84 /* Check for a NULL media or volume name pointer. */
85 if ((media_ptr == FX_NULL) || (volume_name == FX_NULL))
86 {
87 return(FX_PTR_ERROR);
88 }
89
90 /* Check for a valid caller. */
91 FX_CALLER_CHECKING_CODE
92
93 /* Call actual media volume get service. */
94 status = _fx_media_volume_get(media_ptr, volume_name, volume_source);
95
96 /* Return status to the caller. */
97 return(status);
98 }
99
100
