Miscellaneous Global Functions

Description

Defines global functions specific to miscellaneous classes.

Functions

Function	Description
acad__assert	This function will convert the expression argument into C source code and evaluate it. If it results in a false value, then a standard assert dialog will be displayed with the expression string shown to the right of "Failed:", the fileName string will be displayed to the right of "File:", and the lineNumber will be displayed to the right of "Line:".
acad__msize	Returns the size in bytes of the buffer that p points to. The buffer can be returned from acad_malloc(), from AutoCAD, or from another ARX application that obtained the buffer from either AutoCAD or a call to acad_malloc().
acad__strdup	This function allocates enough memory to hold a copy of string p, and then copies p (including the string terminator) into the newly-allocated memory.Returns a pointer to the string copy if successful. Otherwise, returns null.
acad_calloc	Allocates and initializes a region of memory for an array of num elements, which are of size size. Returns a pointer to the first element of the region.
acad_free	Deallocates a region of memory previously allocated by the acad_malloc, acad_realloc, or acad_calloc functions.Releases memory pointed to by p. The memory was either allocated by a call to acad_malloc(), acad_realloc(), or acad_calloc() and returned to the application from AutoCAD, or returned by another ObjectARX application, which obtained the buffer either from AutoCAD or from a call to a memory allocation function.
acad_malloc	Allocates a region of memory large enough to hold an object whose size is returned by acad_msize().Allocates at least size bytes of memory and returns a pointer to it. If memory cannot be allocated, a null pointer is returned.
acad_realloc	These general-purpose memory allocation functions are deprecated in favor of the memory management functions declared in dbmem.h.Takes a pointer to a memory region previously allocated by one of the standard functions and changes its size while preserving its contents.If the function succeeds, it returns a pointer to the memory region, which might be new. Returns a null pointer if the function fails.If the p argument is null, the function behaves like acad_malloc(). If p is not null and size is 0, acad_realloc() returns a null pointer and the old region is deallocated.If the region's... more
acadErrorStatusText	This function will return look up, and return a copy of, the error string associated with errno. For example:acadErrorStatusText(Acad::eOpenForWrite);will return the string eOpenForWrite.This function is most useful as part of acutPrintf() or message dialogs that are part of an error handling routine in an ObjectARX program.
AcArrayValidateParams	Helper function for asserting that the copy/move params are valid.
acByteSwap	This utility function swaps the high order and low order bytes of a wide charater.
acdbGetGeoDataTransform	Insertion method.
acdbGetObjectMesh	Tessellate existing solid or surface object to mesh data using the given faceter settings. The mesh data include the vertex array, face list array and face data.
acDocManagerPtr	Returns a pointer to the AcApDocManager object.
AcFStream_curLocale	Returns the locale for the current file stream.
AcGlobAddDMMReactor	Clients should call this global function to add a DWF Metadata Manager (DMM) reactor.The AcDMMReactorManager, which is required to support these reactors, exists only when AcPublish is running. The recommended practice is to call this function in AcPublishReactor::OnAboutToBeginPublishing() and remove the DMM reactors in both OnEndPublish() and OncanceledOrFailedPublishing(). AcEPlotX must also be loaded because that is where the AcDMMReactorManager is implemented.
AcGlobAddPublishReactor	Clients should call this global function to add a publish reactor.
AcGlobAddPublishUIReactor	Clients should call this global function to add a publish UI reactor.
AcGlobRemoveDMMReactor	Clients should call this global function to remove a DWF Metadata Manager (DMM) reactor.
AcGlobRemovePublishReactor	Clients should call this global function to remove a publish reactor.
AcGlobRemovePublishUIReactor	Clients should call this global function to remove a publish UI reactor.
acIsStackAddress	Checks if the input address is from the stack.
acProfileManagerPtr	Use this function to access the AutoCAD Profile Manager.
acReadAnsiCharFromCFile	This function reads an ANSI character from pCFile, and returns it in wch.Note If pCFile has been opened as a text file, then 'r' is automatically converted to 'n', but if pCFile is opened as a binary file there is no such automatic conversion.
acReadCIFFromCFile	This function reads in a CIF sequence characted from pCFile.
acReadUtf16CharFromCFile	This function allows reading of a single character out of a given CFile.
acReadUtf8CharFromCFile	This function reads in a UTF-8 encoded character from pCFile.Note UTF-8 encodes a single character in 1 to 4 bytes. The following bit patterns in the first byte determine the length of bytes that a particular character was encoded in:
acreEntityToFaces	This function provides a faceted approximation of the entities in the selection set passed in by ss.The caller receives the faceted data through an AcReCallout object (registered with a previous call to acreRegisterCallout()). Optionally, this function creates a temporary file with the facet information. In this case, the name of the temporary file is returned in *name.If no AcReCallout object was registered with a previous call to acreRegisterCallout(), this function will generate only the temporary file with the facet information.If normal is nonzero, the facet's normal vectors are also generated. If normal is... more
acreRegisterCallout	This function registers an AcReCallout object for the function acreEntityToFaces(). A later call to acreEntityToFaces() will result in calls to certain member functions of the imp object. See the AcReCallout class documentation for more information.You can pass a NULL pointer for imp to unregister a previously registered AcReCallout object, or to force acreEntityToFaces() to write the facet information to a temporary file.Only one AcReCallout object can be registered. A later call to acreRegisterCallout() with another AcReCallout object will unregister any previously registered AcReCallout object.Returns 1 if imp is not NULL, and returns 0 if imp... more
AcStrToIntPtr	Provides a polymophic function to parse INT_PTR string
acTransactionManagerPtr	This function returns a pointer to the transaction manager for the current document in AutoCAD. This function is only available in AutoCAD, not in RealDWG.actrTransactionManager is not actually a function and is instead a #define in the header actrans.h:#define actrTransactionManager acTransactionManagerPtr()The acTransactionManagerPtr() function is an inline global function that is also defined in the actrans.h header file.
acutDelBuffer	This function is designed to be used on memory allocated via acutNewString(), acutNewBuffer(), and acutUpdString(). It deallocates the memory pointed to by pString and sets pString to NULL.
acWriteWCharToCFile	This function writes a wide character to a file.
applyCurDwgLayerTableChanges	This function will force AutoCAD to update itself to use any changes made to any layer table records in the drawing currently in the AutoCAD editor.This function requires that the AcDbLayerTable and all the AcDbLayerTableRecords within it be able to be opened for read. If this is not possible, then the function will return without updating the AutoCAD editor.Returns Acad::eOk if successful; otherwise, returns whatever ErrorStatus value was returned from the unsuccessful attempt to open the layer table or layer table record.
asDblArray	This inline function returns vec as an array of two doubles.
asDblArray	This inline function returns vec as an array of three doubles.
asDblArray	This inline function returns pnt as an array of three doubles.
asDblArray	This inline function returns pnt as an array of two doubles.
asPnt2d	This inline function returns the pnt array of two doubles as an AcGePoint2d object.
asPnt3d	This inline function returns the pnt array of three doubles as an AcGePoint3d object.
asVec2d	This inline function returns the vec array of two doubles as an AcGeVector2d object.
asVec3d	This inline function returns the vec array of three doubles as an AcGeVector3d object.
createGradientThumbnailEngine	Returns a pointer to the CAcGradientThumbnailEngine object.
delString	This function is obsolete and will be removed in a future release of ObjectARX. It exists in header acutmigr.h to help migrate existing uses of this function. Please use function acutDelString instead.
duplicateSelectionsAllowed	Returns true if pDoc is non-NULL and duplicate selections are allowed for the document to which it points. Otherwise, returns false.
getAdHostImageAppServices	Gives access to the global object that implements the AdHostImageAppServices interface.If successful, returns a pointer to the AdHostImageAppServices interface. Returns NULL if failed.
getDefaultGlobals	Returns the default AcDbGlobals object. This object is always present, regardless of whether any AcApDocuments or AcDbDatabases exist.
GetSystemVirtualScreen	For internal use only.
isValidCodePageId	This function returns true if value is within the valid range of values for the code_page_id enumerated type.
modelToPixel	Translates from model to pixel coordinates. The transform can be obtained by inverting the entity's pixelToModel matrix.
modelToPixel	Projects modPt along the viewDir direction onto plane, and then translates its model coordinates to pixel coordinates.
newString	This function is obsolete and will be removed in a future release of ObjectARX. It exists in header acutmigr.h to help migrate existing uses of this function. Please use function acutNewString() instead.
pixelToModel	Translates from pixel to model coordinates.
setAllowDuplicateSelection	This function allows and disallows duplicate entities in selection sets. If flag is true, a reference counter is incremented that, when non-zero, enables duplicate selection. If flag is false, the counter is decremented.This setting impacts the PICKFIRST selection set, the PREVIOUS selection set, and AutoCAD commands that acquire selection sets from the user.An application that enables duplicate selections is responsible for removing duplicate entries in the AcEdSSGetFilter::endSSGet() notification if the current command cannot handle duplicate entries.Returns Acad::eOk if successful.Returns Acad::eInvalidContext if flag is false and duplicate selection is already disabled.Returns Acad::eInvalidInput if pDoc is NULL.... more
ucsNormalVector	Returns a vector indicating the Z-axis direction of the current UCS. The vector is the normal to the X and Y axes.
ucsXDir	Returns the X-axis direction of the current UCS.
ucsYDir	Returns the Y-axis direction of the current UCS.
updString	This function is obsolete and will be removed in a future release of ObjectARX. It exists in header acutmigr.h to help migrate existing uses of this function. Please use function acutUpdString() instead.

Topics