IGetClusterObjectInfo::GetObjectName メソッド (cluadmex.h)
[このメソッドは、[要件] セクションで指定したオペレーティング システムで使用できます。 このメソッドのサポートは、Windows Server 2008 で削除されました。]
クラスター オブジェクトの名前を返します。
構文
HRESULT GetObjectName(
[in] LONG lObjIndex,
[out] BSTR lpszName,
[in, out] LONG *pcchName
);
パラメーター
[in] lObjIndex
ターゲット オブジェクトの 0 から始まるインデックスを表す数値。 lObjIndex は、 IGetClusterDataInfo::GetObjectCount を呼び出すことによって取得できる数に制限されます。
[out] lpszName
lObjIndex に関連付けられているオブジェクトの名前を含む null で終わる Unicode 文字列へのポインター。 lpszName パラメーターには NULL を指定できます。これは、呼び出し元が名前の長さのみを要求していることを示します。 BSTR として宣言されていますが、このパラメーターは LPWSTR として実装されます。
[in, out] pcchName
入力時に、 lpszName パラメーターが指すバッファー内の文字数へのポインター。 pcchName パラメーターを NULL にすることはできません。 出力時に、 lpszName のコンテンツに格納されている名前の文字数 ( NULL 終端文字を含む) へのポインター。
戻り値
GetObjectName が成功しなかった場合は、他の HRESULT 値を返すことができます。
リターン コード/値 | Description |
---|---|
|
操作に成功しました。 |
|
1 つ以上のパラメーターが無効です。 |
|
lpszName が指すバッファーが小さすぎて、要求された名前を保持できません。 GetObjectName は、pcchName のコンテンツに必要な文字数を返します。 |
解説
lpszName パラメーターが NULL として指定されている場合、GetObjectName メソッドは NOERROR を返します。
要件
サポートされている最小のクライアント | サポートなし |
サポートされている最小のサーバー | Windows Server 2003 Enterprise、Windows Server 2003 Datacenter |
対象プラットフォーム | Windows |
ヘッダー | cluadmex.h |