CarbonCopyListEx()


List of Carbon Copy configurations for a specified Network/Mailbox.

Public Function CarbonCopyListEx(ByVal SessionID As String, _
                                
ByVal NetworkID As Integer, _
                                 ByVal MailboxID As Integer, _
                                
ByVal ECGridIDFrom As Integer, _
                                
ByVal ECGridIDTo As Integer, _
                                
ByVal ShowInactive As Boolean) _
                                
As CarbonCopyIDInfo()

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.
NetworkID
Integer
The ECGrid NetworkID assigned to the network.
MailboxID
Integer
The ECGrid MailboxID assigned to the ID on the specified network. A value of -1 lists all Mailboxes for the specified NetworkID, contingent on Authorization Level.
ECGridIDFrom
Integer
The ECGridID representing the Original Sending Trading Partner. User -1 to match any. See ECGridIDs.
ECGridIDTo
Integer
The ECGridID representing the Original Receiving Trading Partner. User -1 to match any. See ECGridIDs.
ShowInactive
Boolean
A logical flag which determines if Inactive (Suspended and Terminated) records should be included in the return set.

Returns

CarbonCopyIDInfo Collection

CarbonCopyID
Integer
The value assigned to a specific Carbon Copy entry.
NetworkID
Integer
The NetworkID of the Network owning the Carbon Copy.
MailboxID
Integer
The MailboxID assigned to a Mailbox owning the Carbon Copy.
Created
Date
The date/time (UTC) the record was created.
Modified
Date
The date/time (UTC) the record was last modified.
Status
Short - ECGridOSv0200.Status ENUM
A numeric value representing the entry's status.
OriginalFrom
Object - ECGridIDInfo
An ECGridIDInfo Object matching the Original interchange Sender.
OriginalTo
Object - ECGridIDInfo
An ECGridIDInfo Object matching the Original interchange Receiver.
CCFrom
Object - ECGridIDInfo
An ECGridIDInfo Object matching the Carbon Copy interchange Sender.
CCTo
Object - ECGridIDInfo
An ECGridIDInfo Object matching the Carbon Copy interchange Receiver.
TransactionSet 
String(0,20)
String to match the Transaction Set type, standard dependant. 

Remarks

A list of Carbon Copies for a specified Network/Mailbox. Proper Authorization Level is required.

It may be filtered by Original Sender and or Original Receiver. To list all Carbon Copies for a specific Original Sender, set ECGridIDTo to zero (0). To list all Carbon Copies for a specific Original Receiver, set ECGridIDFrom to zero (0).

To list Carbon Copies for the Session Network/Mailbox use CarbonCopyList().

Example

Visual Basic
[insert code sample]

EventID: 5008

See Also

CarbonCopyList()


© 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.