IVsTextManager::GetUserPreferences Method (array<VIEWPREFERENCES>^, array<FRAMEPREFERENCES>^, array<LANGPREFERENCES>^, array<FONTCOLORPREFERENCES>^)

Visual Studio 2015

Returns the user preferences, such as tab usage, indent size and widget margin presence for the view, frame, and language service.

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

Syntax

C++

int GetUserPreferences(
	array<VIEWPREFERENCES>^ pViewPrefs,
	array<FRAMEPREFERENCES>^ pFramePrefs,
	array<LANGPREFERENCES>^ pLangPrefs,
	array<FONTCOLORPREFERENCES>^ pColorPrefs
)

Parameters

pViewPrefs: Type: array<Microsoft.VisualStudio.TextManager.Interop::VIEWPREFERENCES>^
[out] Pointer to the view preferences. For more information about pViewPrefs, see VIEWPREFERENCES.

pFramePrefs: Type: array<Microsoft.VisualStudio.TextManager.Interop::FRAMEPREFERENCES>^
[out] Pointer to the frame preferences. For more information about pFramePrefs, see FRAMEPREFERENCES.

pLangPrefs: Type: array<Microsoft.VisualStudio.TextManager.Interop::LANGPREFERENCES>^
[in, out] Pointer to the language preferences. For more information about pLangPrefs, see LANGPREFERENCES.

pColorPrefs: Type: array<Microsoft.VisualStudio.TextManager.Interop::FONTCOLORPREFERENCES>^
[in, out] Pointer to the font color preferences.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

C++

HRESULT IVsTextManager::GetUserPreferences(
   [out] VIEWPREFERENCES * pViewPrefs,
   [out] FRAMEPREFERENCES * pFramePrefs,
   [in, out] LANGPREFERENCES * pLangPrefs,
   [in, out] FONTCOLORPREFERENCES * pColorPrefs
);

Use this method to determine view, frame, language, font, and color preferences. Pass in the GUID for the appropriate item and the method returns the filled structure for those preferences. You are not required to pass in a GUID for each structure if you only want preferences for one item (for example, you only want view preferences). Pass in null for the structures that you do not want to fill.