ConversionJobStatus.GetAllActiveJobs Method (WordServiceApplicationProxy, SPUserToken, Nullable<Guid>)

  • Article

Gets all conversion jobs that were started by the specified user and that have one or more active conversion items (that is, conversion items whose status is InProgress or NotStarted).

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

Syntax

'Declaration
Public Shared Function GetAllActiveJobs ( _
    serviceApplicationProxy As WordServiceApplicationProxy, _
    user As SPUserToken, _
    subscriptionId As Nullable(Of Guid) _
) As ReadOnlyCollection(Of ConversionJobInfo)
'Usage
Dim serviceApplicationProxy As WordServiceApplicationProxy
Dim user As SPUserToken
Dim subscriptionId As Nullable(Of Guid)
Dim returnValue As ReadOnlyCollection(Of ConversionJobInfo)

returnValue = ConversionJobStatus.GetAllActiveJobs(serviceApplicationProxy, _
    user, subscriptionId)

public static ReadOnlyCollection<ConversionJobInfo> GetAllActiveJobs(
    WordServiceApplicationProxy serviceApplicationProxy,
    SPUserToken user,
    Nullable<Guid> subscriptionId
)

Parameters

  • user
    Type: Microsoft.SharePoint.SPUserToken

    An SPUserToken that specifies the user credentials presented to filter the list of all active 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 active 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 with active conversion items.

See Also

Reference

ConversionJobStatus Class

ConversionJobStatus Members

GetAllActiveJobs Overload

Microsoft.Office.Word.Server.Conversions Namespace