2.2.4.13.25 Folder::SetComments

Description

set comments to folder

Syntax

BOOL SetComments( LPCSTR lpcszComments )

Parameters

lpcszComments

[input] the comments that you want to set it to folder

Return

if set the comments to folder succeed return true,otherwise return false.

Examples

EX1

void    SetComments_Ex1()
{
    Folder fld = Project.ActiveFolder();
    if(fld.IsValid())
    {
        string strComm("Source code folder");
        BOOL bSuccess;
        bSuccess=fld.SetComments(strComm);
        printf("Is comments has been setted :%s",bSuccess?"yes":"not");
        return;
    }
    printf("there is no active folder in current project");
}

Remark

See Also

OriginC:Folder::GetComments

Header to Included

origin.h