UF_XS_extract_spreadsheet (view source)
Defined in: uf_xs.h
Overview
Reads spreadsheet data from the work part and writes spreadsheet data
to the existing file name that you specify. The basic process used to
read data from the work part, would be to first establish the file
for the data, then call this Open API routine to create the file, then
read the data into the spreadsheet using an XESS routine, e.g.
This routine will extract either an XESS or Excel spreadsheet from the part.
NOTE: The Xess Developer's Library is required in order to access
the function xess_read_file.
Environment
Internal and External
See Also
The following is a
code
outline of how to use the extract function.
Required License(s)
gateway
int UF_XS_extract_spreadsheet
(
char * spreadsheet_name,
char * file_name
)
| char * | spreadsheet_name | Input | Spreadsheet object name:
"MODELING_SHEET" - modeling spreadsheet data
"DEFAULT_SHEET" - Gateway spreadsheet data
"PART_FAMILY_SHEET" - Part Family spreadsheet data |
| char * | file_name | Input | File name to write spreadsheet data to. |
UF_XS_store_spreadsheet (view source)
Defined in: uf_xs.h
Overview
Store spreadsheet data into the work part. If the spreadsheet entity name does
not exist, it will be created. The normal process for saving spreadsheet
data would be to establish a file for the data, write the data file using
the XESS programming call, then store that data into the spreadsheet with
this Open API routine.
This routine will store an XESS or Excel spreadsheet into the part.
Excel spreadsheets can only be stored on the Windows platform.
If it is not a valid spreadsheet the error UF_err_bad_parameter_number_2
is returned.
NOTE: The Xess Developer's Library is required in order to access
the function xess_write_file.
NOTE: Storing of the Part Family spreadsheet is not supported.
Environment
Internal and External
See Also
The following is a
code
outline of how to use the store function.
Required License(s)
gateway
int UF_XS_store_spreadsheet
(
char * spreadsheet_name,
char * file_name
)
| char * | spreadsheet_name | Input | Name of the spreadsheet object:
"MODELING_SHEET" - modeling spreadsheet data
"DEFAULT_SHEET" - Gateway spreadsheet data |
| char * | file_name | Input | Location of existing file name to read XESS spreadsheet
data from. |