pbs_msgjob(3B)

✨ NAME ✨

Okay so this is the PBS manual page for pbs_msgjob(3B) 🫶 and it's literally all about recording a message for a running pbs batch job.

• pbs_msgjob — record a message for a running pbs batch job

🌈 SYNOPSIS 🌈

#include <pbs_error.h>
#include <pbs_ifl.h>

int pbs_msgjob(int connect, char *job_id, int file, char *message,
char *extend)

💅 DESCRIPTION 💅

Bestie, what this does is send off a batch request that writes a message into an output file of a batch job. It builds a Message Job batch request and ships it to the server over the connection you pass as connect — and that connect is the return value of pbs_connect() ✨.

The job_id argument tells the server which job the message is for; it goes in the form sequence_number.server 💌.

The file parameter says which file or files the message string should be written to. These values are defined in pbs_ifl.h:

#define MSG_ERR 2
#define MSG_OUT 1

• MSG_ERR (#define MSG_ERR 2) — sends the message to the standard error stream of the job.
• MSG_OUT (#define MSG_OUT 1) — sends the message to the standard output stream of the job.

The message parameter is the actual message string that gets written ✍️.

The extend parameter is reserved for implementation defined extensions — so hands off that one for now, okay? 🙈

🦋 SEE ALSO 🦋

Go peek at qmsg(1B) and pbs_connect(3B) ✨

💖 DIAGNOSTICS 💖

When the batch request generated by the pbs_msgjob() function has been completed successfully by a batch server, the routine returns 0 (zero) 🎉. Otherwise, a non zero error is returned. That error number is also set in pbs_errno — so check it, bestie.

Sign-off from the Local corner: source/version is Local, page is pbs_msgjob(3B), and the footer doesn't list a date, so no made-up date here 💅🎀