extractEmployeePeriodFrameByFilekey() 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

  • Returns information representing the employee’s pay period framing data

Syntax

  • AePayPeriodFrame = AeXMLBridge.extractEmployeePeriodFrameByFilekey(Filekey);

Parameters

  • Integer - Employee filekey

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
int filekey = 1234;                                                     
// using employee "1234"
 
try
{
   TAePayPeriodFrame ppFrame = ws.extractEmployeePeriodFrameByFilekey(filekey);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

Sample Code

VB.Net

1
2
3
4
5
6
7
8
Dim filekey As Integer = 1234
' using employee "1234"
 
Try
    Dim ppFrame As TAePayPeriodFrame = ws.extractEmployeePeriodFrameByFilekey(filekey)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • None

Possible Errors

  • Unable to locate employee with filekey

Preferred Method

extractEmployeePeriodFrameByIDNum

extractAttendanceMultiFormActivityUsingHyperQuery
extractEmployeeDailySummsByIDNum
extractEmployeeDailySummsInPeriodByIDNum
extractEmployeeDurationTotalsByIDNum
extractEmployeeEditsByIDNum
extractEmployeePeriodShiftDetailsByIDNum
extractEmployeePeriodShiftsByIDNum
extractEmployeePeriodShiftTransactionsByIDNum
extractEmployeePeriodSummsByIDNum
extractEmployeeSummsByIDNum
extractEmployeeTransactionsByIDNum
extractPayPeriodSummaries
extractRangedTransactionsUsingHyperQuery
getManuallySelectedCalculatedData

Back to Top