shisa_principal_remove(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

✨ shisa_principal_remove ✨

okay bestie, welcome to the shisa_principal_remove(3) page from the shishi manual 💖 this one is short and sweet and it's giving "delete button energy", so let's get into it 🎀

🌸 NAME 🌸

shisa_principal_remove — it's an API function, babes. that's the whole name. API function. slay.

🦋 SYNOPSIS 🦋

#include <shisa.h>

int shisa_principal_remove(Shisa * dbh, const char * realm, const char *
principal);

yep, that's the whole thing. three args, one int coming back at you ✨

💜 ARGUMENTS 💜

  • Shisa * dbh — the Shisa library handle, which you got from shisa(). it's literally your all-access pass to the database, no handle no party 🙈
  • const char * realm — the name of the realm that the principal belongs to. tell us where you live, bestie 🌍
  • const char * principal — the name of the principal you wanna remove. and listen 👀 if you set this to NULL, then only the realm realm gets removed. just the realm. that's it. that's the vibe.

👑 DESCRIPTION 👑

so what does it actually do? it removes all information stored in the database for the given principal, which is written as PRINCIPAL@REALM. gone. deleted. not me clearing out the whole contact 💀

and when principal is NULL? then the realm realm itself gets removed instead. BUT — and this is the important part, so pay attention bestie — that can only succeed if the realm is already empty of principals. it's a vibe check. if there's still stuff in there, it's not happening. empty it out first, then come back 🫶

⭐ RETURN VALUE ⭐

returns SHISA_OK if it worked 🎉 or an error code if it didn't 😭

🎀 REPORTING BUGS 🎀

found a bug? don't be shy, tell the people. report bugs to <bug-shishi@gnu.org> 📧

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.

(so basically: go off, share it, just keep the receipts 🧾✨)

🌈 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, then this command

info shishi

should give you access to the complete manual. iykyk 👑

lowkey reminder: principal = NULL nukes the whole realm, but only if it's already empty. no shortcuts, no cap 🚫

and that's the page, bestie!! this one came from shishi version 1.0.3, and you just read shisa_principal_remove(3) 💖 go forth and delete responsibly, mwah 🫶✨💅

📦 where this page comes from