Category Parameters and relations, Object ProParameter

Function ProParameterTableExport


Description
Exports a file containing information from the parameter table in Creo Parametric in the CSV or TXT format.
Replacement in Object TOOLKIT: wfcWParameterOwner::ExportParameterTable
Synopsis
#include <ProParameter.h>
ProErrorProParameterTableExport(
ProModelitem* owner
/* (In)
The owner of the parameters to be exported. May be NULL if the parameter should be selected by context.
*/
ProMdl top_model
/* (In)
The top level model from which parameters will be exported.
*/
int context
/* (In)
A bitmask containing the context of parameters to list in the export. (Members of ProParameterSelectContext). Used only if "owner" is NULL. The following options are supported: No other combination is permitted.
*/
ProParamTableExportType file_type
/* (In)
The type of export file to create. CSV format will export only local parameters Use TXT format to export full list of parameters
*/
ProPath file_path
/* (In)
Full path to the file to export (including name and extension).
*/
ProParamColumn column_list
/* (In)
Bitmask containing one or more columns to include in the exported file. This applies only when the file is being exported in the CSV format, and not when the file is being exported in the TXT format (where the columns exported will match the columns and options set by the user in the active session, in accordance with the behavior of File->Export in the Parameter dialog box).
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_CONTEXTThe owner is invalid or not found and/or
Design Test Mode is activethe function is not available in this mode
PRO_TK_E_NOT_FOUNDThe owner does not contain parameters.
PRO_TK_CANT_WRITECreo Parametric could not write to the file path specified.
PRO_TK_INVALID_TYPEInvalid context for top_model argument.
PRO_TK_BAD_INPUTSOne or more arguments was invalid.

Manual References:

  1. Core: Parameters: Accessing Parameters
  2. Core: Parameters: Accessing Parameters
  3. Model-Based Definition and Drawing Tables: Reading MBD or DrawingTables