cwbUP_SetEntryAttributes

Purpose

Sets any of the following attribute values of the update entry:
CWBUP_FILE_DRIVEN
Updates are based on file date comparisons between target and source files.
CWBUP_PACKAGE_DRIVEN
Updates are based on contents of the package file(s), and comparisons of their files' dates between target and source.
CWBUP_SUBDIRECTORY
Update compares and updates directories under the given path.
CWBUP_ONEPASS
Updates occur directly in one pass. If this isn't specified, updates occur in two passes. The first pass copies the files to be updated to a temporary directory, and then when the PC is rebooted, the files are copied to the target directory.
CWBUP_BACKLEVEL_OK
If this is set, updates will occur if the dates of the files on the source and target don't match. If this is not set, updates will only occur if the source file is more recent than the target file.
Any combination of these values is valid.

Syntax

 
unsigned int CWB_ENTRY cwbUP_SetEntryAttributes(
                             cwbUP_EntryHandle entryHandle,
                             unsigned long entryAttributes);

Parameters

cwbUP_EntryHandle entryHandle - input
Handle that was returned by a previous call to cwbUP_CreateUpdateEntryHandle, cwbUP_GetUpdateEntryHandle, or to cwbUP_FindEntry.
unsigned long entryAttributes - input
Combination of the attribute values. (See defines section for values)

Return Codes

The following list shows common return values.

CWB_OK
Successful completion.
CWB_INVALID_HANDLE
Update entry handle is not valid.
CWBUP_ENTRY_IS_LOCKED
Another application is currently changing the update entry list. No changes are allowed at this time.

Usage

An example of this call follows:

rc = cwbUP_SetEntryAttributes(entryHandle, CWBUP_FILEDRIVEN | CWBUP_ONEPASS );

This call would result in the update entry being file driven and the update would occur in one pass.