GetBlockDefinitions Method (IDocument) Send Feedback
See Also  Example
BlockDefinitionArray[out]
Array of Block definitions
Gets the Block definitions for the document.

Syntax

Visual Basic 
Function GetBlockDefinitions() As System.Object
C# 
System.object GetBlockDefinitions()
JavaScript 
GetBlockDefinitions() : Array
COM native C++ 
HRESULT GetBlockDefinitions(
   VARIANT* BlockDefinitionArray
)  
C++ 
DSRESULT GetBlockDefinitions(
   dsObjectPtrArray* BlockDefinitionArray
)  

Parameters

BlockDefinitionArray[out] or Return Value
Array of Block definitions

Example

This code snippet shows how to write the names of the Block definitions to a file.

COM native C++

void CAddinDumpManager::DumpBlockDefinitions( CStdioFile& fileOutput, LPCWSTR tabStr, IDocumentPtr dsDoc )
{
    CString strPrint;
   
    //Dump block definitions
    _variant_t pVariantArray = dsDoc->GetBlockDefinitions();
    if( V_VT( &pVariantArray ) != VT_EMPTY )
    {
        IBlockDefinitionPtr *blkDefs = NULL;
        int countOfBlockDefs = 0;
        TypeConverter::convertVariantArrayToPtrArray<IBlockDefinitionPtr, IBlockDefinition>( pVariantArray, blkDefs, countOfBlockDefs );

        strPrint.Format( L"Block definitions (%d):\r\n", countOfBlockDefs );
        fileOutput.WriteString( strPrint );

        if( blkDefs && countOfBlockDefs > 0)
        {                           
            for( int i = 0; i < countOfBlockDefs; ++i )
            {
                bstr_t BLockName= blkDefs[i]->GetName();
                strPrint.Format(L"Block definition name: %s\r\n", BLockName.operator const wchar_t*());
                fileOutput.WriteString(strPrint);                
            }           
            delete[] blkDefs;
        }                       
    }
    else
        fileOutput.WriteString( L"ERROR GetBlockDefinitions\r\n" );
}

Example

 

See Also

Availability

DraftSight V1R1