Share via


WorkflowTemplateCollection.GetByName method

Returns the workflow template matching the name provided.

Namespace:  Microsoft.SharePoint.Client.Workflow
Assembly:  Microsoft.SharePoint.Client (in Microsoft.SharePoint.Client.dll)

Syntax

'Declaration
Public Function GetByName ( _
    name As String _
) As WorkflowTemplate
'Usage
Dim instance As WorkflowTemplateCollection
Dim name As String
Dim returnValue As WorkflowTemplate

returnValue = instance.GetByName(name)
public WorkflowTemplate GetByName(
    string name
)

Parameters

  • name
    Type: System.String

    The name of the workflow template to retrieve.

Return value

Type: Microsoft.SharePoint.Client.Workflow.WorkflowTemplate
Returns a WorkflowTemplate instance representing the return of a workflow template matching the name provided.

Remarks

It must return the WorkflowTemplate object with Name property equal to the name parameter, or null if no such WorkflowTemplate exists in the collection. All WorkflowTemplate objects in the collection must have a unique value for their Name property. It must not be a null reference (Nothing in Visual Basic).

See also

Reference

WorkflowTemplateCollection class

WorkflowTemplateCollection members

Microsoft.SharePoint.Client.Workflow namespace