/* * Copyright (C) 1998 by Southwest Research Institute (SwRI) * * All rights reserved under U.S. Copyright Law and International Conventions. * * The development of this Software was supported by contracts NAG5-3148, * NAG5-6855, NAS8-36840, NAG5-2323, and NAG5-7043 issued on behalf of * the United States Government by its National Aeronautics and Space * Administration. Southwest Research Institute grants to the Government, * and others acting on its behalf, a paid-up nonexclusive, irrevocable, * worldwide license to reproduce, prepare derivative works, and perform * publicly and display publicly, by or on behalf of the Government. * Other than those rights granted to the United States Government, no part * of this Software may be reproduced in any form or by any means, electronic * or mechanical, including photocopying, without permission in writing from * Southwest Research Institute. All inquiries should be addressed to: * * Director of Contracts * Southwest Research Institute * P. O. Drawer 28510 * San Antonio, Texas 78228-0510 * * * Use of this Software is governed by the terms of the end user license * agreement, if any, which accompanies or is included with the Software * (the "License Agreement"). An end user will be unable to install any * Software that is accompanied by or includes a License Agreement, unless * the end user first agrees to the terms of the License Agreement. Except * as set forth in the applicable License Agreement, any further copying, * reproduction or distribution of this Software is expressly prohibited. * Installation assistance, product support and maintenance, if any, of the * Software is available from SwRI and/or the Third Party Providers, as the * case may be. * * Disclaimer of Warranty * * SOFTWARE IS WARRANTED, IF AT ALL, IN ACCORDANCE WITH THESE TERMS OF THE * LICENSE AGREEMENT. UNLESS OTHERWISE EXPLICITLY STATED, THIS SOFTWARE IS * PROVIDED "AS IS", IS EXPERIMENTAL, AND IS FOR NON-COMMERCIAL USE ONLY, * AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR * PURPOSE, OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT * SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. * * Limitation of Liability * * SwRI SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED AS A RESULT OF USING, * MODIFYING, CONTRIBUTING, COPYING, DISTRIBUTING, OR DOWNLOADING THIS * SOFTWARE. IN NO EVENT SHALL SwRI BE LIABLE FOR ANY INDIRECT, PUNITIVE, * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGE (INCLUDING LOSS OF BUSINESS, * REVENUE, PROFITS, USE, DATA OR OTHER ECONOMIC ADVANTAGE) HOWEVER IT ARISES, * WHETHER FOR BREACH OF IN TORT, EVEN IF SwRI HAS BEEN PREVIOUSLY ADVISED OF * THE POSSIBILITY OF SUCH DAMAGE. YOU HAVE SOLE RESPONSIBILITY FOR ADEQUATE * PROTECTION AND BACKUP OF DATA AND/OR EQUIPMENT USED IN CONNECTION WITH THE * SOFTWARE AND WILL NOT MAKE A CLAIM AGAINST SwRI FOR LOST DATA, RE-RUN TIME, * INACCURATE OUTPUT, WORK DELAYS OR LOST PROFITS RESULTING FROM THE USE OF * THIS SOFTWARE. YOU AGREE TO HOLD SwRI HARMLESS FROM, AND YOU COVENANT NOT * TO SUE SwRI FOR, ANY CLAIMS BASED ON USING THE SOFTWARE. * * Local Laws: Export Control * * You acknowledge and agree this Software is subject to the U.S. Export * Administration Laws and Regulations. Diversion of such Software contrary * to U.S. law is prohibited. You agree that none of the Software, nor any * direct product therefrom, is being or will be acquired for, shipped, * transferred, or reexported, directly or indirectly, to proscribed or * embargoed countries or their nationals, nor be used for nuclear activities, * chemical biological weapons, or missile projects unless authorized by U.S. * Government. Proscribed countries are set forth in the U.S. Export * Administration Regulations. Countries subject to U.S embargo are: Cuba, * Iran, Iraq, Libya, North Korea, Syria, and the Sudan. This list is subject * to change without further notice from SwRI, and you must comply with the * list as it exists in fact. You certify that you are not on the U.S. * Department of Commerce's Denied Persons List or affiliated lists or on the * U.S. Department of Treasury's Specially Designated Nationals List. You agree * to comply strictly with all U.S. export laws and assume sole responsibilities * for obtaining licenses to export or reexport as may be required. * * General * * These Terms represent the entire understanding relating to the use of the * Software and prevail over any prior or contemporaneous, conflicting or * additional, communications. SwRI can revise these Terms at any time * without notice by updating this posting. * * Trademarks * * The SwRI logo is a trademark of SwRI in the United States and other countries. * */ #ident "@(#) get_error_str.c 1.13 05/08/19 SwRI" #include #include #include "libbase_idfs.h" #include "ret_codes.h" #include "libdb.h" /***************************************************************************** * * * GET_ERROR_STR SUBROUTINE * * * * DESCRIPTION * * This routine is called to compose the error string encountered from * * the database software, the idfs read routines or the PIDF software. * * If the error code is not identified as coming from one of these sources, * * an error code is returned. * * * * INPUT VARIABLES * * SDDAS_SHORT error_code the error code to be processed * * SDDAS_CHAR *err_str ptr to area where string is to be returned * * SDDAS_LONG str_len length of string to be returned * * * * USAGE * * x = get_error_str (error_code, err_str, str_len) * * * * NECESSARY SUBPROGRAMS * * strlen () determines the length of a string * * strcpy() copies a string to another string variable * * sprintf() creates a string based upon arguments and * * conversion characters * * db_msgs () returns the message associated with the error* * code from the database software * * pidf_error_str () returns the message associated with the error* * code from the PIDF software * * idfs_error_message_str () returns the message associated with the error* * code from the idfs read routines * * scf_error_str () returns the message associated with the error* * code from the SCF routines * * * * EXTERNAL VARIABLES * * None * * * * INTERNAL VARIABLES * * size_t length length of the error string * * SDDAS_CHAR e_str[] holds the error string to be outputted * * char *tmp pointer to error string returned by DB_MSGS()* * char error_found flag indicating error code was identified * * char just_pidf flag set if just PIDF code was compiled * * * * SUBSYSTEM * * Display Level * * * *****************************************************************************/ SDDAS_SHORT get_error_str (SDDAS_SHORT error_code, SDDAS_CHAR *err_str, SDDAS_LONG str_len) { size_t length; SDDAS_CHAR e_str[1000]; char *tmp, error_found, just_pidf; /************************************************************************/ /* Determine which set of software generated the error code. */ /************************************************************************/ error_found = 0; just_pidf = 1; #ifdef SCF_ERR just_pidf = 0; /************************************************************************/ /* Database software error. */ /************************************************************************/ if (error_code <= DB_START_neg && error_code >= DB_STOP_neg) { error_found = 1; tmp = db_msgs ((int) error_code); sprintf (e_str, "DB_ERROR: %s.", tmp); } /************************************************************************/ /* Error code generated by idfs read routines. */ /************************************************************************/ else if (error_code <= UTIL_START_CODE && error_code >= UTIL_STOP_CODE) { error_found = 1; idfs_error_message_str (error_code, e_str); } /************************************************************************/ /* Error code generated by scf routines. */ /************************************************************************/ else if (error_code <= SCF_START && error_code >= SCF_END) { error_found = 1; scf_error_str (error_code, e_str); } #endif #ifdef IDFS_ERR just_pidf = 0; /************************************************************************/ /* Database software error. */ /************************************************************************/ if (error_code <= DB_START_neg && error_code >= DB_STOP_neg) { error_found = 1; tmp = db_msgs ((int) error_code); sprintf (e_str, "DB_ERROR: %s.", tmp); } /************************************************************************/ /* Error code generated by idfs read routines. */ /************************************************************************/ else if (error_code <= UTIL_START_CODE && error_code >= UTIL_STOP_CODE) { error_found = 1; idfs_error_message_str (error_code, e_str); } #endif #ifdef DB_ERR just_pidf = 0; /************************************************************************/ /* Database software error. */ /************************************************************************/ if (error_code <= DB_START_neg && error_code >= DB_STOP_neg) { error_found = 1; tmp = db_msgs ((int) error_code); sprintf (e_str, "DB_ERROR: %s.", tmp); } #endif #ifdef PIDF_ERR /************************************************************************/ /* Error code generated by PIDF software. */ /************************************************************************/ if (just_pidf) { error_found = 1; pidf_error_str (error_code, e_str); } else if (error_code <= PIDF_START && error_code >= PIDF_STOP) { error_found = 1; pidf_error_str (error_code, e_str); } #endif /************************************************************************/ /* Error code from some unknown source area. */ /************************************************************************/ if (!error_found) { if (error_code == NO_DATA) { error_found = 1; sprintf (e_str, "META-DATA FOR SOME OF THE DATA SOURCES IS NOT CONTAINED IN THE DATABASE."); } else sprintf (e_str, "A MATCH FOR ERROR CODE %d WAS NOT FOUND.", error_code); } /************************************************************************/ /* Make sure error string will fit in return string. */ /************************************************************************/ length = strlen (e_str); if (length > str_len) e_str[str_len-1] = '\0'; strcpy (err_str, e_str); if (!error_found) return (!ALL_OKAY); else return (ALL_OKAY); }