MI_DestinationOptions_GetCredentialsPasswordAt function (mi.h)

Gets a credentials password based on a specified index.

Syntax

MI_INLINE MI_Result MI_DestinationOptions_GetCredentialsPasswordAt(
  [in]            MI_DestinationOptions *options,
                  MI_Uint32             index,
                  const MI_Char         **optionName,
                  MI_Char               *password,
  [in]            MI_Uint32             bufferLength,
  [out]           MI_Uint32             *passwordLength,
  [out, optional] MI_Uint32             *flags
);

Parameters

[in] options

MI_DestinationOptions object returned from MI_Application_NewDestinationOptions.

index

Zero-based index of the credentials password.

optionName

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

password

Returned password. This memory should be freed for security purposes when finished.

[in] bufferLength

Length of the password buffer. If 0, the passwordLength parameter will contain the buffer size needed to hold the password.

[out] passwordLength

Returned amount of the password buffer used, including the null terminator.

[out, optional] flags

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

Remarks

Passwords should not be stored in memory for long periods of time in an unencrypted manner, as there are ways to snoop for them. After using the password, call the SecureZeroMemory function to clear out the password before deleting it.

Requirements