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

<!-- $XConsortium: PrintCop.sgm /main/7 1996/08/30 13:11:08 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.DtPrintCopySetupData">]]>
<![ %CDE.C.XO; [<refentry id="XCSA.XPRINT.DtPrintCopySetupData">]]>
<refmeta><refentrytitle>
DtPrintCopySetupData
</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
<refname><function>DtPrintCopySetupData</function></refname><refpurpose>
copies one <StructName Role="typedef">DtPrintSetupData</StructName>
structure to another
</refpurpose></refnamediv><refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;Print.h></funcsynopsisinfo>
<funcdef>DtPrintSetupData* <function>DtPrintCopySetupData</function></funcdef>
<paramdef>DtPrintSetupData* <parameter>target</parameter></paramdef>
<paramdef>const DtPrintSetupData* <parameter>source</parameter></paramdef>
</funcsynopsis>
</refsynopsisdiv><refsect1>
<title>DESCRIPTION</title>
<para>The <function>DtPrintCopySetupData</function> function
copies the <StructName Role="typedef">DtPrintSetupData</StructName>
structure pointed to by
<symbol role="Variable">source</symbol> to the
<StructName Role="typedef">DtPrintSetupData</StructName>
structure pointed to by <symbol role="Variable">target</symbol>.
Elements in <symbol role="Variable">target</symbol> are
updated only if different than the
corresponding elements in <symbol role="Variable">source</symbol>.
</para>
<para>For elements that point to allocated
memory, <function>DtPrintCopySetupData</function> allocates
new memory for those elements updated in
<symbol role="Variable">target</symbol>. Existing elements in
<symbol role="Variable">target</symbol> are freed using
<function>XtFree</function>.
All elements in a <StructName Role="typedef">DtPrintSetupData</StructName>
structure can be freed by calling
<function>DtPrintFreeSetupData</function>.
</para>
<para>If <symbol role="Variable">source</symbol> or
<symbol role="Variable">target</symbol>
is NULL, the copy will not be performed.
</para>
</refsect1><refsect1>
<title>ARGUMENTS</title>
<variablelist>
<varlistentry><term><symbol role="Variable">target</symbol></term>
<listitem>
<para>A pointer to the
<StructName Role="typedef">DtPrintSetupData</StructName>
structure to copy to.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">source</symbol></term>
<listitem>
<para>A pointer to the
<StructName Role="typedef">DtPrintSetupData</StructName>
structure to copy from.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1>
<title>RETURN VALUE</title>
<para>If <function>DtPrintCopySetupData</function> completes
successfully, it returns a pointer to the
<symbol role="Variable">target</symbol> structure. If it fails,
it returns a NULL pointer.
</para>
</refsect1><refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>None.
</para>
</refsect1><refsect1>
<title>RESOURCES</title>
<para>None.</para>
</refsect1><refsect1>
<title>ACTIONS/MESSAGES</title>
<para>None.
</para>
</refsect1><refsect1>
<title>ERRORS/WARNINGS</title>
<para>None.</para>
</refsect1><refsect1>
<title>EXAMPLES</title>
<para>None.
</para>
</refsect1><refsect1>
<title>FILES</title>
<para>None.
</para>
</refsect1><refsect1>
<title>SEE ALSO</title>
<para>&cdeman.DtPrintSetupBox;,
&cdeman.DtPrintFreeSetupData;</para>
</refsect1></refentry>