QLibrary Class

メンバ関数のドキュメント

[explicit] QLibrary::QLibrary(QObject *parent = nullptr)

指定されたparent を使用してライブラリを構築します。

[explicit] QLibrary::QLibrary(const QString &fileName, QObject *parent = nullptr)

指定されたparent を使用してライブラリオブジェクトを構築し、fileName で指定されたライブラリを読み込みます。

fileName にはファイルの拡張子を省略することを推奨します。QLibrary はプラットフォームに応じて適切な拡張子（例：Unix では ".so"、macOS および iOS では ".dylib"、Windows では ".dll"）を持つファイルを自動的に検索するためです。（fileName を参照してください。）

[explicit] QLibrary::QLibrary(const QString &fileName, const QString &version, QObject *parent = nullptr)

指定されたparent を使用してライブラリオブジェクトを構築し、fileName で指定されたライブラリと、完全なバージョン番号version を読み込みます。現在、Windowsではバージョン番号は無視されます。

fileName ではファイルの拡張子を省略することを推奨します。QLibrary はプラットフォームに応じて適切な拡張子（例：Unix では ".so"、macOS および iOS では ".dylib"、Windows では ".dll"）を持つファイルを自動的に検索するためです。（fileName を参照してください。）

[explicit] QLibrary::QLibrary(const QString &fileName, int verNum, QObject *parent = nullptr)

指定されたparent を使用してライブラリオブジェクトを構築し、fileName で指定されたライブラリと、メジャーバージョン番号verNum をロードします。現在、Windowsではバージョン番号は無視されます。

fileName ではファイルの拡張子を省略することを推奨します。QLibrary はプラットフォームに応じて適切な拡張子（例：Unix では「.so」、macOS および iOS では「.dylib」、Windows では「.dll」）を持つファイルを自動的に検索するためです。（fileName を参照してください。）

[virtual noexcept] QLibrary::~QLibrary()

QLibrary オブジェクトを破棄します。

unload() が明示的に呼び出されていない限り、ライブラリはアプリケーションが終了するまでメモリ上に残ります。

isLoaded() およびunload()も参照してください 。

QString QLibrary::errorString() const

最後に発生したエラーの説明を含むテキスト文字列を返します。現在、errorString は、load()、unload()、またはresolve() が何らかの理由で失敗した場合にのみ設定されます。

[static] bool QLibrary::isLibrary(const QString &fileName)

fileName にロード可能なライブラリの有効なサフィックスが含まれている場合は `true ` を返し、そうでない場合は `false` を返します。

Unix における末尾のバージョン番号は無視されます。

bool QLibrary::isLoaded() const

load() が成功した場合は `true ` を返し、そうでない場合は `false` を返します。

load()も参照してください 。

bool QLibrary::load()

ライブラリを読み込み、読み込みに成功した場合はtrue を返し、失敗した場合はfalse を返します。resolve()は、シンボルを解決する前に常にこの関数を呼び出すため、明示的に呼び出す必要はありません。状況によっては、ライブラリを事前に読み込んでおきたい場合があるかもしれませんが、その場合はこの関数を使用します。

unload()も参照してください 。

QFunctionPointer QLibrary::resolve(const char *symbol)

エクスポートされたシンボル `symbol` のアドレスを返します。必要に応じてライブラリが読み込まれます。シンボルを解決できなかった場合や、ライブラリを読み込めなかった場合、この関数は `nullptr ` を返します。

例：

typedef int (*AvgFunction)(int, int);

AvgFunction avg = (AvgFunction) library->resolve("avg");
if (avg)
    return avg(5, 8);
else
    return -1;

このシンボルは、ライブラリからC関数としてエクスポートされている必要があります。つまり、ライブラリがC++コンパイラでコンパイルされている場合、この関数はextern "C" でラップされている必要があります。Windowsでは、さらに__declspec(dllexport) コンパイラ指令を使用して、DLLからこの関数を明示的にエクスポートする必要があります。例：

extern "C" MY_EXPORT int avg(int a, int b)
{
    return (a + b) / 2;
}

ここで、MY_EXPORT は次のように定義されます。

#ifdef Q_OS_WIN
#define MY_EXPORT __declspec(dllexport)
#else
#define MY_EXPORT
#endif

[static] QFunctionPointer QLibrary::resolve(const QString &fileName, const char *symbol)

ライブラリ `fileName ` を読み込み、エクスポートされたシンボル `symbol` のアドレスを返します。なお、fileName にはプラットフォーム固有のファイル拡張子を含めないでください（fileName を参照）。ライブラリは、アプリケーションが終了するまで読み込まれたままになります。

シンボルを解決できなかった場合や、ライブラリを読み込めなかった場合、この関数はnullptr を返します。

resolve()も参照してください 。

[static] QFunctionPointer QLibrary::resolve(const QString &fileName, const QString &version, const char *symbol)

完全なバージョン番号version を持つライブラリfileName を読み込み、エクスポートされたシンボルsymbol のアドレスを返します。なお、fileName にはプラットフォーム固有のファイル拡張子を含めないでください（fileName を参照）。ライブラリは、アプリケーションが終了するまで読み込まれたままになります。Windowsでは、version は無視されます。

シンボルを解決できなかった場合、またはライブラリを読み込めなかった場合、この関数はnullptr を返します。

resolve()も参照してください 。

[static] QFunctionPointer QLibrary::resolve(const QString &fileName, int verNum, const char *symbol)

メジャーバージョン番号がverNum のライブラリfileName を読み込み、エクスポートされたシンボルsymbol のアドレスを返します。なお、fileName にはプラットフォーム固有のファイル拡張子を含めないでください（fileName を参照）。ライブラリは、アプリケーションが終了するまで読み込まれたままになります。Windowsでは、verNum は無視されます。

シンボルを解決できなかった場合や、ライブラリを読み込めなかった場合、この関数は `nullptr ` を返します。

resolve()も参照してください 。

void QLibrary::setFileNameAndVersion(const QString &fileName, const QString &version)

fileName プロパティと完全なバージョン番号を、それぞれfileName およびversion に設定します。Windowsでは、version パラメータは無視されます。

setFileName()も参照してください 。

void QLibrary::setFileNameAndVersion(const QString &fileName, int versionNumber)

fileName プロパティとメジャーバージョン番号を、それぞれfileName およびversionNumber に設定します。Windowsでは、versionNumber は無視されます。

setFileName()も参照してください 。

bool QLibrary::unload()

ライブラリをアンロードし、アンロードに成功した場合はtrue を返し、失敗した場合はfalse を返します。

これはアプリケーションの終了時に自動的に行われるため、通常はこの関数を呼び出す必要はありません。

QLibrary の他のインスタンスが同じライブラリを使用している場合、この呼び出しは失敗し、すべてのインスタンスがunload()を呼び出したときにのみアンロードが行われます。

macOS では、ダイナミックライブラリをアンロードすることはできないことに注意してください。QLibrary::unload() はtrue を返しますが、ライブラリはプロセスに読み込まれたままになります。

resolve() およびload()も参照してください 。