gsasl_client_listmech(3)

📦 version 1.10.0, in ubuntu jammy

💖 gsasl_client_listmech — bestie's guide to the gsasl manual 💖

okay so real talk, this page lives inside the gsasl manual (that's the whole manual name, no biggie) and it's literally just about one tiny function. but we're gonna do it properly because that's the vibe. ✨

🌸 NAME 🌸

gsasl_client_listmech — it's an API function, bestie. that's the whole name.

🦋 SYNOPSIS 🦋

#include <gsasl.h>

int gsasl_client_listmech(Gsasl * ctx, char * out, size_t * outlen);

like, yes, that's the whole signature. she's compact. she's iconic. 💅

🎀 ARGUMENTS 🎀

  • Gsasl * ctx — the libgsasl handle. your little context bestie. she holds everything together fr fr.
  • char * out — the output character array. this is where the tea gets written. 🫖
  • size_t * outlen — okay so this one is doing double duty and honestly? main character energy. on the way in, it's the maximum size of the output character array. on the way out, it holds the actual length of the output array. she's got range. 👑

✨ DESCRIPTION ✨

so what does she actually do? she writes the SASL names of all the mechanisms supported by the libgsasl client into the output array, and she separates each name with a space. that's it. that's the job. 🌈

and here's the trick that saves you from guessing, bestie: to find out how large your output array needs to be, just call this function with a NULL out parameter. it's giving "ask first, allocate later." 💖

Return value: Returns GSASL_OK if successful, or an error code. so like, check it. always check it.

💀 DEPRECATED 💀

okay bestie, listen. she's deprecated. do not start anything new with her.

Use gsasl_client_mechlist() instead. periodt. 🙈

🐛 REPORTING BUGS 🐛

found a bug? don't suffer in silence, spill it:

we love a bug report that's actually useful. 🫶

Copyright © 2002-2021 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.

(translation: share the love, keep the receipts. 💜)

🌟 SEE ALSO 🌟

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

info gsasl

should give you access to the complete manual. As an alternative you may obtain the manual from:

http://www.gnu.org/software/gsasl/manual/

and that's the whole page, bestie. this was gsasl_client_listmech(3), from the gsasl manual, version 1.10.0 — mwah, stan, bye. 💅✨🎀

📦 where this page comes from