MatrixObject::SetInternalData

SetInternalData

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 header to Include

Description

Set the Matrix internal data storage type

Syntax

BOOL SetInternalData( UINT iType, BOOL bSaveData = TRUE, BOOL bSetViewData = TRUE )

Parameters

iType: [input] An FSI_* data type constant defined in oc_const.h
bSaveData: [input] when changing internal data type, value of TRUE(by default) will keep the original data by converting them to the new type
bSetViewData: [input] TRUE(by default) will turn the Matrix into View Data mode after the data type change. FALSE will keep current view mode

Return

TRUE, set the Matrix internal type successfully, FALSE, unsuccessful.

Examples

EX1

// Convert the internal storage type for data to BYTE
// Keep the data (reduced resolution) and the current View mode
void    MatrixObject_SetInternalData_Ex1()
{
    MatrixLayer mlay = Project.ActiveLayer();
    if(!mlay) 
        return;
    MatrixObject mobj = mlay.MatrixObjects(0); // Most Matrix windows in Origin have only one MatrixObject
    if(mobj.SetInternalData(FSI_BYTE, TRUE, FALSE))
        out_str("successfully converted into BYTE matrix");
    else
        out_str("conversion failed");
}