File Object

The File object manages information about a file being transferred.

The File object is instantiated with the INmChannelFt::SendFile method.

INmFt Interface

Back to COM Object Reference

INmFt Interface

This interface defines the file that will be transferred, including its transfer state, size, and owner.

Cancel

GetBytesTransferred

GetMember

GetName

GetSize

GetState

IsIncoming

Back to File Object

INmFt::Cancel

HRESULT Cancel(void);

Cancels the file transfer operation.

• Returns S_OK if successful, or E_FAIL if not.

Back to INmFt Interface

Back to File Object

Back to COM Object Listing

INmFt::GetBytesTransferred

HRESULT GetBytesTransferred(
    [out] ULONG *puBytes);

Retrieves the current number of bytes transferred.

• Returns S_OK if successful, or E_POINTER if the puBytes pointer is invalid.

puBytes

Pointer to a ULONG that contains the number of bytes transferred.

Back to INmFt Interface

Back to File Object

Back to COM Object Listing

INmFt::GetMember

HRESULT GetMember(
    [out] INmMember **ppMember);

Retrieves a pointer to information about the remote member of the file transfer based on one of the following conditions:

• If incoming, it returns a pointer to the sending member.
• If outgoing, it returns a pointer to the destination member.
• If sent to everyone, it returns NULL.

• Returns S_OK if successful, or E_POINTER if ppMember is an invalid pointer.

ppMember

Pointer to a pointer to the INmMember Interface on the Member object involved with the file transfer.

The Member object must be released once the application is through with it.

Back to INmFt Interface

Back to File Object

Back to COM Object Listing

INmFt::GetName

HRESULT GetName(
    [out] BSTR *pbstrName);

Retrieves the string for the full path of the file.

• Returns one of the following values:

  S_OK	Success.
  E_POINTER	pbstrName is an invalid pointer.
  E_FAIL	Internal resources are not available.
  E_OUTOFMEMORY	Memory could not be allocated to service the request.

pbstrName

Pointer to a BSTR for the full path of the file.

Back to INmFt Interface

Back to File Object

Back to COM Object Listing

INmFt::GetSize

HRESULT GetSize(
    [out] ULONG *puBytes);

Retrieves the size of the file, in bytes.

• Returns S_OK if successful, or E_POINTER if puBytes is an invalid pointer.

puBytes

Pointer to a ULONG that contains the size of the file, in bytes.

Back to INmFt Interface

Back to File Object

Back to COM Object Listing

INmFt::GetState

HRESULT GetState(
    [out] NM_FT_STATE *uState);

Retrieves the state of the file being transferred.

• Returns S_OK if successful, or E_POINTER if uState is an invalid pointer.

uState

Pointer to the state of the file being transferred. Possible constants include:

NM_FT_COMPLETE	The file transfer is complete.
NM_FT_INVALID	The file transfer is not valid.
NM_FT_RECEIVING	The file transfer is currently being received.
NM_FT_SENDING	The file transfer is currently being sent.

Note that the NM_FT_COMPLETE value simply represents completion of the operation. The operation might have finished due to success, cancellation, or failure.

Back to INmFt Interface

Back to File Object

Back to COM Object Listing

INmFt::IsIncoming

HRESULT IsIncoming(
    void);

Determines whether the current File object is being transferred to the local computer.

• Returns one of the following:

  S_OK	The file is being transferred to the local computer. The INmFt::GetMember method may be used to determine who sent the file.
  S_FALSE	The file is being transferred from the local computer. The INmFt::GetMember method may be used to determine the destination. Note that INmFt::GetMember may return a NULL value if the file was broadcast to everyone.

Back to INmFt Interface

Back to File Object

Back to COM Object Listing

Last Updated: November 1, 1997
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.