Album::GetAlbum

Defined in: C4Slug.h

Returns a new reference to an album object.

Prototype

static Album *GetAlbum(const char *name);

Parameters

name The name of the album resource.

Description

The GetAlbum function returns a new reference to the album object specified by the name parameter. If the album resource has already been loaded, then its reference count is incremented and a pointer to the existing object is returned. If the album specified by the name parameter does not exist, then the return value is nullptr.

The Shared::Release function must be called for the returned album object to balance each call to the GetAlbum function. A convenient way to accomplish this automatically is to use the AutoReleaseAlbum class.