CarbonCopySuspend()


Suspend an active Carbon Copy.

Public Function CarbonCopySuspend(ByVal SessionID As String, _
                                 
ByVal CarbonCopyID As Integer) _
                                  
As Boolean

Parameters

SessionID
String - GUID
The current session's GUID in string format. This is a 32-character hexidecimal string in the format:
00000000-0000-0000-0000-000000000000. This is the value returned by the Login() function.
CarbonCopyID
Integer
The value assigned to a specific Carbon Copy entry.

Returns

Boolean 
True if successful, false on failure.

Remarks

Active Carbon Copies can be temporarily suspended using this method. Once suspended, they can be reactivated with CarbonCopyActivate(). To permanently terminated a Carbon Copy use CarbonCopyTerminate().

Example

Visual Basic
[insert code sample]

EventID: 5004

See Also

CarbonCopyActivate()
CarbonCopyTerminate()


© 2008-2011, Loren Data Corp.
All rights reserved.
ECGrid is a registered service mark of Loren Data Corp.
ECGridOS is a service mark of Loren Data Corp.