Sdílet prostřednictvím


Metoda IVsObjectList.EnumClipboardFormats (UInt32, UInt32, UInt32, VSOBJCLIPFORMAT[], UInt32 )

 

Žádá daného seznamu položek pro vytvoření výčtu jeho formáty podporované schránky.

Obor názvů:   Microsoft.VisualStudio.Shell.Interop
Sestavení:  Microsoft.VisualStudio.Shell.Interop (v Microsoft.VisualStudio.Shell.Interop.dll)

Syntaxe

int EnumClipboardFormats(
    uint index,
    uint grfFlags,
    uint celt,
    VSOBJCLIPFORMAT[] rgcfFormats,
    uint[] pcActual
)
int EnumClipboardFormats(
    unsigned int index,
    unsigned int grfFlags,
    unsigned int celt,
    array<VSOBJCLIPFORMAT>^ rgcfFormats,
    array<unsigned int>^ pcActual
)
abstract EnumClipboardFormats : 
        index:uint32 *
        grfFlags:uint32 *
        celt:uint32 *
        rgcfFormats:VSOBJCLIPFORMAT[] *
        pcActual:uint32[] -> int
Function EnumClipboardFormats (
    index As UInteger,
    grfFlags As UInteger,
    celt As UInteger,
    rgcfFormats As VSOBJCLIPFORMAT(),
    pcActual As UInteger()
) As Integer

Parametry

  • index
    Type: System.UInt32

    [v] Určuje index položky seznamu zájmu.

  • celt
    Type: System.UInt32

    [v] Určuje počet element rgcfFormats.

  • pcActual
    Type: System.UInt32[]

    [out] Ukazatel na počet formátů v rgcfformats pole.

Návratová hodnota

Type: System.Int32

Pokud je metoda úspěšná, vrátí S_OK. Pokud selže, vrátí kód chyby.

Poznámky

Podpis modelu COM

Z vsshell.idl:

HRESULT IVsObjectList::EnumClipboardFormats(
   [in] ULONG Index,
   [in] VSOBJCFFLAGS grfFlags,
   [in] ULONG celt,
   [in, out, size_is(celt)] VSOBJCLIPFORMAT rgcfFormats[],
   [out, optional] ULONG *pcActual
);

Prostředí podporuje tři standardní schránky formáty: CF_NAVINFO, CF_TEXT, a CF_UNICODETEXT. Můžete vytvořit a zaregistrovat vlastní formáty schránky. Podrobnosti implementace formát schránky OLE a registrace naleznete v tématu Clipboard Formats v dokumentaci MSDN knihovna Platform SDK nastaven.

Volání prostředí EnumClipboardFormats získat seznam schránka formátů, které podporují pro operace přetáhněte a kopírování vkládání. První volání prostředí EnumClipboardFormats (index, grfFlags, 0, má hodnotu null, pcActual) získat počet formáty schránky seznamu poskytuje. Potom přiděluje pole o velikosti pcActual, a pak zavolá EnumClipboardFormats (index, grfFlags, pcActual, rcgfFormats, pcActual).

Vyplnění rgcfformats pole s VSOBJCLIPFORMAT struktury obsahující formáty, které podporujete. Každý VSOBJCLIPFORMAT Struktura identifikuje formát typu média, a zda je formát složené jeden. S složené formáty prostředí nemá skutečné vykreslování po volání GetExtendedClipboardVariant. Jinak bude samotný seznam proveďte vykreslování prostřednictvím GetClipboardFormat. V případě vícenásobný výběr by podporují pouze složené formáty. To umožňuje prostředí k zápisu do formuláře ve formátu: < počet položek >< xyz variant z vybraných item1 >< xyz variant z vybraných item2 >.

[!POZNÁMKA]

Jsou podporovány pouze určité trvalé typy VARIANT, jak je popsáno v CComVariant::WriteToStream v dokumentaci MSDN knihovna Platform SDK nastaven.

V případě jednoho vyberte seznamu objektu je zdarma k poskytnutí formáty tradiční a složené a nebude volána v uvedeném pořadí na GetClipboardFormat nebo GetExtendedClipboardVariant pro každý.

[!POZNÁMKA]

Zobrazení tříd a Prohlížeč objektů automaticky poskytují CF_NAVINFO a CF_TEXT/CF_UNICODETEXT formátovat, tak EnumClipboardFormats by měla vrátit nejsou tyto hodnoty.

Viz také

Rozhraní IVsObjectList
Obory názvů Microsoft.VisualStudio.Shell.Interop

Zpět na začátek