Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > UnrealEd > FEditorFileUtils > CheckoutPackages > FEditorFileUtils::CheckoutPackages

Light Theme

Dark Theme

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< UPackage * > & PkgsToCheckOut,
    TArray< UPackage * > * OutPackagesCheckedOut,
    const bool bErrorIfAlreadyCheckedOut,
    const bool bConfirmPackageBranchCheckOutStatus
)

Remarks

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

Returns

true if all the packages were checked out successfully

Parameters

Parameter	Description
PkgsToCheckOut	Reference to array of packages 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
bConfirmPackageBranchCheckOutStatus	true to prompt user on whether a package that is checked out or modified in another branch should be checked out, false to silently attempt check out.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss