WSL Plugin: How to display error messages to the user

[ssijbabu]

I am currently developing a WSL plugin that needs to validate the operating system of the distribution during the onDistributionStarted event. If the OS is not authorized, the plugin should:

• Display a message to the user: "You are not authorized to use this distribution".
• Return an error during the onDistributionStarted event to prevent further execution.

I’m reaching out to seek your guidance on how best to achieve this functionality. Specifically, I’d like to know:

• How to display the message to the user in the console and return an error from this event?

Any advice, examples, or resources you can share would be greatly appreciated. Thank you for your time and expertise!

[github-actions]

Logs are required for review from WSL team

If this a feature request, please reply with '/feature'. If this is a question, reply with '/question'.
Otherwise please attach logs by following the instructions below, your issue will not be reviewed unless they are added. These logs will help us understand what is going on in your machine.

How to collect WSL logs

Download and execute collect-wsl-logs.ps1 in an administrative powershell prompt:

Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/microsoft/WSL/master/diagnostics/collect-wsl-logs.ps1" -OutFile collect-wsl-logs.ps1
Set-ExecutionPolicy Bypass -Scope Process -Force
.\collect-wsl-logs.ps1

The script will output the path of the log file once done.

If this is a networking issue, please use collect-networking-logs.ps1, following the instructions here

Once completed please upload the output files to this Github issue.

Click here for more info on logging
If you choose to email these logs instead of attaching to the bug, please send them to [email protected] with the number of the github issue in the subject, and in the message a link to your comment in the github issue and reply with '/emailed-logs'.

[ssijbabu]

/question

[github-actions]

Diagnostic information

Found '/question', adding tag 'question'

[OneBlue]

@ssijbabu: The best way to achieve would be by calling PluginError(). Something like:

HRESULT OnDistributionStarted(...)
{

if (!DistributionNotAllowed(...))
{
    g_api->PluginError(L"This distribution is not authorized");
    return HRESULT_FROM_WIN32(ERROR_ACCESS_DISABLED_BY_POLICY);
}