BuildPatchServices::IPlatform Class Reference

#include <Platform.h>

Inheritance diagram for BuildPatchServices::IPlatform:

Public Member Functions
virtual	~IPlatform ()
virtual bool	ExecElevatedProcess (const TCHAR *URL, const TCHAR *Params, int32 *OutReturnCode)=0
virtual void	Sleep (float Seconds)=0
virtual uint32	GetLastError ()=0

Detailed Description

Class for wrapping platform functionality. We implement this using a template class, so that the class with platform dependency can easily be provided an implementation, and can still be nicely tested. Under normal circumstances, use FPlatform, which is a typedef below, and/or FPlatformFactory::Create.

Constructor & Destructor Documentation

~IPlatform()

virtual BuildPatchServices::IPlatform::~IPlatform ( )

inlinevirtual

Member Function Documentation

ExecElevatedProcess()

virtual bool BuildPatchServices::IPlatform::ExecElevatedProcess ( const TCHAR *  URL, const TCHAR *  Params, int32 *  OutReturnCode  )

pure virtual

Executes a process as administrator, requesting elevation as necessary. This call blocks until the process has returned.

Parameters

URL	IN The URL of the process to execute, typically the path to an executable file
Params	IN The params to pass to the invoked process
OutReturnCode	OUT Will be set to the return code of the executed process

Returns

true if the execution was successful.

Implemented in BuildPatchServices::TPlatform< FPlatformProcessImpl, FPlatformMiscImpl >.

GetLastError()

virtual uint32 BuildPatchServices::IPlatform::GetLastError ( )

pure virtual

Returns

The error value for last platform error that occurred.

Implemented in BuildPatchServices::TPlatform< FPlatformProcessImpl, FPlatformMiscImpl >.

Sleep()

virtual void BuildPatchServices::IPlatform::Sleep ( float  Seconds )

pure virtual

Sleep this thread for Seconds. 0.0 means release the current time slice to let other threads get some attention.

Parameters

Seconds

The time in seconds to sleep for.

Implemented in BuildPatchServices::TPlatform< FPlatformProcessImpl, FPlatformMiscImpl >.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Online/BuildPatchServices/Private/Core/Platform.h