WSMAN_PLUGIN_SHELL callback function

Defines the shell callback for a plug-in. This function is called when a request for a new shell is received. All Windows Remote Management plug-ins that support shell operations need to implement this callback.

The DLL entry point name must be WSManPluginShell.

Syntax


VOID WINAPI WSManPluginShell(
   PVOID                    pluginContext,
   WSMAN_PLUGIN_REQUEST     *requestDetails,
   DWORD                    flags,
   WSMAN_SHELL_STARTUP_INFO *startupInfo,
   WSMAN_DATA               *inboundShellInformation
);

typedef void (*WSMAN_PLUGIN_SHELL)(
    _In_     PVOID                    pluginContext,
    _In_     WSMAN_PLUGIN_REQUEST     requestDetails,
    _In_     DWORD                    flags,
    _In_opt_ WSMAN_SHELL_STARTUP_INFO startupInfo,
    _In_opt_ WSMAN_DATA               inboundShellInformation
);

Parameters

pluginContext

Specifies the context that was returned by a call to the WSManPluginStartup method. This parameter represents a specific application initialization of a WinRM plug-in.

requestDetails

A pointer to a WSMAN_PLUGIN_REQUEST structure that specifies the resource URI, options, locale, shutdown flag, and handle for the request.

flags

Reserved for future use. Must be set to zero.

startupInfo

A pointer to a WSMAN_SHELL_STARTUP_INFO structure that contains startup information for the shell.

inboundShellInformation

A pointer to a WSMAN_DATA structure that specifies an optional inbound object that contains extra data for the shell.

Return value

This callback function does not return a value.

Remarks

The WinRM (WinRM) plug-in calls WSManPluginReportContext to register a shell context for the shell. All operations on this shell pass into this context. If the shell has shut down or the plug-in checks the requestDetails parameter and reports that the operation was canceled, the plug-in should call WSManPluginOperationComplete. All parameters passed in are valid until the WinRM plug-in calls WSManPluginOperationComplete.

Requirements

Minimum supported client

Windows 7

Minimum supported server

Windows Server 2008 R2

Redistributable

Windows Management Framework on Windows Server 2008 with SP2, Windows Vista with SP1, and Windows Vista with SP2

Header

Wsman.h

 

 

Show: