| Description: | Retrieves a specific validated recipient after a call to InitCheckRecipients(). This function would typically be called prior to sending mail in order to establish the validity of a recipient. |
| Syntax: | Object.GetCheckedRecipient( iIndex, sName, sAddress) |
| Parameters: | |
| object | Required, the Session object |
| iIndex | An index specifying which, of several recipients should be returned to the caller. |
| sName | A string which will be set to the requested matched recipient's name. |
| sAddress | A string which will be set to the requested matched recipient's e-mail address. |
| Remarks: | Prior to calling this function you must call InitCheckRecipients() in order to perform the search for matching recipients. InitCheckRecipients() returns a count of the number of matching recipients.
You can retrieve the appropriate recipient by passing in the appropriate value for iIndex. This function sets up a name and an address string that you must pass into the function.
Note that this function may not be called from VBScript since the language cannot pass strings by reference. |
| Returns: | Returns True if a recipient's details were successfully retrieved. Otherwise False is returned. |
| Example: |
Dim sName As String
Dim sAddress As String
Set session = CreateObject("OfficeTalk.Session")
Set user = session.Logon(login name, password)
iCount = session.InitCheckRecipients("smith")
GetCheckedRecipient(0, sName, sAddress)