FTP information - FTP Transfer

RequestFTPServerSettingList

Overview

You can use this API and GetFTPServerSettingList() to get FTP Server setting information.

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

Definition

CrError RequestFTPServerSettingList(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

• GetFTPServerSettingList

• IDeviceCallback::OnWarning

  See: RequestFTPServerSettingList callback

Special note (details)

This API can be executed when CrDeviceProperty_FTPServerSettingOperationEnableStatus is Enable.

The result of this API will be notified by OnWarning(). When OnWarning notifies you of “CrWarning_RequestFTPServerSettingList_Success”, you can get FTP Server setting information with GetFTPServerSettingList().

When [Access Authen.] is set to [Off] at the camera body, communication is performed without SSH connection authentication or encryption, so the content may be intercepted, or the camera may be accessed by an unintended third party.

GetFTPServerSettingList

Overview

It is an API to get the FTP Server setting information. It can only be executed if RequestFTPServerSettingList() is successful.

Definition

CrError GetFTPServerSettingList(CrDeviceHandle deviceHandle, CrFTPServerSetting** list, CrInt32u* numOfList);

Input parameters

Type	Explanation
CrDeviceHandle	deviceHandle

Output parameters

Type	Explanation
CrFTPServerSetting**	list The CrFTPServerSetting list pointer. Developers should pass the address of a modifiable CrFTPServerSetting pointer. The value of this pointer should be initialized to nullptr. Copy the FTP Server setting information stored inside the SDK-internal after the success of RequestFTPServerSettingList() to this pointer.
CrInt32u*	numOfList An integer pointer that indicates the number of CrFTPServerSetting 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 RequestFTPServerSettingList() may not have been executed. Please do RequestFTPServerSettingList().

Related API

• RequestFTPServerSettingList

• ReleaseFTPServerSettingList

• SetFTPServerSetting

• IDeviceCallback::OnWarning

Special note (details)

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

ReleaseFTPServerSettingList

Overview

This function releases the CrFTPServerSetting allocated by GetFTPServerSettingList().

Definition

CrError ReleaseFTPServerSettingList(CrDeviceHandle deviceHandle, CrFTPServerSetting* list);

Input parameters

Type	Explanation
CrDeviceHandle	deviceHandle
CrFTPServerSetting*	list CrFTPServerSetting 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

• GetFTPServerSettingList

Special note (details)

None in particular

SetFTPServerSetting

Overview

Request the SDK to update FTP Server setting information.

The function is asynchronous and returns to the user as soon as the SDK enqueues the requested action. The result of executing the update request to the camera should be confirmed by retrieving the FTP Server setting information with GetFTPServerSettingList().

Definition

CrError SetFTPServerSetting(CrDeviceHandle deviceHandle, CrFTPServerSetting* setting);

Input parameters

Type	Explanation
CrDeviceHandle	deviceHandle
CrFTPServerSetting*	setting This parameter points to the CrFTPServerSetting object which contains the FTP Server setting information that will be set to the device.

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: SetFTPServerSetting callback

• GetFTPServerSettingList

Special note (details)

This API can be executed when CrDeviceProperty_FTPServerSettingOperationEnableStatus is Enable.

When [Access Authen.] is set to [Off] at the camera body, communication is performed without SSH connection authentication or encryption, so the content may be intercepted, or the camera may be accessed by an unintended third party.

RequestFTPTransferResult

Overview

Request the FTP Transfer result information.

After execution, the SDK will notify the FTP Transfer result with the OnNotifyFTPTransferResult callback.

See to “OnNotifyFTPTransferResult() callback”.

Definition

CrError RequestFTPTransferResult(CrDeviceHandle deviceHandle, CrSlotNumber slotNumber);

Input parameters

Type	Explanation
CrDeviceHandle	deviceHandle
CrSlotNumber	slotNumber Specifies the slot from which to get the FTP Transfer result.

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::OnNotifyFTPTransferResult

  See: RequestFTPTransferResult callback

Special note (details)

If the camera is not supported, CrError_Generic_NotSupported will be returned when executing the API. There is no Device Property that indicates whether this API can be executed or not.