CDE/cde/doc/C/guides/man/m3_Dt/PrSetupP.sgm

<!-- $XConsortium: PrSetupP.sgm /main/7 1996/10/29 12:57:37 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDE.XPRINT.DtPrintSetupProc">]]>
<![ %CDE.C.XO; [<refentry id="XCSA.XPRINT.DtPrintSetupProc">]]>
<RefMeta>
<RefEntryTitle>
DtPrintSetupProc
</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName>DtPrintSetupProc
</RefName>
<RefPurpose>Type definition for <function>DtPrintSetupBox</function> procedure resources.
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<funcsynopsisinfo>#include &lt;Print.h></funcsynopsisinfo>
<FuncDef>typedef XtEnum (*<Function>DtPrintSetupProc</Function>)</FuncDef>
<ParamDef>Widget <Parameter>wid</Parameter></ParamDef>
<ParamDef>DtPrintSetupData <Parameter>*print_data</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><function>DtPrintSetupProc</function> is the type
definition used for <function>DtPrintSetupBox</function> procedure
resources. Each procedure is passed the widget ID of the
<function>DtPrintSetupBox</function> via <symbol role="Variable">wid</symbol>,
and a structure containing information
needed to perform the particular operation via
<symbol role="Variable">print_data</symbol>.
</para>
<para>If a procedure needs to update the <function>DtPrintSetupBox</function>,
it should do so by setting resources as indicated by the procedure
resource description. The only exception to this is when the
<Symbol>DtNverifyPrinterProc</Symbol> is used to verify X printers. In
this case, the procedure may update the
<symbol role="Variable">print_display</symbol> and
<symbol role="Variable">print_context</symbol> elements of the passed
<StructName Role="typedef">DtPrintSetupData</StructName> structure.
</para>
</refsect1><refsect1>
<title>ARGUMENTS</title>
<variablelist>
<varlistentry><term><symbol role="Variable">wid</symbol></term>
<listitem>
<para>The widget ID of the <function>DtPrintSetupBox</function>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">print_data</symbol></term>
<listitem>
<para>A pointer to an existing <StructName Role="typedef">DtPrintSetupData</StructName> structure that contains the
print setup information relevant to the specific procedure.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>RETURN VALUE</title>
<variablelist>
<varlistentry><term><systemitem class="constant">DtPRINT_SUCCESS</systemitem></term>
<listitem>
<para>The procedure completed successfully.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="constant">DtPRINT_FAILURE</systemitem></term>
<listitem>
<para>The procedure encountered an error.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="constant">DtPRINT_BAD_PARM</systemitem></term>
<listitem>
<para>An invalid parameter was passed to the procedure.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.DtPrintSetupBox;
</Para>
</RefSect1>
</RefEntry>