cde/doc/C/guides/man/m3_tt_pattern/print.sgm

   1 <!-- $XConsortium: print.sgm /main/5 1996/08/30 14:17:35 rws $ -->
   2 <!-- (c) Copyright 1995 Digital Equipment Corporation. -->
   3 <!-- (c) Copyright 1995 Hewlett-Packard Company. -->
   4 <!-- (c) Copyright 1995 International Business Machines Corp. -->
   5 <!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
   6 <!-- (c) Copyright 1995 Novell, Inc. -->
   7 <!-- (c) Copyright 1995 FUJITSU LIMITED. -->
   8 <!-- (c) Copyright 1995 Hitachi. -->
   9
  10 <![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN202.rsml.1">]]>
  11 <![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN202.rsml.1">]]>
  12 <RefMeta>
  13 <RefEntryTitle>tt_pattern_print</RefEntryTitle>
  14 <ManVolNum>library call</ManVolNum>
  15 </RefMeta>
  16 <RefNameDiv>
  17 <RefName><Function>tt_pattern_print</Function></RefName>
  18 <RefPurpose>format a pattern
  19 </RefPurpose>
  20 </RefNameDiv>
  21 <!-- $XConsortium: print.sgm /main/5 1996/08/30 14:17:35 rws $-->
  22 <!-- CDE Common Source Format, Version 1.0.0-->
  23 <!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
  24 <!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
  25 <!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
  26 <!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
  27 <RefSynopsisDiv>
  28 <FuncSynopsis Remap="ANSI">
  29 <FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
  30 </FuncSynopsisInfo>
  31 <FuncDef>char <Function>*tt_pattern_print</Function></FuncDef>
  32 <ParamDef>Tt_pattern *<Parameter>p</Parameter></ParamDef>
  33 </FuncSynopsis>
  34 </RefSynopsisDiv>
  35 <RefSect1>
  36 <Title>DESCRIPTION</Title>
  37 <Para>The
  38 <Function>tt_pattern_print</Function> function formats a pattern in the same way a message
  39 is formatted for the
  40 &cdeman.ttsession; trace and returns a string containing it.
  41 </Para>
  42 <Para>The
  43 <Emphasis>p</Emphasis> argument is the pattern to be formatted.
  44 </Para>
  45 </RefSect1>
  46 <RefSect1>
  47 <Title>RETURN VALUE</Title>
  48 <Para>Upon successful completion, the
  49 <Function>tt_pattern_print</Function> function returns the formatted string.
  50 The application can use
  51 &cdeman.tt.ptr.error; to extract one of the following
  52 <StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
  53 </Para>
  54 <VariableList>
  55 <VarListEntry>
  56 <Term>TT_OK</Term>
  57 <ListItem>
  58 <Para>The operation completed successfully.
  59 </Para>
  60 </ListItem>
  61 </VarListEntry>
  62 <VarListEntry>
  63 <Term>TT_ERR_NOMEM</Term>
  64 <ListItem>
  65 <Para>There is insufficient memory available to perform the function.
  66 </Para>
  67 </ListItem>
  68 </VarListEntry>
  69 <VarListEntry>
  70 <Term>TT_ERR_POINTER</Term>
  71 <ListItem>
  72 <Para>The pointer passed does not point to an object of
  73 the correct type for this operation.
  74 </Para>
  75 </ListItem>
  76 </VarListEntry>
  77 </VariableList>
  78 </RefSect1>
  79 <RefSect1>
  80 <Title>APPLICATION USAGE</Title>
  81 <Para>The
  82 <Function>tt_pattern_print</Function> function allows an application writer to dump out patterns
  83 for debugging.
  84 </Para>
  85 </RefSect1>
  86 <RefSect1>
  87 <Title>SEE ALSO</Title>
  88 <Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;.</Para>
  89 </RefSect1>
  90 </RefEntry>
  91 <!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->