AcUt Global Functions

Description

Defines global functions specific to AcUt classes.

Functions

Function	Description
acutAngle	Finds the angle between a line and the current X axis.Returns the angle of the line in radians. The acutAngle() function measures the angle from the X axis of the current User Coordinate System (UCS), with the angle increasing in the counterclockwise direction.This function treats pt1 and pt2 as two-dimensional points. It ignores their Z coordinates, in effect projecting the line onto the current construction plane.
acutAssertMessage	This function uses the Win32 message box to display a message on the screen containing the condition string, file name, line number, and optional status message. In addition to the message on the screen, this function records the condition, file name, line number, and status message to a file whose name is derived from the invoking application or DLL's file name with an appended ".err" extension. The file resides in the same directory as the application or DLL.The message is displayed on screen in a task-modal dialog with buttons for abort, retry, and ignore. Pressing abort will call the... more
acutBuildList	Builds a a linked list of result buffers from individual data items by allocating result buffers, assigning them the values specified by the acutBuildList() arguments, and linking the buffers together. The acutBuildList() function has a variable-length argument list. Most arguments to acutBuildList() are treated as pairs. The first of each pair identifies the type of the argument that follows, and the second contains the actual data. The exceptions are RTLB, RTLE, RTDOTE, and the -3 that is used to indicate the start of xdata. The type code (rtype) arguments must be result type codes as defined in adscodes.h... more
acutCopyAdsResultStr	Takes an ADS return code, such as RTNORM or RTERROR, which was presumably returned by another acedXXX() call. (See adscodes.h for ADS return codes RT*.)Copies the input string into the dest buffer if it fits nSizeDest is length of dest buffer in widecharsIf not enough room for entire string plus null terminator, then the string is truncated and ADS_RTINPUTTRUNCATED is returned.Note: For internal use by deprecated ACHAR-based functions.
acutCvUnit	Translates one unit of measure to another.If acutCvUnit cannot find either oldunit or newunit, it fails. It also will not convert incompatible unit systems, such as inches to years.On success returns RTNORM, otherwise returns RTERROR.
acutDelBuffer	This function is identical to acutDelString().
acutDistance	Returns the distance between 2 points. The points can be three-dimensional points.
acutIsAlNum	Verifies that the specified character is alphanumeric.Returns TRUE if the character is an alphanumeric character (a letter or a digit); otherwise, it returns FALSE.Note This function now works with whatever operating system character code page AutoCAD is using, and is therefore significantly slower than the corresponding standard C/C++ runtime library function.
acutIsAlpha	Verifies that the specified character is alphabetic.Returns TRUE if the character is an alphabetic character; otherwise, it returns FALSE.Note This function now works with whatever operating system character code page AutoCAD is using, and is therefore significantly slower than the corresponding standard C/C++ runtime library function.
acutIsCntrl	Verifies that the specified character is a control character.Returns TRUE if the character is a control character; otherwise, it returns FALSE.Note This function now works with whatever operating system character code page AutoCAD is using, and is therefore significantly slower than the corresponding standard C/C++ runtime library function.
acutIsDigit	Verifies that the specified character is a digit.Returns TRUE if the character is a digit (0-9); otherwise, it returns FALSE.Note This function now works with whatever operating system character code page AutoCAD is using, and is therefore significantly slower than the corresponding standard C/C++ runtime library function.
acutIsGraph	Verifies that the specified character is a graphical character.Returns TRUE if the character is a graphical character; otherwise, it returns FALSE.Note This function now works with whatever operating system character code page AutoCAD is using, and is therefore significantly slower than the corresponding standard C/C++ runtime library function.
acutIsLower	Verifies that the specified character is a lowercase character.Returns TRUE if the character is a lowercase character; otherwise, it returns FALSE.Note This function now works with whatever operating system character code page AutoCAD is using, and is therefore significantly slower than the corresponding standard C/C++ runtime library function.
acutIsPrint	Verifies that the specified character is a printable character.Returns TRUE if the character is printable; otherwise, it returns FALSE.Note This function now works with whatever operating system character code page AutoCAD is using, and is therefore significantly slower than the corresponding standard C/C++ runtime library function.
acutIsPunct	Verifies that the specified character is a punctuation character.Returns TRUE if the character is a punctuation character; otherwise, it returns FALSE.Note This function now works with whatever operating system character code page AutoCAD is using, and is therefore significantly slower than the corresponding standard C/C++ runtime library function.
acutIsSpace	Verifies that the specified character is a white-space character.Returns TRUE if the character is a white-space character (including space, tab, newline, carriage return, and form-feed characters); otherwise, it returns FALSE.Note This function now works with whatever operating system character code page AutoCAD is using, and is therefore significantly slower than the corresponding standard C/C++ runtime library function.
acutIsUpper	Verifies that the specified character is an uppercase character.Returns TRUE if the character is an uppercase character; otherwise, it returns FALSE.Note This function now works with whatever operating system character code page AutoCAD is using, and is therefore significantly slower than the corresponding standard C/C++ runtime library function.
acutIsXDigit	Verifies that the specified character is a hexadecimal digit.Returns TRUE if the character is a hexadecimal digit (0-9 or A-F); otherwise, it returns FALSE.Note This function now works with whatever operating system character code page AutoCAD is using, and is therefore significantly slower than the corresponding standard C/C++ runtime library function.
acutNewBuffer	This function allocates size bytes of memory and sets pOutput to point to the memory allocated. Any memory currently pointed to by pOutput will be lost. Returns Acad::eOk if the allocation is successful; otherwise, returns Acad::eOutOfMemory.
acutNewRb	Allocates a new result buffer and returns a pointer to it.If v is not valid, acutNewRb() still returns a pointer, but a subsequent call to acutRelRb() may not release the correct amount of memory.Note An ARX application is responsible for releasing the memory it allocates. All result buffers allocated by acutNewRb() should be released by matching calls to acutRelRb().
acutNewString	Allocates a new string of length specified by nNumChars.
acutNewString	Deprecated. Makes a copy of the pInput string and sets pOutput to point to the resulting copy. Any memory currently pointed to by pOutput will be lost.Returns Acad::eOk if successful. If the memory allocation for the string copy fails, returns Acad::eOutOfMemory.
acutPolar	Finds a point by means of polar coordinates.
acutPrintf	Displays a message on the AutoCAD text screen. This function is identical to the standard C library function printf(), except that acutPrintf() writes to the host application rather than the standard output stream stdout and also supports the ObjectARX/ObjectDBX-specific q conversion specifier. The q specifier allows conversion of doubles based on the current LUNITS/LUPREC, ALTUNIT/ALTPREC, or AUNITS/AUPREC system variables.In addition, the order in which arguments appear in the formatted string can be different from the order in which the arguments are passed to the function. The sequence is specified using a number followed by the dollar sign. For... more
acutRelRb	Releases the memory allocated to the specified result buffer, to all result buffers that follow it in its linked list, and to any memory allocated to string values in those result buffers.The acutRelRb() function is the complement of acutNewRb(), but your application should call acutRelRb() to also release memory that is automatically allocated by several other ARX library functions, including the acutBuildList(), acdbEntGet(), acdbEntGetX(), acedGetSym(), acedNEntSelP(), acedNEntSel(), acdbTblNext(), and acdbTblSearch() functions.If acutRelRb() succeeds, it returns RTNORM; otherwise, it returns an error code.
acutSplitString	If the string contains the delimiter and a non-empty string lies to the left of the delimiter, numLeftBytes contains the number of bytes that this string occupies to the left of the delimiter. This value includes any trail bytes of multi-byte characters. If the function returns true and this value is non-zero, then the non-empty string that lies to the left of the delimiter extends from the beginning of the string up to byte numLeftBytes - 1, that is, source[0] through source[numLeftBytes - 1]. If this value is zero, then the string either doesn't contain the delimiter or... more
acutSPrintf	Writes a string to a preallocated string buffer in the specified format.This function is identical to the standard C library function sprintf(), except that acutSPrintf() supports the ObjectARX/ObjectDBX-specific q conversion specifier. This permits conversion of doubles based on the current units format system variables: LUNITS/LUPREC, ALTUNITS/ALTPREC, or AUNITS/AUPREC.In addition, the order in which arguments appear in the formatted string can be different from the order in which the arguments are passed to the function. The sequence is specified using a number followed by the dollar sign. For example, "2$" indicates the second argument.On success, acutSPrintf() returns... more
acutToLower	Converts the specified character to lowercase.If the character is lowercase, acutToLower() returns it the way it isNote This function now works with whatever operating system character code page AutoCAD is using, and is therefore significantly slower than the corresponding standard C/C++ runtime library function.
acutToUpper	Converts the specified character to uppercase.If the character is uppercase, acutToUpper() returns it the way it is.Note This function now works with whatever operating system character code page AutoCAD is using, and is therefore significantly slower than the corresponding standard C/C++ runtime library function.
acutUpdString	This function makes a copy of the pInput string and sets pOutput to point to the resulting copy. If pOutput is currently pointing to any allocated memory, then that memory is deallocated even if pInput is NULL.Returns Acad::eOk if successful. If the memory allocation for the string copy fails, returns Acad::eOutOfMemory.
acutVSPrintf	Returns the number of characters put into the buffer, or -1 if there is an error, same as acutSPrintf().
acutWcMatch	Attempts to match a wild-card pattern to a string.The acutWcMatch() function returns RTNORM if the string matches the pattern, and RTERROR if it does not.Alphanumeric characters in the pattern are treated literally. If characters are enclosed in brackets, acutWcMatch() matches a single character (for example, [fo] matches the letter foro). Within brackets, you can use a hyphen (-) to specify a range of letters or digits (for example, [A-D] matches A, B, C, or D). A leading tilde (~) negates the characters; that is, acutWcMatch() reports a... more
acutWcMatchEx	This function is an updated version of acutWcMatch(). It returns true if there is a match and false if there is no match. You can specify if the wildcard matching should be ignore the case of alphabetic characters.string is the string with which to perform the match. If the pointer is NULL, false is returned.The wildcard pattern to use for pattern matching is specified with pattern. Refer to the documentation for acutWcMatch() for details of the wildcard characters. If the pointer is NULL, false is returned.If ignoreCase is true, then the case... more

Topics