3.1.4.4.2 GetAddElementSchema (Opnum 4)

  • Article

The GetAddElementSchema method is received by the server in an RPC_REQUEST packet. In response, the server returns an IAppHostElementSchema that represents the schema and constraints of the IAppHostElement. The IAppHostElement can be a collection item of the specified IAppHostElementCollection from which the specified IAppHostCollectionSchema was retrieved and whose name matches the specified name in the method call.

 HRESULT GetAddElementSchema(
   [in] BSTR bstrElementName,
   [out, retval] IAppHostElementSchema** ppSchema
 );

bstrElementName: The name of the IAppHostElement that is contained in the specified collection. It is one of the names that is returned in the AddElementNames method.

ppSchema: Returns the IAppHostElementSchema schema object that is associated with the specified element name.

Return Values: The server MUST return zero if it successfully processes the message that is received from the client. In this case, *ppSchema MUST NOT be NULL. If processing fails, the server MUST return a nonzero HRESULT code as defined in [MS-ERREF]. The following table describes the error conditions that MUST be handled and the corresponding error codes. A server MAY return additional implementation-specific error codes.

Return value/code

Description

0X00000000

NO_ERROR

The operation completed successfully.

0X80070057

ERROR_INVALID_PARAMETER

One or more parameters are incorrect or null.

0X80070585

ERROR_INVALID_INDEX

The element specified by bstrElementName cannot be found.