extractEmployeePeriodShiftSchedulesByFilekey() Method

Table of Contents

  1. Function
  2. Syntax
  3. Parameters
  4. Return Value
  5. Sample Code
  6. Remarks
  7. Possible Errors
  8. Preferred Method
  9. Related Methods

Function

  • Extracts an employee’s shift work schedules for a selected pay period

Syntax

  • AeShiftScheduleAry = AeXMLBridge.extractEmployeePeriodShiftSchedulesByFilekey(Filekey, PayPeriodEnum, PayLineStateEnum, CalcedDataTypeEnum);

Parameters

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
int filekey = 1234;                                               
// using employee# 1234
 
TPayPeriodEnum payPeriod = TPayPeriodEnum.ppeNext;                         
// lets use the next pay period

TPayLineStateEnum pl = TPayLineStateEnum.plsAsSaved;
TCalcedDataTypeEnum calced = TCalcedDataTypeENum.cdtNormal;
 
try
{
   TAeShiftSchedule[] schedules = ws.extractEmployeePeriodShiftSchedulesByFilekey(filekey, payPeriod, pl, calced);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
13
14
Dim filekey As Integer = 1234
' using employee# 1234
 
Dim payPeriod As TPayPeriodEnum = TPayPeriodEnum.ppeNext
' lets use the next pay period
 
Dim pl As TPayLineStateEnum = TPayLineStateEnum.plsAsSaved
Dim calced As TCalcedDataTypeEnum = TCalcedDataTypeENum.cdtNormal
 
Try
    Dim schedules As TAeShiftSchedule() = ws.extractEmployeePeriodShiftSchedulesByFilekey(filekey, payPeriod, pl, calced)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • None

Possible Errors

  • Unable to locate employee with filekey

Preferred Method

extractEmployeePeriodShiftSchedulesByIDNum

appendEmployeeSchedule2ByIDNum
extractEmployeeSchedules2ByIDNum
extractRangedSchedules2UsingHyperQuery
removeEmployeeScheduleByUniqueID
removeEmployeeSchedulesInRangeByIDNum

Back to Top