SDKBrowsePresets Class Reference Library » Browser

#include <lib_browser.h>

详细描述

Browse presets.

注意
Has to be created with Alloc() and destroyed with Free() 。使用 AutoAlloc to automate the allocation and destruction based on scope.

公共成员函数

Bool   GetNext ( SDKBrowserURL &url, Int32 &plugin_id)

静态公共成员函数

static SDKBrowsePresets Alloc ( Int32 db_index)
static void  Free ( SDKBrowsePresets *browse_presets)

私有成员函数

  SDKBrowsePresets ()
  ~SDKBrowsePresets ()

构造函数 & 析构函数文档编制

◆  SDKBrowsePresets()

SDKBrowsePresets () private

◆  ~SDKBrowsePresets()

~ SDKBrowsePresets () private

成员函数文档编制

◆  Alloc()

static SDKBrowsePresets * Alloc ( Int32   db_index )
static

Allocates a preset browser. Destroy the allocated preset browser with Free() 。使用 AutoAlloc to automate the allocation and destruction based on scope.

参数
[in] db_index The ID of the preset library to browse.
返回
The allocated preset browser, or nullptr if the allocation failed.

◆  Free()

static void Free ( SDKBrowsePresets browse_presets )
static

Destructs reset browsers allocated with Alloc() 。使用 AutoAlloc to automate the allocation and destruction based on scope.

参数
[in,out] browse_presets The preset browser to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

◆  GetNext()

Bool GetNext ( SDKBrowserURL url ,
Int32 plugin_id  
)

Retrieves the next preset.

参数
[out] url Assigned the URL of the preset.
[out] plugin_id Assigned the ID of the plugin that created the preset.
返回
true if a new preset was retrieved, otherwise false .