MI_SubscriptionDeliveryOptions_GetCredentialsAt function (mi.h)

Gets a previously added credential based on a specified index.

Syntax

MI_INLINE MI_Result MI_SubscriptionDeliveryOptions_GetCredentialsAt(
  [in]            MI_SubscriptionDeliveryOptions *self,
                  MI_Uint32                      index,
                  const MI_Char                  **optionName,
  [out]           MI_UserCredentials             *credentials,
  [out, optional] MI_Uint32                      *flags
);

Parameters

[in] self

A MI_SubscriptionDeliveryOptions structure.

index

Zero-based index of the credential.

optionName

A pointer to a null-terminated string containing the returned credential name.

[out] credentials

Returned user credentials. Passwords are always set to asterisks for security reasons. To get the actual password, call the MI_SubscriptionDeliveryOptions_GetCredentialsPasswordAt function.

[out, optional] flags

Returned credential 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

See also

MI_SubscriptionDeliveryOptions

MI_SubscriptionDeliveryOptions_GetCredentialsPasswordAt