write_scf(3)

✨ write_scf — the SCF-writing besties ✨

okay so first things first: this is a page from section 3 of the Staden Package manual, and it's all about the trio of functions that write SCF files 💖 (their names are write_scf, fwrite_scf, and write_scf_header, if you were wondering, which you were).

🎀 NAME 🎀

write_scf, fwrite_scf, write_scf_header — Write SCF files 🦋

✨ SYNOPSIS ✨

#include <scf.h>

int write_scf(
     Scf *scf,
     char *fn);

int fwrite_scf(
     Scf *scf,
     FILE *fp);

int write_scf_header(
     FILE *fp,
     Header *h);

💅 DESCRIPTION 💅

So these three cuties write SCF format trace files. That's the whole vibe. 👑

And here's a lil heads-up that applies to all of the functions that take a FILE * as an argument: they just assume the file pointer is sitting at the correct offset inside the file — which should be the start. They are not gonna check for you. They are trusting. Maybe too trusting. 🙈

• write_scf() — writes an entire SCF file into the Scf structure (peep the scf(4) manual page if you wanna know all the juicy details of that structure 🌸). The data gets written to the file name you specified. iconic.
• fwrite_scf() — writes an entire SCF file into the Scf structure too (again, scf(4) has the deets on that structure 💜). This one writes the data to the file pointer you hand it, and — very important — that file pointer is neither closed nor rewound after the operation. so don't come for it later expecting it to have tidied up after itself, bestie. 😭
• write_scf_header() — writes the Header structure to the file pointer you gave it. simple. elegant. slay. ✨

🔥 RETURN VALUES 🔥

When everything goes perfectly (main character energy only), write_scf(), fwrite_scf(), and write_scf_header() all return 0. 🫶

If it does not go perfectly? These functions return -1. that's the whole story. 💀

🌈 SEE ALSO 🌈

• scf(4)
• read_scf(3)

and that's the tea, bestie 🍓 — this page comes to you courtesy of the Staden Package, and it's the write_scf(3) page, dated just like the original footer says. go forth and write some SCF files, you've totally got this 💖✨🎀