WSMAN_SHELL_COMPLETION_FUNCTION function pointer

The callback function that is called for shell operations, which result in a remote request.

Syntax


typedef void ( CALLBACK *WSMAN_SHELL_COMPLETION_FUNCTION)(
  _In_opt_ PVOID                     operationContext,
           DWORD                     flags,
  _In_     WSMAN_ERROR               *error,
  _In_     HANDLE                    shell,
  _In_opt_ HANDLE                    command,
  _In_opt_ HANDLE                    operationHandle,
  _In_opt_ WSMAN_RECEIVE_DATA_RESULT *data
);

Parameters

operationContext [in, optional]

Represents user-defined context passed to the WinRM (WinRM) Client Shell application programming interface (API) .

flags

Specifies one or more flags from the WSManCallbackFlags enumeration.

error [in]

Defines the WSMAN_ERROR structure, which is valid in the callback only.

shell [in]

Specifies the shell handle associated with the user context. The shell handle must be closed by calling the WSManCloseShell method.

command [in, optional]

Specifies the command handle associated with the user context. The command handle must be closed by calling the WSManCloseCommand API method.

operationHandle [in, optional]

Defines the operation handle associated with the user context. The operation handle is valid only for callbacks that are associated with WSManReceiveShellOutput, WSManSendShellInput, and WSManSignalShell calls. This handle must be closed by calling the WSManCloseOperation method.

data [in, optional]

Defines the output data from the command or shell as a result of a WSManReceiveShellOutput call. For more information about the output data, see the WSMAN_RECEIVE_DATA_RESULT structure.

Return value

This function pointer does not return a value.

Requirements

Minimum supported client

Windows 7

Minimum supported server

Windows Server 2008 R2

Redistributable

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

Header

Wsman.h

 

 

Show: