Namespace: Autodesk.Revit.DB Class: ParameterUtils

ParameterUtils.DownloadParameterOptions

Method

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.

Syntax

public static ParameterDownloadOptions DownloadParameterOptions(
	ForgeTypeId parameterTypeId
)

Public Shared Function DownloadParameterOptions ( 
	parameterTypeId As ForgeTypeId
) As ParameterDownloadOptions

public:
static ParameterDownloadOptions^ DownloadParameterOptions(
	ForgeTypeId^ parameterTypeId
)

static member DownloadParameterOptions : 
        parameterTypeId : ForgeTypeId -> ParameterDownloadOptions

Parameters

Parameter	Type	Description
parameterTypeId	ForgeTypeId	Parameter identifier.

Return Value

Type	Description
ParameterDownloadOptions	Settings associated with a parameter.

Exceptions

Exception	Condition
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.