Returns various information on a drawing link.

    GSErrCode ACAPI_Database (
        APIDb_GetDrawingLinkID,
        const API_Guid*          guid,
        API_DrawingLinkInfo*     drawingLinkInfo
    );

 

Parameters

guid

[in] get information for drawing link identified with drawing’s guid

drawingLinkInfo

[out] the drawing link’s type, guid, etc.

 

Return Values

NoError

The function has completed with success.

APIERR_BADPARS

The drawing link is not valid.

For other common API errors see the API Errors document.

 

Remarks

This function is used to get basic information about a drawing link identified by the linkUID parameter.

Remember to release the linkPath location and the viewPath pointer dynamically allocated by the function, as it is shown in the example below.

 

Example

Int32 IsExternalView (API_DrawingType* drawing)
{
    API_DrawingLinkInfo drawingLinkInfo;
    BNZeroMemory (&drawingLinkInfo, sizeof (API_DrawingLinkInfo));

    GSErrCode err = ACAPI_Database (APIDb_GetDrawingLinkID, (void *) (&drawing->head.guid), &drawingLinkInfo);
    if (drawingLinkInfo.linkPath != nullptr)
        delete drawingLinkInfo.linkPath;
    if (drawingLinkInfo.viewPath != nullptr)
        BMKillPtr (&drawingLinkInfo.viewPath);

    if (err != NoError)
        return -1;
    else if (drawingLinkInfo.linkTypeID == API_DrawingLink_ExternalViewID)
        return 1;

    return 0;
}

 

Requirements

Version: API 10 or later

Header: APIdefs_Database.h

 

See Also

API_DrawingLinkInfo, API_DrawingType
ACAPI_Database, API Functions