LanguageService.DispatchCommand Method (Guid, UInt32, IntPtr, IntPtr)

Called to execute the specified command.

Namespace:  Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.12.0 (in Microsoft.VisualStudio.Package.LanguageService.12.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)

Syntax

'Declaration
Public Function DispatchCommand ( _
    cmdGuid As Guid, _
    cmdId As UInteger, _
    pvaIn As IntPtr, _
    pvaOut As IntPtr _
) As Integer
public int DispatchCommand(
    Guid cmdGuid,
    uint cmdId,
    IntPtr pvaIn,
    IntPtr pvaOut
)
public:
int DispatchCommand(
    Guid cmdGuid, 
    unsigned int cmdId, 
    IntPtr pvaIn, 
    IntPtr pvaOut
)
member DispatchCommand : 
        cmdGuid:Guid * 
        cmdId:uint32 * 
        pvaIn:IntPtr * 
        pvaOut:IntPtr -> int
public function DispatchCommand(
    cmdGuid : Guid, 
    cmdId : uint, 
    pvaIn : IntPtr, 
    pvaOut : IntPtr
) : int

Parameters

  • cmdGuid
    Type: Guid

    [in] The GUID of the command to execute.

  • cmdId
    Type: UInt32

    [in] The ID of the command to execute.

  • pvaIn
    Type: IntPtr

    [in] A pointer to possible parameters for the command.

  • pvaOut
    Type: IntPtr

    [out] A pointer to a place to return the results of the command.

Return Value

Type: Int32
If successful, returns S_OK; otherwise, returns an error code.

Remarks

This method executes the specified command by getting the IOleCommandTarget interface from the SUIHostCommandDispatcher service and calling Exec with the given parameters, but only if the command exists and is enabled.

.NET Framework Security

See Also

Reference

LanguageService Class

DispatchCommand Overload

Microsoft.VisualStudio.Package Namespace