xprintf_protectedChannel Struct Reference

Information for the routine that writes the output of xprintf(). More...

Data Fields
int	protectionCredentials
	May used by .writeProtected() to check the protection.
int(*	writeProtected )(struct xprintf_protectedChannel *xprch, const char *pData, unsigned int length)
	Pointer to the routine that does the actual writing to the channel.
void *	channel
	The abstract channel that .writeProtected() works on.

---

Detailed Description

Information for the routine that writes the output of xprintf().

---

Field Documentation

void* xprintf_protectedChannel::channel

The abstract channel that .writeProtected() works on.

Not used by xvprintf_protected().

int xprintf_protectedChannel::protectionCredentials

May used by .writeProtected() to check the protection.

Not used by xvprintf_protected().

int(* xprintf_protectedChannel::writeProtected)(struct xprintf_protectedChannel *xprch, const char *pData, unsigned int length)

Pointer to the routine that does the actual writing to the channel.

Invoked by xvprintf_protected() as often as needed.

Parameters:

xprch	destination for writing
pData	start of the string to be written
length	length of the string to be written

Returns:

<0: error code, caller should stop processing and return error code
≥0: the count of characters written (should equal length)

---

The documentation for this struct was generated from the following file:

• impl/xprintf-core.h