MI_DestinationOptions_GetCredentialsAt function (mi.h)

Get the credentials at the specified index.

Syntax

MI_INLINE MI_Result MI_DestinationOptions_GetCredentialsAt(
  [in]            MI_DestinationOptions *options,
                  MI_Uint32             index,
                  const MI_Char         **optionName,
  [out]           MI_UserCredentials    *credentials,
  [out, optional] MI_Uint32             *flags
);

Parameters

[in] options

MI_DestinationOptions object returned from MI_Application_NewDestinationOptions.

index

Zero-based index of the credentials.

optionName

Returned name of the credentials option.

[out] credentials

Returned MI_UserCredentials structure. If the credentials include a password, it will be filled with 6 asterisks for security purposes.

[out, optional] flags

Returned credentials option flags.

Return value

A value of the MI_Result enumeration that specifies the function return code. This can be one of the following codes.

Requirements