97 lines
3.2 KiB
Plaintext
97 lines
3.2 KiB
Plaintext
<!-- $XConsortium: create.sgm /main/5 1996/08/30 14:12:08 rws $ -->
|
|
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
|
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
|
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
|
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
|
<!-- (c) Copyright 1995 Novell, Inc. -->
|
|
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
|
<!-- (c) Copyright 1995 Hitachi. -->
|
|
|
|
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN192.rsml.1">]]>
|
|
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN192.rsml.1">]]>
|
|
<RefMeta>
|
|
<RefEntryTitle>tt_pattern_create</RefEntryTitle>
|
|
<ManVolNum>library call</ManVolNum>
|
|
</RefMeta>
|
|
<RefNameDiv>
|
|
<RefName><Function>tt_pattern_create</Function></RefName>
|
|
<RefPurpose>request a new pattern object
|
|
</RefPurpose>
|
|
</RefNameDiv>
|
|
<!-- $XConsortium: create.sgm /main/5 1996/08/30 14:12:08 rws $-->
|
|
<!-- CDE Common Source Format, Version 1.0.0-->
|
|
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
|
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
|
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
|
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
|
<RefSynopsisDiv>
|
|
<FuncSynopsis>
|
|
<FuncSynopsisInfo>#include <Tt/tt_c.h>
|
|
</FuncSynopsisInfo>
|
|
<FuncDef>Tt_pattern <Function>tt_pattern_create</Function></FuncDef>
|
|
<void>
|
|
</FuncSynopsis>
|
|
</RefSynopsisDiv>
|
|
<RefSect1>
|
|
<Title>DESCRIPTION</Title>
|
|
<Para>The
|
|
<Function>tt_pattern_create</Function> function
|
|
requests a new pattern object.
|
|
</Para>
|
|
<Para>After receiving the pattern object,
|
|
the application fills in the message pattern fields to indicate
|
|
what type of messages the process wants to receive and then registers the
|
|
pattern with the ToolTalk service.
|
|
</Para>
|
|
<Para>The application can supply multiple values for each attribute
|
|
added to a pattern
|
|
(although some attributes are set and can only have one value).
|
|
The pattern
|
|
attribute matches a message attribute if any of the values in the pattern match
|
|
the value in the message.
|
|
If no value is specified for an attribute,
|
|
the ToolTalk service assumes that any value will match.
|
|
</Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>RETURN VALUE</Title>
|
|
<Para>Upon successful completion, the
|
|
<Function>tt_pattern_create</Function> function returns the opaque handle for a message pattern.
|
|
The application can use this handle in future calls to
|
|
identify the pattern object.
|
|
The application can use
|
|
&cdeman.tt.ptr.error; to extract one of the following
|
|
<StructName Role="typedef">Tt_status</StructName> values from the returned handle:
|
|
</Para>
|
|
<VariableList>
|
|
<VarListEntry>
|
|
<Term>TT_OK</Term>
|
|
<ListItem>
|
|
<Para>The operation completed successfully.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>TT_ERR_NOMP</Term>
|
|
<ListItem>
|
|
<Para>The
|
|
&cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
</VariableList>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>APPLICATION USAGE</Title>
|
|
<Para>The application should use
|
|
&cdeman.tt.free; to free any data stored in the address returned by the
|
|
ToolTalk API.
|
|
</Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>SEE ALSO</Title>
|
|
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.pattern.register;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
|
|
</RefSect1>
|
|
</RefEntry>
|
|
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|