« back to all changes in this revision
Viewing changes to docs/xml/gksu-context.xml
- browse files at revision 4
- compare with another revision
- download diff
- download tarball
- view history from revision 4
- Committer: Bazaar Package Importer
- Author(s): Michael Vogt
- Date: 2005-11-10 22:41:26 UTC
- mfrom: (1.1.2 upstream)
- Revision ID: james.westby@ubuntu.com-20051110224126-qas4smtk4w5gcgfr
Tags: 1.3.6-1ubuntu1
merged with debian
- files modified:
- ChangeLog
added
removed
docs/xml/gksu-context.xml
43
43
<link linkend="void">void</link> <link linkend="gksu-context-set-ssh-fwd">gksu_context_set_ssh_fwd</link> (<link linkend="GksuContext">GksuContext</link> *context,
44
44
<link linkend="gboolean">gboolean</link> value);
45
45
<link linkend="gboolean">gboolean</link> <link linkend="gksu-context-get-ssh-fwd">gksu_context_get_ssh_fwd</link> (<link linkend="GksuContext">GksuContext</link> *context);
46
<link linkend="gboolean">gboolean</link> <link linkend="gksu-context-sudo-try-need-password">gksu_context_sudo_try_need_password</link>
47
(<link linkend="GksuContext">GksuContext</link> *context);
46
48
<link linkend="gboolean">gboolean</link> <link linkend="gksu-context-try-need-password">gksu_context_try_need_password</link> (<link linkend="GksuContext">GksuContext</link> *context);
49
<link linkend="gboolean">gboolean</link> <link linkend="gksu-context-run-full">gksu_context_run_full</link> (<link linkend="GksuContext">GksuContext</link> *context,
50
<link linkend="GksuAskPasswordFunc">GksuAskPasswordFunc</link> ask_pass,
51
<link linkend="gpointer">gpointer</link> user_data,
52
<link linkend="GksuPasswordNotNeededFunc">GksuPasswordNotNeededFunc</link> pass_not_needed,
53
<link linkend="gpointer">gpointer</link> pnn_user_data,
54
<link linkend="GError">GError</link> **error);
47
55
<link linkend="gboolean">gboolean</link> <link linkend="gksu-context-run">gksu_context_run</link> (<link linkend="GksuContext">GksuContext</link> *context,
48
56
<link linkend="GError">GError</link> **error);
57
<link linkend="gboolean">gboolean</link> <link linkend="gksu-context-sudo-run-full">gksu_context_sudo_run_full</link> (<link linkend="GksuContext">GksuContext</link> *context,
58
<link linkend="GksuAskPasswordFunc">GksuAskPasswordFunc</link> ask_pass,
59
<link linkend="gpointer">gpointer</link> user_data,
60
<link linkend="GksuPasswordNotNeededFunc">GksuPasswordNotNeededFunc</link> pass_not_needed,
61
<link linkend="gpointer">gpointer</link> pnn_user_data,
62
<link linkend="GError">GError</link> **error);
49
63
<link linkend="gboolean">gboolean</link> <link linkend="gksu-context-sudo-run">gksu_context_sudo_run</link> (<link linkend="GksuContext">GksuContext</link> *context,
50
64
<link linkend="GError">GError</link> **error);
51
65
</synopsis>
409
423
</simpara></listitem></varlistentry>
410
424
</variablelist></refsect2>
411
425
<refsect2>
426
<title><anchor id="gksu-context-sudo-try-need-password"/>gksu_context_sudo_try_need_password ()</title>
427
<indexterm><primary>gksu_context_sudo_try_need_password</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gksu_context_sudo_try_need_password
428
(<link linkend="GksuContext">GksuContext</link> *context);</programlisting>
429
<para>
430
Checks if we need to ask for a password or if we have ways of
431
getting the password for ourselves or we simply don't need it.
432
Since 1.3.1.</para>
433
<para>
434
435
</para><variablelist role="params">
436
<varlistentry><term><parameter>context</parameter> :</term>
437
<listitem><simpara> a <link linkend="GksuContext"><type>GksuContext</type></link>
438
</simpara></listitem></varlistentry>
439
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if requesting a password is needed, FALSE otherwise.
440
441
</simpara></listitem></varlistentry>
442
</variablelist></refsect2>
443
<refsect2>
412
444
<title><anchor id="gksu-context-try-need-password"/>gksu_context_try_need_password ()</title>
413
445
<indexterm><primary>gksu_context_try_need_password</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gksu_context_try_need_password (<link linkend="GksuContext">GksuContext</link> *context);</programlisting>
414
446
<para>
415
447
Checks if we need to ask for a password or if we have ways of
416
getting the password for ourselves or we simply don't need it.</para>
448
getting the password for ourselves or we simply don't need it.
449
Since 1.3.0.</para>
417
450
<para>
418
451
419
452
</para><variablelist role="params">
425
458
</simpara></listitem></varlistentry>
426
459
</variablelist></refsect2>
427
460
<refsect2>
461
<title><anchor id="gksu-context-run-full"/>gksu_context_run_full ()</title>
462
<indexterm><primary>gksu_context_run_full</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gksu_context_run_full (<link linkend="GksuContext">GksuContext</link> *context,
463
<link linkend="GksuAskPasswordFunc">GksuAskPasswordFunc</link> ask_pass,
464
<link linkend="gpointer">gpointer</link> user_data,
465
<link linkend="GksuPasswordNotNeededFunc">GksuPasswordNotNeededFunc</link> pass_not_needed,
466
<link linkend="gpointer">gpointer</link> pnn_user_data,
467
<link linkend="GError">GError</link> **error);</programlisting>
468
<para>
469
This could be considered one of the main functions in GKSu.
470
it is responsible for doing the 'user changing' magic calling
471
the <link linkend="GksuAskPasswordFunc"><type>GksuAskPasswordFunc</type></link> function to request a password if needed.
472
and the <link linkend="GksuPasswordNotNeededFunc"><type>GksuPasswordNotNeededFunc</type></link> function if a password won't be
473
needed, so the application has the oportunity of warning the user
474
what it's doing.
475
Since 1.3.3.</para>
476
<para>
477
478
</para><variablelist role="params">
479
<varlistentry><term><parameter>context</parameter> :</term>
480
<listitem><simpara> a <link linkend="GksuContext"><type>GksuContext</type></link>
481
</simpara></listitem></varlistentry>
482
<varlistentry><term><parameter>ask_pass</parameter> :</term>
483
<listitem><simpara> a <link linkend="GksuAskPasswordFunc"><type>GksuAskPasswordFunc</type></link>
484
</simpara></listitem></varlistentry>
485
<varlistentry><term><parameter>user_data</parameter> :</term>
486
<listitem><simpara> a <link linkend="gpointer"><type>gpointer</type></link> with user data to be passed to the
487
<link linkend="GksuAskPasswordFunc"><type>GksuAskPasswordFunc</type></link>
488
</simpara></listitem></varlistentry>
489
<varlistentry><term><parameter>pass_not_needed</parameter> :</term>
490
<listitem><simpara> a <link linkend="GksuPasswordNotNeededFunc"><type>GksuPasswordNotNeededFunc</type></link>
491
</simpara></listitem></varlistentry>
492
<varlistentry><term><parameter>pnn_user_data</parameter> :</term>
493
<listitem><simpara> a <link linkend="gpointer"><type>gpointer</type></link> with the user data to be passed to the
494
<link linkend="GksuPasswordNotNeededFunc"><type>GksuPasswordNotNeededFunc</type></link>
495
</simpara></listitem></varlistentry>
496
<varlistentry><term><parameter>error</parameter> :</term>
497
<listitem><simpara> a <link linkend="GError"><type>GError</type></link> object to be filled with the error code or NULL
498
</simpara></listitem></varlistentry>
499
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the child's error status, 0 if all went fine, -1 if failed
500
</simpara></listitem></varlistentry>
501
</variablelist></refsect2>
502
<refsect2>
428
503
<title><anchor id="gksu-context-run"/>gksu_context_run ()</title>
429
504
<indexterm><primary>gksu_context_run</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gksu_context_run (<link linkend="GksuContext">GksuContext</link> *context,
430
505
<link linkend="GError">GError</link> **error);</programlisting>
444
519
</simpara></listitem></varlistentry>
445
520
</variablelist></refsect2>
446
521
<refsect2>
522
<title><anchor id="gksu-context-sudo-run-full"/>gksu_context_sudo_run_full ()</title>
523
<indexterm><primary>gksu_context_sudo_run_full</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gksu_context_sudo_run_full (<link linkend="GksuContext">GksuContext</link> *context,
524
<link linkend="GksuAskPasswordFunc">GksuAskPasswordFunc</link> ask_pass,
525
<link linkend="gpointer">gpointer</link> user_data,
526
<link linkend="GksuPasswordNotNeededFunc">GksuPasswordNotNeededFunc</link> pass_not_needed,
527
<link linkend="gpointer">gpointer</link> pnn_user_data,
528
<link linkend="GError">GError</link> **error);</programlisting>
529
<para>
530
This could be considered one of the main functions in GKSu.
531
it is responsible for doing the 'user changing' magic calling
532
the <link linkend="GksuAskPasswordFunc"><type>GksuAskPasswordFunc</type></link> function to request a password if needed.
533
and the <link linkend="GksuPasswordNotNeededFunc"><type>GksuPasswordNotNeededFunc</type></link> function if a password won't be
534
needed, so the application has the oportunity of warning the user
535
what it's doing.
536
Since 1.3.3.</para>
537
<para>
538
539
</para><variablelist role="params">
540
<varlistentry><term><parameter>context</parameter> :</term>
541
<listitem><simpara> a <link linkend="GksuContext"><type>GksuContext</type></link>
542
</simpara></listitem></varlistentry>
543
<varlistentry><term><parameter>ask_pass</parameter> :</term>
544
<listitem><simpara> a <link linkend="GksuAskPasswordFunc"><type>GksuAskPasswordFunc</type></link>
545
</simpara></listitem></varlistentry>
546
<varlistentry><term><parameter>user_data</parameter> :</term>
547
<listitem><simpara> a <link linkend="gpointer"><type>gpointer</type></link> with user data to be passed to the
548
<link linkend="GksuAskPasswordFunc"><type>GksuAskPasswordFunc</type></link>
549
</simpara></listitem></varlistentry>
550
<varlistentry><term><parameter>pass_not_needed</parameter> :</term>
551
<listitem><simpara> a <link linkend="GksuPasswordNotNeededFunc"><type>GksuPasswordNotNeededFunc</type></link>
552
</simpara></listitem></varlistentry>
553
<varlistentry><term><parameter>pnn_user_data</parameter> :</term>
554
<listitem><simpara> a <link linkend="gpointer"><type>gpointer</type></link> with the user data to be passed to the
555
<link linkend="GksuPasswordNotNeededFunc"><type>GksuPasswordNotNeededFunc</type></link>
556
</simpara></listitem></varlistentry>
557
<varlistentry><term><parameter>error</parameter> :</term>
558
<listitem><simpara> a <link linkend="GError"><type>GError</type></link> object to be filled with the error code or NULL
559
</simpara></listitem></varlistentry>
560
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the child's error status, 0 if all went fine, -1 if failed
561
</simpara></listitem></varlistentry>
562
</variablelist></refsect2>
563
<refsect2>
447
564
<title><anchor id="gksu-context-sudo-run"/>gksu_context_sudo_run ()</title>
448
565
<indexterm><primary>gksu_context_sudo_run</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gksu_context_sudo_run (<link linkend="GksuContext">GksuContext</link> *context,
449
566
<link linkend="GError">GError</link> **error);</programlisting>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1