M

ParameterUtils.DownloadParameterOptions

Description:
Retrieves settings associated with the given parameter from the Parameters Service.

Remarks:

The settings associated with a parameter definition are accessible only to an authorized user. To retrieve them, the user must be signed in.

This method only supports parameter definitions on Parameters Service accounts in the US.

Overloads (2):

DownloadParameterOptions

DownloadParameterOptions(ForgeTypeId)

DownloadParameterOptions(ForgeTypeId,String)

[ObsoleteAttribute("This method is deprecated in Revit 2027 and may be removed in a later version of Revit. We suggest you use the overload which accepts a region input instead.")]
public static ParameterDownloadOptions DownloadParameterOptions(
	ForgeTypeId parameterTypeId
)

<ObsoleteAttribute("This method is deprecated in Revit 2027 and may be removed in a later version of Revit. We suggest you use the overload which accepts a region input instead.")>
Public Shared Function DownloadParameterOptions ( 
	parameterTypeId As ForgeTypeId
) As ParameterDownloadOptions

public:
[ObsoleteAttribute(L"This method is deprecated in Revit 2027 and may be removed in a later version of Revit. We suggest you use the overload which accepts a region input instead.")]
static ParameterDownloadOptions^ DownloadParameterOptions(
	ForgeTypeId^ parameterTypeId
)

[<ObsoleteAttribute("This method is deprecated in Revit 2027 and may be removed in a later version of Revit. We suggest you use the overload which accepts a region input instead.")>]
static member DownloadParameterOptions : 
        parameterTypeId : ForgeTypeId -> ParameterDownloadOptions

ForgeTypeId

parameterTypeId

Parameter identifier.

Return Value ParameterDownloadOptions Settings associated with a parameter.

AccessDeniedException

Thrown when the user is not authorized to access the requested information.
ArgumentException

Thrown when the given parameter identifier is empty.
ArgumentNullException

A non-optional argument was null
[!:Autodesk::Revit::Exceptions::NetworkCommunicationError]

Thrown when communication with the Parameters Service is unsuccessful.
ResourceNotFoundException

Thrown when the requested parameter is not found.
ServerInternalException

Thrown when the Parameters Service reports an internal error.
UnauthenticatedException

Thrown when the user is not signed in.