有关在 C# 中构建错误代码查找的建议

Question

我是 C# 新手，如果我的一些概念有偏差，请原谅我。我正在使用 Canon EDSDK，为了让生活更轻松，我希望能够将错误消息视为文本而不是十六进制值。 EDSDK.cs 文件包含一长串错误，例如：

public const uint EDS_ERR_TAKE_PICTURE_CARD_NG = 0x00008D07;
public const uint EDS_ERR_TAKE_PICTURE_CARD_PROTECT_NG = 0x00008D08;

理想情况下，我想将所有这些放入某种查找表中，以便我可以输入十六进制错误代码并以字符串形式返回实际消息。例如

Hashtable EDSDKErrorCodes = new Hashtable();

EDSDKErrorCodes.Add("0x00008D01", "EDS_ERR_TAKE_PICTURE_AF_NG");
EDSDKErrorCodes.Add("0x00008D08", "EDS_ERR_TAKE_PICTURE_CARD_PROTECT_NG");
etc etc...

，在我的代码中，我可以抓取从 EDSDK 方法之一返回的错误消息，并以人类可读的形式显示它：

errorcode= EDSDK.EdsInitializeSDK();

MessageBox.Show(Convert.ToString(EDSDKErrorCodes[errorcode]));

我的问题是..这是处理所有这些错误代码的好方法还是有更好的方法人们会推荐更有效的方式吗？如果是这样，我如何将哈希表填充为一系列常量，而不必使用 Add 方法？

Answer 1

另一种方法是创建一个带有描述属性的枚举。有关完整详细信息，请参阅此处。这是总结它的外观：

public enum ErrorCodes : uint
{
    [Description("Description for EDS_ERR_TAKE_PICTURE_CARD_NG")]
    EDS_ERR_TAKE_PICTURE_CARD_NG = 0x00008D07,
    [Description("Description for EDS_ERR_TAKE_PICTURE_CARD_PROTECT_NG")]
    EDS_ERR_TAKE_PICTURE_CARD_PROTECT_NG = 0x00008D08
}

最简单的是，如果您不关心描述，您可以使用 Enum.GetName

Answer 2

您可以为此使用枚举。

public enum ErrorCodes : uint
{
    EDS_ERR_TAKE_PICTURE_CARD_NG = 0x00008D07,
    EDS_ERR_TAKE_PICTURE_CARD_PROTECT_NG = 0x00008D08
}

那么您的用法可能如下所示：

ErrorCodes error = (ErrorCodes)EDSDK.EdsInitializeSDK();
MessageBox.Show(Enum.GetName(typeof(ErrorCodes), error));

Answer 3

我认为制作一个枚举会更好：

public enum CanonErrorCode
{
    SomeErrorDescription = 14,
    SomeOtherErrorDescription = 15
    // .. etc
}

您只需将十六进制转换为整数即可。然后你可以简单地这样调用它：

// Samples
var myErrorCode = (CanonErrorCode)someIntegerValue;
var myErrorCode = CanonErrorCode.SomeOtherErrorDescription;

如果你想要人工格式化的错误描述，那么我会建议某种映射，例如：

static Dictionary<int, string> errorlookups = new Dictionary<int, string>();

errorLookups.Add(10, "This is the human readable error message.");
errorLookups.Add(17, "Create this guy once in a static constructor.");

Answer 4

您可以使用通用字典而不是哈希表，

Dictionary<uint, String> myDict = new Dictionary<uint, String>();

然后您可以通过执行操作来检索您想要的值

MessageBox.Show(myDict[errorCode]);

对于添加，我认为您可能可以通过反射执行一些操作来反映 EDSDK 类并找到所有常量 uint 成员。然后遍历该列表添加值和常量名称。

Answer 5

好吧，自从我们开始工作以来，又采取了另一种方式:-)
如果当前错误代码未定义，此解决方案还会生成人类可读的错误字符串。

像这样创建一个 Enum：

public enum ErrorCode : uint
{
    EDS_ERR_TAKE_PICTURE_CARD_NG = 0x00008D07,
    EDS_ERR_TAKE_PICTURE_CARD_PROTECT_NG = 0x00008D08
}

然后，创建一个 扩展方法 对于像这样的枚举类型：

public static class ErrorHandler
{
    public static string ToErrorString(this ErrorCode errorCode)
    {
        return Enum.IsDefined(typeof(ErrorCode), errorCode) ? 
            errorCode.ToString() : "Undefined error code";
    }
}

最后，像这样使用它：

var errorCode = (ErrorCode)EDSDK.EdsInitializeSDK();
MessageBox.Show(errorCode.ToErrorString());

Answer 6

首先，您应该使用通用字典而不是哈希表。其次，我对 Canon EDSDK 一无所知，但奇怪的是它返回一个十六进制字符串的错误代码，而不是定义常量时简单的 uint 。他们真的就是这样被退回的吗？如果是这样，那就很奇怪，但是您应该能够将它们转换为整数，否则，您可以跳过该步骤。

如果您想使用反射创建数组，您可以执行以下操作：

Dictionary<int,String> EDSDKErrorCodes = new Dictionary<int,String>;
System.Reflection.FieldInfo[] fields = typeof(EDSDK).GetFields(System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.Static);
foreach (System.Reflection.FieldInfo field in fields) {
  EDSDKErrorCodes[(uint)field.GetValue(null)] = field.Name;
}

然后您可以使用以下方式访问它：

MessageBox.Show(EDSDKErrorCodes[errorCode]);

如果 errorCode 是字符串，请首先使用以下方式转换它：

uint errorNumber = uint.Parse(errorCode.Substring(2), System.Globalization.NumberStyle.HexNumber);