• Article

CubeDef.GetSchemaObject Method (SchemaObjectType, String, Boolean)

Returns an object associated with the CubeDef from a specified schema rowset.

Namespace:  Microsoft.AnalysisServices.AdomdClient
Assembly:  Microsoft.AnalysisServices.AdomdClient (in Microsoft.AnalysisServices.AdomdClient.dll)

Syntax

'Declaration
Public Function GetSchemaObject ( _
    schemaObjectType As SchemaObjectType, _
    uniqueName As String, _
    retryUniqueNameOnServer As Boolean _
) As Object
'Usage
Dim instance As CubeDef
Dim schemaObjectType As SchemaObjectType
Dim uniqueName As String
Dim retryUniqueNameOnServer As Boolean
Dim returnValue As Object

returnValue = instance.GetSchemaObject(schemaObjectType, _
    uniqueName, retryUniqueNameOnServer)

public Object GetSchemaObject(
    SchemaObjectType schemaObjectType,
    string uniqueName,
    bool retryUniqueNameOnServer
)

public:
Object^ GetSchemaObject(
    SchemaObjectType schemaObjectType, 
    String^ uniqueName, 
    bool retryUniqueNameOnServer
)

member GetSchemaObject : 
        schemaObjectType:SchemaObjectType * 
        uniqueName:string * 
        retryUniqueNameOnServer:bool -> Object 

public function GetSchemaObject(
    schemaObjectType : SchemaObjectType, 
    uniqueName : String, 
    retryUniqueNameOnServer : boolean
) : Object

Parameters

  • uniqueName
    Type: System.String
    The unique name of the object to find.
  • retryUniqueNameOnServer
    Type: System.Boolean
    Determines whether to resolve the unique name on the server if it is not found in the client cache. Setting this to false may improve performance by preventing round trips to the server when objects are not found in the client cache. This should be set to false only when the uniqueName parameter is in the same format as the format used by the client cache, thus preventing the need to attempt unique name resolution on the server.

Return Value

Type: System.Object
An Object that contains an object associated with the CubeDef.

Remarks

This method can be used to retrieve Dimension, Hierarchy, Level, Member, Measure, NamedSet, and other objects that are associated with the CubeDef without navigating the collections associated with these objects.

If the uniqueName parameter is set to an empty string, or if the specified object cannot be found, an exception is raised.