ks_combination.h File Reference

Interface to the libkarmaclient combination type. More...

#include "ks_assoc.h"
#include "ks_combination.h"

Go to the source code of this file.

Typedefs
typedef ks_assoc_t	ks_combination_t
	libkarmaclient combination type.
Functions
long	ks_combination_score (ks_combination_t *)
const char *	ks_combination_data (ks_combination_t *)

---

Detailed Description

Interface to the libkarmaclient combination type.

Type and function declarations for the functions defined in ks_combination.c. Do not include this file directly in your client. Instead, include the application header file, ks.h, which will include all the libkarmaclient header files for you.

Definition in file ks_combination.h.

---

Typedef Documentation

typedef ks_assoc_t ks_combination_t

libkarmaclient combination type.

Definition at line 40 of file ks_combination.h.

---

Function Documentation

const char* ks_combination_data

(

ks_combination_t *

c

)

Get the data for the combination type ks_combination_t (c).

Parameters:

c

A pointer to a ks_combination_t.

Returns:

NULL when the combination has no data, or a NUL terminated string containing the data.

Definition at line 61 of file ks_combination.c.

References ks_assoc_get(), KS_CAST, and ks_string_get().

long ks_combination_score

(

ks_combination_t *

c

)

Get the score for the combination type ks_combination_t (c).

Parameters:

c

A pointer to a ks_combination_t.

Returns:

The score for c, or 0L if it does not have one.

Definition at line 43 of file ks_combination.c.

References ks_assoc_get(), KS_CAST, and ks_number_get().

---