Class ConversionResult

Represents a conversion result, either a successful result which can be downloaded as a file or an error result if a page or set of pages could not be converted.

Inheritance

Object

ConversionResult

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Accusoft.PrizmDocServer.Conversion

Assembly: PrizmDocServerSDK.dll

Syntax

public class ConversionResult

Properties

ErrorCode

Gets the specific error code if this is an error result, or null if this is a successful result.

Declaration

public string ErrorCode { get; }

Property Value

Type	Description
String

IsError

Gets a value indicating whether this result represents an error. When true, this is an error result. See the ErrorCode for more information. When false, this is a successful result and you can use RemoteWorkFile to download this particular output file. true if this result represents an error and has an associated ErrorCode; false if this result was successful and has an associated RemoteWorkFile.

Declaration

public bool IsError { get; }

Property Value

Type	Description
Boolean

IsSuccess

Gets a value indicating whether this result represents a successfully-produced output document. When true, this is a successful result and you can use RemoteWorkFile to download this particular output file. When false, this is an error result. See the ErrorCode for more information. true if this result was successful and has an associated RemoteWorkFile; false if this result represents an error and has an associated ErrorCode.

Declaration

public bool IsSuccess { get; }

Property Value

Type	Description
Boolean

PageCount

Gets the total number of pages for a successful result, or null for an error result.

Declaration

public int? PageCount { get; }

Property Value

Type	Description
Nullable<Int32>

RemoteWorkFile

Gets the RemoteWorkFile for a successful result.

Declaration

public RemoteWorkFile RemoteWorkFile { get; }

Property Value

Type	Description
RemoteWorkFile

Exceptions

Type	Condition
InvalidOperationException	IsError was true; this result has no associated RemoteWorkFile.

Sources

Gets the collection of source documents which contributed to this specific result.

Declaration

public IEnumerable<ConversionSourceDocument> Sources { get; }

Property Value

Type	Description
IEnumerable<ConversionSourceDocument>