IVsExpansionSession.SetFieldDefault(String, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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.

Sets the default value for the specified field.

public:
 int SetFieldDefault(System::String ^ bstrFieldName, System::String ^ bstrNewValue);

public:
 int SetFieldDefault(Platform::String ^ bstrFieldName, Platform::String ^ bstrNewValue);

int SetFieldDefault(std::wstring const & bstrFieldName, std::wstring const & bstrNewValue);

public int SetFieldDefault (string bstrFieldName, string bstrNewValue);

abstract member SetFieldDefault : string * string -> int

Public Function SetFieldDefault (bstrFieldName As String, bstrNewValue As String) As Integer

Parameters

bstrFieldName: String

[in] A string containing the name of the field.

bstrNewValue: String

[in] A string containing the default value to use.

Returns

Int32

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

Remarks

COM Signature

From textmgr2.idl:

HRESULT IVsExpansionSession::SetFieldDefault(  
   [in] BSTR bstrFieldName,  
   [in] BSTR bstrNewValue  
);

Typically, a code snippet specifies default values for all fields. This method is used to override the default value for a specified field.

Applies to

Share via