InvokeRetrieve

Overview

Returns an array of API objects from a RetrieveRequest object.

Syntax

InvokeRetrieve(1, 2, 3)

Function Properties

Ordinal	Type		Description
1	object	Required	API object from which to return array of API objects
2	variable		Retrieve call OverallStatus parameter that is passed to a defined AMPscript variable. You pass in the variable and the method returns the value stored in that variable. See other Invoke calls for previously defined variables. See the Retrieve method for possible OverallStatus values.
3	variable		Retrieve call RequestID parameter that is passed to a defined AMPscript variable. You pass in the variable and the method returns the value stored in that variable. See other Invoke calls for previously defined variables. See the Retrieve method for more information about RequestID values.

Usage

SET @rr_1=CreateObject("RetrieveRequest")
SetObjectProperty(@rr_1,"ObjectType","Subscriber")
AddObjectArrayItem(@rr_1,"Properties","EmailAddress")
SET @sfp=CreateObject("SimpleFilterPart")
SetObjectProperty(@sfp,"Property","EmailAddress")
SetObjectProperty(@sfp,"SimpleOperator","equals")
AddObjectArrayItem(@sfp,"Value",@emailaddress)
SetObjectProperty(@rr_1,"Filter",@sfp)
SET @sub=InvokeRetrieve(@rr_1)