TPSearchEx()


Finds matching ECGridID(s) for specified X12 or EDIFACT Qualifier/ID pair in the specified Network/Mailbox.

Public Function TPSearchEx(ByVal SessionID As String, _
                           ByVal NetworkID As Integer, _
                           ByVal MailboxID As Integer, _
                          
ByVal Qualifier As String, _
                           ByVal ID As String, _
                           ByVal ShowInactive As Boolean) _
                       
   As ECGridIDInfo()

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 NetworkID, use -1 to specify all Networks.
MailboxID
Integer
The new MailboxID, use -1 to specify all Mailboxes for the given NetworkID.
Qualifier
String(0,3)
The X12 or EDIFACT ID Qualifier for the ISA and UNB segments.
ID
String(1,35)
The X12 or EDIFACT ID for the ISA and UNB segments. 
ShowInactive
Boolean
A logical flag which determines if Inactive (Suspended and Terminated) records should be included in the return set.

Returns

ECGridIDInfo Collection

ECGridID
Integer
A value representing a routeable address on ECGrid. See ECGridIDs.
NetworkID
Integer
The Network where this address is located.
NetworkName
String(0,40)
The name of the Network.
Qualifier
String(0,3)
The X12 or EDIFACT ID Qualifier for the ISA and UNB segments.
ID
String(1,35)
The X12 or EDIFACT ID for the ISA and UNB segments. 
Description
String(3,35)
The name associated with a Qualifier/ID pair. 
Status
Short - ECGridOSv0200.StatusECGrid ENUM
A numeric value representing the entry's status.
OwnerInfo
Object - ECGridOwnerInfo
The OwnerInfo object is only returned if the current UserID has sufficient ownership rights to this entry; otherwise, a value of Nothing is returned for this object. Network-level users can see this information for any ECGridID in any Mailbox on the Network. Mailbox-level users only see this information within their own mailbox.
NetworkID
Integer
The actually Network where this address is routed on ECGrid, may be different in the case of Redirection.
NetworkName
String(3,40)
The descriptive name of the Network.
MailboxID
Integer
The Mailbox where this address is routed on ECGrid.
MailboxName
String(3,40)
The descriptive name of the Mailbox.
DataEMail 
String(0,511)
When the data is to be forwarded to an SMTP or X.400 system, the e-mail address is entered here. X.400 addresses are noted by using "X400:" to prefix the address asin"X400:c=us;a=ecgrid;p=testdata;"
Created
Date
The date/time (UTC) the record was created.
Modified
Date
The date/time (UTC) the record was last modified.
Effective
Date
The date/time (UTC) the record becomes active. Used for migrations from one Network/Mailbox to another.
Expires
Date
The date/time (UTC) the record terminates. Used for migrations from one Network/Mailbox to another.
LastTraffic 
Date
The date/time (UTC) of the last traffic to/from this ECGridID.
 

Remarks

When ShowInactive is True both Suspended and Terminated records are returned. In this way, historical data can be retrieved for any ECGridID.

To list Trading Partners by Network/Mailbox use TPList() or TPListEx()

Example

Visual Basic
[insert code sample]

EventID: 3014

See Also

TPInfo()
TPSearch()
TPFind()
TPFindEx()
TPList()
TPListEx()


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