shishi_apreq_to_file(3)

πŸ“¦
version 1.0.3 Β· 2 versions
  • 1.0.3 Β· debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 1.0.2 Β· ubuntu jammy
, in debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– shishi_apreq_to_file β€” the manual page, but make it make sense πŸ’–

okay bestie, so this is a page from the shishi manual (section 3, the library-function girlies) and it's literally all about one little function called shishi_apreq_to_file. she's a save button. that's the whole vibe. let's get into it 🫢


✨ NAME ✨

shishi_apreq_to_file β€” API function

yes that's it, that's the name, it's an API function, we love a concise queen πŸ’…


πŸŽ€ SYNOPSIS πŸŽ€

#include <shishi.h>

int shishi_apreq_to_file(Shishi * handle, Shishi_asn1 apreq, int
filetype, const char * filename);

there she is. four arguments, one int return, zero drama. slay ✨


🌸 ARGUMENTS 🌸

  • Shishi * handle β€” the shishi handle, and you gotta have one that was allocated by shishi_init(). no handle, no service, that's the rule πŸ’€
  • Shishi_asn1 apreq β€” the AP-REQ you wanna save. that's the whole point of this function, bestie, don't lose her πŸ™ˆ
  • int filetype β€” an input variable that says what type of file we're writing. which types exist? go check Shishi_filetype, that's where the menu lives πŸ“
  • const char * filename β€” an input variable holding the filename you're writing to. yes, the actual name. iconic of her πŸŽ€

πŸ¦‹ DESCRIPTION πŸ¦‹

Write AP-REQ to file in specified TYPE. and because the universe is chaotic: the file will be truncated if it exists. 😭

okay so real talk β€” truncated means whatever was in that file before? gone. poof. so pls pls pls make sure you're pointing filename at something you actually want to overwrite. no cap 🫢

πŸ‘‘ RETURN VALUE πŸ‘‘

Returns SHISHI_OK iff successful.

that's the good one. that's the one you want. if you don't get SHISHI_OK, something went sideways and you should probably read the room (and the docs) πŸ’…


πŸ’œ REPORTING BUGS πŸ’œ

found a bug? not cute, but also not your fault, go tell the maintainers:

they want the tea, fr fr. give them the tea β˜•


Copyright Β© 2002-2022 Simon Josefsson.

Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved.

^ that's the legal bit and it's actually pretty generous of them, we love a permissive license moment 🫢✨


⭐ SEE ALSO ⭐

The full documentation for shishi is maintained as a Texinfo manual. If the info and shishi programs are properly installed at your site, the command

info shishi

should give you access to the complete manual.

iykyk β€” the Texinfo manual is the main character of documentation formats, and she has everything πŸ’–


and that's the page!! footer says this is from shishi, version 1.0.3, and honestly? 1.0.3 ate. go save those AP-REQs responsibly bestie, and remember: truncation is forever πŸ˜­πŸ’…βœ¨