C# Class SecureDelete.WipeSession

Mostrar archivo Open project: gratianlup/SecureDelete Class Usage Examples

Public Properties

Property	Type	Description
DefaultSessionGuid	System.Guid

Public Methods

Method	Description
BeginStart ( AsyncCallback callback, object state ) : bool	Start wiping asynchronously
EndStart ( ) : bool	Wait until the start operation has been completed
GenerateGuid ( ) : void
GenerateReport ( ) : WipeReport	Generate a report containing statistics, failed objects and errors This method is not intended to be used in conjunction with scheduled tasks.
GetFailedObjects ( bool getAssociatedError ) : SecureDelete.FailedObject[]	Get the category of failed objects
GetWipeErrors ( ) : List	Get the category of wipe errors
GetWipeStatus ( WipeStatus &s, bool includeChildren ) : bool	Get the status of the wiping process
Initialize ( ) : bool	Initialize the wipe session. Needs to be called before Start or BeginStart.
Pause ( ) : bool	Pause the wiping process
Resume ( ) : bool	Resume the wiping process
SetGuid ( System.Guid newGuid ) : void
Start ( ) : bool	Start wiping
Stop ( ) : bool	Stop the wiping process
WipeSession ( ) : System

Private Methods

Method	Description
AllocateObjects ( ) : void
GenerateStatistics ( ) : void
GetChildrenStatus ( WipeStatus s, NativeMethods wipeStatus, int childrenNumber ) : NativeMethods.WStatus
OnDeserializedMethod ( StreamingContext context ) : void
ReportPluginError ( Plugin plugin, Exception e ) : void
SendSingleWipeObject ( IWipeObject item ) : bool
SendWipeObjects ( List items ) : bool
StartAsync ( object sender, EventArgs e ) : void
StartImpl ( ) : bool

Method Details

BeginStart() public method

Start wiping asynchronously

public BeginStart ( AsyncCallback callback, object state ) : bool
callback	AsyncCallback	The method to be called when the operation has been completed.
state	object	The state object.
return	bool

EndStart() public method

Wait until the start operation has been completed

public EndStart ( ) : bool
return	bool

GenerateGuid() public method

public GenerateGuid ( ) : void
return	void

GenerateReport() public method

Generate a report containing statistics, failed objects and errors

This method is not intended to be used in conjunction with scheduled tasks.

public GenerateReport ( ) : WipeReport
return	WipeReport

GetFailedObjects() public method

Get the category of failed objects

public GetFailedObjects ( bool getAssociatedError ) : SecureDelete.FailedObject[]
getAssociatedError	bool	Specifies whether or not to attach the associated error to the wipe object.
return	SecureDelete.FailedObject[]

GetWipeErrors() public method

Get the category of wipe errors

public GetWipeErrors ( ) : List
return	List

GetWipeStatus() public method

Get the status of the wiping process

public GetWipeStatus ( WipeStatus &s, bool includeChildren ) : bool
s	WipeStatus	The WipeStatus object where to store the status
includeChildren	bool	Include the status of all children of the context
return	bool

Initialize() public method

Initialize the wipe session. Needs to be called before Start or BeginStart.

public Initialize ( ) : bool
return	bool

Pause() public method

Pause the wiping process

public Pause ( ) : bool
return	bool

Resume() public method

Resume the wiping process

public Resume ( ) : bool
return	bool

SetGuid() public method

public SetGuid ( System.Guid newGuid ) : void
newGuid	System.Guid
return	void

Start() public method

Start wiping

public Start ( ) : bool
return	bool

Stop() public method

Stop the wiping process

public Stop ( ) : bool
return	bool

WipeSession() public method

public WipeSession ( ) : System
return	System

Property Details

DefaultSessionGuid public_oe static_oe property

public static Guid,System DefaultSessionGuid
return	System.Guid