CTR-Pia
5.4.3
Game Communication Engine
メインページ
ネームスペース一覧
クラス構成
クラス索引
関連ページ
Result 検索
全て
クラス
ネームスペース
関数
変数
型定義
列挙型
列挙型の値
ページ
lan_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/lan/lan_Definitions.h>
17
18
19
// lan モジュールの非メンバ関数群です。
20
21
namespace
nn
22
{
23
namespace
pia
24
{
25
namespace
lan
26
{
27
28
29
/*!
30
@brief lan モジュールが初期化された状態であるかどうかを返します。
31
32
@return 初期化されていれば true、されていなければ false が返されます。
33
*/
34
bool
IsInitialized
(
void
);
35
36
37
/*!
38
@brief lan モジュールを初期化します。
39
40
@return 無事に初期化が完了すれば、成功の Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
41
@retval ResultAlreadyInitialized 既に初期化は終了しています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
42
@see Setting
43
*/
44
Result
Initialize
();
45
46
47
/*!
48
@brief lanモジュールを終了します。
49
*/
50
void
Finalize
(
void
);
51
52
53
/*!
54
@brief セットアップの開始を宣言します。
55
@details lanモジュールのシングルトンなどを作成する前に呼び出す必要があります。
56
アプリケーションが lan モジュールのシングルトンを一つも作成しない場合であっても、
57
このAPIと @ref EndSetup は必ず呼び出す必要があります。
58
59
@return この API を適切なタイミングで呼び出していれば、成功の Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
60
@retval ResultNotInitialized lan モジュールの初期化関数が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
61
@retval ResultInvalidState この関数を呼び出すタイミングが誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
62
*/
63
Result
BeginSetup
(
void
);
64
65
66
/*!
67
@brief セットアップの終了を宣言します。
68
@details lan モジュールのシングルトンなどを作成し終えた後に呼び出す必要があります。。
69
この API 呼び出しにより、lan モジュールのシングルトンなどが消費する
70
メモリを確定し、ライブラリ内部でのメモリ管理を最適化します。
71
アプリケーションが lan モジュールのシングルトンを一つも作成しない場合であっても、
72
@ref BeginSetup とこの API は必ず呼び出す必要があります。
73
74
@return この API を適切なタイミングで呼び出していれば、成功の Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
75
@retval ResultNotInitialized lan モジュールの初期化関数が呼ばれていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
76
@retval ResultInvalidState この関数を呼び出すタイミングが誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
77
*/
78
Result
EndSetup
(
void
);
79
80
81
/*!
82
@cond PRIVATE
83
@brief BeginSetup() ~ EndSetup()間の状態であるかどうかを返します。
84
@endcond
85
*/
86
bool
IsInSetupMode(
void
);
87
}
88
}
89
}
// end of namespace nn::pia::lan
Include
nn
pia
lan
lan_Api.h
© 2016 Nintendo Co., Ltd. All rights reserved. 記載されている会社名、製品名等は、各社の登録商標または商標です。