Add custom DebuggerDisplay for HRESULT

[misaz]

PR adds support for using customized DebuggerDisplay for customized types (templates) instead of hardocoding DebuggerDisplay to structure's first field name. It is designed to work in a way, that when there is property named DebuggerDisplay, it is used instead. Actually there already were some custom DebuggerDisplays in templates, but these only work with SpecialTypeDefNames because for normal types, only Members are obtained and rest of the template is thrown away and recrated including DebuggerDisplay attribute.

PR also uses newly introduced capability and adds custom DebuggerDisplay for HRESULT type. Custom visualizer show HEX error code number followed by humman readable description of HRESULT error code:

It allows developer debugging apps to understand errors without need to use Error Lookup tool or searching online.

Message is internally obtained using avalaible .NET APIs (two variants are implemented depending on .NET version, both should produce same results because internally both end up using FormatMessageW). As you can see, FormatMessage provides localized message. I use Czech windows, so message is in Czech. For debugging it should be no problem.

It also brings debugger visualization experience on par with native debugger which has similar natvis (or maybe hardcoded, who knows?) visualizer for HRESULT as well.

I was also considering adding similar for NTSTATUS, but obtaining message for NTSTATUSes is not that easy because it requires passing NTDLL module handle (+ one more flag) to FormatMessageW and this is not exposed to .NET API. But it can be done manually. Instead of bloating NTSTATUS template in horroble way, I decided to step back on it. Also note, that native debugger do not support visualizer for NTSTATUS as well.

[misaz]

@microsoft-github-policy-service agree

[AArnott]

Thanks! This is awesome.

[AArnott]

Note for next time: you could simplify this line to:

Suggested change

	if (members.Where(x => x is PropertyDeclarationSyntax && ((PropertyDeclarationSyntax)x).Identifier.ValueText == "DebuggerDisplay").Any())
	if (members.Where(x => x is PropertyDeclarationSyntax { Identifier.ValueText: "DebuggerDisplay" }).Any())

[AArnott]

/azp run

[azure-pipelines]

No pipelines are associated with this pull request.