Files
filex/common/src/fx_media_volume_get.c
T

89 lines
5.1 KiB
C

/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** FileX Component */
/** */
/** Media */
/** */
/**************************************************************************/
/**************************************************************************/
#define FX_SOURCE_CODE
/* Include necessary system files. */
#include "fx_api.h"
#include "fx_system.h"
#include "fx_directory.h"
#include "fx_media.h"
#include "fx_utility.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _fx_media_volume_get PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* William E. Lamie, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function reads the volume name stored in the media's boot */
/* record or root directory. */
/* */
/* Note, this API is deprecated as fx_media_volume_get_extended should */
/* be used. The maximum written size to volume_name could be 12. */
/* */
/* 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_extended 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 _fx_media_volume_get(FX_MEDIA *media_ptr, CHAR *volume_name, UINT volume_source)
{
/* Call the extended version with 12 bytes volume name length. */
return(_fx_media_volume_get_extended(media_ptr, volume_name, 12, volume_source));
}