IVsLayeredTextView::GetSelectedAtom Method (UInt32, Object^)

Visual Studio 2015

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

C++

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

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:

C++

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.