|
发表于 2010-11-17 09:58:27
|
显示全部楼层
本帖最后由 wenforever 于 2010-11-17 10:01 编辑
: w0 e1 J% Y& p. y1 l1 E1 g
3 M# [* v3 h% H9 M$ @贴一下目录+ f( _' ?4 o8 [, G7 u; r
Telelogic DOORS API Manual Release 9.1
: a) H' j' i p3 H/ z' y b- ]1 Y/ k" L% l% k3 J2 t) N
Table of contents" P n8 d* H5 P6 l/ s& e
Chapter 1: About this manual 1
4 v! \# H( g; G9 w' L. eTypographical conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
: g' t) o! S; S; T0 n7 p7 z9 wTerminology. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
9 Z" l- u2 I' P+ u4 }Related Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
$ L! |) h+ p" CChapter 2: Introduction 5
& A( f) {0 | A& y/ O0 nDOORS APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5' R0 r5 O+ E: w$ J& b
DOORS and external data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6$ |' P, @; T0 O3 n
Strings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
4 y. R( ~: A j, p" ]6 S4 S! P. nChapter 3: The DOORS C API 7
. f$ x; F% E5 v1 O/ s2 cAbout the API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7" Q: P7 J9 Y4 o- G
Object and library files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
7 y7 Q8 W9 B, C7 X5 h1 L& q6 JExtending the DOORS C API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 h# f1 E2 s& L0 I
New DXL types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7* x G* r: R% o9 I
apiInstall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
# v9 r a% ]( z1 A0 wBEGIN_FN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8/ e! w8 Y0 a" x! n% P3 }
P_. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 V% B8 U8 |: W# V: g( N
END_DECLS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9* t8 m, M0 d- H* T& o
RETURN_ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
$ X2 e( G, g1 v- ~4 ~END_FN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
8 U4 Q; H" Q0 a" q; s0 kBEGIN_FOR_DO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
; s8 h3 U" x- c, A HPROCESS_DO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10! g# G& }( B1 S/ ?+ V+ T$ U
END_FOR_DO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1 Z! _8 O$ ]; YExample. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 p: i- j+ b, O3 t/ r# J5 P
DOORS C API entry points. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
( s+ h$ o# T e" \: v4 k, c6 YapiError. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11# u3 D+ b. X* v4 s. F
apiWarn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12( t' r N5 ?) _5 u: V* v) h
apiMainProg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 `" Q& B W4 S+ k6 q6 k
apiInitLibrary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
W4 ]- f3 M9 D, A- M# B, FapiFinishLibrary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4 _; z! \4 n! \% \$ T8 c! zapiParse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13& X9 I# v. I; e2 p( f
apiConnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
% G& O( s& W2 M2 Z: q' V7 KapiConnectSock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
5 V) r$ @& f- e$ g+ }" YapiSend. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
# U& `6 p8 o* Q) ?8 BapiSendTimesout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14. r. ]( L' o& g" ~
apiSendFile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 o5 q: j6 W- _ n4 K, R
apiExitOnError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 e; X0 Z% F. Q& D3 l4 g9 }
apiQuietError. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
$ N4 r. n, l; yapiGetErrorState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
5 u) x! h' V2 CapiGetIPC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15- h/ o, f! `( q- w6 G
apiSetIPC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15% @4 C! t0 \' x/ ~% m n) t2 {
apiDeleteIPC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 ~9 U' \& ]* M7 L/ x- p9 Y8 O
Chapter 4: Using the DXL server 17
2 l+ v1 N2 p+ A7 _2 U# V: i* Y3 YAbout the DXL server interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
9 W7 t; A' Z6 o( b: i# BStarting the server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17, ?0 s2 k5 n# u2 G9 h x6 Z5 G
dxlips. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
' R& t3 `. A y- Z5 b& c! Fdxlfile and dxlipf. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18- U2 U, b3 H. K4 e# r; `
system. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18( @" _, }. c4 l2 ]
Using the DXL server in batch mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 L. `: f4 V0 R4 M9 M
Chapter 5: DXL API integration features 213 o* S q$ f' ?9 l+ H p
General functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
! J7 |, s' h8 U2 haddr_. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
+ z; Q9 D `2 Y+ D+ T" t5 c& aeval_ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
3 J: d, m: ?" B) areturn_ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22& W$ }& t( B; P1 y" j
evalTop_. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
4 k- ~. i. H( k, {1 Q) t. [. pinitDXLServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22. ~! H, `$ H. t
replyAPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
7 o- L& @% c% m0 tsetAPIClientTimeout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
& F/ T" Q8 U6 k/ e- m IipcHostname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23" V# ^; U% Q8 l& x: n0 h' @
Interprocess communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
( S- ^* y1 D) p/ I& `server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24- g+ } i: w; W9 s- [3 w' D7 y: J+ a
client. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246 }) v x" K2 b; Z$ y
accept. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24: S0 O4 _4 V: y- r; j
send . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
4 u! x) P, G7 a2 N) p8 [! c. hrecv. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
& c1 z* X& Y4 @5 WDXL contexts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4 S7 u% i! _/ Q3 N2 S5 vImpact on triggers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
+ k3 T4 ?6 d: {& q4 DChapter 6: Interactive interfacing with a complex external tool 276 d, Y5 _) T, f5 g+ S! H; h$ {9 b( |* m
Integrating DOORS with user tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276 C3 q0 |) \5 L. z5 H+ _' w
Integrating DOORS using DOORS URLs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
) h0 Q+ Q6 P4 {: L/ ZExamples of DOORS URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30* d5 t" D; h; Q; J2 z. N2 t
Example tool to be interfaced to DOORS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310 ~- V, {; d# K( N9 v7 O
C API for example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
' ?: D( n" c9 \" w- _$ y0 PMaking a language like DXL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
2 p/ {5 {" @; vCompiling TXL on Win32 with Microsoft Developer Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . 387 O9 u9 q# z+ Y3 J& l4 w' M
Completing the DOORS active link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38# k c5 c4 E) m; _8 {1 Z2 `: g
DOORS passive link. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
) |1 ^ a. h/ v2 t wWorking with OLE objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 \( t: q( H& b6 c3 ]! @' m2 N5 Z
Listing of tds.c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49+ N0 H. q1 {- C# {; G4 _% ]
Chapter 7: Contacting support 53! I' q% v) R j6 h% M a
Contacting IBM Rational Software Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
& l- `! _( I* `* }( E8 C6 MProduct support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53" a; U' J5 I6 b; o0 }
What to do before you contact Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53) \9 o! R8 w( r' R2 F
Sending an automated problem report form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54( K0 t; k( L2 ?( w! ?
Guidelines for writing a problem report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55: j& V; d% J# D! C# E- p
Automatic responses and recording defects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
2 Q; H$ R7 ]) ~Automatically generated problem reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
! i8 U6 W3 c, q" C& P9 U* mChanging the email address of the problem report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
+ z0 H c- S1 ? O8 G/ b2 FOther information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565 ]' N1 ~' Z4 m8 @. i. y9 ]! D
Chapter 8: Notices 57* x; G6 l) s% H7 X( ?0 [8 | g; C
Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 |
|