IVsSingleFileGenerator.DefaultExtension(String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.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.

Retrieves the file extension that is given to the output file name.

public:
 int DefaultExtension([Runtime::InteropServices::Out] System::String ^ % pbstrDefaultExtension);

int DefaultExtension([Runtime::InteropServices::Out] std::wstring const & & pbstrDefaultExtension);

public int DefaultExtension (out string pbstrDefaultExtension);

abstract member DefaultExtension : string -> int

Public Function DefaultExtension (ByRef pbstrDefaultExtension As String) As Integer

Parameters

pbstrDefaultExtension: String

[out, retval] Returns the file extension that is to be given to the output file name. The returned extension must include a leading period.

Returns

Int32

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

Remarks

The project system invokes DefaultExtension in order to determine what extension to give to the generated output file.

The project system creates the file name of the generated file by:

Stripping the extension of the input file.
Appending the extension obtained from DefaultExtension.
Making the file name unique, if necessary.

Applies to