ITextTemplatingEngineHost.ResolveParameterValue-Methode

Artikel
07/20/2011

Ermittelt den Wert eines Parameters für einen Direktivenprozessor, wenn der Parameter nicht im Vorlagentext angegeben ist.

Namespace: Microsoft.VisualStudio.TextTemplating
Assembly: Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (in Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll)

Syntax

'Declaration
Function ResolveParameterValue ( _
    directiveId As String, _
    processorName As String, _
    parameterName As String _
) As String

string ResolveParameterValue(
    string directiveId,
    string processorName,
    string parameterName
)

String^ ResolveParameterValue(
    String^ directiveId, 
    String^ processorName, 
    String^ parameterName
)

abstract ResolveParameterValue : 
        directiveId:string * 
        processorName:string * 
        parameterName:string -> string

function ResolveParameterValue(
    directiveId : String, 
    processorName : String, 
    parameterName : String
) : String

Parameter

directiveId
Typ: System.String
Die ID des Direktivenaufrufs, zu dem der Parameter gehört.Diese ID unterscheidet wiederholte Aufrufe der gleichen Direktive von der gleichen Textvorlage.

processorName
Typ: System.String
Der Name des Direktivenprozessors, zu dem die Direktive gehört.

parameterName
Typ: System.String
Der Name des Parameters, der aufgelöst werden soll.

Rückgabewert

Typ: System.String
Ein String, der den aufgelösten Parameterwert darstellt.

Hinweise

Diese Methode kann von einem Direktivenprozessor oder vom Code einer Textvorlage aufgerufen werden, um Werte aus dem Textvorlagenhost abzurufen. Normalerweise ruft der Direktivenprozessor die Methode auf, um einen Standardwert für einen Parameter der Direktive abzurufen.

Beispielsweise ruft im Host, der im Befehlszeilenprogramm TextTransform.exe ausgeführt wird, diese Methode Werte aus der –a-Befehlszeilenoption ab. Weitere Informationen finden Sie unter Generieren von Dateien mit dem Hilfsprogramm "TextTransform".

Beispiele

Im folgenden Codebeispiel wird eine mögliche Implementierung für einen benutzerdefinierten Host veranschaulicht. Dieses Codebeispiel ist Teil eines umfangreicheren Beispiels. Das vollständige Beispiel finden Sie unter Exemplarische Vorgehensweise: Erstellen eines benutzerdefinierten Textvorlagenhosts.

public string ResolveParameterValue(string directiveId, string processorName, string parameterName)
{
    if (directiveId == null)
    {
        throw new ArgumentNullException("the directiveId cannot be null");
    }
    if (processorName == null)
    {
        throw new ArgumentNullException("the processorName cannot be null");
    }
    if (parameterName == null)
    {
        throw new ArgumentNullException("the parameterName cannot be null");
    }

    //code to provide "hard-coded" parameter values goes here
    //this code depends on the directive processors this host will interact with

    //if we cannot do better - return the empty string
    return String.Empty;
}

Public Function ResolveParameterValue(ByVal directiveId As String, ByVal processorName As String, ByVal parameterName As String) As String Implements Microsoft.VisualStudio.TextTemplating.ITextTemplatingEngineHost.ResolveParameterValue

    If directiveId Is Nothing Then
        Throw New ArgumentNullException("the directiveId cannot be null")
    End If
    If processorName Is Nothing Then
        Throw New ArgumentNullException("the processorName cannot be null")
    End If
    If parameterName Is Nothing Then
        Throw New ArgumentNullException("the parameterName cannot be null")
    End If

    'code to provide "hard-coded" parameter values goes here
    'this code depends on the directive processors this host will interact with

    'if we cannot do better - return the empty string
    Return String.Empty
End Function

.NET Framework-Sicherheit

Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.

Siehe auch

Referenz

ITextTemplatingEngineHost Schnittstelle

Microsoft.VisualStudio.TextTemplating-Namespace

Weitere Ressourcen

Exemplarische Vorgehensweise: Erstellen eines benutzerdefinierten Textvorlagenhosts

Freigeben über