MI_SubscriptionDeliveryOptions_GetCredentialsPasswordAt function (mi.h)

Gets a previously added credential password based on a specified index.

Syntax

MI_INLINE MI_Result MI_SubscriptionDeliveryOptions_GetCredentialsPasswordAt(
  [in]            MI_SubscriptionDeliveryOptions *self,
                  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] self

A MI_SubscriptionDeliveryOptions structure.

index

Zero-based index of the credential password.

optionName

A pointer to a null-terminated string containing the returned name of the option. This name is owned by the MI_SubscriptionDeliveryOptions structure.

password

Returned password. This parameter is an in/out buffer that is passed in to be filled. This buffer should be cleared (using the SecureZeroMemory function) as soon as the password is no longer needed for security reasons. If the input value is NULL, the bufferLength parameter should be zero, and the length needed will be passed back in the passwordLength parameter.

[in] bufferLength

Length of the password buffer. If 0, the passwordLength value will receive the length of the buffer needed.

[out] passwordLength

Returned password length.

[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

Requirement Value
Minimum supported client Windows 8
Minimum supported server Windows Server 2012
Target Platform Windows
Header mi.h
Redistributable Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2

See also

MI_SubscriptionDeliveryOptions