WorkflowDeploymentService.PackageDefinition method

Packages a single workflow definition into a SharePoint solution package (.wsp file) and saves the package to the Site Assets library.

Namespace:  Microsoft.SharePoint.WorkflowServices
Assembly:  Microsoft.SharePoint.WorkflowServicesBase (in Microsoft.SharePoint.WorkflowServicesBase.dll)

Syntax

'Declaration
<ClientCallableMethodAttribute> _
Public MustOverride Function PackageDefinition ( _
    definitionId As Guid, _
    packageDefaultFilename As String, _
    packageTitle As String, _
    packageDescription As String _
) As String
'Usage
Dim instance As WorkflowDeploymentService
Dim definitionId As Guid
Dim packageDefaultFilename As String
Dim packageTitle As String
Dim packageDescription As String
Dim returnValue As String

returnValue = instance.PackageDefinition(definitionId, _
    packageDefaultFilename, packageTitle, _
    packageDescription)
[ClientCallableMethodAttribute]
public abstract string PackageDefinition(
    Guid definitionId,
    string packageDefaultFilename,
    string packageTitle,
    string packageDescription
)

Parameters

  • definitionId
    Type: System.Guid

    The guid identifier of the workflow definition.

  • packageDefaultFilename
    Type: System.String

    The default filename to choose for the new package.

  • packageDescription
    Type: System.String

    The description of the package.

Return value

Type: System.String
Returns the URL of the package file in the Site Asset library.

Remarks

This method does not activate the package. If a package with the same name already exists in the Site Assets library, the method adds an integer suffix in braces to the file name. For example, a package with the filename packageDefaultFilename.wsp would have a duplicate filename altered to be packageDefaultFilename{2}.wsp and so forth.

See also

Reference

WorkflowDeploymentService class

WorkflowDeploymentService members

Microsoft.SharePoint.WorkflowServices namespace