FEditorFileUtils::CheckoutPackages

Check out the specified packages from source control and report any errors while checking out

Windows
MacOS
Linux

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/FileHelpers.h

Include

#include "FileHelpers.h"

Source

/Engine/Source/Editor/UnrealEd/Private/FileHelpers.cpp

Syntax

static ECommandResult::Type CheckoutPackages
(
    const TArray< FString > & PkgsToCheckOut,
    TArray< FString > * OutPackagesCheckedOut,
    const bool bErrorIfAlreadyCheckedOut
)

Remarks

Check out the specified packages from source control and report any errors while checking out

Returns

the result of the check out operation

Parameters

Parameter

Description

PkgsToCheckOut

Reference to array of package names to check out

OutPackagesCheckedOut

If not NULL, this array will be populated with packages that were checked out.

bErrorIfAlreadyCheckedOut

true to consider being unable to checkout a package because it is already checked out an error, false to allow this without error
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss