;---------------------------------------------------------------------------
; Document name: WRITE_ASCII.PRO
; Created by:    Liyun Wang, NASA/GSFC, September 23, 1996
;
; Last Modified: Mon Sep 23 13:58:46 1996 (LWANG@sumop1.nascom.nasa.gov)
;---------------------------------------------------------------------------
;
FUNCTION write_ascii, file, array, error=error
;+
; PROJECT:
;       SOHO - CDS/SUMER
;
; NAME:
;       WRITE_ASCII()
;
; PURPOSE: 
;       Write a given string array as an ASCII file
;
; CATEGORY:
;       Utility
; 
; SYNTAX: 
;       Result = write_ascii(file, array)
;
; INPUTS:
;       FILE - String scalar, name of the file to be written
;       ARRAY - String array to be writtten out
;
; OPTIONAL INPUTS: 
;       None.
;
; OUTPUTS:
;       None.
;
; OPTIONAL OUTPUTS:
;       None.
;
; KEYWORDS: 
;       ERROR - String scalar containing error message; if no error occurs,
;               the null string is returned
;
; COMMON:
;       None.
;
; RESTRICTIONS: 
;       None.
;
; SIDE EFFECTS:
;       None.
;
; HISTORY:
;       Version 1, September 23, 1996, Liyun Wang, NASA/GSFC. Written
;
; CONTACT:
;       Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
;-
;
   ON_ERROR, 2
   IF N_PARAMS() NE 2 THEN BEGIN
      error = 'Syntax: a = write_ascii(file_name, str_array)'
      MESSAGE, error, /cont
      RETURN, 0
   ENDIF
   
   ON_IOERROR, wrong
   
   OPENW, unit, file, /GET_LUN
   FOR i=0, N_ELEMENTS(array)-1 DO BEGIN
      PRINTF, unit, array(i)
   ENDFOR
   FREE_LUN, unit
   RETURN, 1
   
wrong:
   error = !err_string
   MESSAGE, error, /cont

   RETURN, 0
END


;---------------------------------------------------------------------------
; End of 'WRITE_ASCII.PRO'.
;---------------------------------------------------------------------------
