Share via

ICcConnection::SendFile (Compact 2013)

  • Article

3/26/2014

Deprecated.

This method copies a specified file from the desktop to the device.

In Windows Embedded Compact 2013, CoreCon HLAPI has been deprecated.

Syntax

HRESULT SendFile(
  LPCOLESTR in_szDesktopFile,
  LPCOLESTR in_szDeviceFile,
  FileAction in_FileAction,
  DWORD dwCreationDisposition,
  LPCOLESTR in_FileCustomAction
);

Parameters

  • in_szDesktopFile
    [in] Desktop file name.
    This parameter can also designate a CSIDL special directory. For more information, see Remarks.
  • in_szDeviceFile
    [in] Device file name.
    This parameter can also designate a CSIDL special directory. For more information, see Remarks.

  • in_FileActiondwCreationDisposition
    [in] Flag indicating the file copy action to take. The following table shows possible values for this flag.

    Flag value

    Description

    CREATE_ALWAYS

    Creates a file.
    If the file exists, the function overwrites the file and clears the existing attributes. In addition, it combines the specified file attributes and flags with FILE_ATTRIBUTE_ARCHIVE. Does not set the security descriptor specified by the SECURITY_ATTRIBUTES structure.

    CREATE_NEW

    Creates a file. The function fails if the specified file exists.

    OPEN_ALWAYS

    Opens the file, if it exists. If the file does not exist, the function creates the file as if dwCreationDisposition were CREATE_NEW.

    OPEN_EXISTING

    Opens the file. The function fails if the file does not exist.

    TRUNCATE_EXISTING

    Opens the file and truncates it so that its size is zero bytes. The calling process must open the file with the GENERIC_WRITE access right. The function fails if the file does not exist.
  • in_FileCustomAction
    [in] Custom file action.

Return Value

If the method fails, it returns an HRESULT error code.

If the method succeeds, it returns one of the following:

Value

Description

S_OK

Indicates the method call was successful.

E_INVALIDARG

Indicates invalid arguments.

E_FAIL

Indicates any other failure.

Remarks

The caller can specify a CSIDL file path for in_szDesktopFileandin_szDeviceFileby using a special string substitution format.

CSIDL values provide a unique system-independent way to identify these special folders. The values supersede the use of environment variables for this purpose.

The format of the substitution string is %CSIDL_<tag>%\mydirectory\myfile.ext, where CSIDL_<tag> must be one of the following strings.

CSIDL_<tag> string

Description

CSIDL_APPDATA

File system directory that serves as a common repository for application-specific data.

CSIDL_COMMON_APPDATA

File system directory containing application data for all users.
A typical path is C:\Documents and Settings\All Users\Application Data.

CSIDL_DESKTOPDIRECTORY

The file system path to the desktop directory.

CSIDL_FAVORITES

File system directory that serves as a common repository for the user's favorite items.

CSIDL_FONTS

Virtual folder containing fonts.

CSIDL_PERSONAL

File system directory that serves as a common repository for documents.

CSIDL_PROFILE

Folder that contains the profile of the user.

CSIDL_PROGRAM_FILES

Program files folder.

CSIDL_PROGRAMS

File system directory that contains the user's program groups, which are also file system directories.

CSIDL_STARTMENU

File system directory that contains Start menu items.

CSIDL_STARTUP

File system directory that corresponds to the user's Startup program group.
The system starts these programs when a device is turned on.

CSIDL_WINDOWS

Windows folder.

Each of the CSIDL tags expands to the information provided by SHGetSpecialFolderPath.

That is, the following string

%CSIDL_WINDOWS%\myfile.txt

expands to \WINDOWS\myfile.txt if SHGetSpecialFolderPath returns

\Windows

when passed CSIDL_WINDOWS.

The CSIDL_<tag> string must appear as the first element in the argument.

Requirements

Header

ccconnection.h

See Also

Reference

ICcConnection
Core Connectivity Interfaces