Autodesk ObjectARX

https://help.autodesk.com/view/OARX/2024/ENU/
Admin
This documentation provides comprehensive guides, references, and tutorials for developers to...
Tokens:16,192,459
Snippets:176,714
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example Script for Startup Setup

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-5510017F-4656-478F-BD4C-AB6B1998BF55

This script can be used to automate initial drawing settings like grid, linetype scale, and layer properties when the application starts.

```script
grid on 
ltscale 3.0 
layer set 0 color red 0
```

--------------------------------

### Example msiexec.exe Usage for Stock Tool Installation

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-AcTcStockTool__SetModuleInstallArguments_LPCTSTR

Illustrates how msiexec.exe is used with the module install URL and arguments for stock tool installation, showing examples for both MSI and MSP files.

```text
Msiexec.exe /i <url> <Arguments>
Msiexec.exe /i http:_//pointa.autodesk.com/tools.msi /l* msi.log_
Msiexec.exe /p http:_//pointa.autodesk.com/tools.msp /l* msi.log_
```

--------------------------------

### Get or Set PointCloudItem GUID (C#)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_DatabaseServices_PointCloudItem_Guid

Use this property to get or set the GUID of a PointCloudItem. It is a read/write property.

```csharp
public string Guid;
```

--------------------------------

### Setup Basic Web Light

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-6A42AEEC-A62A-411A-96B5-F0B07495ABE6

Use this code to initialize and configure a web light. Ensure you have the correct path to the IES web file and valid vector/point data.

```cpp
// To setup a web light
AcDbLight webLight;
webLight.setLightType(AcGiDrawable::kwebLight);
webLight.setWebFile(web file path);
webLight.setWebRotation(AcGeVector3d(x,y,z));
webLight.setWebflux(value);
webLight.setTargetlocation(AcGepoint3d(0,0,0));
```

--------------------------------

### Get or Set PointCloudItem GUID (Visual Basic)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_DatabaseServices_PointCloudItem_Guid

Use this property to get or set the GUID of a PointCloudItem. It is a read/write property.

```vb
Public Property Guid() As string
```

--------------------------------

### StartRecording Method

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_EditorInput_LivePreview_StartRecording

Initiates the live preview recording process.

```APIDOC
## StartRecording Method

### Description
This method starts the live preview recording.

### Method Signature
#### Visual Basic
```vb.net
Public Function StartRecording() As void
```

#### C#
```csharp
public void StartRecording();
```

### Remarks
This method is a member of the `LivePreview` class.
```

--------------------------------

### Combine functions using defun-q-list-set and defun-q-list-ref

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-CDA30337-9889-4D33-9461-503F307D1360

This example combines the 's::startup' function with the 'my-startup' function (excluding its first element) into a single function named 's::startup' using 'defun-q-list-set'.

```lisp
(defun-q-list-set 's::startup (append
   (defun-q-list-ref 's::startup)
   (cdr (defun-q-list-ref 'my-startup))))
```

--------------------------------

### Setup a Simple Point Light

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-E71F182A-2717-4672-B78A-6CDD7B099860

Use this code to initialize and configure a basic point light. Ensure the AcGiDrawable::kPointLight type is set and specify the light's position.

```cpp
// To setup a point light
AcDbLight pointLight;
pointLight.setLightType(AcGiDrawable::kPointLight);
pointLight.setPosition(AcGePoint3d(0,0,5));
```

--------------------------------

### Get Polyline Start Width at Index (C#)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_DatabaseServices_Polyline_GetStartWidthAt_int

Use this method in C# to get the start width of a polyline at a specific vertex. The index is 0-based.

```C#
public double GetStartWidthAt(
    int index
);
```

--------------------------------

### Get or Set Polar Array Start Angle (C#)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_DatabaseServices_AssocArrayPolarParameters_StartAngle

Use this property to get or set the starting angle for a polar array in degrees. This is a read/write property.

```csharp
public double StartAngle;
```

--------------------------------

### VB.NET Example for PlugIn_Start Method

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-150D5213-1015-4361-AB6B-6683362F9AB7

This example demonstrates how to implement the PlugIn_Start method in VB.NET to handle objects that do not match DWS file standards, either starting from a specific error or the beginning of the context list.

```VB.NET
Public Sub PlugIn_Start(ByVal pStartError As AcStError) _
                        Implements IAcStPlugin2.Start

    ' pStartError is not an actual programming error that needs to be handled,
    ' but a reference to an object that does not match the standards
    ' in the DWS file.

    ' If pStartError is an object, checking should start
    ' from that error, not the beginning of the current context.
    If IsNothing(pStartError) = False Then

        ' Get the ObjectId of the first object to check
        Dim badId As Long = pStartError.BadObjectId

        ' Find the index for ObjectId in the context list stored in m_objIDArray
        For m_curIndex = 0 To m_ContextList.Count - 1
            If m_ContextList.Item(m_curIndex) = badId Then
                m_curIndex = m_curIndex - 1
                PlugIn_Next()
            End If
        Next
    Else
        ' A valid AcStError object was not passed to the method.
        ' Checking should start at the beginning of the context list.
        m_curIndex = -1
        PlugIn_Next()
    End If
End Sub
```

--------------------------------

### C# Example for PlugIn_Start Method

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-150D5213-1015-4361-AB6B-6683362F9AB7

This C# example shows the implementation of the PlugIn_Start method for handling non-compliant objects, allowing error checking to begin from a specific error or the start of the context list.

```C#
public void PlugIn_Start(AcStError pStartError)
{
    // pStartError is not an actual programming error that needs to be handled,
    // but a reference to an object that does not match the standards
    // in the DWS file.

    // If pStartError is an object, checking should start
    // from that error, not the beginning of the current context.
    if ((pStartError == null) == false)
    {
        // Get the ObjectId of the first object to check
        long badId = pStartError.BadObjectId;

        // Find the index for ObjectId in the context list stored in m_objIDArray
        for (m_curIndex = 0; m_curIndex <= m_ContextList.Count - 1; m_curIndex++)
        {
            if (Convert.ToInt64(m_ContextList.GetItem(m_curIndex)) == badId)
            {
                m_curIndex = m_curIndex - 1;
                PlugIn_Next();
            }
        }
    }
    else
    {
        // A valid AcStError object was not passed to the method.
        // Checking should start at the beginning of the context list.
        m_curIndex = -1;
        PlugIn_Next();
    }
}

void IAcStPlugin2.Start(AcStError pStartError)
{
    PlugIn_Start(pStartError);
}
```

--------------------------------

### Get or Set Polar Array Start Angle (Visual Basic)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_DatabaseServices_AssocArrayPolarParameters_StartAngle

Use this property to get or set the starting angle for a polar array in degrees. This is a read/write property.

```vb
Public Property StartAngle() As double
```

--------------------------------

### Render Preview Window Example

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-IAcDcContentView__RenderPreviewWindow__in-_string__BSTR__in__VARIANT

This C++ example demonstrates how to render an icon in the DesignCenter preview window. It retrieves the window handle, gets its client rectangle to determine dimensions, and draws an icon. Error checking is omitted for brevity. Components should ideally render the item visual to match the provided width and height.

```cpp
STDMETHODIMP
    AcDcComponent::RenderPreviewWindow(BSTR bstrFullPath
                                       , VARIANT varhPreviewWindow)
    {
        CString strFullPath = bstrFullPath;

        _// unmarshall the data..._
        HWND hPreviewWnd = (HWND)varhPreviewWindow.lVal;

        CWnd *pWnd = CWnd::FromHandle(hPreviewWnd);
        CRect rcClient;
        pWnd->GetClientRect(&rcClient);

        int nWidth = rect.right - rect.left;
        int nHeight = rect.bottom - rect.top;
        if(0 == nWidth || 0 == nHeight)
            return S_OK;    _// we don't have any client area to render on_

        _//_
        _// in the following example, we simply draw one of the icons we have created_
        _// in our image list(32x32); we ignore nWidth and nHeight. However,_
        _// components are recommended to render the item visual of size nWidth wide_
        _// and nHeight high._
        _//_
        HICON hIcon = m_pLargeImageList->ExtractIcon(0);

        _// get a device context_
        CDC *pDC = pWnd->GetDC ();
        pDC->DrawIcon((rcClient.Width() - 32) / 2
                    , (rcClient.Height() - 32) / 2
                    , hIcon);   
        pWnd->ReleaseDC (pDC);

        return S_OK;
    } _// AcDcComponent::RenderPreviewWindow_
```

--------------------------------

### Get Polyline Start Width at Index (Visual Basic)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_DatabaseServices_Polyline_GetStartWidthAt_int

Use this method in Visual Basic to get the start width of a polyline at a specific vertex. The index is 0-based.

```Visual Basic
Public Function GetStartWidthAt(
    index As Integer
) As double
```

--------------------------------

### Setup a Basic Spot Light

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-1183F8CD-E2EB-45B5-A562-FFC2ED175679

This code snippet demonstrates how to initialize and configure a basic spot light, setting its type, position, hotspot and falloff angles, and target location.

```cpp
// To setup a spot light
AcDbLight spotLight;
spotLight.setLightType(AcGiDrawable::kSpotLight);
spotLight.setPosition(AcGePoint3d(0,0,5));
spotLight.setHotspotAndFalloff(40,150);
spotLight.setTargetLocation(AcGePoint3d(0,0,0));
```

--------------------------------

### Example Usage of GeomapImage.ImageHeight

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_DatabaseServices_GeomapImage_ImageHeight

Demonstrates how to get the GeomapImage.ImageHeight property in an example. This property is read-only.

```csharp
double height = GeomapImage.ImageHeight;
```

--------------------------------

### Get Leader Start Point (C++)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-AcDbLeader__firstVertex

Returns the leader's start point in WCS coordinates. This will be the start of the arrowhead if enabled.

```cpp
virtual AcGePoint3d firstVertex() const;
```

--------------------------------

### StartRecording Method in C#

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_EditorInput_LivePreview_StartRecording

Use this method to start live preview recording in C#. It returns void.

```csharp
public void StartRecording();
```

--------------------------------

### Example Registration Command

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-84671562-3ADA-4B0A-871E-C38DDE0D8DF3

An example of registering a specific DLL and creating a REG file. This command registers 'MyLayersPlugin.dll' and creates 'MyLayersPlugin.reg'.

```batch
"C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\RegAsm.exe" /codebase /regfile:"C:\CAD Plug-ins\MyLayersPlugin.reg" "C:\CAD Plug-ins\MyLayersPlugin.dll"
```

--------------------------------

### Get Point Cloud Item GUID (C++)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-AcPointCloudItem__guid_const

Retrieves the GUID of a point cloud item. The default value for the GUID is an empty string.

```cpp
const AcString& guid() const;
```

--------------------------------

### AcDbTextEditorParagraph::startOfText

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-AcDbTextEditorParagraph__startOfText

Gets the location of the start of a selection. Returns an AcDbTextEditorLocation object for the start of a selection.

```APIDOC
## AcDbTextEditorParagraph::startOfText

### Description
Gets the location of the start of a selection.

### Returns
Returns an AcDbTextEditorLocation object for the start of a selection.

### C++ Signature
```cpp
ACDBCORE2D_PORT AcDbTextEditorLocation* startOfText() override;
```
```

--------------------------------

### C++ Example: Initializing Dialog Controls with SetControlProperty

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-CAdUiDialog__SetControlProperty_PDLGCTLINFO_DWORD

Demonstrates how to define a DLGCTLINFO table and use SetControlProperty within OnInitDialog to manage control resizing and movement. This example shows various combinations of flags like ELASTICXY, MOVEX, MOVEY, and MOVEXY.

```cpp
static DLGCTLINFO  dcMenuGroup[] = {
    {IDC_STATIC1, ELASTICXY, 100},
    {IDC_LIST_MLOAD, ELASTICXY, 100},
    {IDC_GRP_UNLOAD, MOVEX, 100 },
    {IDC_EDIT_MLOAD, ELASTICX|MOVEY, 100},
    {IDC_GRP_REP_ALL, MOVEXY, 100},
    {IDC_MENU_LOAD, MOVEXY, 100},
    {IDC_GRP_BROWSE, MOVEXY, 100},
    {IDC_STATIC2, MOVEY, 100},
    {IDC_STATIC3, ELASTICX | MOVEY, 100},
};
void CAsdkDialog::OnInitDialog ()
{
    SetDialogName('Asdk:SampleDialog');
    CAdUiDialog::OnInitDialog();
    _// .... other stuff_
    SetControlProperty (&dcDlgCtls, sizeof(dcDlgCtls)/sizeof(DLGCTLINFO));
    _// .... other stuff_
    return TRUE;
}
```

--------------------------------

### Define a startup function using defun-q

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-CDA30337-9889-4D33-9461-503F307D1360

This snippet defines a function 's::startup' that prints its argument.

```lisp
(defun-q s::startup (x) (print x))
```

--------------------------------

### AcDbTextEditorColumn::startOfText

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-AcDbTextEditorColumn__startOfText

Gets the start location for the column. Returns an AcDbTextEditorLocation object for the start of a column.

```APIDOC
## AcDbTextEditorColumn::startOfText

### Description
Gets the start location for the column.

### Returns
Returns an AcDbTextEditorLocation object for the start of a column.
```

--------------------------------

### Get CircularArc2d StartPoint in C#

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_Geometry_CircularArc2d_StartPoint

Use this property to get the starting point of the arc. This property is read-only.

```C#
public Point2d StartPoint;
```

--------------------------------

### (startapp _appcmd file_)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-E2B683FE-43FB-4F5D-A9AE-809772FE8D3B

Starts a Windows application.

```APIDOC
## (startapp _appcmd file_)

### Description
Starts a Windows application.

### Parameters
- `_appcmd` - The command to execute.
- `file` - The file to open with the application.

### Platforms
- Windows: ✓
- Mac OS: ✓
```

--------------------------------

### Get Helix Start Point (C++)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-AcDbHelix__startPoint

Returns the start point of the helix. This is a const member function.

```cpp
virtual AcGePoint3d startPoint() const;
```

--------------------------------

### Initialize User Input with Keywords (Visual LISP)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-B03BCD05-F925-4FD2-B131-BD7DCF3FA06C

This Visual LISP example shows how to set up keywords ('Line', 'Circle') with InitializeUserInput for user input. It prompts for a point and can return either the point's coordinates or a recognized keyword. The code uses error handling to distinguish between keyword input and other input types.

```visual-lisp
(vl-load-com)
(defun c:Example_InitializeUserInput()
    ;; This example prompts for user input of a point. By using the
    ;; InitializeUserInput method to define a keyword list, it can also
    ;; return keywords entered by the user.
    (setq acadObj (vlax-get-acad-object))
    (setq doc (vla-get-ActiveDocument acadObj))
    
    ;; Define the valid keywords
    (setq keywordList "Line Circle")
    
    ;; Call InitializeUserInput to set up the keywords
    (vla-InitializeUserInput (vla-get-Utility doc) 128 keywordList)
    
    ;; Get the user input
    (setq returnPntOrErr (vl-catch-all-apply 'vla-GetPoint (list (vla-get-Utility doc) nil "Enter a point [Line/Circle]: ")))

    (if (= (type returnPntOrErr)'VL-CATCH-ALL-APPLY-ERROR)
        (progn
            (if (= (vl-catch-all-error-message returnPntOrErr) "Automation Error. User input is a keyword")
	        (progn
                    (setq inputString (vla-GetInput (vla-get-Utility doc)))
                    (alert (strcat "You entered the keyword: " inputString))
		)
                (alert "User pressed ESC or unknown input was provided.")
	    )
        )
        ;; Display point coordinates
        (progn
	    (setq returnPnt (vlax-safearray->list (vlax-variant-value returnPntOrErr)))
            (alert (strcat "The WCS of the point is: " (rtos (nth 0 returnPnt) 2) ", " (rtos (nth 1 returnPnt) 2) ", " (rtos (nth 2 returnPnt) 2)))
	)
    )
)
```

--------------------------------

### Get Start Parameter (AutoLISP/ActiveX)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-4684C76F-02F7-4989-AA53-C886E528350A

Returns the start parameter value on the curve. Available on AutoCAD for Windows.

```AutoLISP
(vlax-curve-getStartParam _curve-obj_)
```

--------------------------------

### Create Environment Variables

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-3C25E517-8660-4BB7-9447-2310462EF06F

Example demonstrating the creation of two environment variables, one for a number and one for a string.

```xml
<EnvironmentVariables>
    <EnvironmentVariable
        Name="MYNUMVAR"
        Value="123"
    />

    <EnvironmentVariable
        Name="MYSTRVAR"
        Value="Example"
    />
</EnvironmentVariables>
```

--------------------------------

### Get Current Milliseconds

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-EF8856E5-DB58-4EFC-B223-AB8B8A25F240

Demonstrates how to get the current value of the MILLISECS system variable to mark a start time.

```autolisp
Command: (setq start (getvar "MILLISECS"))
25494432

Command: (setq end (getvar "MILLISECS"))
25499471

Command: (- end start)
5039
```

--------------------------------

### AcDbTextEditor::startOfText

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-AcDbTextEditor__startOfText

Gets the start location for the text editor. Returns an AcDbTextEditorLocation object for the start of the text editor.

```APIDOC
## AcDbTextEditor::startOfText

### Description
Gets the start location for the text editor.

### Returns
Returns an AcDbTextEditorLocation object for the start of the text editor.

### C++ Signature
```cpp
ACDBCORE2D_PORT AcDbTextEditorLocation* startOfText() override;
```
```

--------------------------------

### Comprehensive Example

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-AcDbSmartObjectPointer

A complete example demonstrating the usage of AcDbSmartObjectPointer for opening, accessing, and managing an object's lifetime.

```APIDOC
## Comprehensive Example

This function demonstrates the typical usage pattern for `AcDbSmartObjectPointer`.

```cpp
void demoFunction(AcDbObjectId id, AcDb::OpenMode mode, bool openErased) {
    // Declare the pointer, then use it as an instance of AcDbObject
    AcDbObjectPointer<AcDbEntity> sop(id, mode, true);
    if (eOk == (sop.openStatus())) {
        // Now, object() returns the object associated with id
        // if openStatus() is eOk, then the object() should be non-null
        assert(sop.object() != 0);
        assert(sop->isKindOf(AcDbEntity::desc()));
        // make read/write/notify calls on the object as desired.
    }
    // sop's destructor will revert the object's open status
}
```
```

--------------------------------

### StartRecording Method in Visual Basic

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_EditorInput_LivePreview_StartRecording

Use this method to start live preview recording in Visual Basic. It returns void.

```vb
Public Function StartRecording() As void
```

--------------------------------

### Get Start Draft Distance C++

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-AcDbSweepOptions__startDraftDist

Returns the start draft distance. The default value of this option is 0.

```cpp
double startDraftDist() const;
```

--------------------------------

### Get Curve Start Point (C#)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_DatabaseServices_Curve_StartPoint

Use this property to retrieve the starting point of a curve. It is a read/write property.

```C#
public virtual Point3d StartPoint;
```

--------------------------------

### OnInitDialogBegin

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-__MEMBERTYPE_Methods_CAdUiTabMainDialog

By default this does nothing.

```APIDOC
## OnInitDialogBegin

### Description
A placeholder method called at the beginning of dialog initialization. By default, it performs no action.

### Method
(Not specified in source)

### Endpoint
(Not specified in source)
```

--------------------------------

### Get Spline Start Point (AutoLISP)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-AA1C450F-AA6E-4B05-AFB3-989AD91ADBFC

Retrieves the start point of a spline object. This function is only supported on Windows.

```autolisp
(vlax-curve-getStartPoint splineObj)
(1.73962 2.12561 0.0)
```

--------------------------------

### Initialize

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-59B150DC-B52D-438F-91FD-E466201887E1

Initializes the plug-in.

```APIDOC
## Initialize

### Description
Initializes the plug-in.

### Method
(Not specified, assumed to be a method call)

### Parameters
(Not specified)

### Response
(Not specified)
```

--------------------------------

### Example_Output Visual LISP

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-5722B0EC-678A-4797-B17F-823EE27BCF51

This example obtains a reference to the Output Preferences object from the Application Preferences object and reads one of the Output preferences.

```APIDOC
## Example_Output (Visual LISP)

### Description
This example obtains a reference to the Output Preferences object from the Application Preferences object, and reads one of the Output preferences.

### Code
```lisp
(vl-load-com)
(defun c:Example_Output()
    ;; This example obtains a reference to the Output Preferences object
    ;; from the Application Preferences object, and reads one of the Output
    ;; preferences
    (setq acadObj (vlax-get-acad-object))
    (setq preferences (vla-get-Preferences acadObj))
    
    ;; Obtain a reference to the Output Preferences object
    (alert (strcat "You now have access to the properties and methods of the Output Preferences object!"
                   "\nThe Output preference DefaultOutputDevice is set to: " (vla-get-DefaultOutputDevice (vla-get-Output preferences))))
)
```
```

--------------------------------

### Get Start Point (AutoLISP/ActiveX)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-4684C76F-02F7-4989-AA53-C886E528350A

Returns the start point of the curve in WCS coordinates. Available on AutoCAD for Windows.

```AutoLISP
(vlax-curve-getStartPoint _curve-obj_)
```

--------------------------------

### startOfText

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-__MEMBERTYPE_Methods_AcDbTextEditorColumn

Gets the start location for the column.

```APIDOC
## startOfText

### Description
Gets the start location for the column.

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
None

### Response
#### Success Response (200)
- **location** (object) - The start location of the column.
```

--------------------------------

### Define a function with defun-q

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-5EE138EF-D531-441B-9F12-8D5645C540FE

Use defun-q to define a function named 'my-startup' that accepts one argument 'x' and prints a list containing 'x'. This function is for backward compatibility.

```AutoLISP
(defun-q my-startup (x) (print (list x)))
```

--------------------------------

### Example_Output VBA

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-5722B0EC-678A-4797-B17F-823EE27BCF51

This example obtains a reference to the Output Preferences object from the Application Preferences object and reads one of the Output preferences.

```APIDOC
## Example_Output (VBA)

### Description
This example obtains a reference to the Output Preferences object from the Application Preferences object, and reads one of the Output preferences.

### Code
```vba
Sub Example_Output()
    ' This example obtains a reference to the Output Preferences object
    ' from the Application Preferences object, and reads one of the Output
    ' preferences
    
    Dim ACADPref As AcadPreferencesOutput
    
    ' Obtain a reference to the Output Preferences object
    Set ACADPref = ThisDrawing.Application.preferences.Output
    
    MsgBox "You now have access to the properties and methods of the Output Preferences object!"
    MsgBox "The Output preference DefaultOutputDevice is set to: " & ACADPref.DefaultOutputDevice

End Sub
```
```

--------------------------------

### Get User Preferences Object in Visual LISP

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-A21BC5CA-982E-4B64-B5A9-EAA3DCF57DAD

This Visual LISP example shows how to get the User Preferences object and retrieve the state of the KeyboardAccelerator preference. It loads the COM functions and defines a command to execute the example.

```Visual LISP
(vl-load-com)
(defun c:Example_User()
    ;; This example obtains a reference to the User Preferences object
    ;; from the Application Preferences object, and reads one of the User
    ;; preferences
    (setq acadObj (vlax-get-acad-object)
          preferences (vla-get-Preferences acadObj))
    
    (alert "You now have access to the properties and methods of the User Preferences object!")
    (alert (strcat "The User preference KeyboardAccelerator is set to: " 
                   (if (= (vla-get-KeyboardAccelerator (vla-get-User preferences)) :vlax-true) "True" "False")))
)
```

--------------------------------

### Call a function defined with defun-q

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-5EE138EF-D531-441B-9F12-8D5645C540FE

Execute the 'my-startup' function with the argument 5. This demonstrates how to call a function defined using defun-q.

```AutoLISP
(my-startup 5)
```

--------------------------------

### Search from a specific start position

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-4E7AE1DA-1ED5-4D96-A7D3-34241AA94AA6

Searches for 'foo' within 'fooey-more-fooey' starting from the 1st character (index 1). This example shows how the start position affects the result.

```AutoLISP
(vl-string-search "foo" "fooey-more-fooey" 1)
```

--------------------------------

### Get CircularArc2d StartPoint in Visual Basic

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_Geometry_CircularArc2d_StartPoint

Use this property to get the starting point of the arc. This property is read-only.

```Visual Basic
Public Property StartPoint() As Point2d
```

--------------------------------

### VB.NET Application Initialization and Command Handling

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-FA3B4125-F7BD-4E89-969F-9DCC90AC6977

This VB.NET code demonstrates how to use the ExtensionApplication and CommandClass attributes to define an application's entry point and command handlers. It implements the IExtensionApplication interface for initialization and termination tasks.

```vbnet
Imports Autodesk.AutoCAD.Runtime
Imports Autodesk.AutoCAD.Interop
Imports Autodesk.AutoCAD.ApplicationServices
Imports Autodesk.AutoCAD.DatabaseServices

<Assembly: ExtensionApplication(GetType(HelloWorld.HelloWorldApp))>
<Assembly: CommandClass(GetType(HelloWorldCommands))>

Namespace HelloWorld
    Public Class HelloWorldApp
        Implements Autodesk.AutoCAD.Runtime.IExtensionApplication
        ...
    End Class

    Public Class HelloWorldCommands
        ' Defines a command that prompts a message on the AutoCAD
        ' command line.
        <Autodesk.AutoCAD.Runtime.CommandMethod("HELLO")>
        Public Sub HelloCommand()
            ...
        End Sub
    End Class
End Namespace
```

--------------------------------

### Get String Input (VBA/ActiveX)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-203F2756-1BA6-4226-A505-B776ED8AF0FB

This VBA/ActiveX example shows how to get a string input from the user, which is then displayed in a message box.

```vba
Sub GetStringFromUser()
    Dim retVal As String
    retVal = ThisDrawing.Utility.GetString _
                                         (1, vbCrLf & "Enter your name: ")
    MsgBox "The name entered was: " & retVal
End Sub
```

--------------------------------

### Start Notepad and open acad.lsp on Windows

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-30EC493A-674B-4AAE-8C88-358E38CDAB21

This snippet demonstrates how to start the Notepad application and open a specific file on Windows using the startapp function.

```autolisp
(startapp "notepad" "acad.lsp")
33
```

--------------------------------

### Example Usage of acadErrorStatusText

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-acadErrorStatusText_Acad__ErrorStatus

This example demonstrates how to use acadErrorStatusText to get the string representation of an error status, such as Acad::eOpenForWrite.

```cpp
acadErrorStatusText(Acad::eOpenForWrite);
```

--------------------------------

### showPageSetup

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-__MEMBERTYPE_Methods_AcApLayoutManager

Returns whether the Page Setup dialog is automatically launched upon initial entry into a paper space layout.

```APIDOC
## showPageSetup

### Description
This function returns whether the Page Setup dialog is automatically launched upon initial entry into a paper space layout.

### Method
Not specified (assumed to be a method call within the SDK)

### Parameters
None explicitly documented.

### Returns
- 1: Indicates the Page Setup dialog is launched.
- 0: Indicates it is not launched.
```

--------------------------------

### Initialize Design Center Extension Application

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-DD2771F3-FB6D-4A3A-AE34-2D7236F17656

Implement the InitInstance() function to register the application and its information. Pass the instance handle to registerAppInfo().

```cpp
BOOL CAsdkDesignCenterSampApp::InitInstance()
{
    DllRegisterServer(); 
    
    registerAppInfo(m_hInstance);

return CWinApp::InitInstance(); }
```

--------------------------------

### Get Start Point of AcGeCircArc3d in C++

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-AcGeCircArc3d__startPoint

Retrieves the starting point of the circular arc. This method is part of the AcGeCircArc3d class.

```cpp
GE_DLLEXPIMPORT AcGePoint3d startPoint() const;
```

--------------------------------

### Example Usage of ViewBorder.Height

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_DatabaseServices_ViewBorder_Height

Demonstrates how to access the Height property to get the view border's height. This property is read-only.

```C#
double height = viewborder.Height;
```

--------------------------------

### pageSetup

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-__MEMBERTYPE_Methods_AcApLayoutManager

Launches the Page Setup dialog, optionally with different layout or dialog settings.

```APIDOC
## pageSetup

### Description
By default, this function launches the Page Setup dialog with the current AcDbLayout object. Optionally, this function takes arguments to initialize it with a different AcDbLayout object, a pointer to a different parent window, and whether to bring up the shared Plot dialog instead of the Page Setup dialog.

### Method
Not specified (assumed to be a method call within the SDK)

### Parameters
- layout (AcDbLayout, optional): A different AcDbLayout object to initialize the dialog with.
- parentWindow (pointer, optional): A pointer to a different parent window.
- showPlotDialog (boolean, optional): Whether to bring up the shared Plot dialog instead of the Page Setup dialog.

### Returns
- 0: If the Page Setup dialog has been canceled.
- 1: If the Page Setup dialog has succeeded.
- -1: For any error conditions.
```

--------------------------------

### Registering Help for a Custom Command

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-acedSetFunHelp_ACHAR__ACHAR__ACHAR__int

This example demonstrates how to register a Help call for a custom command 'c:sld2ps' using acedDefun() and acedSetFunHelp(). If the user requests transparent help at the command line for 'sld2ps', the specified Help file and topic will be displayed. Ensure the function name starts with 'C:' for proper registration.

```cpp
int funcload()
{
    char* exfun = "c:sld2ps";
    if (acedDefun(exfun, 0) != RTNORM)
        return 0;
    if (acedSetFunHelp(exfun, "sld2ps.chm" "sld2ps", 0) != RTNORM)
        return 0;
    return 1;
}
```

--------------------------------

### Access Edge Start Vertex (C#)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_BoundaryRepresentation_Edge_Vertex1

Use this property to get the starting vertex of an edge in C#. This property is read-only.

```csharp
public Autodesk.AutoCAD.BoundaryRepresentation.Vertex Vertex1;
```

--------------------------------

### PointCloudItem.Guid Property

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_DatabaseServices_PointCloudItem_Guid

Gets or sets the GUID of item.

```APIDOC
## PointCloudItem.Guid Property

### Description
Gets or sets the GUID of item.

### Visual Basic
```vb.net
Public Property Guid() As string
```

### C#
```csharp
public string Guid;
```

### Conditions
Read / Write
```

--------------------------------

### C++ Example: Set Face Lighting Model

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-AcDbVisualStyle__setTrait_AcGiVisualStyleProperties__Property_int_AcGiVisualStyleOperations__Operation

Example demonstrating how to set the face lighting model property of a visual style to kGooch using the setTrait method.

```cpp
// Set lighting model to kGooch
using namespace AcGiVisualStyleProperties;
acdbVisualStyle.setTrait (kFaceLightingModel, kGooch);
```

--------------------------------

### AcadAppInfo::appImplements Command Examples

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-AcadAppInfo__appImplements_ACHAR___const

Demonstrates various command strings that would return true when searched using the appImplements function, based on a sample registry structure.

```text
"doit"
"moveme"
"mygroup1.doit"
"mygroup2.doit"
"mygroup1.moveme"
"mygroup2.moveme"
```

--------------------------------

### vl-member-if-not Example

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-27EA5788-B68D-4302-900F-9D99902025E4

This example demonstrates how vl-member-if-not checks a list for the first element that is not an atom. It returns the rest of the list starting from that element.

```autolisp
(vl-member-if-not 'atom '(1 "Str" (0 . "line") nil t))
```

--------------------------------

### AcPointCloudItem::guid Method

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-AcPointCloudItem__guid_const

Gets the GUID of the point cloud item. The default value for the GUID is an empty string in the default constructor.

```APIDOC
## AcPointCloudItem::guid Method

### Description
Gets the GUID of item.

### Method Signature
```cpp
const AcString& guid() const;
```

### Returns
GUID of item.

### Remarks
default value of GUID is set to empty string in default constructor
```

--------------------------------

### Example: Create MLeader and Manage Block Attributes (Visual LISP)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-5E874529-F35B-427E-8310-CF7AB3833B0B

Provides a Visual LISP equivalent for creating an MLeader, configuring it for block content, and interacting with its attributes. Includes setting and retrieving attribute values.

```LISP
(vl-load-com)
(defun c:Example_BlockAttribute()
    ;; This example creates an MLeader object and gets and sets values for
    ;; the block attribute type.
    (setq acadObj (vlax-get-acad-object))
    (setq doc (vla-get-ActiveDocument acadObj))
  
    (setq points (vlax-make-safearray vlax-vbDouble '(0 . 5)))
    (vlax-safearray-fill points '(0 4 0
				              1.5 5 0
				             )
    )
    (setq i 0)
  
    (setq modelSpace (vla-get-ModelSpace doc))  
    (setq oML (vla-AddMLeader modelSpace points i))
    
    (vla-put-ContentType oML acBlockContent)
    (vla-put-ContentBlockType oML acBlockBox)

    (setq sBlock (vla-get-ContentBlockName oML))

    (vlax-for o (vla-Item (vla-get-Blocks doc) sBlock)
        (if (= (vla-get-ObjectName o) "AcDbAttributeDefinition")
	           (progn
                (vla-SetBlockAttributeValue oML (vla-get-ObjectID o) "123")
                (alert (vla-GetBlockAttributeValue oML (vla-get-ObjectID o)))
	           )
        )
    )
  
    (vla-Update acadObj)
    (vla-ZoomExtents acadObj)
)
```

--------------------------------

### Create and Launch Job Directory (Windows)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-29FCFD3B-8B5B-4609-A626-F5BD0A108F91

Use this batch script to verify, create, and set a specified directory as the current working directory before launching the application. Replace '<product name>' with your installed product name.

```batch
@echo off
C:
if exist \AcadJobs\Jobs\%1 goto RUNACAD
echo.
echo *** Creating \AcadJobs\Jobs\%1 
echo *** Press Ctrl+C to cancel.
echo.
pause
mkdir \AcadJobs\Jobs\%1
:RUNACAD
cd \AcadJobs\Jobs\%1
start “ C:\Program Files\Autodesk\_\u003cproduct name>_\acad.exe ”
```

--------------------------------

### Get Database Version GUID (C++)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-AcDbDatabase__getVersionGuid_AcString___const

Retrieves the database's Version GUID string. Ensure AcString is available for output.

```cpp
ACDBCORE2D_PORT Acad::ErrorStatus getVersionGuid(
    AcString & guidString
) const;
```

--------------------------------

### GetInput Example in Visual LISP

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-75A18A2B-37B4-44B4-973B-B9E04CDB8203

This Visual LISP example shows how to prompt for user input, set up keywords with InitializeUserInput, and retrieve the keyword using GetInput. It includes error handling for user input and displays the result.

```Visual LISP
(vl-load-com)
(defun c:Example_GetInput()
    ;; This example prompts for user input of a point. By using the
    ;; InitializeUserInput method to define a keyword list, the example can also
    ;; return keywords entered by the user.
    (setq acadObj (vlax-get-acad-object))
    (setq doc (vla-get-ActiveDocument acadObj))
    
    ;; Define the valid keywords
    (setq keywordList "Line Circle")
    
    ;; Call InitializeUserInput to set up the keywords
    (vla-InitializeUserInput (vla-get-Utility doc) 128 keywordList)
    
    ;; Get the user input
    (setq returnPntOrErr (vl-catch-all-apply 'vla-GetPoint (list (vla-get-Utility doc) nil "Enter a point [Line/Circle]: ")))

    (if (= (type returnPntOrErr)'VL-CATCH-ALL-APPLY-ERROR)
        (progn
            (if (= (vl-catch-all-error-message returnPntOrErr) "Automation Error. User input is a keyword")
	               (progn
                    (setq inputString (vla-GetInput (vla-get-Utility doc)))
                    (alert (strcat "You entered the keyword: " inputString))
	              )
                (alert "User pressed ESC or unknown input was provided.")
	           )
        )
        ;; Display point coordinates
        (progn
	           (setq returnPnt (vlax-safearray->list (vlax-variant-value returnPntOrErr)))
            (alert (strcat "The WCS of the point is: " (rtos (nth 0 returnPnt) 2) ", " (rtos (nth 1 returnPnt) 2) ", " (rtos (nth 2 returnPnt) 2)))
	       )
    )
)
```

--------------------------------

### Get Named Page Setup String (C#)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_PlottingServices_DsdEntry_Nps

Use this property to retrieve the named page setup string. It is a read/write property.

```C#
public string Nps;
```

--------------------------------

### Displaying a Modeless Window with a URI (C#)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_ApplicationServices_Application_ShowModelessWindow_Uri

This C# example demonstrates how to launch a modeless window displaying a specified website. It creates a Uri object and then calls the ShowModelessWindow method.

```csharp
Uri uri = new Uri("http://anywebsite.com");
IntPtr owner = Application.MainWindow.Handle;
Autodesk.AutoCAD.ApplicationServices.Application.ShowModelessWindow(uri);
```

--------------------------------

### Access Database Version GUID (C#)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_DatabaseServices_Database_VersionGuid

Use this property to get or set the database's Version GUID. It is a read/write property.

```csharp
public string VersionGuid;
```

--------------------------------

### start

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-__MEMBERTYPE_Methods_AcDbHostApplicationProgressMeter

The start() method initializes the progress meter to its initial state and makes it visible. It can optionally display a provided string message.

```APIDOC
## start(message: string)

### Description
Initializes and displays the progress meter. An optional message can be provided to be shown to the user. The message string should not be modified after being passed to this method.

### Method
`start(message: string)`

### Parameters
#### Path Parameters
- **message** (string) - Optional - The message to display with the progress meter. Do not modify this string after passing it to start().
```

--------------------------------

### Get Curve Start Point (Visual Basic)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_DatabaseServices_Curve_StartPoint

Use this property to retrieve the starting point of a curve. It is a read/write property.

```Visual Basic
Public virtual Property StartPoint() As Point3d
```

--------------------------------

### Initialize Method Signature

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_Windows_PaletteSetDockSite_Initialize_PaletteSet_Size_int

Initializes the PaletteSetDockSite with a PaletteSet, desired size, and docking style.

```APIDOC
## Initialize Method

### Description
Initializes the PaletteSetDockSite with a PaletteSet, desired size, and docking style.

### Visual Basic
```vb
Public Function Initialize(
    paletteset As PaletteSet,
    desiredSize As Size,
    dockSyle As Integer
) As void
```

### C#
```csharp
public void Initialize(
    PaletteSet paletteset,
    Size desiredSize,
    int dockSyle
);
```

### Parameters
#### Visual Basic
- **paletteset** (PaletteSet) - The PaletteSet to initialize.
- **desiredSize** (Size) - The desired initial size of the PaletteSet.
- **dockSyle** (Integer) - The docking style for the PaletteSet.

#### C#
- **paletteset** (PaletteSet) - The PaletteSet to initialize.
- **desiredSize** (Size) - The desired initial size of the PaletteSet.
- **dockSyle** (int) - The docking style for the PaletteSet.
```

--------------------------------

### Access Arc Start Angle in C#

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_DatabaseServices_Arc_StartAngle

Use this property to get or set the start angle of an arc. The value must be in radians.

```C#
public double StartAngle;
```

--------------------------------

### Brep.GetComplexsStartingFrom Method

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_BoundaryRepresentation_Brep_GetComplexsStartingFrom_Complex

Returns a collection of complexes starting from a starting point.

```APIDOC
## Brep.GetComplexsStartingFrom Method

### Description
Returns a collection of complexes starting from a starting point.

### Visual Basic
```vb.net
Public Function GetComplexsStartingFrom(
    startFrom As Complex
) As BrepComplexCollection
```

### C#
```csharp
public BrepComplexCollection GetComplexsStartingFrom(
    Complex startFrom
);
```

### Parameters
#### Path Parameters
- **startFrom** (Complex) - Required - Input complex to start collecting from
```

--------------------------------

### Get Start Parameter of a Spline

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-B506C696-DBDA-466B-9EF8-1AF3B1A485F8

Retrieves the starting parameter value of a spline object. This is useful for setting up curve measurement calculations.

```autolisp
(setq startSpline (vlax-curve-getStartParam splineObj))
0.0
```

--------------------------------

### Promoted StartPoint property example

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-A65FBCCF-CC5D-47E8-9117-D577D9CB9D8A

Illustrates how the StartPoint property is displayed when promoted (context = 1) versus when not promoted (context = 0). Promoted values show individual X, Y, and Z components.

```text
StartPoint (type: AcGePoint3d)  (LocalName: StartPoint) = 6.250000   8.750000  0.000000
```

```text
StartPoint/X (type: double)  (LocalName: Start X) = 6.250000
StartPoint/Y (type: double)  (LocalName: Start Y) = 8.750000
StartPoint/Z (type: double)  (LocalName: Start Z) = 0.000000
```

--------------------------------

### Get Start Parameter of a Curve (AutoLISP)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-37282EB1-D47C-4039-B1AF-744EB5B53F25

Obtain the start parameter of a curve object. This is a prerequisite for calculating derivatives at specific points.

```autolisp
(setq startSpline (vlax-curve-getStartParam splineObj))
```

--------------------------------

### Visual LISP Example

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-2CB54DAD-8594-42E7-91F0-448F80C5F20C

This example shows how to get the Profiles Preferences object using Visual LISP and retrieve the ActiveProfile setting.

```APIDOC
## Visual LISP Example

### Description
This example obtains a reference to the Profiles Preferences object from the Application Preferences object, and reads one of the Profiles preferences.

### Code
```lisp
(vl-load-com)
(defun c:Example_Profiles()
    ;; This example obtains a reference to the Profiles Preferences object
    ;; from the Application Preferences object, and reads one of the Profiles
    ;; preferences
    (setq acadObj (vlax-get-acad-object))
    (setq preferences (vla-get-Preferences acadObj))
    
    ;; Obtain a reference to the Profiles Preferences object
    (alert "You now have access to the properties and methods of the Profiles Preferences object!")
    (alert (strcat "The Profiles preference ActiveProfile is set to: " (vla-get-ActiveProfile (vla-get-Profiles preferences))))
)
```
```

--------------------------------

### Complex.GetShellsStartingFrom Method

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_BoundaryRepresentation_Complex_GetShellsStartingFrom_Shell

Returns a collection of shells starting from a starting point.

```APIDOC
## Complex.GetShellsStartingFrom Method

### Description
Returns a collection of shells starting from a starting point.

### Visual Basic
```vb.net
Public Function GetShellsStartingFrom(
    startFrom As Shell
) As ComplexShellCollection
```

### C#
```csharp
public ComplexShellCollection GetShellsStartingFrom(
    Shell startFrom
);
```

### Parameters
#### Path Parameters
- **startFrom** (Shell) - Required - Input the shell to start collecting from
```

--------------------------------

### AcString::substr (int)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-__OVERLOADED_substr_AcString

Gets a substring from the start of the string.

```APIDOC
## AcString::substr (int)

### Description
Gets a substring from the start of the string.

### Method
(Implicitly a method call on an AcString object)

### Parameters
#### Path Parameters
- **startIndex** (int) - Required - The starting index of the substring.

### Response
#### Success Response
- Returns an AcString object representing the substring.
```

--------------------------------

### C++ Example: Set Display Brightness

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-AcDbVisualStyle__setTrait_AcGiVisualStyleProperties__Property_double_AcGiVisualStyleOperations__Operation

Example demonstrating how to set the display brightness property of a visual style to 1.0 using the setTrait method.

```cpp
// Set brightness to 1.0
acdbVisualStyle.setTrait (AcGiVisualStyleProperties::kDisplayBrightness, 1.0);
```

--------------------------------

### AlignStart Property

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-ManagedRefGuide-Autodesk_AutoCAD_DatabaseServices_SweepOptionsBuilder_AlignStart

Gets and sets the align start option.

```APIDOC
## SweepOptionsBuilder.AlignStart Property

### Description
Gets and sets the align start option.

### Visual Basic
```vb.net
Public Property AlignStart() As bool
```

### C#
```csharp
public bool AlignStart;
```

### Conditions
Read / Write
```

--------------------------------

### Create MInsertBlock and Display Row/Column Info (Visual LISP)

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-F93CE898-0504-4C44-BCC2-86EBAA742E24

This Visual LISP example demonstrates creating a new MInsertBlock and then displaying its column and row information, including spacing. Ensure the ActiveX COM objects are loaded and accessible.

```Visual LISP
(vl-load-com)
(defun c:Example_Rows()
    ;; This example creates a new MInsertBlock in the current drawing and
    ;; displays the column and row information for the new MInsertBlock
    (setq acadObj (vlax-get-acad-object))
    (setq doc (vla-get-ActiveDocument acadObj))
        
    ;; Define the Circle object
    (setq centerPoint (vlax-3d-point 0 0 0)
          InsertPoint (vlax-3d-point 1 1 0)
          radius 0.5)
    
    ;; Create a new block to hold the Circle
    (setq newBlock (vla-Add (vla-get-Blocks doc) centerPoint "CBlock"))
    
    ;; Add the Circle object to the new block
    (setq circleObj (vla-AddCircle newBlock centerPoint radius))
    
    ;; Create a rectangular array of Circles using the new block containing the Circle
    ;; and the AddMInsertBlock method
    (setq modelSpace (vla-get-ModelSpace doc))   
    (setq newMBlock (vla-AddMInsertBlock modelSpace InsertPoint "CBlock" 1 1 1 1 2 2 1 1))
        
    (vla-ZoomAll acadObj)
    
    ;; Display information about the Columns and Rows defined by the MInsertBlock
    (alert (strcat "The new rectangular array comprises: \n"
                   (itoa (vla-get-Columns newMBlock)) " columns with a spacing of " (rtos (vla-get-ColumnSpacing newMBlock) 2) " and\n"
                   (itoa (vla-get-Rows newMBlock)) " rows with a spacing of " (rtos (vla-get-RowSpacing newMBlock) 2) "."))
)
```

--------------------------------

### Example PackageContents.xml Structure

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=GUID-40F5E92C-37D8-4D54-9497-CD9F0659F9BB

This XML file defines the metadata for a plug-in, such as its name, icon, help file, company details, and the modules it includes. Ensure a unique ProductCode GUID is added.

```xml
<?xml version="1.0" encoding="utf-8" ?>
<ApplicationPackage SchemaVersion="1.0" AppVersion="1.0"
    ProductCode="[Add Unique Plug-in GUID Here]"
    Name="Office Symbols"
    Icon="./Contents/Resources/OfficeSymbols.ico"
    Helpfile="./Contents/Resources/OfficeSymbols.htm"
>
 
    <CompanyDetails
        Name="ABC Indoor CAD, Inc."
        Email="support@abcindoorcad.com"
    />
 
    <Components>
        <ComponentEntry
            ModuleName="./Contents/LISP/OfficeSymbolsUtilities.lsp"
        />
    </Components>
</ApplicationPackage>
```

--------------------------------

### getGuideCurve

Source: https://help.autodesk.com/view/OARX/2024/ENU?guid=OARX-RefGuide-__MEMBERTYPE_Methods_AcDbLoftedSurface

Gets the guide curve at the zero-based index idx.

```APIDOC
## getGuideCurve

### Description
Gets the guide curve at the zero-based index idx.

### Method
[Method Signature - Not explicitly provided in source]

### Parameters
- **idx**: (integer) - The zero-based index of the guide curve.

### Returns
[Return type and description not explicitly provided in source]
```
Tokens:
Raw