ConversionJobStatus.GetAllJobs Method (String, SPUserToken, Nullable<Guid>)

  • Article

Gets all conversion jobs that were started by the specified user, regardless of the status of those jobs.

Namespace:  Microsoft.Office.Word.Server.Conversions
Assembly:  Microsoft.Office.Word.Server (in Microsoft.Office.Word.Server.dll)

Syntax

'Declaration
Public Shared Function GetAllJobs ( _
    name As String, _
    user As SPUserToken, _
    subscriptionId As Nullable(Of Guid) _
) As ReadOnlyCollection(Of ConversionJobInfo)
'Usage
Dim name As String
Dim user As SPUserToken
Dim subscriptionId As Nullable(Of Guid)
Dim returnValue As ReadOnlyCollection(Of ConversionJobInfo)

returnValue = ConversionJobStatus.GetAllJobs(name, _
    user, subscriptionId)

public static ReadOnlyCollection<ConversionJobInfo> GetAllJobs(
    string name,
    SPUserToken user,
    Nullable<Guid> subscriptionId
)

Parameters

  • user
    Type: Microsoft.SharePoint.SPUserToken

    An SPUserToken that specifies the user credentials that were presented to filter the list of all conversion jobs.

    Note

    If the argument for user is a null reference (Nothing in Visual Basic), then the list of conversion jobs is not filtered and all conversion jobs in the specified partition are returned.

  • subscriptionId
    Type: System.Nullable<Guid>

    A Nullable<Guid> structure that specifies a tenant partition.

    Note

    If the SharePoint farm is not configured for multiple tenants, then pass a null reference (Nothing in Visual Basic) as the argument for this parameter.

Return Value

Type: System.Collections.ObjectModel.ReadOnlyCollection<ConversionJobInfo>
A ReadOnlyCollection<T> object.

Remarks

The collection of Guid structures returned by this method is scoped to a single partition. Each Guid corresponds to the JobId of a ConversionJob object.

See Also

Reference

ConversionJobStatus Class

ConversionJobStatus Members

GetAllJobs Overload

Microsoft.Office.Word.Server.Conversions Namespace