Locates the named parameter in the parameter bag and returns the value of the object it holds.


Namespace: FileNet.Api.Action
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
Public Overridable Function GetIdValue( _ 
   ByVal name As String _ 
) As Id
C#
public virtual Id GetIdValue(
   string name
)
C++
public:
 virtual Id GetIdValue(
   String name
)
J#
public virtual Id GetIdValue(
   string name
)
JScript
public virtual  function GetIdValue(
   name : String
) : Id

Parameters

name
A String that specifies the parameter name to retrieve.

Return Value

The value of the parameter as an Id object. Returns Null if the parameter cannot be found in the parameter bag.

Exceptions

Exception TypeCondition
API_INVALID_PROPERTY_TYPE Thrown if the parameter is not of the type being requested.

See Also