Files
filex/common/src/fxe_media_volume_get.c
T

101 lines
5.4 KiB
C

/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** FileX Component */
/** */
/** Media */
/** */
/**************************************************************************/
/**************************************************************************/
#define FX_SOURCE_CODE
/* Include necessary system files. */
#include "fx_api.h"
#include "fx_media.h"
FX_CALLER_CHECKING_EXTERNS
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _fxe_media_volume_get PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* William E. Lamie, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks for errors in the media volume get service. */
/* */
/* INPUT */
/* */
/* media_ptr Media control block pointer */
/* volume_name Pointer to destination for */
/* the volume name (maximum */
/* 11 characters + NULL) */
/* volume_source Source of volume */
/* */
/* OUTPUT */
/* */
/* return status */
/* */
/* CALLS */
/* */
/* _fx_media_volume_get Actual media volume get */
/* service */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _fxe_media_volume_get(FX_MEDIA *media_ptr, CHAR *volume_name, UINT volume_source)
{
UINT status;
/* Check for a NULL media or volume name pointer. */
if ((media_ptr == FX_NULL) || (volume_name == FX_NULL))
{
return(FX_PTR_ERROR);
}
/* Check for a valid caller. */
FX_CALLER_CHECKING_CODE
/* Call actual media volume get service. */
status = _fx_media_volume_get(media_ptr, volume_name, volume_source);
/* Return status to the caller. */
return(status);
}