IVsLayeredTextView.GetSelectedAtom Method

Artigo
08/02/2012

Tells a client when the selection is "at" an atomic object. The selection flags determine what “at” means.

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

'Declaração
Function GetSelectedAtom ( _
    dwFlags As UInteger, _
    <OutAttribute> ByRef ppunkAtom As Object _
) As Integer

int GetSelectedAtom(
    uint dwFlags,
    out Object ppunkAtom
)

int GetSelectedAtom(
    [InAttribute] unsigned int dwFlags, 
    [OutAttribute] Object^% ppunkAtom
)

abstract GetSelectedAtom : 
        dwFlags:uint32 * 
        ppunkAtom:Object byref -> int

function GetSelectedAtom(
    dwFlags : uint, 
    ppunkAtom : Object
) : int

Parameters

dwFlags
Type: System.UInt32
[in] Selection flags. Values are taken from GetSelectedAtomFlags.

ppunkAtom
Type: System.Object%
[out] The atomic object the selection is “at”.

Return Value

Type: System.Int32
If an atomic object is found, the method returns S_OK. If an atomic object is not found, the method returns S_FALSE.

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsLayeredTextView::GetSelectedAtom(
   [in] DWORD dwFlags,
   [out] IUnknown **ppunkAtom
);

GetSelectedAtom tells a client when the selection is "at" an atomic object, "at" being defined by dwFlags. An atomic object is a special object inserted into the regular text stream, such as a hidden text banner. The returned IUnknown is a pointer to the object that corresponds to the atom; QI it for whatever custom interface might be of interest.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Compartilhar via