PFF
[Query]

Data Structures

• struct REPORT_user_column_entry_s

Define attribute size

• #define PFF_name_size_c   128
• #define PFF_desc_size_c   240
• #define PFF_class_size_c   32
• #define PFF_clause_size_c   240

Typedefs

• typedef int(* REPORT_user_column_function_t )(tag_t pff_tag, tag_t *obj_tags, int n_tags, char **output)
• typedef struct
  REPORT_user_column_entry_s REPORT_user_column_entry_t

Functions

• QRY_API int PFF_ask_name (tag_t pff_tag, char qname[PFF_name_size_c+1])
• QRY_API int PFF_ask_name2 (tag_t pff_tag, char **qname)
• QRY_API int PFF_set_name (tag_t pff_tag, const char qname[PFF_name_size_c+1])
• QRY_API int PFF_set_name2 (tag_t pff_tag, const char *qname)
• QRY_API int PFF_ask_description (tag_t pff_tag, char qdesc[PFF_desc_size_c+1])
• QRY_API int PFF_ask_description2 (tag_t pff_tag, char **qdesc)
• QRY_API int PFF_set_description (tag_t pff_tag, const char qdesc[PFF_desc_size_c+1])
• QRY_API int PFF_set_description2 (tag_t pff_tag, const char *qdesc)
• QRY_API int PFF_ask_class (tag_t pff_tag, char qclass[PFF_class_size_c+1])
• QRY_API int PFF_ask_class2 (tag_t pff_tag, char **qclass)
• QRY_API int PFF_set_class (tag_t pff_tag, const char qclass[PFF_class_size_c+1])
• QRY_API int PFF_set_class2 (tag_t pff_tag, const char *qclass)
• QRY_API int PFF_ask_clauses (tag_t pff_tag, char **qclauses)
• QRY_API int PFF_set_clauses (tag_t pff_tag, const char *qclauses)
• QRY_API int PFF_find (const char name[PFF_name_size_c+1], tag_t *pff_tag)
• QRY_API int PFF_find2 (const char *name, tag_t *pff_tag)
• QRY_API int PFF_extent (int *pff_count, tag_t **pff_tag)
• QRY_API int PFF_write_xml (tag_t pff_tag, int num_tuples, int num_tags_per_tuple, tag_t *tuples, char *output_file_name)
• QRY_API int PFF_write_xml_with_clauses (tag_t pff_tag, int num_tuples, int num_tags_per_tuple, tag_t *tuples, int num_clauses, char **clauses, char *output_file_name)
• QRY_API int PFF_describe_pff (tag_t pff_tag, int *num_clauses, char ***column_names, char ***relation_to_base)
• QRY_API int PFF_create (const char name[PFF_name_size_c+1], const char qdesc[PFF_desc_size_c+1], const char qclass[PFF_class_size_c+1], const char *qclauses, tag_t *pff_tag)
• QRY_API int PFF_create2 (const char *name, const char *qdesc, const char *qclass, const char *qclauses, tag_t *pff_tag)
• QRY_API void PFF_register_user_columns (int n_columns, REPORT_user_column_entry_t *column_methods)

---

Define Documentation

#define PFF_class_size_c   32

Definition at line 31 of file pff.h.

#define PFF_clause_size_c   240

Definition at line 32 of file pff.h.

#define PFF_desc_size_c   240

Definition at line 30 of file pff.h.

#define PFF_name_size_c   128

Definition at line 29 of file pff.h.

---

Typedef Documentation

typedef struct REPORT_user_column_entry_s REPORT_user_column_entry_t

typedef int(* REPORT_user_column_function_t)(tag_t pff_tag, tag_t *obj_tags, int n_tags, char **output)

Defined for report writer user exits

Definition at line 40 of file pff.h.

---

Function Documentation

QRY_API int PFF_ask_class	(	tag_t	pff_tag,
		char	qclass[PFF_class_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PFF_ask_class2

Parameters:

pff_tag	(I)
qclass	(O)

QRY_API int PFF_ask_class2	(	tag_t	pff_tag,
		char **	qclass
	)

ask the class

Parameters:

pff_tag	(I)
qclass	(OF)

QRY_API int PFF_ask_clauses	(	tag_t	pff_tag,
		char **	qclauses
	)

Parameters:

pff_tag	(I)
qclauses	(OF)

QRY_API int PFF_ask_description	(	tag_t	pff_tag,
		char	qdesc[PFF_desc_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PFF_ask_description2

Parameters:

pff_tag	(I)
qdesc	(O)

QRY_API int PFF_ask_description2	(	tag_t	pff_tag,
		char **	qdesc
	)

ask the description

Parameters:

pff_tag	(I)
qdesc	(OF)

QRY_API int PFF_ask_name	(	tag_t	pff_tag,
		char	qname[PFF_name_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PFF_ask_name2

Parameters:

pff_tag	(I)
qname	(O)

QRY_API int PFF_ask_name2	(	tag_t	pff_tag,
		char **	qname
	)

ask the name

Parameters:

pff_tag	(I)
qname	(OF)

QRY_API int PFF_create	(	const char	name[PFF_name_size_c+1],
		const char	qdesc[PFF_desc_size_c+1],
		const char	qclass[PFF_class_size_c+1],
		const char *	qclauses,
		tag_t *	pff_tag
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PFF_create2

Parameters:

name	(I)
qdesc	(I)
qclass	(I)
qclauses	(I)
pff_tag	(O)

QRY_API int PFF_create2	(	const char *	name,
		const char *	qdesc,
		const char *	qclass,
		const char *	qclauses,
		tag_t *	pff_tag
	)

Parameters:

name	(I)
qdesc	(I)
qclass	(I)
qclauses	(I)
pff_tag	(O)

QRY_API int PFF_describe_pff	(	tag_t	pff_tag,
		int *	num_clauses,
		char ***	column_names,
		char ***	relation_to_base
	)

Parameters:

pff_tag	(I)
num_clauses	(O)
column_names	(OF) num_clauses
relation_to_base	(OF) num_clauses

QRY_API int PFF_extent	(	int *	pff_count,
		tag_t **	pff_tag
	)

Parameters:

pff_count	(O)
pff_tag	(OF) pff_count

QRY_API int PFF_find	(	const char	name[PFF_name_size_c+1],
		tag_t *	pff_tag
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PFF_find2

Parameters:

name	(I)
pff_tag	(O)

QRY_API int PFF_find2	(	const char *	name,
		tag_t *	pff_tag
	)

Parameters:

name	(I)
pff_tag	(O)

QRY_API void PFF_register_user_columns	(	int	n_columns,
		REPORT_user_column_entry_t *	column_methods
	)

Parameters:

n_columns	(I)
column_methods	(I)

QRY_API int PFF_set_class	(	tag_t	pff_tag,
		const char	qclass[PFF_class_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PFF_set_class2

Parameters:

pff_tag	(I)
qclass	(I)

QRY_API int PFF_set_class2	(	tag_t	pff_tag,
		const char *	qclass
	)

set the class

Parameters:

pff_tag	(I)
qclass	(I)

QRY_API int PFF_set_clauses	(	tag_t	pff_tag,
		const char *	qclauses
	)

Parameters:

pff_tag	(I)
qclauses	(I)

QRY_API int PFF_set_description	(	tag_t	pff_tag,
		const char	qdesc[PFF_desc_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PFF_set_description2

Parameters:

pff_tag	(I)
qdesc	(I)

QRY_API int PFF_set_description2	(	tag_t	pff_tag,
		const char *	qdesc
	)

set the description

Parameters:

pff_tag	(I)
qdesc	(I)

QRY_API int PFF_set_name	(	tag_t	pff_tag,
		const char	qname[PFF_name_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use PFF_set_name2

Parameters:

pff_tag	(I)
qname	(I)

QRY_API int PFF_set_name2	(	tag_t	pff_tag,
		const char *	qname
	)

set the name

Parameters:

pff_tag	(I)
qname	(I)

QRY_API int PFF_write_xml	(	tag_t	pff_tag,
		int	num_tuples,
		int	num_tags_per_tuple,
		tag_t *	tuples,
		char *	output_file_name
	)

Parameters:

pff_tag	(I)
num_tuples	(I)
num_tags_per_tuple	(I)
tuples	(I)
output_file_name	(I)

QRY_API int PFF_write_xml_with_clauses	(	tag_t	pff_tag,
		int	num_tuples,
		int	num_tags_per_tuple,
		tag_t *	tuples,
		int	num_clauses,
		char **	clauses,
		char *	output_file_name
	)

Parameters:

pff_tag	(I)
num_tuples	(I)
num_tags_per_tuple	(I)
tuples	(I)
num_clauses	(I)
clauses	(I)
output_file_name	(I)