Difference between revisions of "MAGGADDIMAGE"

From VistApedia
Jump to: navigation, search
Line 2: Line 2:
  
 
  NUMBER: 938                             
 
  NUMBER: 938                             
   NAME: MAGGADDIMAGE
+
   ''NAME'': '''MAGGADDIMAGE'''
   TAG: ADD                               
+
   ''TAG'': '''ADD'''                              
   ROUTINE: MAGGTIA
+
   ''ROUTINE'': '''MAGGTIA'''
   RETURN VALUE TYPE: SINGLE VALUE       
+
   ''RETURN VALUE TYPE'': SINGLE VALUE       
   AVAILABILITY: RESTRICTED
+
   ''AVAILABILITY'': RESTRICTED
  DESCRIPTION:
+
  ''DESCRIPTION'':
 
   RPC Call to add new entry to Image File using UPDATE^DIE.
 
   RPC Call to add new entry to Image File using UPDATE^DIE.
  INPUT PARAMETER: MAGGZ                   
+
  ''INPUT PARAMETER'': '''MAGGZ'''                  
  PARAMETER TYPE: LIST
+
  ''PARAMETER TYPE'': '''LIST'''
 
   REQUIRED: YES                         
 
   REQUIRED: YES                         
 
   SEQUENCE NUMBER: 1
 
   SEQUENCE NUMBER: 1
Line 27: Line 27:
 
     action depending on piece 2, "STUFFONLY", which says to NOT schedule the
 
     action depending on piece 2, "STUFFONLY", which says to NOT schedule the
 
     abstract to be created by the background processor.
 
     abstract to be created by the background processor.
   RETURN PARAMETER DESCRIPTION:
+
   ''RETURN PARAMETER DESCRIPTION'':
 
   MAGGRY - Ret variable (Single Variable)
 
   MAGGRY - Ret variable (Single Variable)
 
     If successful  MAGGRY = IEN^Drive:Dir ^ FILE NAME
 
     If successful  MAGGRY = IEN^Drive:Dir ^ FILE NAME

Revision as of 17:53, 19 September 2005

MAGGADDIMAGE

NUMBER: 938                             
 NAME: MAGGADDIMAGE
 TAG: ADD                              
 ROUTINE: MAGGTIA
 RETURN VALUE TYPE: SINGLE VALUE       
 AVAILABILITY: RESTRICTED
DESCRIPTION:
  RPC Call to add new entry to Image File using UPDATE^DIE.
INPUT PARAMETER: MAGGZ                  
PARAMETER TYPE: LIST
 REQUIRED: YES                         
 SEQUENCE NUMBER: 1
 DESCRIPTION:
  MAGGZ is an array of fields and their entries.
   i.e. MAGGZ(1)=".5^38"   field .5   data is 38

   If Long Description is included in fields, we create a new array to hold
   the text, and pass that to UPDATE^DIE.

   If this entry is an object group then MAGGZ(n)="2005.04^344"
   (The field 2005.04 is the OBJECT GROUP MULTIPLE.)

   Special processing is done to 'coded' entries.
   i.e. MAGGZ(n)="ABS^STUFFONLY"  The "ABS" code tells routine to take extra
   action depending on piece 2, "STUFFONLY", which says to NOT schedule the
   abstract to be created by the background processor.
 RETURN PARAMETER DESCRIPTION:
  MAGGRY - Ret variable (Single Variable)
    If successful   MAGGRY = IEN^Drive:Dir ^ FILE NAME
      IEN is Internal Entry Number of ^MAG(2005.
      Drive:Dir is the Drive and Directory where the image file is saved.
      FILE NAME is what the application will name the image file.
    If UNsuccessful MAGGRY = 0^Error desc