SetupSetPlatformPathOverride

The SetupSetPlatformPathOverride function sets the platform path override or removes it if none is specified.

BOOL SetupSetPlatformPathOverride(
  PCTSTR Override  // optional, platform replacement string
);
 

Parameters

Override
This optional parameter points to a string that contains the replacement platform information. For example, "mips", "alpha", "ppc", or "i386".

Return Values

If the function succeeds, the return value is a non-zero value.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

If GetLastError returns ERROR_NOT_ENOUGH_MEMORY, SetupSetPlatformPathOverride was unable to store the Override string.

Remarks

SetPlatformPathOverride is used to change the source path when queuing files. If a platform path override has been set by a call to SetPlatformPathOverride, any setup function that queues file copy operations will examine the final component of the source path and if the final component matches the name of the user's platform, replace it with the override string set by SetPlatformPathOverride.

For example, consider a MIPS-platform machine where the platform has been set to Alpha by a call to SetPlatformPathOverride. After the platform path override has been set, a file copy operation is queued with a source path of \\foo\bar\baz\mips\x.exe, the path will be changed to \\foo\bar\baz\alpha\x.exe.

The paths of file copy operations queued before the path override is set are not changed.

QuickInfo

  Windows NT: Use version 4.0 and later.
  Windows: Use Windows 95 and later.
  Windows CE: Unsupported.
  Header: Declared in setupapi.h.
  Import Library: Link with setupapi.lib.

See Also

Overview, Functions, SetupSetDirectoryId