Function |
Description |
---|
acedActiveViewportId |
Returns the object ID of the viewport that is currently active in the editor. In tilemode, it returns the ID is of a viewport table record. In layout mode, returns the object ID of a viewport entity .Returns a null object ID if no document is open. |
acedAddDefaultContextMenu |
This function adds a default mode shortcut menu (AcEdUIContext instance).The appName should be based on the name of the ObjectARX application. If an appName is not given, the filename of the application will be used.Returns Adesk::kTrue if successful; otherwise, returns Adesk::kFalse. |
acedAddDropTarget |
Adds a hook that notifies an ObjectARX application of any drop event started from an application other than AutoCAD. |
acedAddHTMLPalette |
This function can be used to launch an AutoCAD palette with the specified URI. The palette hosts a browser window which displays the html page. |
acedAddObjectContextMenu |
This function adds an edit mode shortcut menu for a given class.Returns Adesk::kTrue if successful; otherwise, returns Adesk::kFalse. |
acedAddSupplementalCursorImage |
Adds a supplemental cursor image. Only one cursor badge image can be shown at a time. If multiple features supply badges the last badge with the highest priorityOrder will be the badge shown. |
acedAlert |
Displays an alert box with an error or warning message. An alert box is a dialog box with a single OK button. If you want the message to have multiple lines, you can include newline characters (specified by n) in the string. Note This function displays the "native" alert box mechanism of the platform on which AutoCAD is running to preserve that platform's look and feel. If your program needs to display an alert box that differs from the standard in any way other than the contents of the text message, you need to design a customized alert box.... more |
acedArxLoad |
Loads an ARX module.Corresponds to the AutoLISP (arxload). acedArxLoad() returns an error status code when the string parameter does not specify an existing file or when the file cannot be loaded for some other reason. |
acedArxLoaded |
Returns a pointer to a list of the external ARX applications that are currently loaded.The name of each application is returned as a string in its own result buffer (resval->rstring). If no external applications are currently loaded, acedArxLoaded() returns NULL.Note The application is responsible for releasing the memory it allocates. After the external function has been invoked and its arguments have been processed, the application should call acutRelRb() to release the list that acedArxLoaded() returns, unless the list is NULL. |
acedArxUnload |
Unloads an ARX module.Corresponds to the AutoLISP (arxunload) function. The acedArxUnload() function returns an error status code when the string parameter does not specify a loaded ARX program or when the program to be unloaded has dependents registered on its services. |
acedAudit |
This function audits the AcDbDatabase pointed to by pDb. |
acedCallBackOnCancel |
If you have made a call to acedCommandC or acedCmdC and wish to have your registered callback called when a CANCEL or other error occurs, call this function before returning. If you don't call this function and a CANCEL or other error occurs, your callback will not be called, instead AutoCAD will directly cancel the command state. |
acedClearOLELock |
This function is for use with OLE Automation applications. Whenever such an application uses any of the ObjectARX API functions, it must call acedSetOLELock() to set a lock. When the lock is set, the application calls this function to clear the lock and allow other OLE applications their chance to lock and use ObjectARX API functions. handle is a lock "code" integer that is used to make sure that the setting and clearing of the lock are done by the same application. Both acedSetOLELock() and this function must be passed this integer lock code as an identifier. If handle is... more |
acedClipFormatName |
Returns the clipboard format name string for the product. This string is the same for all AutoCAD based products, but is different for OEM and LT products.This function replaces the CF_AUTOCAD macro. |
acedCmdC | |
acedCmdCWasCancelled |
When your registered callback is called in response to a CANCEL or error, this function will return true, else it will return false. |
acedCmdLookup |
This function calls acedCmdLookup2(), but it always skips acedDefun'd commands. |
acedCmdLookup2 |
This function is a "C" code wrapper for:acedRegCmds->lookupCmd2(cmdStr, globalLookup, true, sf);The ObjectARX command stack is searched for the command cmdStr. If globalLookup is non-zero, then only the global command name list is searched for cmdStr; otherwise, the local command name list is searched.sf can be set to a bitwise combination of any of the following to indicate which types of commands should be skipped in the search: |
acedCmdS |
This function does the same thing with the same restructions as acedCommandS, with a resbuf chain rather than a veriable arguments list. Two more supplied parameters are intended for future use. |
acedCmdUndefine |
This function searches the command stack of registered commands for the command name cmdstr and if found sets (if undefit == 1) or unsets (if undefit == 0) the "undefine" bit in the command flags for that command. If the "undefine" bit is set, then AutoCAD will treat this command as though it is undefined in the same way that internal AutoCAD commands are treated if they have been undefined via the AutoCAD UNDEFINE command. |
acedCommandC |
Executes one or more AutoCAD commands. |
acedCommandS |
Syntax-compatible replacement of acedCommand, use for "full commands", not partial ones. This command essentially begins with its own private command line processor, initialized at the "Command:" prompt. The commands are executed in the same manner as with acedCommand, except that when the supplied input has all been executed, the private command line processor is deleted and the previous command line processor is unchanged from when the call is made. Modality and transparent "builtin" commands may not be nested. |
acedConvertEntityToHatch |
Converts a block reference or a solid to a hatch.If transferId is true, the calling AcDbHatch assumes the AcDbObjectId, handle, any extended entity data, extension dictionaries, or reactors, as well as any hatch associativity of pEnt. This is the only way the associativity with the boundary objects can be transferred. pEnt will then be deleted and set to NULL.If transferId is false, pEnt remains in the database as is and the caller is responsible for closing it. The resulting AcDbHatch is not database-resident and, as such, cannot assume any of the associativity with pEnt boundary... more |
acedCoordFromWorldToPixel |
Converts coordinates in given viewport to Windows screen coordinates.Returns TRUE if it successfully converts the coordinates; otherwise, returns FALSE. |
acedCreateInternetShortcut |
Creates an MSIE-compatible Internet shortcut using the arguments passed to it. |
acedCreateShortcut |
This function creates a Windows shell link (in other words, a shortcut) as specified in the parameter szLinkPath.Returns Adesk::kTrue on success; Adesk::kFalse on failure. |
acedCreateSteeringWheel |
Creates a steering wheel object and returns the pointer to it. |
acedCreateViewCube |
Creates a view cube object for a specified AcGsView.Returns the created view cube; NULL is the function failed. |
acedCreateViewportByView |
This function creates a viewport for the given model view at the desired location. It bases the size of the viewport on the scale factor and the size of the model view. For example, a model view 20 feet across and a scale of one foot to a quarter inch would yield a viewport that was five inches across on the paper of the layout. This call assumes that the viewport is being created in the current layout. Returns eOk on success. Possible error codes include Acad::eNotInPaperspace if not currently in a layout, Acad::eWrongDatabase if the AcDbDatabase passed in was... more |
acedDefun |
Defines an ARX application function as an external AutoLISP function and clears any existing acedSetFunHelp() reference.Once a function in an ARX application has been defined by a call to acedDefun(), it can be called from AutoLISP. When AutoLISP sends an kInvkSubrMsg message to the application, the funcno for the function can be retrieved by a call to acedGetFunCode(), and any arguments can be retrieved by a call to acedGetArgs(). As in AutoLISP, if the first characters of sname are C:, you can invoke the function as an AutoCAD command without enclosing its name in parentheses.... more |
acedDefunEx |
Defines an ARX application function as an external AutoLISP function and clears any existing acedSetFunHelp() references. It is similar to acedDefun(), but takes both global and local name arguments.If you want to set up global and local names for the same function, please use a single call to acedDefunEx(), rather than two calls to acedDefun().Once a function in an ARX application has been defined by a call to acedDefunEx(), it can be called from AutoLISP. When AutoLISP sends an kInvkSubrMsg message to the application, the nFuncNum for the function can be retrieved by a call to acedGetFunCode(), and... more |
acedDestroySteeringWheel |
Destroys a steering wheel object. |
acedDestroyViewCube |
Destroys a view cube object. |
acedDisableDefaultARXExceptionHandler |
This function will disable (if disable is Adesk::kTrue) or enable (if disable is Adesk::kFalse) exception handling in AutoCAD for exceptions thrown while code is executing in an ObjectARX or ObjectDBX module.When AutoCAD starts up, this exception handling is enabled. Disabling this exception handling allows applications to do their own exception handling of exceptions thrown while an ObjectARX or ObjectDBX module is executing. |
acedDisableUsrbrk | This function disables the user break mechanism for the current document. |
acedDisplayBorder |
Shows or hides a blue border around the inner edge of the drawing area of the current window.This behavior is used with the Drawing Compare feature (COMPARE command). |
acedDragGen |
Prompts the user to modify a selection set by graphically dragging its entities.Only entities from the current drawing's model space and paper space can be manipulated by this function. It does not manipulate nongraphical objects or entities in other block definitions.The acedDragGen() function regenerates the selection set whenever the user moves the cursor. Dragging ends when the user either specifies a point (returned as p) or cancels the drag by pressing [Esc]. Like other user-input (acedGetXxx()) functions, acedDragGen() can be set up also to recognize keywords, using a prior call to acedInitGet().The possible... more |
acedDrawingStatusBarsVisible |
This global method returns a value indicating whether or not the drawing status bars are visible in AutoCAD.By default, the drawing status bars are hidden in AutoCAD. Use this method to query the display state of the drawing status bars. If the display state is FALSE, acedShowDrawingStatusBars() can be used to display the drawing status bars in AutoCAD. |
acedDrawOrderInherit |
This function is called to set the draw order on a new child array object or objects. It should be called after the child array objects are added to the database, but before they are regen'ed, so that they are regen'ed to the proper location the first time. If cmd argument is kDrawOrderBelow or kDrawOrderAbove, then a valid parent ID must be supplied, and children objects are placed either just below or just above the parent entity, visually. If the cmd argument is kDrawOrderTop or kDrawOrderBottom, the parent entity can be null and any parent value is ignored... more |
acedEatCommandThroat |
For internal use only. |
acedEditDimstyleInteractiveEx |
This function invokes a dimstyle dialog to modify the dimstyle object pRec in the specified database pDb. pRec must be opened for write.Valid family types include: |
acedEditMTextInteractive |
Invokes the MTEXT user interface. |
acedEditToleranceInteractive |
Invokes the AutoCAD user interface for editing AcDbFcf objects. |
acedEnableUsrbrk | This function enables the user break mechanism for the the current document. |
acedEndOverrideDropTarget |
Ends an ObjectARX application's participation in a drag-and-drop event started from an AutoCAD window. Only one ObjectARX application can override the AutoCAD IDropTarget at any given time. |
acedEntSel |
Prompts the user to select an entity by specifying a point.Pauses for user input and returns both an entity name and the point that is used to select the entity.The acedEntSel() function does not return the names of nongraphical objects.Some entity operations require knowledge of the point by which the entity was selected. Examples are the AutoCAD BREAK, TRIM, and EXTEND commands, as well as OSNAP; acedEntSel() provides the same capability to ARX applications. The acedEntSel() function ignores the current OSNAP setting (no object snap) unless the user specifically requests it.When the user responds to acedEntSel()... more |
acedFiberWorld |
On Windows-based AutoCAD, by default this function returns "true". On MacOS, this function always returns "false". |
acedGetAcadDoc |
This function is used to get the pointer to AutoCAD's CDocument
object. |
acedGetAcadDockCmdLine |
This function is used to get the AutoCAD's Command Line window.For building ObjectARX applications with a static MFC library, or when not using the same shared MFC DLL as AutoCAD, a pointer to a window cannot be used. Instead, use the window handle. To get the window handle, use acedGetAcadDockCmdLine()->m_hWnd; |
acedGetAcadDwgView |
This function is used to get the pointer to AutoCAD's CView window.For building ObjectARX applications with a static MFC library, or when not using the same shared MFC DLL as AutoCAD, a pointer to a window cannot be used. Instead, use the window handle. To get the window handle, use acedGetAcadDwgView()->m_hWnd; |
acedGetAcadFrame |
This function is used to get the pointer to AutoCAD's main frame window.For building ObjectARX applications with a static MFC library, or when not using the same shared MFC DLL as AutoCAD, a pointer to a window cannot be used. Instead, use the window handle. To get the window handle, use acedGetAcadFrame()->m_hWnd; |
acedGetAcadResourceInstance |
This function returns a resource instance from AutoCAD's resource pool. If none are available, then NULL is returned. |
acedGetAcadTextCmdLine |
This function is used to get the AutoCAD's Text Command Line window.For building ObjectARX applications with a static MFC library, or when not using the same shared MFC DLL as AutoCAD, a pointer to a window cannot be used. Instead, use the window handle. To get the window handle, use acedGetAcadTextCmdLine()->m_hWnd; |
acedGetAcadWinApp |
This function is used to get the pointer to AutoCAD's CWinApp object. |
acedGetAngle |
Gets user input for an angle, taking into account the current value of the ANGBASE system variable.The AutoCAD user can specify the angle by entering a number in the current angular units format. The user can set the angle also by specifying two 2D locations on the graphics screen. AutoCAD draws a rubber-band line from the first point to the current crosshair position to help the user visualize the angle. If the pt argument is not null, AutoCAD uses this value as the first of the two points. The angle is measured in the XY plane of the current... more |
acedGetAnimationFrameId |
Provides the id of the last frame rendered in animations invoked from the ANIPATH command. |
acedGetApplicationFrame |
Returns the pointer to the AutoCAD Application Frame. |
acedGetApplicationStatusBar |
This global method returns a pointer to the application status bar, allowing developers to customize it. |
acedGetAppName |
Retrieves the file name of the current ARX application, which is needed in order to unload the application. |
acedGetArgs |
Retrieves arguments to requested external function.Returns a pointer to a linked list of the arguments that AutoLISP has passed to the ARX application through an kInvkSubrMsg message. The acedGetArgs() function retrieves these arguments, allocates result buffers, and places the argument values in these result buffers. If AutoLISP has not passed any arguments to the application, acedGetArgs() returns a null pointer.After calling acedGetArgs(), the ARX application can traverse the result-buffer list to retrieve and use the function arguments.Unlike the result lists returned by other ARX library functions, the list returned by acedGetArgs() is managed by the ARX... more |
acedGetBitmapForCommand |
Queries for the bitmap associated with a command in the AutoComplete Suggestion List pop-up window.By default, a bitmap/icon in the CUI menu macro can be associated with a command/sysvar. In the CUI dialog, the 'Command Display Name' property points to a command/sysvar name. This is how a bitmap is linked to a command.It is recommended that the bitmap-to-command association be done through the CUI. If this is not possible, or there is a need for override behavior, please use the callback function mentioned above. Note that the name is all in Localized name. |
acedGetBlockEditMode | This function returns the current BlockEdit mode value. The possible values are defined in the BlockEditModeFlags enum. The returned value may be a bitwise combination of the various enum values. |
acedGetCachedBitmapForCommand |
Queries for cached bitmap associated with a command in the AutoComplete Suggestion List pop-up window. |
acedGetCfg |
Deprecated. Retrieves application data from the AppData section of the acad.cfg file.Note: This function is obsolete and will be removed in a future release. Move all CFG stored settings to the registry or elsewhere.The sym argument must be a string of this form:"AppData/application_name/section_name/.../parameter" |
acedGetCfg |
Deprecated. Retrieves application data from the AppData section of the acad.cfg file.Note: This function is obsolete and will be removed in a future release. Move all CFG stored settings to the registry or elsewhere.The sym argument must be a string of this form:"AppData/application_name/section_name/.../parameter"If the length of the string is greater than len, this function copies only the first len characters into var with no NULL terminator, and returns RTNORM. Otherwise, it copies the complete string, including a NULL terminator, into var and returns RTNORM.Returns RTERROR if sym is not valid or is... more |
acedGetChildFrameSettings |
This function returns settings for the frame represented by pWnd. Settings indicate colors used for the view, whether scrollbars and layout tabs are visible, and whether the view is given a special border. The caller is responsible for allocating and deallocating pChildFrmSettings.Returns true if the settings are successfully retrieved. Returns false if pChildFrmSettings is null, or if the operation fails for any other reason. |
acedGetCMBaseAlias |
This function returns the current base context menu alias for one of either Default, Edit, Hotgrip, or Command mode context menus. The returned string is the full menu alias, as in "MyGroup.MyMenuAlias".mode may be one of the following values: kDefault, kEdit, kCommand, kHotGrip. |
acedGetCommandForDocument |
Gets the global or local name of the innermost current command for the given document. |
acedGetCommandForDocument |
This function sets pGlobalCmdName to the global name of the innermost command currently running for the document specified by pDoc. If there is no running command in this document, then pGlobalCmdName is set to an empty string.Note: The caller of this function is responsible for deallocating the memory used by the returned string. The acutDelString() function is the preferred way to do this.This function is marked as deprecated. |
acedGetCommandVersion | This function is used to query the requested version of the command in progress in the current document. It does this by querying the version set at this depth of the command version stack. |
acedGetCorner |
Gets user input for the corner of a rectangle.The AutoCAD user can specify the corner by entering a point in the current units format; acedGetCorner() treats pt as a three-dimensional point. The user can specify the corner also by specifying a location on the graphics screen. AutoCAD draws a dynamically sized rectangle from pt to the current crosshair position to help the user visualize the location of the second corner. The rectangle is drawn in the XY plane of the current DCS. When the pointing device is used, acedGetCorner() ignores the Z field of pt and sets the Z... more |
acedGetCurDwgXrefGraph |
This function fills in graph
with a completed graph of the current drawing's xrefs.Ghosts references appear when there are unresolved xrefs in a drawing. Ghosts are an unresolved xref's last known outgoing references (that is, its nested xrefs.) To determine outgoing references of a node, see the AcDbGraphNode::numOut() and AcDbGraphNode::out() methods.There is no distinction between ghost references and non-ghost references in the graph. However, any outgoing edge of a node that is not AcDb::kResolved is a ghost reference.Returns Acad::eOk if successful. |
acedGetCurrentColors |
Gets AutoCAD's current colors. The colors returned are those of the AutoCAD drawing window, text window, command line window, crosshair, and AutoTrack vector.Returns TRUE if it successfully gets the current color setting. Otherwise returns FALSE. |
acedGetCurrentColorsEx |
Gets the current colors for the AutoCAD windows.Returns true if successful. |
acedGetCurrentColorsEx2 |
Gets the current colors for the AutoCAD windows. |
acedGetCurrentColorsEx3 |
Gets current colors. The colors returned are those of the AutoCAD drawing window, text window, command line window, crosshair, and AutoTrack vector. |
acedGetCurrentSelectionSet |
This function fills sset in with the object IDs of all entities in the current selection set within AutoCAD.The "current selection set" may be one of the following: a pickfirst set, a selection set selected by the select command or any other command that does a selection (that is, similar to the "Previous" selection option), or the most recent set from an ssget.If a pickfirst set is available it will always be used. If no pickfirst set is available, then whichever of the other two types is available will be used. If both of the other two... more |
acedGetCurrentUCS |
This function sets mat to the matrix that maps the World Coordinate System (WCS) to the User Coordinate System (UCS) that is current in the current document.Returns Acad::eOk if successful. |
acedGetCurViewportObjectId |
This function returns the objectId of the current AcDbViewport entity (it does not work with AcDbViewportTableRecords). If TILEMODE is 1, then there is no AcDbViewport entity current so it will return AcDbObjectId::kNull. |
acedGetCurVportCircleSides | This function returns the circle zoom percent value for the current viewport. If there is no current viewport then 0 is returned.See the VIEWRES command section of the AutoCAD Command Reference for information on circle zoom percent. |
acedGetCurVportPixelToDisplay | This function sets xFactor and yFactor to the x and y pixel space to display space conversion factors for the current viewport. These values represent the size of a pixel in display coordinates. If there is no current viewport, then both are set to 0.0. |
acedGetCurVportScreenToDisplay | This function sets xFactor and yFactor to the x and y screen space to display space conversion factors for the current viewport. If there is no current viewport, then both are set to 0.0. |
acedGetDist |
Gets user input for a linear distance.The AutoCAD user can specify the distance by entering a number in the current units format. The user can set the distance also by specifying two locations on the graphics screen. AutoCAD draws a rubber-band line from the first point to the current crosshair position to help the user visualize the distance. If the pt argument is not null, AutoCAD uses this value as the first of the two points.By default, acedGetDist() treats pt and result as three-dimensional points. A prior call to acedInitGet() can force pt to be two dimensional, ensuring... more |
acedGetDpiScalingValue |
Returns DPI scaling value for Windows system. Returns 1.0 on Mac platform. |
acedGetFileD |
Prompts the user for a file name with the standard AutoCAD file dialog box. |
acedGetFileNavDialog |
The acedGetFileNavDialog() function prompts the user for a file name using the AutoCAD file navigation dialog box.The title argument specifies the caption of the entire dialog box; default specifies the default file name (which can be null); and ext is the default file name extension (if passed as null, ext defaults to "*"). The ext argument accepts multiple file name extensions separated by semicolons, as shown in the following example call to acedGetFileNavDialog(): |
acedGetFullInput |
Deprecated. Function acedGetFullInput() is an alternate form of acedGetInput(). Instead of truncating any characters beyond the 131, acedGetFullInput() returns a new copy of the entire string using acutUpdString() and updates pStr to point to the new copy. Aside from the manner in which it returns the input string, this function behaves exactly like acedGetInput().The caller is responsible for freeing the returned string using acutDelString().This function returns the same error codes as acedGetInput(). If there is insufficient memory for a copy of the string, this function returns RTERROR.See function acedGetInput() for more information. |
acedGetFullKword |
Deprecated. Function acedGetFullKword() is an alternate form of acedGetKword(). Instead of truncating any characters beyond the 131, acedGetFullKword() returns a new copy of the entire string using acutUpdString() and updates pStr to point to the new copy. Aside from the manner in which it returns the input string, this function behaves exactly like acedGetKword().The caller is responsible for freeing the returned string using acutDelString().This function returns the same error codes as acedGetInput(). If there is insufficient memory for a copy of the string, this function returns RTERROR.See function acedGetKword() for more information. |
acedGetFullString |
Deprecated. Function acedGetFullString() is an alternate form of acedGetString(). Instead of truncating any characters beyond the 132, acedGetFullString() returns a new copy of the entire string using acutUpdString() and updates pResult to point to the new copy. Aside from the manner in which it returns the input string, this function behaves exactly like acedGetString().The caller is responsible for freeing the returned string using acutDelString().This function returns the same error codes as acedGetString(). If there is insufficient memory for a copy of the string, this function returns RTERROR. |
acedGetFullSubentPathArray |
Gets the full subent path from selection set. |
acedGetFullSubentPathsForCurrentSelection |
Obtains the selected subentities on the entity specified in the current selection set.Returns Acad::eOk if successful and subentities are selected. Returns Acad::eSubSelectionSetEmpty if the entity is in the current selection set but none of its subentities are selected. Returns Acad::eKeyNotFound if the entity is not in the current selection set. |
acedGetFunCode |
Retrieves code number of requested external function.Returns the function code that AutoLISP has passed to the ARX application with a kInvkSubrMsg message. If the application implements more than one external function, it can call acedGetFunCode() to find out which function AutoLISP requested.The ARX application associates the function code with the external function name when it defines the function with a call to acedDefun(). The function code must be a nonnegative integer.If acedGetFunCode() succeeds, it returns the function code, which is a nonnegative integer; otherwise, it returns RTERROR. |
acedGetIUnknownForCurrentCommand |
This function obtains the IUnknown of the object associated with the current command of the current document.Returns false if no command is currently executing or no object has been set for the current command. |
acedGetOrient |
Gets user input for an angle.The AutoCAD user can specify the angle by entering a number in the current angular units format. The user can specify the angle also by specifying two 2D locations on the graphics screen. AutoCAD draws a rubber-band line from the first point to the current crosshair position to help the user visualize the angle. If the pt argument is not null, AutoCAD uses this value as the first of the two points. The angle is measured in the XY plane of the current UCS (acedGetOrient() ignores the Z field of pt). The... more |
acedGetPoint |
Gets user input for a point.The AutoCAD user can specify the point by entering a coordinate in the current units format; acedGetPoint() treats pt and result as three-dimensional points. The user can specify the point also by specifying a location on the graphics screen. If the pt argument is not null, AutoCAD draws a rubber-band line from pt to the current crosshair position.The coordinates of the point stored in result are expressed in terms of the current UCS.The user cannot respond to acedGetPoint() by entering an AutoLISP expression.The acedGetPoint() function returns one of the following: RTNORM... more |
acedGetReal |
Gets user input for a real value.The AutoCAD user can enter any valid real value, but the user cannot respond to acedGetReal()
by entering an AutoLISP expression.The acedGetReal() function returns one of the following: RTNORM if it succeeds, RTERROR if it fails, or RTCAN if the user cancels the request (by pressing [Esc]). It returns RTMODELESS, if the active command was registered using the ACRX_CMD_INTERRUPTIBLE flag and the document has received a modeless interrupt signal from a call to AcApDocManager::sendModelessInterrupt(). A prior call to acedInitGet() can also enable return values of RTNONE or RTKWORD. |
acedGetRegistryCompany |
Returns the AutoCAD company name as used for registry access. For all products except AutoCAD OEM, this function returns "Autodesk". For AutoCAD OEM, it is at the discretion of the AutoCAD OEM developer to specify, via an entry in aoemres2.rc, the company name for use in registry accesses. |
acedGetRGB |
This function returns a RGB color value in Win32 COLORREF (0x00bbggrr) format for the color specified by the AutoCAD Color Index (ACI) number. The ACI number must be a value between 0 and 255.If this function is passed a value less than 0 or greater than 255, then the return value will be meaningless. |
acedGetSupplementalCursorOffset |
Sets x and y to be the cursor offset to the top right corner of the pickbox. |
acedGetSym |
Retrieves the value of a bound AutoLISP symbol.This function can be used in the ARX program environment only when AutoCAD sends the message kInvkSubrMsg to the application.If the AutoLISP symbol is bound to a value of a type that can't be represented by a list of ARX result buffers (such as a subr or exsubr), the acedGetSym() call fails. If the symbol is not found or is nil, acedGetSym() returns RTNORM and sets the contents of value (*value) to null.The acedGetSym() function returns RTNORM if it succeeds and RTERROR if it fails. It returns RTMODELESS... more |
acedGetSystemColors |
Returns the current system colors. |
acedGetSystemColorsEx |
Gets the system window colorsReturns true if successful. |
acedGetSystemColorsEx2 |
Gets the system window colors |
acedGetSystemColorsEx3 |
Returns the current system colors. |
acedGetUnitsConversion | This function computes the conversion factor that blocks and xrefs need to be scaled during insertion to retain their size. For example, if a block that is created using feet as its units is inserted into a drawing with inches as its units, the conversion will be 12.Returns true if a conversion factor was computed. |
acedGetUnitsValueString |
Gets a localized string for a given AcDb::UnitsValue
.Returns a const pointer to an AcString containing the localized string. |
acedGetVar |
Retrieves the current value of the specified AutoCAD system variable.The result argument must point to a resbuf structure, because the system variables consist of a variety of types.Warning The result argument must point to an allocated resbuf (it can be static, automatic, or dynamically allocated). It must not be declared as just a pointer; if the application doesn't allocate enough space for the resbuf structure, acedGetVar() will return garbage or corrupt other data in memory.If the requested system variable is a string value, acedGetVar() dynamically allocates the memory needed to hold the string. The ARX application is... more |
acedGetWinNum |
Provide coordinates in AutoCAD drawing window (in client coordinates) and this function will return the viewport number the coordinates correspond to.This function usually is used with acedCoordFromWorldToPixel() or acedCoordFromPixelToWorld().Returns the viewport number based on Windows client coordinates. |
acedGraphScr |
On single-screen AutoCAD installations, causes the display to switch from the text screen to the graphics screen. This is equivalent to using the AutoCAD GRAPHSCR command or to pressing the Flip Screen function key (when the text screen is current).The acedTextScr() function is the complement of acedGraphScr().If acedGraphScr() succeeds, it returns RTNORM; otherwise, it returns an error code. |
acedGrDraw |
Draws a vector between two points in the current viewport.AutoCAD clips the vector as required to fit the screen.Highlighting, controlled by the hl argument, depends on the display device. Most display drivers indicate highlighting by a dashed line, but some indicate it by using a distinctive color.Unless a critical error occurs, acedGrDraw() returns RTNORM. |
acedGrRead |
Input devices directly read the next input that the user provides to any AutoCAD input device.Note Only specialized ARX applications need this function. The various user input functions (acedGetXxx(), acedEntSel(), acedNEntSelP(), acedNEntSel(), and acedDragGen()) are sufficient for almost all purposes.The following list describes the control bits. |
acedGrText |
Displays the specified text in the menu, mode, or status area of the graphics screen.If box equals the number of a screen menu box and hl is less than 0, acedGrText() displays text in that box. The menu boxes are numbered beginning at 0. If the value of box is greater than the number of menu boxes minus one, the call to acedGrText() usually has no effect.If box specifies a screen menu box and hl is greater than 0, the text displayed by acedGrText() is highlighted. If hl equals 0 and the box is highlighted, acedGrText() turns highlighting... more |
acedGrVecs |
Draws multiple vectors on the graphics screen.Result-buffer elements in the vlist can be as follows:- A pair of points (RTPOINT or RT3DPOINT) that specify the endpoints of the vector, expressed in the current UCS; these can be three-dimensional points.
Note You must pass these points as pairs--that is, in two successive result buffers--or the acedGrVecs() call will fail.- A color value that applies to all succeeding vectors until vlist specifies another color. The color is specified as a short integer (RTSHORT). AutoCAD colors are in the range 0-255. If the color value is greater than... more
|
acedHasSupplementalCursorImage |
Checks if the current supplemental cursor badge is set. |
acedHelp |
Provides Help using the specified HTML Help file.If szFilename is NULL, acedHelp() tries the name in the ACADHELP environment variable. If no ACADHELP environment variable exists, then it tries the product-specific built-in name (for example, acad.chm or acad.hlp for AutoCAD). Note Use acedHelp() to make a call for Help from a dialog box button. Use acedSetFunHelp() to define a call for command line help.If szFilename is an HTML Help file and command is not equal to 0, the three acedHelp() parameters are passed directly to HtmlHelp() in the Microsoft Windows API. The topic parameter is cast to... more |
acedHelpForExternal |
This function looks up the specified function name in a table, and if it is found, invokes the corresponding Help call.This function can be registered using acedSetFunHelp. |
acedHideConstraintBar |
This function is used to hide the constraint bars for a given set of constrained entities. |
acedInitCommandVersion |
This function sets an Adesk::UInt8 variable in the current document establishing the version requested for the next command to be run. The return value is the old version prior to being set. Calling this method will no argument will initialize the value to 0, which indicates that no version has been established. |
acedInitDialog |
This function sets an internal flag in AutoCAD so that when a command that has a dialog that is normally not activated by LISP (such as the PLOT command) is run, the dialog will be activated rather than using the command line interface.If useDialog is Adesk::kTrue, then the next use (and next use only) of the command (such as PLOT) when run from LISP or ObjectARX, will display the command's dialog rather than its command line prompts.If useDialog is Adesk::kFalse, then any previous call to this function (or the LISP (initdia) function) to tell... more |
acedInitGet |
Initializes the options used by the next call to a user-input function, such as acedGetXxx(), acedDragGen(), acedEntSel(), acedNEntSelP(), or acedNEntSel().Note The control bits and keywords established by acedInitGet() apply only to the next user-input function call. They are discarded immediately afterward. The application doesn't have to call acedInitGet() a second time to clear any special conditions.If acedInitGet() succeeds, it returns RTNORM; otherwise, it returns RTERROR.Input Options for User-Input FunctionsThe following table summarizes the control bits that can be specified by the val argument. To set more than one condition... more |
acedInvoke |
Invokes an external function defined in another ARX application.When acedInvoke() returns RTNORM, this implies that the external function was called and returned successfully. It does not imply that the external function successfully obtained a result. To determine the result, your program must inspect the result argument. If the external function failed or returned no value, result will be NULL; otherwise, result points to a list of return values.The external function being invoked must be an external function in an ARX application currently loaded. From the external function's point of view, the acedInvoke() call is invisible. It... more |
acedIsDragging |
This function indicates whether dragging is occurring in AutoCAD's editor.Returns 0 if no dragging is occurring, and a non-zero value otherwise. |
acedIsFieldUpdateEnabled |
Sets the flag of field update enabled. |
acedIsInBackgroundMode |
This function returns true if the AutoCAD session in which it is called is running in background mode for plotting. |
acedIsInputPending |
This function should be called from a dialog after a user-interactive action has been canceled. If this function returns false, the dialog should be restored. Otherwise, the dialog should be terminated in order to allow the queued input to be processed by AutoCAD. |
acedIsMenuGroupLoaded |
This function checks to see if the menugroup pszGroupName is currently loaded in the AutoCAD editor.Returns Adesk::kTrue if the pszGroupName menugroup is currently loaded, or Adesk::kFalse if not. |
acedIsOsnapOverride |
Informs a custom Osnap routine whether it was called by a running Osnap or an Osnap override.In other words, this function returns true if a custom Osnap routine was called by an Osnap override. |
acedIsUpdateDisplayPaused |
Returns true if display updates are paused, or false otherwise.This function should be used before calling acedUpdateDisplayPause(), to record the current update display pause state and restore that when finished pausing the display. This prevents other users of acedUpdateDisplayPause() from having the display re-enabled prematurely. |
acedIsUsrbrkDisabled | This function returns true if the user break mechanism is enabled for the current document. |
acedLoadPartialMenu |
Adds (loads) a partial menu to the current main menu. |
acedManageHatchEditorReactor | This function is used to create, edit and delete AcHatchCmdWatcher objects. The purpose of AcHatchCmdWatcher objects is to detect command ended messages to manage hatch entity associativity. |
acedMarkForDelayXRefRelativePathResolve |
Marks the input Xref definition object ID that helps to delay resolving its referenced file path type to relative .This function should be used for unnamed host drawing, in which the host drawing's file path is still not determined until it is saved, so relative type path cannot be saved in Xref definitions with this function. These marked XRef definitions will be resolved to relative path when the host drawing is saved. |
acedMenuCmd |
This function issues menu commands, or sets and retrieves menu item status.The acedMenuCmd() function can activate a specified submenu of the current AutoCAD customization file. This function can also force the display of menus or gray out menu items.Creating and adding specific menus to the pull-down menus on the menu bar is done dynamically. AutoCAD can also load a partial customization (CUI) file to an existing loaded menu. A partial CUI file uses the same syntax.Allowed values for the menuarea portion of str are: |
acedMspace |
When called in a layout, this function switches the editor to model space.Returns Acad::eOk if successful, or if the editor is already in model space. Returns Acad::eInvalidInput if TILEMODE is set to 1, or if there is no current drawing. Returns Acad::eCannotChangeActiveViewport if no on-screen viewports are available for switching. |
acedNEntSel |
Identical to acedNEntSelP(), except that it returns xformres as a 4 x 3 transformation matrix expressed as four points, and it doesn't let the program specify the pick point.The acedNEntSel() function does not return the names of nongraphical objects.This function is provided for compatibility with existing ARX applications. If you are writing a new application, use acedNEntSelP(). |
acedNEntSelP |
Gets the name of an entity selected by the user and the point used to select the entity. For entities nested in block references, acedNEntSelP() also returns the entity's transformation matrix and the names of the entity's container blocks in the result-buffer list .This function ignores the current OSNAP setting (no object snap) unless the user specifically requests it. It is similar to acedEntSel() except for the additional data it returns, which makes it easier for the ARX application to determine the location and appearance of the entity in World space, given the location, orientation, and scale factors of... more |
acedNumberOfViewports |
Returns the number of viewports in the current editor window. Includes the paperspace viewport when in Layout mode. |
acedOpenDocWindowsMinimized |
This function sets a flag in AutoCAD that controls whether or not newly opened documents appear minimized. If this function is called with bMinimized == true, then the flag is set. If this function is called with bMinimized == false, then the flag is cleared. While the flag is set, any documents that are opened will be opened with a minimized window. |
acedOsnap |
Finds a point by means of object snap.Applies the specified Object Snap modes to find the closest point to a reference point.The APERTURE system variable determines the allowable proximity of a selected point to an entity when using Object Snap.If acedOsnap() can find a point, it returns RTNORM; otherwise, it returns an error code. |
acedPendingCmdCTokens |
This predicate should be checked immediately after calling acedInvoke from a function registered via acedDefun that has itself been invoked from LISP. If it returns true, then the calling function should itself also immediately return RSRSLT, without necessarily establishing a return value. The tokens will be processed, and either the calling function will be called back (see acedResumeInvocation below for determining if this is the case), or cancel will terminate the rest of the operation.Note that acedFiberWorld() must return true for acedCmdC to succeed in an acedInvoke context, and for this function to return true. |
acedPendingFiberlessDocSwitch |
Returns true if: $FIBERWORLD is 0 and a cancel is in progress and a document switch has been requested but hasn't occurred yet, else false is returned.If a cancel happens at an input prompt and you want your command to continue in the new document, use something like AcApDocumentManager::sendStringToExecute to the new document to perpetuate control. |
acedPopCommandDirectory |
This function is a "C" code wrapper for:acedRegCmds->popGroupToTop(cmdDirName);The ObjectARX command stack is searched to find a command group with the name cmdDirName. If such a group is found, then it is popped to the top of the command stack and the function returns 1 to indicate success. If no group is found, then 0 is returned to indicate failure. |
acedPostCommandPrompt |
This function causes AutoCAD to repost the last command prompt message. This is intended to be used from OLE applications that are invoked without going through the normal AutoCAD user interface. In such a case this function should be called just prior to exiting from the OLE application. |
acedPrompt |
Displays the specified string on the command line of the AutoCAD graphics screen. If the length of the string is greater than the prompt line length (typically no more than 80 characters), the characters may wrap around and be visible on the text screen. On some platforms, however, they will be truncated.The acedPrompt() function returns RTNORM if successful; otherwise, it returns an error code. |
acedPspace |
When called in a layout, this function switches the editor to paper space.Returns Acad::eOk if successful, or if the editor is currently in paper space. Returns Acad::eInvalidInput if TILEMODE is set to 1, or if there is no current drawing. |
acedPutSym |
Sets the value of an AutoLISP symbol.Warning This command can be used in the ARX program environment only when AutoCAD sends the message kInvkSubrMsg to the application.To set the value of the AutoLISP symbol to nil, make the following assignment:value->restype = RTNIL;If sname is not the name of a current symbol, acedPutSym() creates a new AutoLISP symbol with this name and assigns it the value.Note An acedPutSym() function call can create a new AutoLISP symbol that AutoLISP cannot access--for example, by including illegal characters in the symbol name, such as "pair(s". An acedGetSym() call... more |
acedRedraw |
Redraws either the graphics viewport or a single entity, according to the arguments.The following table shows the acceptable values for mode and the effect that each has. (If ent is not NULL but mode is 0, the call has no effect.)Modes for acedRedraw: |
acedRegFunc |
Registers an external function so that the ARX library can call it directly, bypassing the dispatch loop. |
acedRegisterCommandBitmapQuery |
Register a bitmap query function to be notified when AutoCAD queries for a bitmap for a given command. |
acedRegisterCommandRejector |
Registers an AcEdCommandRejector object with the command rejector list.Commands in the rejector list are blocked and prevented from being executed. |
acedRegisterCustomDropTarget |
Registers a new IDroptarget to AutoCAD's drawing window. Only one IDropTarget can be registered at one time. AutoCAD's default Drag-and-Drop handling capabilities are not available until the IDroptarget is revoked.Returns TRUE if it successfully registers the IDropTarget. Otherwise, returns FALSE. |
acedRegisterExtendedTab |
Registers the fact that the application with name "szAppName" may want to add a tab to the tabbed dialog named "szDialogName". This function creates the key necessary to register the added tab(s) if it is not there. |
acedRegisterFilterWinMsg |
Register a filter message hook into AutoCAD's Windows message loop. The message passed to your application can be changed and can be blocked out.Returns TRUE if successfully registers the hook. Otherwise, returns FALSE.AcedFilterWinMsgFn is typedef BOOL (* AcedFilterWinMsgFn)(MSG*);The function pointed to by pfn can change the value of MSG passed to it. If the function returns FALSE, the message will be passed to other hook functions and AutoCAD, provided that the other hooks don't block out the message.If the function returns TRUE, the message will not be passed to other hook functions or... more |
acedRegisterNavDialogCallbackFunction |
This function adds the passed in function pointer to the list of functions to be called whenever Acad creates a CAcUiNavDialog. The functions that are registered will only be called for CAcUiNavDialogs created by Acad.exe and calls to acedGetFileNavDialog() or AcDbHostApplicationServices::selectFile(). The registered functions will be called after the dialog has been created and its data set, but just before the dialog is actually displayed. This allows the called functions to make changes or additions before the dialog's DoModal() method is called to activate it. |
acedRegisterOnIdleWinMsg |
Register a message hook into AutoCAD in order to be notified when AutoCAD is on idle.Returns true if the hook is registered successfully. |
acedRegisterOnModal |
Registers a callback function that is called when AutoCAD displays a modal dialog.Returns true if successful. |
acedRegisterWatchWinMsg |
Registers a hook function into AutoCAD message loop. The function can only look up AutoCAD's Windows message. It cannot change or block a message.Returns TRUE if successfully registers the hook. Otherwise, returns FALSE.AcedWatchWinMsgFn is typedef void (* AcedWatchWinMsgFn)(const MSG*); |
acedReloadMenus |
Updates the User Interface in AutoCAD to reflect any changes made to the currently loaded menus. |
acedRemoveCommandBitmapQuery |
Takes a bitmap query hook function pointer and removes it |
acedRemoveDefaultContextMenu |
This function removes a default mode shortcut menu (AcEdUIContext instance).Returns Adesk::kTrue if successful; otherwise, returns Adesk::kFalse. |
acedRemoveDropTarget |
Removes the hook that notifies an ObjectARX application of any drop event started from an application other than AutoCAD. |
acedRemoveFilterWinMsg |
Removes the filter message hook.Returns TRUE if successfully removes the hook. Otherwise, returns FALSE. |
acedRemoveObjectContextMenu |
This function removes an edit mode shortcut menu for a given class.Returns Adesk::kTrue if successful; otherwise, returns Adesk::kFalse. |
acedRemoveOnIdleWinMsg |
Removes the OnIdle hook.Returns true if the hook is removed successfully. |
acedRemoveOnModal |
Removes the notification that is called when AutoCAD displays a modal dialog.Returns true if successful. |
acedRemoveSupplementalCursorImage |
Removes a previously added supplemental cursor badge. |
acedRemoveWatchWinMsg |
Removes the filter message hook.Returns TRUE if successfully removes the hook. Otherwise, returns FALSE.AcedWatchWinMsgFn is typedef void (* AcedWatchWinMsgFn)(const MSG*); |
acedRestoreCurrentView |
Restore a named view to the current active viewport. This function restores the view parameters, layers state, and all associated properties to the current active viewport. The fucntion is equivalent to the -view restore command.Returns Acad::eOk if it successfully restores a named view into the current active viewport. |
acedRestorePreviousUCS |
Sets the previous UCS to be the current UCS. This function operates on the document currently displayed in the editor.Returns Acad::eOk if successful. Returns Acad::eNotApplicable if there is no previous UCS to restore, or if there is no current document. |
acedRestoreStatusBar |
Restores AutoCAD's original status bar. |
acedResumingInvocation |
True, when in a function registered via acedDefun and/or acedRegFunc and invoked from LISP that is being called back after a previous invocation called acedCommandC or acedCmdC, (see acedPendingCmdCTokens()), either directly or via a nested invocation. In this case, the function is responsible for determining how to resume. If, during its resumption, acedCommandC or acedCmdC is invoked again, then after returning to process those tokens, the function will be "resumed" again, until no call to acedCommandC or acedCmdC is made. Because acedCommandC/acedCmdC can be invoked regardless of the FIBERWORLD state, this function can also return true,... more |
acedRetInt |
Returns an integer value to AutoLISP. The AutoLISP expression that invoked the external function returns the integer result as built-in and user-defined AutoLISP functions do.An external function can make more than one call to value-return functions upon a single kInvkSubrMsg message, but the AutoLISP function returns only the value passed to it by the last value-return function invoked.The acedRetInt() function always returns RTNORM. |
acedRetList |
Returns a result-buffer list to AutoLISP. The AutoLISP expression that invoked the external function returns the list result as built-in and user-defined AutoLISP functions do.A list returned to AutoLISP by acedRetList() can include only the following result type codes: RTREAL, RTPOINT, RTSHORT, RTANG, RTSTR, RTENAME, RTPICKS, RTORINT, RT3DPOINT, RTT, RTNIL, RTLB, RTLE, and RTDOTE.The list can be any length. It can be a nested list if the external function uses acutBuildList() to construct it by using the list-construction result type codes.An external function... more |
acedRetName |
Returns a selection set or entity name to AutoLISP, depending on the value of the type argument. The AutoLISP expression that invoked the external function returns the name result as built-in and user-defined AutoLISP functions do.An external function can make more than one call to value-return functions upon a single kInvkSubrMsg message, but the AutoLISP function returns only the value passed it by the last value-return function invoked.If acedRetName() succeeds, it returns RTNORM; it returns RTERROR if it fails or if aname is a null pointer. |
acedRetNil |
Returns a nil value to AutoLISP. The AutoLISP expression that invoked the external function returns the nil result as built-in and user-defined AutoLISP functions do.The value returned by acedRetNil() is a special value that can be used to indicate a nil (empty) list, an error condition, or the successful completion of an external function that was not expected to return a value.An external function can make more than one call to value-return functions upon a single kInvkSubrMsg message, but the AutoLISP function returns only the value passed it by the last value-return function invoked.The acedRetNil() function always... more |
acedRetPoint |
Returns a three-dimensional point to AutoLISP. The AutoLISP expression that invoked the external function returns the point result, as built-in and user-defined AutoLISP functions do.An external function can make more than one call to value-return functions upon a single kInvkSubrMsg message, but the AutoLISP function returns only the value passed it by the last value-return function invoked.The acedRetPoint() function always returns RTNORM. |
acedRetReal |
Returns a real value to AutoLISP. The AutoLISP expression that invoked the external function returns the real result as built-in and user-defined AutoLISP functions do.An external function can make more than one call to value-return functions upon a single kInvkSubrMsg message, but the AutoLISP function returns only the value passed it by the last value-return function invoked.The acedRetReal() function always returns RTNORM. |
acedRetStr |
Returns a string to AutoLISP. The AutoLISP expression that invoked the external function returns the string result, as built-in and user-defined AutoLISP functions do.The acedRetStr() function passes the entire string, not its address. If s is too long, it is truncated. The maximum allowable length is 503 characters (with the 504th character reserved for the null character, EOS).An external function can make more than one call to value-return functions upon a single kInvkSubrMsg message, but the AutoLISP function returns only the value passed it by the last value-return function invoked.If acedRetStr() succeeds, it returns RTNORM;... more |
acedRetT |
Returns a true value to AutoLISP. The AutoLISP expression that invoked the external function returns the result as built-in and user-defined AutoLISP functions do.An external function can make more than one call to value-return functions upon a single kInvkSubrMsg message, but the AutoLISP function returns only the value passed it by the last value-return function invoked.The acedRetT() function always returns RTNORM. |
acedRetVal |
Returns the value in the result buffer to AutoLISP. The AutoLISP expression that invoked the external function returns the result as built-in and user-defined AutoLISP functions do.The acedRetVal() function passes the contents of the result buffer, not its address. The result buffer must be initialized and must contain a valid result type code and value (for example, RTSHORT or RT3DPOINT, but notRTLONG).An external function can make more than one call to value-return functions upon a single kInvkSubrMsg message, but the AutoLISP function returns only the value passed it by the last value-return function invoked.The... more |
acedRetVoid |
Returns a blank value (void, which is not displayed) to AutoLISP. The AutoLISP expression that invoked the external function does not print a result. This is useful in external functions defined as AutoCAD C: commands. (Calling acedRetVoid() is similar to using the AutoLISP function (princ) to suppress the printing of a return value.)An external function can make more than one call to value-return functions upon a single kInvkSubrMsg message, but the AutoLISP function returns only the value passed it by the last value-return function invoked.The acedRetVoid() function always returns RTNORM. |
acedRevokeCustomDropTarget |
Revokes the previously set IDroptarget. The AutoCAD default handling of the Drag-and-Drop event is now restored.Returns TRUE if it successfully register the IDropTarget. Otherwise, returns FALSE. |
acedScaleImageWithGDIPlus |
Scales AcGiImage using gpiplus functions. |
acedSelectTransients |
This function returns all transients that draw geometries inside the specified pickbox. |
acedSendModelessOperationEnded |
Informs AutoCAD when a modeless application has finished some significant operation identified by strContext. |
acedSendModelessOperationStart |
Informs AutoCAD when a modeless application is starting some significant operation identified by strContext. |
acedSetCfg |
Writes application data to the AppData section of the acad.cfg file.Note: This function is obsolete and will be removed in a future release. Move all CFG stored settings to the registry or elsewhere.The sym argument must be a string of the following form:"AppData/application_name/section_name/.../parameter"For example, the following code adds the line (or modifies the value of an existing line) param1=8 to the AppData section of the acad.cfg file.acedSetCfg("appdata/param1", "8");The following code adds the line param2=10 to the AppData/sec1 section:acedSetCfg("appdata/sec1/param2", "10"); |
acedSetChildFrameSettings |
This function sets properties for the frame represented by pWnd. Settings indicate colors used for the view, whether scrollbars and layout tabs are visible, and whether the view is given a special border. The caller is responsible for allocating and deallocating pChildFrmSettings.Returns true if the properties are successfully set. Returns false if pChildFrmSettings is null, or if the operation fails for any other reason. |
acedSetCMBaseAlias |
This function sets the base context menu alias for either Default, Edit, Hotgrip, or Command mode.strAlias may be a menugroup.menuname or simply a menuname. The menugroup and menuname strings may each be up to 32 characters long and may not contain spaces. Strings longer than this limit are truncated. If spaces are found, they are removed. If strAlias is not a full base alias (e.g. "MyGroup.MyMenuAlias"), then the current base menugroup is used.mode may be one of the following values: kDefault, kEdit, kCommand, kHotGrip.Returns true if successful. |
acedSetColorDialog |
This function starts the SetColor dialog within the AutoCAD editor. The value passed in via nColor is used as the default color index in the dialog. Upon return nColor contains the color index of the color selected by the user. If bAllowMetaColor is Adesk::kTrue, the BYLAYER and BYBLOCK meta-colors are allowed in the dialog. nCurLayerColor is used as the color index of the color to show for BYLAYER.If the SetColor dialog is invoked using this function, only the color index tab is available. To enable the user to select additional color types, invoke the SetColor dialog with the... more |
acedSetColorDialogTrueColor |
This function starts the Set Color dialog box within the AutoCAD editor.The value passed in color is the default color in the dialog. This can affect which tab and controls are active upon entering the dialog box. When the function returns, color contains the color selected by the user or the original value if the dialog box was aborted.If bAllowMetaColor is Adesk::kTrue, the BYLAYER and BYBLOCK metacolors are allowed in the dialog. curLayerColor is the color to show for BYLAYER.The function returns Adesk::kTrue if the dialog box was successfully terminated by the OK button; it returns... more |
acedSetColorDialogTrueColorWithCallback |
Perform the SetColor dialog but with a callback. This is similar to acedSetColorDialogTrueColor, but the caller receives callbacks on each intermediate color selection.Return TRUE if successful. |
acedSetCurrentColors |
Sets the current AutoCAD colors.Returns TRUE if it successfully sets the current color setting. Otherwise, returns FALSE. |
acedSetCurrentColorsEx |
Sets the AutoCAD windows' colorsReturns true if successful. |
acedSetCurrentColorsEx2 |
Sets the AutoCAD windows' colors. |
acedSetCurrentColorsEx3 |
Sets the current AutoCAD colors. |
acedSetCurrentUCS |
This function sets the current UCS from the 3D matrix mat. The first row of the matrix is the UCS X-axis (in WCS coordinates), the second row is the UCS Y-axis, and the third row is the UCS Z-axis.This function must not be used while acedCommand is active. Always returns Acad::eOk. |
acedSetCurrentView |
This function uses the information from the AcDbViewTableRecord pointed to by pVwRec to set the view in the AcDbViewport pointed to by pVP (if pVP != NULL) or in the current viewport (if pVP == NULL). |
acedSetEnv |
The acedSetEnv() function sets the value of an environment variable. It stores the data only in the AutoCAD-specific FixedProfile/General section of the registry: |
acedSetFieldUpdateEnabled |
Gets the flag of field update enabled. |
acedSetFunHelp |
Defines a Help call that should be made if a transparent Help request is made during a command line prompt for the function named pszFunctionName.This function registers Help for functions that are called from the AutoCAD command line so that the appropriate Help file and topic are called when help is requested at a user prompt. acedSetFunHelp() may be used for ObjectARX commands, as well as ObjectARX and AutoLISP commands that start with C:. |
acedSetIgnoredEntAndDuplicatedBlkCount |
Gets the number of ignored entities and duplicated blocks from selection set. |
acedSetOLELock |
This function is for use with OLE Automation applications. Whenever such an application uses any of the ObjectARX API functions, it must call this function to set a lock and then, when done, it needs to call acedClearOLELock() to clear the lock and allow other OLE applications their chance to lock and use ObjectARX API functions. handle is a lock "code" integer that is used to make sure that the setting and clearing of the lock are done by the same application. Both this function and acedClearOLELock() must be passed this integer lock code as an identifier.The lock that... more |
acedSetStatusBarProgressMeter |
This displays an option label and a progress meter on the AutoCAD status bar. Pass NULL or an empty string for the label if no label is desired.Returns 0 if it successfully creates the label and progress meter; otherwise, returns -1. |
acedSetStatusBarProgressMeterPos |
Call this with a positive value within the range specified to set the current position of the status bar. Pass a negative number to add an amount to the current position (relative).Returns 0 if it successfully creates the label and progress meter; otherwise, returns -1. |
acedSetSupplementalCursorOffset |
Sets x and y to be the cursor offset to the top right corner of the pickbox. |
acedSetVar |
Sets the specified AutoCAD system variable. The val argument must point to a result buffer, because the system variables consist of a variety of types. The result buffer must be initialized and must contain a valid result type code and value that correspond to the type and values allowed for the specified system variable.AutoCAD system variables that take integer values are 16-bit short integers. The value supplied in the val->resval.rint field of the result buffer must be between -32,768 and +32,767.Some AutoCAD commands inspect the values of system variables before they prompt the user. If the application calls... more |
acedSetView |
Establishes a three-dimensional view for a specified viewport.Note This function can be used in the ARX program environment only when AutoCAD sends the message kInvkSubrMsg to the application.The acedSetView() function returns RTNORM if successful; otherwise, it returns RTERROR. |
acedSetXrefResolvedWithUpdateStatus |
This function forces the Xref Notification feature to treat the specified Xref as having been resolved with an updated drawing, just as if it was reloaded through the user interface.Returns Acad::eOk if successful; otherwise, eInvalidInput if pBTR was NULL or invalid. |
acedShowConstraintBar |
This function is used to show or hide the constraint bars for all constrained entities in the active document. |
acedShowConstraintBarForAll |
This function is used to show or hide the constraint bars for all constrained entities in the active document. |
acedShowDrawingStatusBars |
This global function hides or shows the drawing status bars. By default, the drawing status bars are hidden in AutoCAD; use this function to display them.If this function succeeds, the return value is true. If the function fails, the return value is false.This function is deprecated and will be removed in a future release. |
acedShowHTMLModalWindow |
This function can be used to launch a modal dialog with the specified URI. The window hosts a browser window which displays the html page. |
acedShowHTMLModelessWindow |
This function can be used to launch a modeless dialog with the specified URI. The window hosts a browser window which displays the html page. |
acedSkipXrefNotification |
This function directs the Xref Notification feature to ignore the update of the Xref, identified by its name, xrefName, for the specified host database, pHostDb. In effect, the Xref is treated as if it had been reloaded as of the time this function is called.Returns Acad::eOk if the xref notification will be skipped for the specified xref.Returns Acad::eNotApplicable if the XREFNOTIFY system variable is 0 (indicating xref notification is disabled).Returns Acad::eInvalidInput if the pHostDb parameter is NULL or xrefName is the empty string.Returns Acad::eKeyNotFound if the xref cannot be found. |
acedSSAdd |
Creates a new selection set or adds an entity to an existing selection set.If both ename and sname are null pointers, acedSSAdd() creates a new selection set with no members. If ename is a valid entity but sname is null, acedSSAdd() creates a new selection set whose (single) member is ename. If ename specifies a valid entity and sname specifies an existing selection set, acedSSAdd() adds the ename entity to the set specified by sname. In all cases, acedSSAdd() sets result to the name of the new or updated selection set.If the entity specified by ename... more |
acedSSDel |
Deletes the specified entity from the specified selection set. Both the entity and selection set names must be valid for the current drawing.Note Only entities from the current drawing's model space and paper space, not nongraphical objects or entities in other block definitions, can be deleted by this function.The acedSSDel()
function returns RTNORM if successful; otherwise, it returns an error code. When acedSSDel() fails, it sets the system variable ERRNO to a value that indicates the reason for the failure. |
acedSSFree |
Frees the specified selection set . The set must have been previously obtained from a call to acedSSGet() or acedSSAdd().An ARX application cannot have more than 128 selection sets open at once. (The limit may be different on your system.) If the limit is reached, AutoCAD refuses to create more selection sets. Simultaneously managing a large number of selection sets is not recommended. Instead, keep a reasonable number of sets open at any given time, and call acedSSFree() to free unused selection sets as soon as possible. Unlike AutoLISP, the ARX environment has no automatic garbage collection to... more |
acedSSGet |
Returns a selection set obtained by specifying one of the AutoCAD selection modes. A selection mode is specified either by prompting the AutoCAD user or by filtering the drawing database.You must release the allocated selection set after you are finished with processing the selection. If you fail to do this the selection set will be kept on the stack until AutoCAD terminates. Since AutoCAD can only hold 128 application-based selection sets per session, the unreleased selection sets can result in failed object selections through ObjectARX. |
acedSSGetFirst |
Determines which objects are selected and gripped. |
acedSSGetKwordCallbackPtr |
Sets a pointer to the keyword callback function currently in use by AutoCAD.The keyword callback function pointer within AutoCAD can only point to one callback function at a time. acedSSGetKwordCallbackPtr() can be used to preserve another callback function pointer while AutoCAD's keyword callback function pointer is temporarily reset to another function. In this process:- Use acedSSGetKwordCallbackPtr() to get and store a pointer to the currentt callback function.
- Use acedSSSetKwordCallbackPtr() to set AutoCAD to another callback function.
- When the other callback function is no longer needed, use acedSSSetKwordCallbackPtr() with the original function pointer to restore AutoCAD's use of the original... more
|
acedSSGetOtherCallbackPtr |
Sets a pointer to the "other" current callback function currently in use by AutoCAD.The "other" keyword callback function pointer within AutoCAD can only point to one callback function at a time. acedSSGetOtherCallbackPtr() can be used to preserve another callback function pointer while AutoCAD's keyword callback function pointer is temporarily reset to another function. In this process:- Use acedSSGetOtherCallbackPtr() to get and store a pointer to the currentt callback function.
- Use acedSSSetOtherCallbackPtr() to set AutoCAD to another callback function.
- When the other callback function is no longer needed, use acedSSSetOtherCallbackPtr() with the original function pointer to restore AutoCAD's use of... more
|
acedSSMemb |
Tests whether the specified entity is a member of the specified selection set. The entity and selection set names must be valid for the current drawing.Note Only entities from the current drawing's model space and paper space, not nongraphical objects or entities in other block definitions, can be tested by this function.If acedSSMemb() finds ename, it returns RTNORM; if it doesn't, it returns RTERROR. When acedSSMemb() fails, it sets the system variable ERRNO to a value that indicates the reason for the failure. |
acedSSName |
Returns the name of an entity, specified by its position in a selection set.Warning Because of the potential size of selection sets, i must be a long integer. Declaring an index value as short (or as int on short-integer platforms) leads to disaster. A common error is coding the i argument as 0 to retrieve the set's first element. If you pass i as a constant, it must be followed by an L (as in 0L) to specify a long value.Entity names in selection sets obtained with acedSSGet() are always the names of main entities. The acedSSName()... more |
acedSSNameX |
Retrieves information about how one or more elements in a selection set were created.Note Only selection sets with entities from the current drawing's model space and paper space (not nongraphical objects or entities in other block definitions) can be retrieved by this function.Call acutRelRb()
to deallocate resbufs pointed to by rbpp.acedSSNameX() returns RTNORM if successful; otherwise, it returns RTERROR.The contents of the list returned from this function is composed of a series of sublists, each encapsulated within its own RTLB/RTLE pair. At the top level, there is a sublist for the i'th entity (or,... more |
acedSSNameXEx |
When flags is 0, this function behaves the same as acedSSNameX(). When the second bit in flags is set (in other words, 0x2), then the behavior is the same as acedSSNameX(), except that GS markers will be treated as longs. In that case, if the resbuf list returned by rbpp contains GS markers, they will have a restype of RTLONG and the value in the union in such resbufs will be a long.Bit 1 of the flags argument is for Autodesk internal use only and should not be set. Bits above 2 are not currently used.... more |
acedSSSetFirst |
This function sets which objects are selected and gripped.The parameters have the following data type definition:typedef long ads_name[2];The selection set of objects specified by the gset argument are gripped, and the selection set of objects specified by pset are both gripped and selected. If any objects are common to both selection sets, acedSSSetFirst() grips and selects the selection set specified by pset only (it does not grip the gset set). If gset is NULL and pset is specified, acedSSSetFirst() grips and selects pset. If gset and pset are NULL, acedSSSetFirst() turns off any existing grips... more |
acedSSSetKwordCallbackPtr |
Provides a pointer to a keyword callback function.The function acedSSGet() has been extended to allow callers to specify additional keywords available during the user interactive portion of acedSSGet().When an application-specific keyword is entered and a keyword callback function has been registered via this function, AutoCAD calls the callback function passing in a pointer to the keyword entered.The callback function that is registered by acedSSSetKwordCallbackPtr() takes the following form:struct resbuf* fcn(const char* str)When the callback function is called, the str argument will point to the keyword string entered by the user. This string must not... more |
acedSSSetOtherCallbackPtr |
Provides pointer to an "other" callback function. When acedSSGet() receives a string that it does not recognize as a valid keyword (either built-in or custom) and an "other" callback function has been registered via this function, AutoCAD calls the callback function passing in a pointer to the unknown "other" string entered.The callback function that is registered by acedSSSetOtherCallbackPtr() takes the following form:struct resbuf* fcn(const char* str)When the callback function is called, the str argument will point to the string entered by the user. This string must not be freed by the callback function!The callback function should... more |
acedSSSetSubentTypes |
When selecting subentities, AutoCAD calls AcDbEntity::getSubentPathsAtGsMarker() for the GS marker on the entity that satisfied the selection operation. AcDbEntity::getSubentPathsAtGsMarker() can only return one AcDb::SubentType at a time to the caller. AutoCAD calls this method repeatedly using different AcDb::SubentType values until a successful, non-empty path is returned which then becomes selected, or until all subentity types have been exhausted resulting in no selection.Applications can define the subentity types that AutoCAD will request from the entity, and the order in which it requests them, by calling acedSSSetSubentTypes() before calling acedSSGet() to create a selection set. The types passed to acedSSSetSubentTypes() define... more |
acedSSSubentAdd |
Creates a new selection set or adds an entity to an existing selection set.If subentity is a valid subentity but sname is null, this function creates a new selection set whose single member is subentity. If subentity specifies a valid subentity and sname specifies an existing selection set, this function adds subentity to the set specified by sname. In all cases, this function sets result to the name of the new or updated selection set.If the subentity specified by ename is already in the set sname, this function ignores the request and does not report an... more |
acedSSSubentDel |
Deletes the specified entity from the specified selection set. Both the subentity and selection set names must be valid for the current drawing.Only entities from the current drawing's model space and paper space can be deleted by this function. This function does not delete nongraphical objects or entities in block definitions other than model space or paper space.Returns RTNORM if successful. Otherwise, returns an error code. |
acedSSSubentLength |
Selection sets containing subentities store all subentities for a given entity under one index in the selection set. This method returns the number of subentities selected for a given entity.Because selection sets can contain more than 65,535 entities, the index and len arguments must be long integers. Be sure to pass a pointer to type long in your application. Passing type short (or int on short-integer platforms) leads to disaster.Only selection sets with entities from the current drawing's model space and paper space can be addressed by this function. This function does not handled non-graphical objects or entities... more |
acedSSSubentMemb |
Tests whether the specified subentity is a member of the specified selection set. The subentity and selection set names must be valid for the current drawing.Only entities from the current drawing's model space and paper space, not nongraphical objects or entities in other block definitions, can be tested by this function.Only entities from the current drawing's model space and paper space can be tested by this function. This function does not test nongraphical objects or entities in block definitions other than model space or paper space.Returns RTNORM if it finds subentity in the selection set. Otherwise, returns... more |
acedSSSubentName |
Returns the full path of a subentity, specified by the position of its entity in the selection set and the position of the subentity within the selection set entry.Subentity selections obtained with acedSSGet() (such as faces, edges, or vertices on entities, but not block attributes or polyline vertices) are stored in a selection set as a collection of AcDbFullSubentPath objects for each selection set entry. The two indices passed to this method define the main entity index in the selection set, and the selected subentity index within the entity entry.Because of the potential size of selection sets, the... more |
acedSSSubentNameX |
Retrieves information about how one or more subentity selections in a selection set were created.Subentity selections obtained with acedSSGet() (such as faces, edges, or vertices on entities, but not block attributes or polyline vertices) are stored in a selection set as a collection of AcDbFullSubentPath objects for each selection set entry. The two indices passed to this method define the main entity index in the selection set, and the selected subentity index within the entity entry.Only selection sets with entities from the current drawing's model space and paper space can be retrieved by this function. This function does... more |
acedStartOverrideDropTarget |
Begins an ObjectARX application's participation in a drag-and-drop event started from an AutoCAD window. The ObjectARX application's IDropTarget replaces the AutoCAD IDropTarget and all events that occur while dragging go to the application. Only one ObjectARX application can override the AutoCAD IDropTarget at any given time. |
acedSuppressFileMRU |
Controls whether or not file open adds the filename to the 'File' MRU list. |
acedSymUtil |
This function returns a pointer to the AcEdSymUtilServices object that you dereference in order to invoke the member functions. It never returns NULL. AcEdSymUtilServices is a typedef to abbreviate the longer name AcEdSymbolUtilities::Services(). |
acedSyncFileOpen |
This function opens the drawing file specified by pszFileToOpen and loads it into the AutoCAD editor in much the same way as the AutoCAD OPEN command, but without the user interface. If pszFileToOpen does not point to a valid DWG file, the function issues a prompt to that effect and displays the standard Select File dialog. |
acedTablet |
Depending on the first item in args, either retrieves the current digitizer (tablet) calibration or sets the calibration. The first item in args must be an integer (RTSHORT) whose value is either 0 or 1. If args begins with 0, acedTablet() retrieves the current calibration and returns it in the result list. If args begins with 1, it must also specify the new calibration arguments. The elements of args and result have the same meanings, as follows:codeAn integer code (RTSHORT).If the code you pass in args equals 0, acedTablet() retrieves the current... more |
acedTextBox |
Finds the coordinates of a box that encloses a text entity. Assumes that the origin is (0,0) and the rotation is 0 (or 270 if the text is vertical). If the text is located at a different point or is rotated, your program must handle these values explicitly.If the text is horizontal and is not rotated, p1 (the bottom-left corner) and p2 (the top-right corner) describe the bounding box of the text. The coordinates are expressed in the ECS of ent, with the origin (0,0) at the left endpoint of the baseline. (The origin is not the bottom-left... more |
acedTextPage |
On single-screen AutoCAD installations, this function causes the display to switch from the graphics screen to the text screen. This is identical to the acedTextScr() function.If acedTextPage() succeeds, it returns RTNORM. Otherwise, it returns an error code. |
acedTextScr |
On single-screen AutoCAD installations, causes the display to switch from the graphics screen to the text screen. This is equivalent to the AutoCAD TEXTSCR command or to pressing the flip screen function key (when the graphics screen is current). Its functionality is also identical to that of the acedTextPage() function.The acedGraphScr() function is the complement of acedTextScr().If acedTextScr() succeeds, it returns RTNORM. Otherwise, it returns an error code. |
acedTraceBoundary |
Performs a boundary trace on the given seedPoint, and returns a set of AcDbPolyline * objects that represent the boundary found.To succeed, the entities that form the boundary to be found must be entirely visible on screen in the AutoCAD editor. |
acedTrans |
Translates a point or a displacement from one coordinate system into another.The from and to arguments can specify a coordinate system in any of the following ways:- An integer code (restype == RTSHORT) that specifies the WCS, current User Coordinate System (UCS), or current Drawing Coordinate System (DCS) (of either the current viewport or paper space), as described in the following table.
- An entity name (restype == RTENAME), as returned by one of the entity name or selection set functions. This specifies the ECS of the named entity.
For planar entities, the ECS can differ... more |
acedUndef |
Undefines an AutoLISP external function that was previously defined by a call to acedDefun().If AutoLISP doesn't recognize both arguments as identifying the same external function, it returns an error status and leaves the function defined.The ARX application that calls acedUndef() must be the same program that originally defined the function with acedDefun().It is not necessary to call acedUndef() in response to an kUnloadDwgMsg message. This function is provided for applications that need to manage the use of function names explicitly.If acedUndef() succeeds, it returns a value of RTNORM; otherwise, it returns an error... more |
acedUnloadPartialMenu |
Removes (unloads) a partial menu from the current main menu. |
acedUnmarkForDelayXRefRelativePathResolve |
Unmarks the input Xref definition object ID, which is marked in the function acedMarkForDelayXRefRelativePathResolve(.)If this object ID is not marked before by the function acedMarkForDelayXRefRelativePathResolve(), then this function will be a no-operation. |
acedUnRegisterCommandRejector |
Unregisters an AcEdCommandRejector object from the command rejector list when it is no longer needed. |
acedUnregisterNavDialogCallbackFunction |
This function removes the passed in function pointer from the list of functions to be called whenever Acad creates a CAcUiNavDialog. |
acedUpdate |
Refreshes a rectangular sub-area of the viewport. The corners must be specified in drawing coordinates. As long as p1 and p2 are diagonally opposite each other, it does not matter which two corners of the area are specified. |
acedUpdateDisplay |
This function causes AutoCAD to update its display screen. The update is essentially a repaint of the AutoCAD graphics window with what AutoCAD's display engine has cached as the window's image.AutoCAD manages its display area in the most efficient way by keeping track of which portions of the screen are affected as you make various calls to AutoCAD. In general the calls you make will not immediately be reflected in screen changes. AutoCAD will conglomerate the calls and make them apparent at times that minimize disturbances to the screen. When AutoCAD is not active or has no focus, it... more |
acedUpdateDisplayPause |
This function allows an application to turn off display updates in order to hide automated tasks from the user. All documents are affected by this call. This call should not be enabled if any kind of drawing area input is expected from the user. The restrictions on what can be done in this paused state are the same as they would be if the display was not paused.Callers of this function should first save the return value from acedIsUpdateDisplayPaused(), then restore that value when finished pausing the display. |
acedUsrBrk |
Checks whether the user has pressed [Esc] to interrupt execution of the current external function.This function enables ARX applications that do long, complex operations to check for a user interrupt.The interactive ARX library functions, such as acedEntSel() or those in the user input (acedGetXxx()) group, check for [Esc] before they return to the ARX application (returning a status of RTCAN if [Esc] was pressed). Because of this, ARX applications don't need to call acedUsrBrk() unless they perform a lot of computation between requests for user input. Your application should call this function at strategic locations, such... more |
acedViewportIdFromNumber |
Returns the objectID that corresponds to the viewport number specified by nVpNum. This number is the same as that reported by the CVPORT AutoCAD system variable. For example, the Paper Space viewport is number 1.In tilemode the returned ID is obtained from a viewport table record. In layout mode it is obtained from a viewport entity.Returns null if no documents are open, or if the number does not correspond to a valid viewport. |
acedVPLayer |
This function modifies the viewport specified by vpId to freeze, thaw, or reset the layers specified by the object IDs in layerIds. If operation is AcDb::kFreeze, the specified layers will be frozen in the viewport. If operation is AcDb::kThaw, the specified layers will be thawed in the viewport. If operation is AcDb::Reset, the specified layers whose VPDFLT() method returns true will be frozen in the viewport and those whose VPDFLT() method returns false will be thawed in the viewport. |
acedVports |
Returns a pointer to a list of viewport descriptors for the current viewport configuration.Warning To avoid a memory leak, before calling acedVports(), set result to null to ensure that it does not point to allocated memory.If the AutoCAD TILEMODE system variable is set to 1 (on), the returned list describes the viewport configuration created with the AutoCAD VIEWPORTS command. The corners of the viewports are expressed in values between 0.0 and 1.0, with (0.0, 0.0) representing the lower-left corner of the display screen's graphics area, and (1.0, 1.0) representing the upper-right corner.Each viewport descriptor is a... more |
acedVports2VportTableRecords |
For the currently active drawing, this function copies the displayed viewport data over into the corresponding AcDbViewportTableRecords (those with the name "*ACTIVE"), creating or erasing "*ACTIVE" AcDbViewportTableRecords as necessary.Returns Acad::eOk if successful. Returns Acad::eNotApplicable when called while tilemode is 0. |
acedVportTableRecords2Vports |
For the currenlty active drawing, this function copies the data from the AcDbViewportTableRecords with the name "*ACTIVE" over into the corresponding displayed viewports creating or removing display viewports if necessary. This function will result in a regen in all viewports.Returns Acad::eOk if successful. Returns Acad::eNotApplicable when called while tilemode is 0. |
acedXformSS |
Applies a transformation matrix to the specified selection set. If genmat does not do uniform scaling, acedXformSS() returns RTERROR. To do uniform scaling, the elements in the scaling vector [Sx Sy Sz] must all be equal; in matrix notation, M00 = M11 = M22.Applying a transformation to a selection set is a means of scaling, rotating, or moving the entities in the selection set without using acedCommand(), acedCmd(), or acdbEntMod().If it succeeds, acedXformSS() returns RTNORM; otherwise, it returns RTERROR. When acedXformSS() fails, it sets the system variable ERRNO to a value... more |
acedXrefAttach |
Attaches an xref file to the database specified by pHostDb or the current document in the editor if pHostDb is null. Default behavior is as follows:- Insertion Point(X,Y,Z) = 0.0, 0.0, 0.0
- Scale Factor(X,Y,Z) = 1.0, 1.0, 1.0
- Rotation Angle(radians) = 0.0
Any of these default values can be overridden by providing appropriate values.This function provides document locking (if the current document is used as the host) and session fiber mode internally. If these conditions are not met, the function returns Acad::ErrorStatus eLockViolation. No input validation or range checking is done other than checking for null pointers or... more |
acedXrefBind |
Changes the bind type of the xref block by its given block name. This assumes a valid xref block exists in the database specified by pHostDb (or in the current document if pHostDb == NULL). This function operates on the database specified by pHostDb, or on the current document if pHostDb == NULL. It provides document locking (if current document is used as the host) and session fiber mode internally. If these conditions are not met, the function returns Acad::ErrorStatus eLockViolation. No input validation or range checking is done other than checking for NULL pointers or strings. Input validation... more |
acedXrefDetach |
Detaches the xref block by its given block name. This assumes a valid xref block exists in the database specified by pHostDb (or the current document if pHostDb == NULL).This function operates on the database specified by pHostDb, or on the current document if pHostDb == NULL. It provides document locking (if current document is used as the host) and session fiber mode internally. If these conditions are not met, the function returns Acad::ErrorStatus eLockViolation. No input validation or range checking is done other than checking for NULL pointers or strings. Input validation is the caller's responsibility.Xref... more |
acedXrefNotifyCheckFileChanged |
This function can be used to check whether an external reference file has been changed since it has been loaded into the host database. |
acedXrefOverlay |
Overlays an xref file on the database specified by pHostDb (or the current document if pHostDb is null). Default behavior is as follows: - Insertion Point(X,Y,Z) = 0.0, 0.0, 0.0
- Scale Factor(X,Y,Z) = 1.0, 1.0, 1.0
- Rotation Angle(radians) = 0.0
Any of these default values can be overridden by providing appropriate values.This function operates on the database specified by pHostDb, or on the current document if pHostDb is null. It provides document locking (if the current document is used as the host) and session fiber mode internally. If these conditions are not met, the function returns Acad::ErrorStatus eLockViolation.... more |
acedXrefResolve |
This function resolves existing xrefs in pHostDb. pHostDb must not point to an AcDbDatabase that is the primary database for a document in AutoCAD (i.e., it must not point to a database that is loaded in the AutoCAD editor). Returns Acad::eOk if successful. Returns Acad::eInvalidInput if pHostDb is null or if pHostDb is a pointer to the primary database for a document. |
acedXrefUnload |
Unloads the xref block by its given block name. This assumes a valid xref block exists in the database specified by pHostDb (or the current document if pHostDb == NULL).This function operates on the database specified by pHostDb, or on the current document if pHostDb == NULL. It provides document locking (if current document is used as the host) and session fiber mode internally. If these conditions are not met, the function returns Acad::ErrorStatus eLockViolation. No input validation or range checking is done other than checking for NULL pointers or strings. Input validation is the caller's responsibility.Xref... more |
acedXrefXBind |
This function binds the XREF table records whose object IDs are in symbolIds. This is the same as the XBIND command in AutoCAD. symbolIds may contain IDs for the following symbol table record types: AcDbBlockTableRecord, AcDbLayerTableRecord, AcDbLinetypeTableRecord, AcDbTextStyleTableRecord (if it does not represent a shape file), AcDbRegAppTableRecord, and AcDbDimStyleTableRecord. This function returns Acad::eOk if successful, Acad::eInvalidInput if symbolIds is empty, or Acad::eWrongObjectType if any of the IDs in symbolIds refer to objects of an inappropriate type. |