2.2.4.46.26 Worksheet::GetASCIMP

GetASCIMP

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

Description

Get the internal ASCII import settings for the worksheet. The settings will be returned in an ASCIMP structure. The ASCIMP structure is defined and documented in the oc_types.h header file.

Syntax

BOOL GetASCIMP( ASCIMP & stAscImp )

Parameters

stAscImp: [output] An ASCIMP struct that has been setup with import settings.

Return

TRUE on success, FALSE on failure

Examples

EX1

//Get the internal ASCII import settings for the worksheet. The settings will be returned in an ASCIMP structure. 
void Worksheet_GetASCIMP_Ex1()
{
    Worksheet wks;
    wks.Create();
    if( wks.IsValid() )
    {
        ASCIMP ascimp;
        if( wks.GetASCIMP(ascimp) )
        {
            printf("Worksheet ASCII import settings obtained.\n");
            Tree tr;
            tr = ascimp;
            out_tree(tr);
        }
        else
            printf("Failed to get worksheet's ASCII import settings.\n");
    }
    else
        printf("Failed to create a test worksheet.\n");
}