IVsTextManager2::GetUserPreferences2 Method (array<VIEWPREFERENCES2>^, array<FRAMEPREFERENCES2>^, array<LANGPREFERENCES2>^, array<FONTCOLORPREFERENCES2>^)

 

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.8.0 (in Microsoft.VisualStudio.TextManager.Interop.8.0.dll)

int GetUserPreferences2(
	array<VIEWPREFERENCES2>^ pViewPrefs,
	array<FRAMEPREFERENCES2>^ pFramePrefs,
	array<LANGPREFERENCES2>^ pLangPrefs,
	array<FONTCOLORPREFERENCES2>^ pColorPrefs
)

Parameters

pViewPrefs
Type: array<Microsoft.VisualStudio.TextManager.Interop::VIEWPREFERENCES2>^

[out] Pointer to the view preferences. For more information about pViewPrefs, see VIEWPREFERENCES2.

pFramePrefs
Type: array<Microsoft.VisualStudio.TextManager.Interop::FRAMEPREFERENCES2>^

[out] Pointer to the frame preferences. For more information about pFramePrefs, see FRAMEPREFERENCES2.

pLangPrefs
Type: array<Microsoft.VisualStudio.TextManager.Interop::LANGPREFERENCES2>^

[in, out] Pointer to the language preferences. For more information about pLangPrefs, see LANGPREFERENCES2.

pColorPrefs
Type: array<Microsoft.VisualStudio.TextManager.Interop::FONTCOLORPREFERENCES2>^

[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.

[in] Pointer to the IVsTextBuffer interface.

HRESULT IVsTextManager2::GetUserPreferences2(
   [out] VIEWPREFERENCES2 * pViewPrefs,
   [out] FRAMEPREFERENCES2 * pFramePrefs,
   [in, out] LANGPREFERENCES2 * pLangPrefs,
   [in, out] FONTCOLORPREFERENCES2 * 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.

For the LANGPREFERENCES member, specify the language in question by setting pLangPrefs->guidLang to the language SID.

Return to top
Show: