ISSOAdmin.GetApplicationInfo Method

Artigo
04/19/2022

The GetApplicationInfo method gets the application information from the Enterprise Single Sign-On (SSO) server database.

Syntax

  
HRESULT GetApplicationInfo(  
BSTR bstrApplicationName,  
BSTR* pbstrDescription,  
BSTR* pbstrContactInfo,  
BSTR* pbstrUserGroupName,  
BSTR* pbstrAdminGroupName,  
LONG* plFlags,  
LONG* plNumFields  
);

  
Function GetApplicationInfo(  
bstrApplicationName As String,  
pbstrDescription As String,  
pbstrContactInfo As String,  
pbstrUserGroupName As String,  
pbstrAdminGroupName As String,  
plFlags As Long  
)  
As Long

Parameters

bstrApplicationName
[in] String that specifies the application name. This parameter cannot be NULL, an empty string, or contain spaces. Application names are not case-sensitive, but case will be preserved. For example, ABC, abc, and AbC are considered to be the same application.

pbstrDescription
[out] Pointer to a string that receives the description for the application.

pbstrDescription
[out] String that receives the description for the application.

pbstrContactInfo
[out] Pointer to a string that receives the contact information for the application.

pbstrContactInfo
[out] String that receives the contact information for the application.

pbstrUserGroupName
[out] Pointer to a string that receives the application user group name.

pbstrUserGroupName
[out] String that receives the application user group name.

pbstrAdminGroupName
[out] Pointer to a string that receives the Application Administrator group name.

pbstrAdminGroupName
[out] String that receives the Application Administrator group name.

plFlags
[out] Pointer to a long integer that receives the flags currently set for the application.

plFlags
[out] Long that receives the flags currently set for the application.

plNumFields
[out] Pointer to a long integer that receives the number of fields associated with the application.

Return Value

This method returns an HRESULT indicating whether it completed successfully. For more details, see the Error Values section.

This method returns a Long that receives the number of fields associated with the application.

Error Values

This method returns an HRESULT containing one of the values in the following table.

This method indicates errors by setting the Number property of the global Err object to one of the values in the following table.

Value	Description
S_OK	The method succeeded.
E_ACCESSDENIED	Access is denied to the caller.
E_INVALIDARG	An invalid parameter was detected.

Remarks

To access this method, you must be an SSO Administrator, SSO Affiliate Administrator, or an SSO Application Administrator.

Requirements

Platforms: Windows Server 2022, Windows Server 2019, Windows Server 2016, Windows 11, and Windows 10

Partilhar via