Developer's reference DW2XLS for PowerBuilder

Reference > uf_save_dw_as_excel_parm

uf_save_dw_as_excel_parm() function

Converts datawindow into excel file. Allows to specify some options for process of converting.

Syntax

uf_save_dw_as_excel_parm ( dw, filename, parm )

Parameters

dwA reference to the datawindow object
filenameA string whose value is the name of the file you want to create. If filename is not on the operating system's search path, you must enter the fully qualified name
parmA reference to the n_dwr_service_parm object which contain a set of parameters for process of converting

Return value

Integer. Returns 1 if it succeeds and -1 if an error occurs.

Examples

//export using parameters
integer li_ret
n_dwr_service_parm lnvo_parm
lnvo_parm = create n_dwr_service_parm
lnvo_parm.ib_header = false         //skip header band 
lnvo_parm.ib_summary = false        //skip summary band 
lnvo_parm.ib_footer = false         //skip footer band 
lnvo_parm.ib_group_header = false   //skip all group headers 
lnvo_parm.ib_group_trailer = false  //skip all group trailers 

li_ret = uf_save_dw_as_excel_parm(dw_1, 'c:\doc\report.xls', lnvo_parm)
if li_ret = 1 then
   //success
   //...
else
   //fail
   //...
end if
// adding a header to generated XLS
integer li_ret
n_dwr_service_parm lnvo_parm
lnvo_parm = create n_dwr_service_parm
lnvo_parm.is_header_text = "Report"
lnvo_parm.ib_header_font_underline = True

li_ret = uf_save_dw_as_excel_parm(dw_1, 'c:\doc\report.xls', lnvo_parm)
if li_ret = 1 then
   //success
   //...
else
   //fail
   //...
end if