Trf_SetOption(3)

✨ Trf_SetOption — the whole vibe ✨

okay so bestie, welcome to Trf_SetOption(3) 💖 this one lives in the Library Functions Manual and it's literally the interface to the procedures that define the value of an option. that's the whole job. she sets options. she's booked and busy. 👑

🌸 NAME 🌸

Trf_SetOption — Interface to procedures to define the value of an option. periodt.

🦋 SYNOPSIS 🦋

#include <transform.h>

int Trf_SetOption
(
     Trf_Options options,
     Tcl_Interp *interp,
     const char *optname,
     const char *optvalue,
     ClientData clientData
);

🎀 PARAMETERS 🎀

• Trf_Options options — the container you're placing the value into. like, the little box she goes in. 📦
• Tcl_Interp *interp — the interpreter used for error messages, and yes NULL is possible here, she's flexible.
• const char *optname — the name of the option you're defining. gotta know what we're setting, bestie.
• const char *optvalue — the value to set into the container. the actual content. the moment. ✨
• ClientData clientData — arbitrary information, exactly as defined in Trf_TypeDefinition.clientData. it's giving "you already know what this is." iykyk.

💅 DESCRIPTION 💅

so the procedure takes the specified optionname — and yes, she rejects the illegal ones, no gatekeeping but also no nonsense 🚫 — and places the given optionvalue into the container.

all the necessary conversions from a string to the required type should be done here. right in this function. this is the spot. do not pass go. 🫶

the return value is a standard tcl error code.

⚠️ in case of failure and interp not NULL, an error message should be left in the result area of the specified interpreter. don't forget that part, or the error message just vanishes into the void and nobody can debug anything. 💀

🔥 SEE ALSO 🔥

she has a whole friend group, and every single one of them is iconic:

Trf_Init(3), Trf_SafeInit(3), Trf_IsInitialized(3), Trf_CreateOptions(3), Trf_DeleteOptions(3), Trf_CheckOptions(3), Trf_SetObjOption(3), Trf_QueryOptions(3), Trf_SeekQueryOptions(3), Trf_WriteProc(3), Trf_CreateCtrlBlock(3), Trf_DeleteCtrlBlock(3), Trf_TransformCharacter(3), Trf_TransformBuffer(3), Trf_FlushTransformation(3), Trf_ClearCtrlBlock(3), Trf_QueryMaxRead(3), Trf_Register(3), Trf_ConverterOptions(3), Trf_MDStart(3), Trf_MDUpdate(3), Trf_MDUpdateBuf(3), Trf_MDFinal(3), Trf_MDCheck(3), Trf_RegisterMessageDigest(3), Trf_LoadLibrary(3), Trf_XorBuffer(3), Trf_ShiftRegister(3), Trf_FlipRegisterShort(3), Trf_FlipRegisterLong(3), Trf_InitStubs(3)

like. the roster. the lineup. go read all of them fr fr 🌈

and that's the page!! 🎉 this lil cutie was brought to you by c2man reading from transform.h, dated 27 August 2002 🌸 so she's vintage, she's classic, she's an icon and she ate. mwah 💅✨🫶