Kernel - NKS0031

Use TimeDateRenderersUtc.RenderTimeUtc()

This analyzer provides the following strings:

Context	String
Error List	Caller uses TimeDateTools.KernelDateTimeUtc.ToString instead of TimeDateRenderersUtc.RenderTimeUtc()
Suggestion Box	Use TimeDateRenderersUtc.RenderTimeUtc() instead of TimeDateTools.KernelDateTimeUtc.ToString
Description	TimeDateRenderersUtc.RenderTimeUtc() respects your kernel settings when rendering time.

Extended Description

This code analyzer detects the usage of KernelDateTimeUtc.ToString from the TimeDateTools class found in the KS.Kernel.Time namespace.

TimeDateTools.KernelDateTime contains an override to a function that converts that instance of the current date and time to its string representation. However, there is a function dedicated to that, called Render() and its siblings, that renders your target time to its equivalent string representation and also respects your kernel settings.

Similarly, TimeDateTools.KernelDateTimeUtc has been given the same treatment, because you can also use the RenderUtc() function and its siblings.

Analysis Comparison

To get a brief insight about how this analyzer works, compare the two code blocks shown to you below:

Before the fix

Somewhere in your mod code...

public static void MyFunction()
{
    string value = TimeDateTools.KernelDateTimeUtc.ToString();
}

After the fix

Somewhere in your mod code...

public static void MyFunction()
{
    string value = TimeDateRenderersUtc.RenderTimeUtc();
}

Suppression

You can suppress this suggestion by including it in the appropriate place, whichever is convenient.

For more information about how to suppress any warning issued by the Nitrocid analyzer, visit the below page:

Suppress code analysis warnings - .NETMicrosoftLearn

Recommendation

We recommend that every caller which use this function use the recommended abovementioned method.