piogetstr Subroutine

Purpose

Retrieves an attribute string for a printer formatter.

Library

None (linked with the pioformat formatter driver)

Syntax

#include <piostruct.h> piogetstr (attrname, bufrptr, bufsiz, NULL) char * attrname,* bufptr; int bufsiz;

Description

The piogetstr subroutine retrieves the specified attribute string from the Printer Attribute database and returns the string to the caller. In the course of retrieval, this subroutine also resolves any logic and any embedded references to other attribute strings or integers.

Parameters

Item Description
attrname Points to a two-character attribute name for a string. The attribute name must be defined in the database. It may optionally have been defined to the piogetvals subroutine as a variable string. The attribute should not be one that has been defined to the piogetvals subroutine as an integer.
bufptr Points to where the constructed attribute string is to be stored.
bufsiz Specifies the amount of memory that is available for storage of the string.
Note: The fourth parameter is reserved for future use. This parameter should be a NULL pointer.

Return Values

Upon successful completion, the piogetstr subroutine returns the length of the constructed string. The null character placed at the end of a constructed string by the piogetstr subroutine is not included in the length.

If the piogetstr subroutine detects an error, it issues an error message and terminates the print job.