IVsLayeredTextView.GetSelectedAtom(UInt32, Object) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int GetSelectedAtom(System::UInt32 dwFlags, [Runtime::InteropServices::Out] System::Object ^ % ppunkAtom);

int GetSelectedAtom(unsigned int dwFlags, [Runtime::InteropServices::Out] winrt::Windows::Foundation::IInspectable const & & ppunkAtom);

public int GetSelectedAtom (uint dwFlags, out object ppunkAtom);

abstract member GetSelectedAtom : uint32 * obj -> int

Public Function GetSelectedAtom (dwFlags As UInteger, ByRef ppunkAtom As Object) As Integer

Parameters

dwFlags: UInt32

[in] Selection flags. Values are taken from GetSelectedAtomFlags.

ppunkAtom: Object

[out] The atomic object the selection is “at”.

Returns

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.

Applies to