PromptToAuthenticate Property

  • Article

The PromptToAuthenticate property contains the flag that indicates whether to display a user authentication dialog box when the current user cannot access the item because of permission restrictions.

Property PromptToAuthenticate As Boolean[C++]
Get method:
HRESULT get_PromptToAuthenticate(VARIANT_BOOL*pPromptToAuthenticate);
Put method:
HRESULT put_PromptToAuthenticate(VARIANT_BOOLvarPromptToAuthenticate);

[Visual Basic]

Parameters

None.

Return Values

This property returns a Boolean that contains the flag that indicates whether to display a user authentication dialog box.

Error Values

If an error is raised, Err.Number is set to one of the values documented on the Error Messages page.

[C++]

Parameters

Get method:

  • pPromptToAuthenticate
    [out, retval] Pointer to a VARIANT_BOOL that contains the flag that indicates whether to display a user authentication dialog box.

Put method:

  • varPromptToAuthenticate
    [in] VARIANT_BOOL that contains the flag that indicates whether to display a user authentication dialog box.
Return Values

For a list of error messages returned by SharePoint Portal Server, see Error Messages.

Remarks

When the PromptToAuthenticate property is VARIANT_TRUE, it specifies that an authentication dialog box is presented whenever the user is unable to access the item due to user permission restrictions.