[ssr] / StraySrc / Libraries / Sapphire / csapph / h / choices / choices

/*
 * choices.h
 *
 * [Generated from choices, 08 November 1995]
 */

#pragma include_only_once
#pragma force_top_level

#ifndef __choices_h
#define __choices_h

/*----- Overview ----------------------------------------------------------*
 *
 * Functions provided:
 *
 *  choices_useChoices
 *  choices_find
 */

/* --- choices_useChoices --- *
 *
 * On entry:	R0 == 0 to disable use of `Choices', >0 to enable, or <0 to
 *			read
 *
 * On exit:	R0 == previous setting
 *
 * Use:		This call allows an application to determine whether its
 *		user-configurable resources are looked for in Acorn's
 *		`Choices' directory, or only in the application's directory.
 *
 *		An application would typically make this call after parsing
 *		its command-line options, to allow a Network Manager to
 *		enable the `Choices' support.
 */

extern routine choices_useChoices;

/* --- choices_find --- *
 *
 * On entry:	R0 == pointer to resource filename
 *		R1 == pointer to buffer to build filename in
 *		R2 == flags:
 *			bit 0 == file will be written to (use Choices$Write)
 *
 * On exit:	R0 == pointer to filename
 *		R1 == pointer to terminating NULL
 *		CS if the file was found, else CC
 *
 * Use:		Locates a user-configurable resource file.  The search order
 *		depends on (a) whether the file will be written (bit 0 of R2)
 *		and (b) whether the use of Acorn's `Choices' system is
 *		enabled.
 *
 *		The search order is as follows:
 *
 *		* Choices:appName.leaf / <Choices$Write>.appName.leaf
 *		* res_find(leaf)
 *
 *		(i.e. it looks in the `Choices' structure first, and if that
 *		fails, it will use res_find).
 */

extern routine choices_find;

/*----- That's all, folks -------------------------------------------------*/

#endif
Commit	Line	Data
2ee739cc	1	/*
	2	* choices.h
	3	*
	4	* [Generated from choices, 08 November 1995]
	5	*/
	6
	7	#pragma include_only_once
	8	#pragma force_top_level
	9
	10	#ifndef __choices_h
	11	#define __choices_h
	12
	13	/----- Overview ----------------------------------------------------------
	14	*
	15	* Functions provided:
	16	*
	17	* choices_useChoices
	18	* choices_find
	19	*/
	20
	21	/* --- choices_useChoices --- *
	22	*
	23	* On entry: R0 == 0 to disable use of `Choices', >0 to enable, or <0 to
	24	* read
	25	*
	26	* On exit: R0 == previous setting
	27	*
	28	* Use: This call allows an application to determine whether its
	29	* user-configurable resources are looked for in Acorn's
	30	* `Choices' directory, or only in the application's directory.
	31	*
	32	* An application would typically make this call after parsing
	33	* its command-line options, to allow a Network Manager to
	34	* enable the `Choices' support.
	35	*/
	36
	37	extern routine choices_useChoices;
	38
	39	/* --- choices_find --- *
	40	*
	41	* On entry: R0 == pointer to resource filename
	42	* R1 == pointer to buffer to build filename in
	43	* R2 == flags:
	44	* bit 0 == file will be written to (use Choices$Write)
	45	*
	46	* On exit: R0 == pointer to filename
	47	* R1 == pointer to terminating NULL
	48	* CS if the file was found, else CC
	49	*
	50	* Use: Locates a user-configurable resource file. The search order
	51	* depends on (a) whether the file will be written (bit 0 of R2)
	52	* and (b) whether the use of Acorn's `Choices' system is
	53	* enabled.
	54	*
	55	* The search order is as follows:
	56	*
	57	* * Choices:appName.leaf / <Choices$Write>.appName.leaf
	58	* * res_find(leaf)
	59	*
	60	* (i.e. it looks in the `Choices' structure first, and if that
	61	* fails, it will use res_find).
	62	*/
	63
	64	extern routine choices_find;
65
66	/----- That's all, folks -------------------------------------------------/
67
68	#endif