scan.hpp

Go to the documentation of this file.

// ======================================================================
// \title  scan.hpp
// \author mstarch
// \brief  hpp file for c-string scan function (sscanf equivalent)
//
// \copyright
// Copyright (C) 2026 California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
// ======================================================================
#ifndef FW_TYPES_SCAN_HPP_
#define FW_TYPES_SCAN_HPP_
#include <Fw/FPrimeBasicTypes.hpp>
#include <cstdarg>
namespace Fw {

enum class ScanStatus {
    SUCCESS,                     
    INVALID_FORMAT_STRING,       
    SIZE_OVERFLOW,               
    UNTERMINATED_SOURCE_STRING,  
    OTHER_ERROR                  
};

ScanStatus stringScan(FwSizeType& count, const char* source, FwSizeType maximumSize, const char* formatString, ...);

ScanStatus stringScan(FwSizeType& count,
                      const char* source,
                      FwSizeType maximumSize,
                      const char* formatString,
                      va_list args);
}  // namespace Fw
#endif  // FW_TYPES_SCAN_HPP_