ISSOAdmin.CreateFieldInfo 方法

CreateFieldInfo方法會建立應用程式的欄位資訊。

語法

  
HRESULT CreateFieldInfo(  
BSTR bstrApplicationName,  
BSTR bstrLabel,  
LONG lFlags  
);  
  
Sub CreateFieldInfo(  
bstrApplicationName As String,  
bstrLabel As String,  
lFlags As Long  
)  

參數

bstrApplicationName
[in] 指定應用程式名稱的字串。 這個參數不可以是 NULL 或空字串,或是包含空格。 應用程式名稱不區分大小寫,但是將會保留原來的大小寫。 例如,ABC、abc 和 AbC 都會被視為相同的應用程式。

bstrApplicationName
[in] 指定應用程式名稱的字串。 這個參數不可以是 NULL 或空字串,或是包含空格。 應用程式名稱不區分大小寫,但是將會保留原來的大小寫。 例如,ABC、abc 和 AbC 都會被視為相同的應用程式。

bstrLabel
[in]指定標籤值的字串。 這個參數不可以是 NULL 或空字串。

bstrLabel
[in]指定標籤值的字串。 這個參數不可以是 NULL 或空字串。

lFlags
[in]長整數會指定欄位是否已遮罩。 如果顯示在使用者介面中的欄位必須遮罩,請指定 SSO_FLAG_FIELD_INFO_MASK。 第一個 (使用者識別碼) 欄位不會遮罩,因此將忽略此旗標參數。

lFlags
[in]長整數會指定欄位是否已遮罩。 如果顯示在使用者介面中的欄位必須遮罩,請指定 SSO_FLAG_FIELD_INFO_MASK。 第一個 (使用者識別碼) 欄位不會遮罩,因此將忽略此旗標參數。

傳回值

這個方法會傳回 HRESULT,指出它是否已成功完成。 如需詳細資訊,請參閱「錯誤值」一節。

不適用。

錯誤值

這個方法會傳回 HRESULT,其中包含下表的一個值。

此方法會將全域 Err 物件的 Number 屬性設定為下表中的其中一個值,以指出錯誤。

描述
S_OK 此方法已成功。
E_ACCESSDENIED 拒絕呼叫者的存取。
E_INVALIDARG 偵測到無效的參數。

備註

必須先結束應用程式才能建立其欄位資訊。 新增的欄位數目必須等於建立應用程式時所指定的 numFields 值,否則會在執行時間停用應用程式。

雖然外部使用者識別碼不會被視為外部認證,但是仍然需要透過欄位來描述使用者介面顯示此識別碼的方式。 第一個建立的欄位會被視為描述外部使用者識別碼的欄位。 至少需要一個欄位,而且通常至少應指定兩個欄位來提供認證。 應用程式不能有認證。

若要存取此方法,您必須是 SSO 系統管理員、SSO 分支機構系統管理員,或是 SSO 應用程式系統管理員。

規格需求

平臺:Windows Server 2022、Windows Server 2019、Windows Server 2016、Windows 11和Windows 10

另請參閱

企業單一登入程式設計
ISSOAdmin 介面 (COM)
ISSOAdmin 成員