IAccFileXferSession Interface Reference

Inherits IAccSecondarySession.

---

Detailed Description

IAccFileXferSession is used for managing individual file/folder transfers.

Public Types

• enum AccFileXferSessionProp {
    AccFileXferSessionProp_CurrentFileXfer = 1000,
    AccFileXferSessionProp_DownloadDirPath,
    AccFileXferSessionProp_FileSharingSession,
    AccFileXferSessionProp_IsDirectory,
    AccFileXferSessionProp_Name,
    AccFileXferSessionProp_Send,
    AccFileXferSessionProp_Speed,
    AccFileXferSessionProp_TotalBytes,
    AccFileXferSessionProp_TotalBytesXferred,
    AccFileXferSessionProp_TotalNumFiles,
    AccFileXferSessionProp_TotalNumFilesRemaining
  }
• enum AccFileXferSessionCollisionAction {
    AccFileXferSessionCollisionAction_SaveAs,
    AccFileXferSessionCollisionAction_Skip,
    AccFileXferSessionCollisionAction_Replace,
    AccFileXferSessionCollisionAction_SkipAll,
    AccFileXferSessionCollisionAction_ReplaceAll
  }
• typedef enum
  IAccFileXferSession::AccFileXferSessionProp AccFileXferSessionProp
• typedef enum
  IAccFileXferSession::AccFileXferSessionCollisionAction AccFileXferSessionCollisionAction

Public Member Functions

• HRESULT Property_ ([in] AccFileXferSessionProp property,[out, retval] xp_variant *value)
• HRESULT Property_ ([in] AccFileXferSessionProp property,[in] xp_kvariant value)
• HRESULT ResolveCollision ([in] AccFileXferSessionCollisionAction action,[in, defaultvalue("")] xp_kstr path)

---

Member Typedef Documentation

typedef enum IAccFileXferSession::AccFileXferSessionProp IAccFileXferSession::AccFileXferSessionProp

Properties for the Property method.

typedef enum IAccFileXferSession::AccFileXferSessionCollisionAction IAccFileXferSession::AccFileXferSessionCollisionAction

Options for dealing with a file collision.

---

Member Enumeration Documentation

enum IAccFileXferSession::AccFileXferSessionProp

Properties for the Property method.

Enumerator:

AccFileXferSessionProp_CurrentFileXfer	The current file being sent [get] IAccFileXfer**
AccFileXferSessionProp_DownloadDirPath	The download path for files to be transfered to [get] xp_str* [put] xp_kstr
AccFileXferSessionProp_FileSharingSession	The file sharing session, if any may be NULL [get] IAccFileXferSession**
AccFileXferSessionProp_IsDirectory	Whether this is a transfer of a file or directory [get] xp_bool*
AccFileXferSessionProp_Name	Name of the transfer, either the file or directory name [get] xp_str* [put] xp_kstr
AccFileXferSessionProp_Send	Whether this transfer is a send or a receive [get] xp_bool*
AccFileXferSessionProp_Speed	Overall bytes per second of this session [get] xp_s32*
AccFileXferSessionProp_TotalBytes	Total bytes to be transferred for this session [get] xp_s64*
AccFileXferSessionProp_TotalBytesXferred	Total bytes transferred so far [get] xp_s64*
AccFileXferSessionProp_TotalNumFiles	Total number of files in the transfer [get] xp_s32*
AccFileXferSessionProp_TotalNumFilesRemaining	Number of files remaining to be transfered [get] xp_s32*

enum IAccFileXferSession::AccFileXferSessionCollisionAction

Options for dealing with a file collision.

Enumerator:

AccFileXferSessionCollisionAction_SaveAs
AccFileXferSessionCollisionAction_Skip
AccFileXferSessionCollisionAction_Replace
AccFileXferSessionCollisionAction_SkipAll
AccFileXferSessionCollisionAction_ReplaceAll

---

Member Function Documentation

HRESULT IAccFileXferSession::Property_	(	[in] AccFileXferSessionProp	property,
		[out, retval] xp_variant *	value
	)			[get]

DEPRECATED. Use IAccSecondarySession::Property instead. Get a specific property of the session.

HRESULT IAccFileXferSession::Property_	(	[in] AccFileXferSessionProp	property,
		[in] xp_kvariant	value
	)			[set]

DEPRECATED. Use IAccSecondarySession::Property instead. Set a specific property of the session.

HRESULT IAccFileXferSession::ResolveCollision	(	[in] AccFileXferSessionCollisionAction	action,
		[in, defaultvalue("")] xp_kstr	path
	)

Used to respond to DAccEvents::OnFileXferCollision. The action specified by "action" will be taken.