Main Page | Class Hierarchy | Class Members | Global Enums and Constants | Global Entry Points | Related Pages

IAccFileXferSession Interface Reference

Inherits IAccSecondarySession.


Detailed Description

IAccFileXferSession is used for managing individual file/folder transfers.

Public Types

Public Member Functions

Properties


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::ResolveCollision ( [in] AccFileXferSessionCollisionAction  action,
[in, defaultvalue("")] xp_kstr  path 
)

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


Property Documentation

xp_variant IAccFileXferSession::Property_( [in] AccFileXferSessionProp property) ( [in] AccFileXferSessionProp  property  )  [get]

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

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

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


Questions? Stop by the AIM SDK Developer Forum
Created Mon Oct 15 18:06:39 2007 for AIM: Developer SDK
© 2007 AOL LLC. All Rights Reserved.