127 lines
3.7 KiB
Plaintext
127 lines
3.7 KiB
Plaintext
<!-- $XConsortium: objid_eq.sgm /main/5 1996/08/30 12:49:01 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.MAN163.rsml.1">]]>
|
|
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN163.rsml.1">]]>
|
|
<RefMeta>
|
|
<RefEntryTitle>tt_objid_equal</RefEntryTitle>
|
|
<ManVolNum>library call</ManVolNum>
|
|
</RefMeta>
|
|
<RefNameDiv>
|
|
<RefName><Function>tt_objid_equal</Function></RefName>
|
|
<RefPurpose>test whether two objids are equal
|
|
</RefPurpose>
|
|
</RefNameDiv>
|
|
<!-- $XConsortium: objid_eq.sgm /main/5 1996/08/30 12:49:01 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 Remap="ANSI">
|
|
<FuncSynopsisInfo>#include <Tt/tt_c.h>
|
|
</FuncSynopsisInfo>
|
|
<FuncDef>int <Function>tt_objid_equal</Function></FuncDef>
|
|
<ParamDef>const char *<Parameter>objid1</Parameter></ParamDef>
|
|
<ParamDef>const char *<Parameter>objid2</Parameter></ParamDef>
|
|
</FuncSynopsis>
|
|
</RefSynopsisDiv>
|
|
<RefSect1>
|
|
<Title>DESCRIPTION</Title>
|
|
<Para>The
|
|
<Function>tt_objid_equal</Function> function
|
|
tests whether two
|
|
objids
|
|
are equal.
|
|
</Para>
|
|
<Para>The
|
|
&cdeman.tt.objid.equal; function is recommended rather than
|
|
<Function>strcmp</Function>(3) for this purpose because the
|
|
&cdeman.tt.objid.equal; function returns 1 even in the
|
|
case where one
|
|
objid
|
|
is a forwarding pointer for the other.
|
|
</Para>
|
|
<Para>The
|
|
<Emphasis>objid1</Emphasis> argument is the identifier of the first object involved in this operation.
|
|
The
|
|
<Emphasis>objid2</Emphasis> argument is the identifier of the second object involved in this operation.
|
|
</Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>RETURN VALUE</Title>
|
|
<Para>Upon successful completion, the
|
|
<Function>tt_objid_equal</Function> function returns an integer that indicates whether the
|
|
objids
|
|
are equal.
|
|
The application can use
|
|
&cdeman.tt.int.error; to extract one of the following
|
|
<StructName Role="typedef">Tt_status</StructName> values from the returned integer:
|
|
</Para>
|
|
<VariableList>
|
|
<VarListEntry>
|
|
<Term>0</Term>
|
|
<ListItem>
|
|
<Para>The
|
|
<Emphasis>objid1</Emphasis> and
|
|
<Emphasis>objid2</Emphasis> objects are not equal.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>1</Term>
|
|
<ListItem>
|
|
<Para>The
|
|
<Emphasis>objid1</Emphasis> and
|
|
<Emphasis>objid2</Emphasis> objects are equal.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
</VariableList>
|
|
<Para>The application can use
|
|
&cdeman.tt.int.error; to determine if the integer is valid.
|
|
The
|
|
<Function>tt_objid_equal</Function> function returns one of the following
|
|
<StructName Role="typedef">Tt_status</StructName> values:
|
|
</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>
|
|
<VarListEntry>
|
|
<Term>TT_ERR_OBJID</Term>
|
|
<ListItem>
|
|
<Para>The
|
|
objid
|
|
passed to the ToolTalk service does not reference an existing object spec.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
</VariableList>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>SEE ALSO</Title>
|
|
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.int.error;.</Para>
|
|
</RefSect1>
|
|
</RefEntry>
|
|
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|