[每日一码] Xref API 文档

admin

1. 本帖最后由 LoveArx 于 2017-2-13 16:20 编辑
4. 问题：
5. 如何用OBJECTARX创建XREFS ？
7. 回答：
8. The following function have been introduced with ObjectARX 2000:
10. acedXrefAttach()
11. acedXrefOverlay()
12. acedXrefUnload()
13. acedXrefDetach()
14. acedXrefReload()
15. acedXrefBind()
16. acedXrefXBind()
17. acedXrefCreateBlockname()
19. 下面是帮助手册没有写入的信息。
21. The following information is not found in the ObjectARX Reference Manual because
22. they were mistakenly excluded. Here's more information on them:
24. Common Rules
25. --  All Xref APIs operate on the current document only.
27. --  The APIs provide document locking internally. If the document cannot be
28. locked they return Acad::ErrorStatus eLockViolation.
30. -- No input validation or range checking is done other than checking for NULL
31. pointers or strings. Input validation is the caller's responsibility.
33. --  Xref log file processing is available if option is enabled.
35. --  Normal AutoCAD behavior with regards to output indicators, such as, progress
36. meters, and msgs, may be turned off when scripts enabled && cmdecho == 0, or
37. menu macros enabled && menuecho == 0, or menu encryption set.
39. The attached sample application uses these functions to implement a set of very
40. simple xref commands.  Each command uses one of the Xref API functions, and very
41. little else, so it should be easy to see how they should be used.  Here is a
42. list of which sample command implements which API function:
44.    XRA uses acedXrefAttach()
45.    XRO uses acedXrefOverlay()
46.    XRU uses acedXrefUnload()
47.    XRD uses acedXrefDetach()
48.    XRR uses acedXrefReload()
49.    XRB uses acedXrefBind()
50.    XRI uses acedXrefBind() (with the insertBind method)
54. -----
55. Acad::ErrorStatus
56. acedXrefAttach(const char* XrefPathname,
57. const char* XrefBlockname,
58. AcDbObjectId* pXrefBTRid = NULL,
59. AcDbObjectId* pXrefRefid        = NULL,
60. const AcGePoint3d* pXrefInsertPt = NULL,
61. const AcGeScale3d*    pXrefScale = NULL,
62. const double* pXrefRotateAngle = NULL,
63. const Adesk::Boolean bQuiet = Adesk::kTrue);
65. Attaches an xref file to the current document.
67. Returns:
68. Returns Acad::eOk if operation is successful.
70. Parameters:
71. const char* XrefPathname [in] Xref file pathname
72. const char* XrefBlockname [in] Xref block name symbol to use
73. AcDbObjectId* pXrefBTRid [out,optional] AcDbObjectId ptr for the
74. attached/overlaid Xref block object Id
75. AcDbObjectId* pXrefRefid [out,optional] AcDbObjectId ptr for the
76. attached/overlaid Xref block reference object Id
77. const AcGePoint3d* pXrefInsertPt [in,optional] AcGePoint3d ptr for Insertion Pt
78. const AcGeScale3d* pXrefScale [in,optional] AcGeVector3d ptr for Scale factor
79. const double* pXrefRotateAngle [in, optional] double ptr for Rotate
80. angle(radians)
81. const Adesk::Boolean bQuiet [in, optional] Flag to suppress output msgs
83. Default behavior is as follows:
84. Insertion Point(X,Y,Z) = 0.0, 0.0, 0.0
85. Scale Factor(X,Y,Z) = 1.0, 1.0, 1.0
86. Rotation Angle(radians) = 0.0
88. -------
89. Acad::ErrorStatus
90. acedXrefOverlay(const char* XrefPathname,
91. const char* XrefBlockname,
92. AcDbObjectId* pXrefBTRid = NULL,
93. AcDbObjectId* pXrefRefid = NULL,
94. const AcGePoint3d* pXrefInsertPt = NULL,
95. const AcGeScale3d* pXrefScale = NULL,
96. const double* pXrefRotateAngle = NULL,
97. const Adesk::Boolean bQuiet = Adesk::kTrue);
99. Creates an xref overlay to the current document.
101. Returns:
102. Returns Acad::eOk if operation is successful.
104. Parameters:
105. const char* XrefPathname [in] Xref file pathname
106. const char* XrefBlockname [in] Xref block name symbol to use
107. AcDbObjectId* pXrefBTRid [out,optional] AcDbObjectId ptr for the
108. attached/overlaid Xref block object Id
109. AcDbObjectId* pXrefRefid [out,optional] AcDbObjectId ptr for the
110. attached/overlaid Xref block reference object Id
111. const AcGePoint3d* pXrefInsertPt [in,optional] AcGePoint3d ptr for Insertion Pt
112. const AcGeScale3d* pXrefScale [in,optional] AcGeVector3d ptr for Scale factor
113. const double* pXrefRotateAngle [in, optional] double ptr for Rotate
114. angle(radians)
115. const Adesk::Boolean bQuiet [in, optional] Flag to suppress output msgs
117. Default behavior is as follows:
118. Insertion Point(X,Y,Z) = 0.0, 0.0, 0.0
119. Scale Factor(X,Y,Z) = 1.0, 1.0, 1.0
120. Rotation Angle(radians) = 0.0
122. -----
123. Acad::ErrorStatus
124. acedXrefUnload(const char* XrefBlockname,
125. const Adesk::Boolean bQuiet = Adesk::kTrue);
127. Unloads the Xref block by its given block name. This assumes a valid Xref block
128. exists in the current document.
130. Returns:
131. Returns Acad::eOk if operation is successful.
133. Parameters:
134. const char* XrefBlockname [in] Xref block name symbol for unload
135. const Adesk::Boolean bQuiet [in,optional] Flag to suppress output msgs
137. ----
139. Acad::ErrorStatus
140. acedXrefDetach(const char* XrefBlockname,
141. const Adesk::Boolean bQuiet = Adesk::kTrue);
143. Detaches the Xref block by its given block name. This assumes a valid Xref block
144. exists in the current document.
146. Returns:
147. Returns Acad::eOk if operation is successful
149. Parameters:
150. const char* XrefBlockname [in] Xref block name symbol for detach
151. const Adesk::Boolean bQuiet [in,optional] Flag to suppress output msgs
153. -------
155. Acad::ErrorStatus
156. acedXrefReload(const char* XrefBlockname,
157. const Adesk::Boolean bQuiet = Adesk::kTrue);
159. Reloads the Xref block by its given block name. This assumes a valid Xref block
160. exists in the current document.
162. Returns:
163. Returns Acad::eOk if operation is successful.
165. Parameters:
166. const char* XrefBlockname [in] Xref block name symbol for reload
167. const Adesk::Boolean bQuiet [in,optional] Flag to suppress output msgs
169. -------
171. Acad::ErrorStatus
172. acedXrefBind(const char* XrefBlockname,
173. const Adesk::Boolean bInsertBind = Adesk::kFalse,
174. const Adesk::Boolean bQuiet = Adesk::kTrue);
176. Changes the Bind type of the Xref block by its given block name. This assumes a
177. valid Xref block exists in the current document.
179. Returns:
180. Returns Acad::eOk if operation is successful.
182. Parameters:
183. const char* XrefBlockname [in] Xref block name symbol for bind change
184. const Adesk::Boolean bInsertBind [in, optional] Converts Xref symbols to
185. insert-like bind names.
186. const Adesk::Boolean bQuiet [in, optional] Flag to suppress output msgs
188. -----
189. Acad::ErrorStatus
190. acedXrefXBind(const AcDbObjectIdArray symbolIds,
191. const bool bQuiet = true);
193. Binds symbols from xrefs to the current drawing.
195. Returns:
196. Returns Acad::eOk if operation is successful.
198. Parameters:
199. const AcDbObjectIdArray [in] object ids of symbol table records to be bound
200. const Adesk::Boolean bQuiet [in, optional] Flag to suppress output msgs
202. -----
203. Acad::ErrorStatus
204. acedXrefCreateBlockname(const char* XrefPathname,
205. char*& XrefBlockname);
207. Accepts a Xref file pathname and returns an internally allocated block name
208. symbol string buffer which follows the AutoCAD policy rules for its creation.
209. Typically, is composed of the filename of the Xref file. A return error will
210. occur if the block name cannot be created. The block name string's buffer must
211. be released via the acutDelString().
213. Returns:
214. Returns Acad::eOk if operation is successful.
216. Parameters:
217. const char* XrefPathname [in] pointer to a Xref file pathname
218. char*& XrefBlockname [out] Returns a pointer to a copy of the block
219. name symbol string

复制代码