Layer::GetSystemParam

GetSystemParam

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

Description

Get the layer's internal info

Syntax

DWORD GetSystemParam( int nParamType )

Parameters

nParamType: [input]specify the info to obtain

Return

a generic value that depends on the request

Examples

EX1

//Output the plot type of the active graph layer.
void Layer_GetSystemParam_Ex1()
{
    GraphLayer gl = Project.ActiveLayer();
    if(gl)
    {
        DWORD dw = gl.GetSystemParam(GLI_PCD_BITS);
        switch(dw & MASK_PCD_LAYER_BITS)
        {
        case PCD_LAYER_POLAR:
            out_str("polar plot");
            break;
        case PCD_LAYER_TRI:
            out_str("ternary plot");
            break;
        case PCD_LAYER_3D:
            out_str("3D scatter or wire or surface");
            break;
        case PCD_LAYER_3D_XYY:
            out_str("3D bar, ribbon, wall etc");
            break;
        default:
            out_str("some other layer type");
        }
    }
    else
        out_str("not graph layer");
}