GetListMember

Top  Previous  Next

S

A

W

WS

ü

ü

Syntax -

GetListMember <NameOfList> <Var1> <Var2> <Var3> ...

       Where:

               <NameOfList> is the user defined name that is assigned to the list.

               <Var1> is the name of the variable

               <Var2> is the name of the variable

               <Var3> is the name of the variable

 

Description:

This command retrieves the next list member in the list defined by <NameOfList> and stores each of the fields in the record in variables defined by <Var1>, <Var2>...  The order of the variables listed should match the order of the fields in the list.  GetListMember also increments the current pointer in the list.  The next time the command is called, it will not retrieve the same list member.

 

Note: By default, all fields in the list must be retrieved in the GetListMember command.  That is, if the list has four columns, then there should be four variables listed to store each of the fields.  Only if NoVerifyCount was specified when the list was created with CreateList or if the list is a web table, then the GetListMember command can specify fewer variable than there are fields in the list.  Variables must still match the fields in the list going from left to right.  For example, it is not possible to retrieve the first, second, and fifth fields from a list, but it is possible to retrieve the first and second fields even if there are a total of five fields in the list.

 

Sample:

The following statement uses the GetListMember command to retrieve the first three fields from the list named  Providers and stores them in the Variables named NPI, DocID, and Name.

GetListMember Providers NPI DocID Name

 

See Also:

CreateList

DisposeList

ListExists

FindListPosition

GetListCount

GetListPosition

PutListMember

SetListPosition