FTP information - FTP Job

FTP Job function supported models : Specific camera

RequestFTPJobList

Overview

You can use this API and GetFTPJobList() to get FTP Job information.

If you want to use the FTP Job information, first request of this API. Then get information on GetFTPJobList() after that.

Definition

CrError RequestFTPJobList(CrDeviceHandle deviceHandle);

Input parameters

Type	Explanation
CrDeviceHandle	deviceHandle

Output parameters

None

Return value

Type	Explanation
CrError	CrError_None on Success Other than errors above, see Status code & Error

Related API

• GetFTPJobList

• IDeviceCallback::OnWarning

  See: RequestFTPJobList callback

Special note (details)

This API can be executed when CrDeviceProperty_FTPJobListDataVersion exists and CrDeviceProperty_FTPJobListDataVersion is CrEnableValue_DisplayOnly.

The result of this API will be notified by OnWarning(). When OnWarning notifies you of “CrWarning_RequestFTPJobList_Result_Success”, you can get FTP Job information with GetFTPJobList().

GetFTPJobList

Overview

It is an API to get the FTP Job information. It can only be executed if RequestFTPJobList() is successful.

See “Control the FTP Jobs” for instructions on how to control FTP Jobs.

Definition

CrError GetFTPJobList(CrDeviceHandle deviceHandle, CrFTPJobInfo** list, CrInt32u* numOfList);

Input parameters

Type	Explanation
CrDeviceHandle	deviceHandle

Output parameters

Type	Explanation
CrFTPJobInfo**	list The CrFTPJobInfo list pointer. Developers should pass the address of a modifiable CrFTPJobInfo pointer. The value of this pointer should be initialized to nullptr. Copy the FTP Job information stored inside the SDK-internal after the success of RequestFTPJobList() to this pointer.
CrInt32u*	numOfList An integer pointer that indicates the number of CrFTPJobInfo returned by the list pointer. Developers should pass the address of a modifiable CrInt32u variable.

Return value

Type	Explanation
CrError	CrError_None on Success CrError_Api_NoApplicableInformation RequestFTPJobList() may not have been executed. Please do RequestFTPJobList().

Related API

• RequestFTPJobList

• ReleaseFTPJobList

• ControlFTPJobList

• IDeviceCallback::OnWarning

Special note (details)

This API can be executed only once. If you want to get the FTP Job information after this API, please request again to get the FTP Job information from the camera with RequestFTPJobList().

ReleaseFTPJobList

Overview

This function releases the CrFTPJobInfo allocated by GetFTPJobList().

Definition

CrError ReleaseFTPJobList(CrDeviceHandle deviceHandle, CrFTPJobInfo* list);

Input parameters

Type	Explanation
CrDeviceHandle	deviceHandle
CrFTPJobInfo*	list CrFTPJobInfo list pointer to release.

Output parameters

None

Return value

Type	Explanation
CrError	CrError_None If the list is released successfully CrError_Init if the SDK is uninitialized CrError_Generic_InvalidHandle If the deviceHandle is an invalid handle Other than errors above, see Status code & Error

Related API

• GetFTPJobList

Special note (details)

None in particular

ControlFTPJobList

Overview

Request the SDK to control FTP Job.

The function is asynchronous and returns to the user as soon as the SDK enqueues the requested action.

See “Control the FTP Jobs” for instructions on how to control FTP Jobs.

Definition

CrError ControlFTPJobList(CrDeviceHandle deviceHandle, CrFTPJobControlType control, void* jobList, CrInt32u numOfList, CrFTPJobDeleteType deleteType);

Input parameters

Type	Explanation
CrDeviceHandle	deviceHandle
CrFTPJobControlType	control Specify the control type of FTP Job. Use the CrFTPJobControlType defined in CrDeviceProperty.h.
void*	jobList There are two types of data to be set for this parameter 1) CrFTPJobSetting class(Array) - Register an FTP Job - Specify CrFTPJobControlType_Add for the control parameter. 2) CrInt32u (Array) - Delete, suspend, and resume an FTP Job - Specify one of the following for control parameter. CrFTPJobControlType_Delete CrFTPJobControlType_Suspend CrFTPJobControlType_Resume
CrInt32u	numOfList Number of arrays set in jobList.
CrFTPJobDeleteType	deleteType This parameter is valid for deleting an FTP Job. Specify the deletion type. CrFTPJobDeleteType defined in CrDeviceProperty.h.

Output parameters

None

Return value

Type	Explanation
CrError	CrError_None on Success CrError_Init if the SDK is uninitialized CrError_Generic_InvalidHandle If the deviceHandle is an invalid handle Other than errors above, see Status code & Error

Related API

• IDeviceCallback::OnWarning

  See: RequestFTPJobList callback

  See: ControlFTPJobList callback

• GetMediaProfile

• GetFTPJobList

Special note (details)

The result will be notified by OnWarning().

If the control is successful, CrWarning_ControlFTPJobList_XXXX_Result_OK will be notified by OnWarning().

If the control fails, OnWarning() will notify you of the cause of the failure.

This API does not support all models.