3.1.4.16.3 GetSiteElementFromSiteID (Opnum 5)

  • Article

The GetSiteElementFromSiteId method is received by the server in an RPC_REQUEST packet. In response, the server obtains the site section element from a specific site ID in order to access site configuration and properties.

 HRESULT GetSiteElementFromSiteId(
   [in] DWORD dwSiteId,
   [out, retval] IAppHostElement** ppSiteElement
 );

dwSiteId: The unique site ID number that is represented in a double-word format.

ppSiteElement: Returns an administration element object that represents the site element of the site section and includes properties, metadata, and methods.

Return Values: The server MUST return zero if it successfully processes the message that is received from the client. 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.

0X00000008 

ERROR_NOT_ENOUGH_MEMORY

Not enough memory is available to process this command.

0X80070002

ERROR_FILE_NOT_FOUND

The given site ID could not be found.