Daylight v4.9
Release Date: 1 February 2008


dt_mer_progob_compareparams - retrieve parameter names and default values for a program object comparison

Generic Prototype

dt_mer_progob_compareparams(dt_Handle, dt_Integer) => dt_Handle

C Prototype

#include "dt_merlin.h"

dt_Handle dt_mer_progob_compareparams(dt_Handle server, dt_Integer iprogob)

FORTRAN Prototype

include ''

integer*4 dt_f_mer_progob_compareparams(server, iprogob)

integer*4 server
integer*4 iprogob


Asks a program object, via the Merlin server, to report the names and default values for the parameters used by the function dt_mer_progob_compare(..., parameters)

It is up to the program object to decide what to return for this function, but the convention is to return the parameters names, followed by the default value in parentheses. For example, a fingerprint-computing program object might return "FP minsize (2048)".

There may be several program objects associated with a particular server; the parameter "iprogob" indicates which one is to perform the computation: program objects are referred to by index, beginning with the first (index 0) to the Nth (index N-1), in the same order as the names returned by dt_mer_progob_getnames(3).

Return Value

Returns a sequence of string objects containing the parameter's names, as reported by the program object, or NULL_OB if there are no parameters.

Related Topics

dt_mer_nprogobs(3) dt_mer_progob2name(3) dt_mer_progob_compare(3) dt_mer_progob_compute(3) dt_mer_progob_computeparams(3) dt_mer_server(3)