putcbp Kernel Service

Purpose

Places several characters at the end of a character list.

Syntax

#include <sys/types.h>
#include <sys/errno.h>
#include <cblock.h>

int putcbp ( header,  source,  n)
struct clist *header;
char *source;
int n;

Parameters

Item Description
header Specifies the address of the clist structure that describes the character list.
source Specifies the address from which characters are read to be placed on the character list.
n Specifies the number of characters to be placed on the character list.

Description

Attention: The caller of the putcbp service must ensure that the character list is pinned. This includes the clist header and all of the cblock character buffers. Character blocks acquired from the getcf service are pinned. Otherwise, the system may crash.

The putcbp kernel service operates on the characters specified by the n parameter starting at the address pointed to by the source parameter. This service places these characters at the end of the character list pointed to by the header parameter. The putcbp service then returns the number of characters added to the character list. If the character list is full and no more buffers are available, the putcbp service returns a 0. Otherwise, it returns the number of characters written.

Execution Environment

The putcbp kernel service can be called from either the process or interrupt environment.

Return Values

The putcbp service returns the number of characters written or a value of 0 if the character list is full, and no more buffers are available.