<< Click to Display Table of Contents > 

Client Control Interface Manual > Job > Entity Objects > Date Time

Date Time
Previous pageReturn to chapter overviewNext page

Date Time Format

 

Date Time Format
 

Set

Get

DLL Function

int CCI_Return = ScSetEntityStringData(string Entity_Name, int Data_ID, string Format)

int CCI_Return = ScGetEntityStringData(string Entity_Name, int Data_ID, ref string Format)

ASCII Function

int CCI_Return = ScCciSetEntityStringData(string Entity_Name, int Data_ID, string Format)

string Format = ScCciGetEntityStringData(string Entity_Name, int Data_ID)

Description

This allows to get or set the format string of a date time bbject.

Entity_Name

Type: string

Unit: none

Specify the entity to be changed.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlStringDataIdSerialNumberFormatString

27

Format

Type: int

Unit: none

The corresponding format. For the details on the DateTime format please refer to the SAMLight manual.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Set date time format for the entity "DateTime1" as %y/%m/%d:

 

int CCI_Return = cci.ScSetEntityStringData( "DateTime1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlStringDataIdSerialNumberFormatString, "%y/%m/%d" );

C# Example: Get date time format for the entity "DateTime1":

 

string Date_Time_Format = "";

int CCI_Return2 = cci.ScGetEntityStringData( "DateTime1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlStringDataIdSerialNumberFormatString, ref Date_Time_Format );

Table 161: Date Time Format