QueryResults Struct Reference

A datatype for holding an array of the results of a search on an iRODS server. More...

#include <query.h>

Collaboration diagram for QueryResults:

Public Member Functions
void	PrintQueryResults (FILE *out_f, const QueryResults *const result_p)
	Print a QueryResults to an output FILE. More...
void	PrintQueryResult (FILE *out_f, const QueryResult *const result_p)
	Print a QueryResult to an output FILE. More...
void	FreeQueryResults (QueryResults *result_p)
	Free a QueryResults. More...
json_t *	GetQueryResultAsJSON (const QueryResults *const results_p)
	Get the json representation of a QueryResults. More...
json_t *	GetQueryResultAsResourcesJSON (const QueryResults *const qrs_p)
	Get the json representation of a QueryResults in the format of a Resource. More...
LinkedList *	GetQueryResultsPaths (const QueryResults *const qrs_p)
	Get the full path to all collections and data objects in the given QueryResults. More...

Data Fields
int	qr_num_results
	The number of results in the array. More...
QueryResult *	qr_values_p
	The array of results. More...

Detailed Description

A datatype for holding an array of the results of a search on an iRODS server.

Member Function Documentation

PrintQueryResults()

void PrintQueryResults	(	FILE *	out_f,
		const QueryResults *const	result_p
	)

Print a QueryResults to an output FILE.

Parameters

out_f	The FILE to write to.
result_p	The QueryResults to print.

PrintQueryResult()

void PrintQueryResult	(	FILE *	out_f,
		const QueryResult *const	result_p
	)

Print a QueryResult to an output FILE.

Parameters

out_f	The FILE to write to.
result_p	The QueryResult to print.

FreeQueryResults()

void FreeQueryResults

(

QueryResults *

result_p

)

Free a QueryResults.

Parameters

result_p

The QueryResults to free.

GetQueryResultAsJSON()

json_t * GetQueryResultAsJSON

(

const QueryResults *const

results_p

)

Get the json representation of a QueryResults.

Parameters

results_p

The QueryResults to get the json for.

Returns

The json_t object representing the QueryResults or NULL upon error.

GetQueryResultAsResourcesJSON()

json_t * GetQueryResultAsResourcesJSON

(

const QueryResults *const

qrs_p

)

Get the json representation of a QueryResults in the format of a Resource.

Parameters

qrs_p

The QueryResults to get the json for.

Returns

The json_t object representing the QueryResults or NULL upon error.

GetQueryResultsPaths()

LinkedList * GetQueryResultsPaths

(

const QueryResults *const

qrs_p

)

Get the full path to all collections and data objects in the given QueryResults.

Parameters

qrs_p

The QueryResults to get the values from.

Returns

A LinkedList of StringListNodes where each node contains the full path to each of the values in the given QueryResults.

Field Documentation

qr_num_results

int qr_num_results

The number of results in the array.

qr_values_p

QueryResult* qr_values_p

The array of results.

---

The documentation for this struct was generated from the following file:

• query.h