Download full document:

OSImport Class

Represents an OS import as it progresses.

Inheritance Hierarchy

System.Object
  Citrix.SDK.AppDNA.OSImport
Namespace: Citrix.SDK.AppDNA
Assembly: Citrix.SDK.AppDNA (in Citrix.SDK.AppDNA.dll) Version: 7.11.0.0 (7.11.0.0)

Syntax

C

public class OSImport : IDisposable

VB

Public Class OSImport
    Implements IDisposable

The OSImport type exposes the following members.

Properties

 

NameDescription
Public propertyIsFinished Returns true if the import has finished. The return value of this does not indicate success, error or cancellation, simply whether or not the task is complete.
Public propertyLogFilePath Returns the full path to the text log file that holds the log of the import.
Public propertyOSImage Returns the OSImage object resulting from the import.
Public propertyProcessingState Returns the ProcessingState object that represents the state of the import.
  Back to Top

Methods

 

NameDescription
Public methodDispose Halts the import and releases resources. Failure to dispose of this object may leak resources.
Public methodEquals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodGetType Gets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodRequestCancel Requests that the current import should abort. Cancellation may not happen immediately, and the task may still fail or complete successfully after cancellation is requested.
Public methodToString Returns a string that represents the current object. (Inherited from Object.)
Public methodWaitForCompletion() Returns when IsFinished is true.
Public methodWaitForCompletion(TimeSpan) Returns true if IsFinished is true before timeout elapses.
  Back to Top

Events

 

NameDescription
Public eventFinished This event is raised when IsFinished becomes true. If IsFinished is true when this is subscribed to, it is fired immediately.
Public eventImportStateChanged This event is raised when the ProcessingState object has changed.
  Back to Top

Remarks

An OS Import object is obtained by calling one of the OSImageService.Import function overloads. It drives the import, providing status information and access to the completed import.

See Also

Reference

Citrix.SDK.AppDNA Namespace