This documentation is archived and is not being maintained.

BuildProvider::GetCustomString Method

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

Generates a string to be persisted in the compiled assembly.

Namespace:  System.Web.Compilation
Assembly:  System.Web (in System.Web.dll)

public:
virtual String^ GetCustomString(
	CompilerResults^ results
)

Parameters

results
Type: System.CodeDom.Compiler::CompilerResults
The compilation results for the build provider's virtual path.

Return Value

Type: System::String
A string to be persisted in the build environment, or nullptr if the BuildProvider instance does not implement GetCustomString.

The GetCompiledCustomString method of a BuildManager object creates an instance of a build provider for an input virtual path, and calls the GetCustomString method on the BuildProvider object.

The base BuildProvider class returns nullptr for the GetCustomString method, indicating that GetCustomString is not implemented.

Certain build provider implementations can implement GetCustomString in place of the GetGeneratedType method. A BuildProvider object typically uses GetGeneratedType to return a Type object for a virtual path. However, the GetCustomString method can be used to indicate that a BuildProvider object can generate multiple types from a virtual path.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: