CTR-Pia
5.4.3
Game Communication Engine
メインページ
ネームスペース一覧
クラス構成
クラス索引
関連ページ
Result 検索
全て
クラス
ネームスペース
関数
変数
型定義
列挙型
列挙型の値
ページ
clone_Api.h
1
/*--------------------------------------------------------------------------------*
2
Copyright (C)Nintendo All rights reserved.
3
4
These coded instructions, statements, and computer programs contain proprietary
5
information of Nintendo and/or its licensed developers and are protected by
6
national and international copyright laws. They may not be disclosed to third
7
parties or copied or duplicated in any form, in whole or in part, without the
8
prior written consent of Nintendo.
9
10
The content herein is highly confidential and should be handled accordingly.
11
*--------------------------------------------------------------------------------*/
12
13
14
#pragma once
15
16
#include <nn/pia/clone/clone_Definitions.h>
17
18
19
namespace
nn
20
{
21
namespace
pia
22
{
23
namespace
clone
24
{
25
26
27
/*!
28
@brief clone モジュールが初期化された状態であるかどうかを返します。
29
30
@return clone モジュールが初期化されていれば true、されていなければ false が返されます。
31
@see Initialize, Finalize
32
*/
33
bool
IsInitialized
(
void
);
34
35
36
/*!
37
@brief clone モジュールを初期化します。
38
39
@return 無事に初期化が完了すれば、成功の Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
40
@retval ResultAlreadyInitialized 既に初期化は終了しています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
41
@see IsInitialized, Finalize
42
*/
43
Result
Initialize
(
void
);
44
45
46
/*!
47
@brief clone モジュールを終了します。
48
Initialize() を呼び出していない状態でこの関数を呼び出した場合は、
49
何もせずに返ります。
50
51
@see IsInitialized, Initialize
52
*/
53
void
Finalize
(
void
);
54
55
56
/*!
57
@brief セットアップの開始を宣言します。
58
59
@return この関数を適切なタイミングで呼び出していれば、成功の Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
60
@retval ResultNotInitialized clone::Initialize() が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
61
@retval ResultInvalidState この関数を呼び出すタイミングが誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
62
@see EndSetup
63
*/
64
Result
BeginSetup
(
void
);
65
66
67
/*!
68
@brief セットアップの終了を宣言します。
69
70
@return この関数を適切なタイミングで呼び出していれば、成功の Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
71
@retval ResultNotInitialized clone::Initialize() が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
72
@retval ResultInvalidState この関数を呼び出すタイミングが誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
73
@see BeginSetup
74
*/
75
Result
EndSetup
(
void
);
76
77
78
/*!
79
@cond PRIVATE
80
@brief BeginSetup() ~ EndSetup()間の状態であるかどうかを返します。
81
82
@details この関数はスレッドセーフです。
83
*/
84
bool
IsInSetupMode(
void
);
85
//! @endcond
86
}
87
}
88
}
// end of namespace nn::pia::clone
Include
nn
pia
clone
clone_Api.h
© 2016 Nintendo Co., Ltd. All rights reserved. 記載されている会社名、製品名等は、各社の登録商標または商標です。