Variant Structure
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here. ArchiveDisclaimer

Variant Structure

Represents an object that can be interpreted as more than one type.

This API is not CLS-compliant. The CLS-compliant alternative is [None].

Namespace:  Microsoft.VisualStudio.Package
Assembly:  Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)

public struct Variant

This version of the variant structure is specific to the managed package framework (MPF) language service classes and is designed to primarily convert a variant to a character. More specifically, if the variant has the type VT_UI2, the variant object is converted to a character.

This structure is actually used in only one place in the MPF language service classes, the HandlePreExec method of the ViewFilter class. This structure is used to convert the incoming variant to a character if the type of command is TYPECHAR.

Notes to Implementers:

This is a limited structure and there is nothing to override.

Notes to Callers:

This is a structure and can be treated as a variable type. It has limited functionality, mainly designed to convert from a variant object to a character.

This example shows how the MPF ViewFilter class uses this Variant structure to convert an incoming variant object to a character.

namespace Microsoft.VisualStudio.Package
    public class ViewFilter 
        : IVsTextViewFilter
        , IVsTextViewEvents
        , IOleCommandTarget
        , IDisposable
        public virtual void HandlePostExec(ref Guid guidCmdGroup,
                                           uint nCmdId,
                                           uint nCmdexecopt,
                                           IntPtr pvaIn,
                                           IntPtr pvaOut)

            if (guidCmdGroup == VsMenus.guidStandardCommandSet2K) {
                VsCommands2K cmd = (VsCommands2K)nCmdId;
                char ch = '\0';
                if (cmd == VsCommands2K.TYPECHAR && pvaIn != IntPtr.Zero) {
                    Variant v = Variant.ToVariant(pvaIn);
                    ch = v.ToChar();

                    // Do something with the character


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
© 2016 Microsoft