Share via

SPFile.GetConversionState Method

  • Article

Returns the transform state of the file to the specified transformer ID.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online

Syntax

'Declaration
Public Function GetConversionState ( _
    ConverterId As Guid, _
    workItemId As Guid _
) As SPFileConversionState
'Usage
Dim instance As SPFile
Dim ConverterId As Guid
Dim workItemId As Guid
Dim returnValue As SPFileConversionState

returnValue = instance.GetConversionState(ConverterId, _
    workItemId)

public SPFileConversionState GetConversionState(
    Guid ConverterId,
    Guid workItemId
)

Parameters

  • ConverterId
    Type: System.Guid

    A System.Guid object that specifies the document transformer.

  • workItemId
    Type: System.Guid

    A System.Guid object that specifies the work item ID that is returned by the Convert method. This ID must be used to determine whether a work item is pending.

Return Value

Type: Microsoft.SharePoint.SPFileConversionState
An SPFileConversionState value that indicates the conversion state.

See Also

Reference

SPFile Class

SPFile Members

Microsoft.SharePoint Namespace

SPFileConversionState