Expand Minimize

MI_SubscriptionDeliveryOptions_GetCredentialsAt function

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,
  _Outptr_result_z_ const MI_Char **optionName,
  _Out_      MI_UserCredentials *credentials,
  _Out_opt_  MI_Uint32 *flags
);

Parameters

self [in]

A MI_SubscriptionDeliveryOptions structure.

index

Zero-based index of the credential.

optionName

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

credentials [out]

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

flags [out, optional]

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.

Return codeDescription
MI_RESULT_OK

The operation succeeded.

MI_RESULT_SERVER_LIMITS_EXCEEDED

There is not enough memory to complete the request.

MI_RESULT_INVALID_PARAMETER

One or more parameters passed to the function were not valid.

MI_RESULT_FAILED

A failure not covered by other MI_Result error codes.

 

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Redistributable

Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2

Header

Mi.h

See also

MI_SubscriptionDeliveryOptions
MI_SubscriptionDeliveryOptions_GetCredentialsPasswordAt

 

 

Show:
© 2014 Microsoft