//                           UNCLASSIFIED
/*-------------------------------------------------------------------------
RAYTHEON PROPRIETARY: THIS DOCUMENT CONTAINS DATA OR INFORMATION
PROPRIETARY TO RAYTHEON COMPANY AND IS RESTRICTED TO USE ONLY BY PERSONS
AUTHORIZED BY RAYTHEON COMPANY IN WRITING TO USE IT. DISCLOSURE TO
UNAUTHORIZED PERSONS WOULD LIKELY CAUSE SUBSTANTIAL COMPETITIVE HARM TO
RAYTHEON COMPANY'S BUSINESS POSITION. NEITHER SAID DOCUMENT NOR ITS
CONTENTS SHALL BE FURNISHED OR DISCLOSED TO OR COPIED OR USED BY PERSONS
OUTSIDE RAYTHEON COMPANY WITHOUT THE EXPRESS WRITTEN APPROVAL OF RAYTHEON
COMPANY.

THIS PROPRIETARY NOTICE IS NOT APPLICABLE IF DELIVERED TO THE U.S.
GOVERNMENT.

UNPUBLISHED WORK - COPYRIGHT RAYTHEON COMPANY.
-------------------------------------------------------------------------*/

using System;
using System.Text;

namespace FpgaMeasurementInstrumentsLib
{
   /// <summary>
   /// A collection of utilities.
   /// </summary>
   public static class HssUtilSs
   {
      #region PublicFuctions

      /// <summary>
      /// 
      /// </summary>
      /// <param name="chassisHandle"></param>
      /// <param name="errorCode"></param>
      /// <param name="moduleName"></param>
      /// <returns></returns>
      public static string BuildErrorString(uint chassisHandle, int errorCode, string moduleName)
      {
         StringBuilder errorStrTemp = new StringBuilder(512);

         int ret = HssubNativeMethods.terHsi_error_message(chassisHandle, errorCode, errorStrTemp);

         if (ret != 0)
         {
            throw new Exception("HssUtilSs::BuildErrorString() - terHsi_error_message returned an error(" + ret + ")");
         }

         string errorMsg = errorStrTemp.ToString();

         return errorMsg += "(" + moduleName + ")";
      }
      #endregion
   }
}
