الاسم¶

fmtmsg - طباعة رسائل خطأ منسقة

المكتبة¶

مكتبة سي المعيارية (libc، -lc)

موجز¶

#include <fmtmsg.h>

int fmtmsg(long classification, const char *label,
           int severity, const char *text,
           const char *action, const char *tag);

الوصف¶

تعرض هذه الدالة رسالة موصوفة بوسائطها على الجهاز (الأجهزة) المحدد في وسيط classification. بالنسبة للرسائل المكتوبة إلى stderr، يعتمد التنسيق على متغير البيئة MSGVERB.

يحدد وسيط label مصدر الرسالة. يجب أن تتكون سلسلة المحارف من جزأين مفصولين بنقطتين حيث لا يزيد الجزء الأول عن 10 أحرف والجزء الثاني عن 14 حرفًا.

يصف وسيط text حالة الخطأ.

يصف وسيط action الخطوات الممكنة للتعافي من الخطأ. إذا طُبع، يُسبق بـ "TO FIX: ".

وسيط tag هو مرجع للتوثيق عبر الإنترنت حيث يمكن العثور على مزيد من المعلومات. يجب أن يحتوي على قيمة label ورقم تعريف فريد.

قيمة الإرجاع¶

يمكن للدالة أن تُرجع 4 قيم:

MM_OK

سار كل شيء بسلاسة.

MM_NOTOK

فشل كامل.

MM_NOMSG

خطأ في الكتابة إلى stderr.

MM_NOCON

خطأ في الكتابة إلى وحدة التحكم.

البيئة¶

يمكن استخدام متغير البيئة MSGVERB ("إسهاب الرسالة") لكبت أجزاء من المخرجات إلى stderr. (لا يؤثر على المخرجات إلى وحدة التحكم.) عندما يُعرّف هذا المتغير، ويكون غير NULL، ويكون قائمة مفصولة بنقطتين من الكلمات المفتاحية الصالحة، فعندها تُطبع فقط أجزاء الرسالة المطابقة لهذه الكلمات المفتاحية. الكلمات المفتاحية الصالحة هي "label" و"severity" و"text" و"action" و"tag".

يمكن استخدام متغير البيئة SEV_LEVEL لإدخال مستويات شدة جديدة. مبدئيًا، تتوفر فقط مستويات الشدة الخمسة الموصوفة أعلاه. أي قيمة عددية أخرى ستجعل fmtmsg() لا يطبع شيئًا. إذا وضع المستخدم SEV_LEVEL بتنسيق مثل

في بيئة العملية قبل أول استدعاء لـ fmtmsg()، حيث يكون كل وصف بالشكل

عندها سيقبل fmtmsg() أيضًا القيم المشار إليها للمستوى (بالإضافة إلى المستويات القياسية 0–4)، وسيستخدم سلسلة الطباعة المشار إليها عند حدوث مثل هذا المستوى.

الجزء الخاص بكلمة الشدة لا يُستخدم بواسطة fmtmsg() لكن يجب أن يكون موجودًا. جزء المستوى هو تمثيل سلسلة محارف لرقم. يجب أن تكون القيمة العددية رقمًا أكبر من 4. يجب استخدام هذه القيمة في وسيط الشدة لـ fmtmsg() لاختيار هذه الفئة. لا يمكن الكتابة فوق أي من الفئات المحددة مسبقًا. سلسلة الطباعة هي السلسلة المطبوعة عند معالجة رسالة من هذه الفئة بواسطة fmtmsg().

السمات¶

للاطلاع على شرح للمصطلحات المستخدمة في هذا القسم، انظر attributes(7).

قبل glibc 2.16، تستخدم دالة fmtmsg() متغيرًا ثابتًا غير محمي، لذا فهي غير آمنة متعددة الخيوط.

منذ glibc 2.16، تستخدم دالة fmtmsg() قفلًا لحماية المتغير الثابت، لذا فهي آمنة متعددة الخيوط.

المعايير¶

fmtmsg()

MSGVERB

POSIX.1-2008.

التاريخ¶

fmtmsg()

System V. POSIX.1-2001 و POSIX.1-2008. glibc 2.1.

MSGVERB

System V. POSIX.1-2001 و POSIX.1-2008.

SEV_LEVEL

System V.

تخبرنا صفحات دليل System V و UnixWare أن هذه الدوال قد استُبدلت بـ "pfmt() و addsev()" أو بـ "pfmt()، vpfmt()، lfmt()، و vlfmt()"، وسيتم إزالتها لاحقًا.

أمثلة¶

#include <fmtmsg.h>
#include <stdio.h>
#include <stdlib.h>
int
main(void)
{


    long c = MM_PRINT | MM_SOFT | MM_OPSYS | MM_RECOVER;


    int err;


    err = fmtmsg(c, "util-linux:mount", MM_ERROR,


                 "unknown mount option", "See mount(8).",


                 "util-linux:mount:017");


    switch (err) {


    case MM_OK:


        break;


    case MM_NOTOK:


        printf("Nothing printed\n");


        break;


    case MM_NOMSG:


        printf("Nothing printed to stderr\n");


        break;


    case MM_NOCON:


        printf("No console output\n");


        break;


    default:


        printf("Unknown error from fmtmsg()\n");


    }


    exit(EXIT_SUCCESS);
}

يجب أن يكون المخرج:

util-linux:mount: ERROR: unknown mount option
TO FIX: See mount(8).  util-linux:mount:017

وبعد

MSGVERB=text:action; export MSGVERB

يصبح المخرج:

unknown mount option
TO FIX: See mount(8).

انظر أيضًا¶

addseverity(3), perror(3)

ترجمة¶

تُرجمت هذه الصفحة من الدليل بواسطة زايد السعيدي <zayed.alsaidi@gmail.com>

هذه الترجمة هي وثيقة مجانية؛ راجع رخصة جنو العامة الإصدار 3 أو ما بعده للاطلاع على شروط حقوق النشر. لا توجد أي ضمانات.

إذا وجدت أي أخطاء في ترجمة صفحة الدليل هذه، يرجى إرسال بريد إلكتروني إلى قائمة بريد المترجمين: kde-l10n-ar@kde.org.