MAG4 FILTER SAVE (1946)    REMOTE PROCEDURE (8994)

Name Value
NAME MAG4 FILTER SAVE
TAG SET
ROUTINE MAGGSFL1
RETURN VALUE TYPE SINGLE VALUE
AVAILABILITY RESTRICTED
DESCRIPTION
Stores the new filter to the IMAGE LIST FILTERS file (#2005.87) or updates
properties of the existing filter.
INPUT PARAMETER
  • MAGGZ
    PARAMETER TYPE:   LIST
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    List that stores the filter data and related parameters.
      FLAGS - Value contains flags that control the execution 
              (can be combined):
     
                S  Selective save. If this flag is
                   provided, then only the fields listed
                   in the MAGZ array are updated; other
                   filter properties are not changed.
     
                   By default, all filter properties,
                   which do not have new values in the
     
                   MAGZ array, are cleared.
     
      IEN   - Value is the Internal Entry Number of the filter 
              that has to be modified.
     
      USER  - Value is the IEN of the user who this filter is 
              saved for.
     
    Example:
     
    Each list item has 2 pieces separated by '^': 
      with RPCBroker.Param[0] do
        begin
          PType := list;
          Mult[1] := 'IEN^23';
          Mult[2] := 'FLAGS^S';
          Mult[3] := '15^Column Description';
        end;
     
      ^01: Field number
      ^02: Field value
     
    The following special names can be used in place of field numbers:
     
    
RETURN PARAMETER DESCRIPTION
The return literal is two piece "^" delimited string
If successful:    Filter IEN ^ Filter NAME
If an Error:  0^error message